org.jboss.as.controller.operations.common

Class SystemPropertyAddHandler

java.lang.Object

org.jboss.as.controller.operations.common.SystemPropertyAddHandler

All Implemented Interfaces:

DescriptionProvider, OperationStepHandler

public class SystemPropertyAddHandler
extends Object
implements OperationStepHandler, DescriptionProvider

Operation handler for adding domain/host and server system properties.

Author:

Kabir Khan

Field Summary

Fields

Modifier and Type	Field and Description
static SystemPropertyAddHandler	INSTANCE_WITH_BOOTTIME
static SystemPropertyAddHandler	INSTANCE_WITHOUT_BOOTTIME
static String	OPERATION_NAME

Constructor Summary

Constructors

Constructor and Description
SystemPropertyAddHandler(ProcessEnvironment processEnvironment, boolean useBoottime) Create the SystemPropertyAddHandler

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(OperationContext context, org.jboss.dmr.ModelNode operation) Execute this step.
org.jboss.dmr.ModelNode	getModelDescription(Locale locale) Gets the descriptive information (human-friendly description, list of attributes, list of children) describing a single model node or operation.
static org.jboss.dmr.ModelNode	getOperation(org.jboss.dmr.ModelNode address, String value)
static org.jboss.dmr.ModelNode	getOperation(org.jboss.dmr.ModelNode address, String value, Boolean boottime)
protected boolean	requiresRuntimeVerification()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

See Also:

Constant Field Values

INSTANCE_WITH_BOOTTIME

public static final SystemPropertyAddHandler INSTANCE_WITH_BOOTTIME

INSTANCE_WITHOUT_BOOTTIME

public static final SystemPropertyAddHandler INSTANCE_WITHOUT_BOOTTIME

Constructor Detail

SystemPropertyAddHandler

public SystemPropertyAddHandler(ProcessEnvironment processEnvironment,
                        boolean useBoottime)

Create the SystemPropertyAddHandler

Parameters:

processEnvironment - the local process environment, or null if interaction with the process environment is not required

useBoottime - true if the system property resource should support the "boot-time" attribute

Method Detail

getOperation

public static org.jboss.dmr.ModelNode getOperation(org.jboss.dmr.ModelNode address,
                                   String value)

getOperation

public static org.jboss.dmr.ModelNode getOperation(org.jboss.dmr.ModelNode address,
                                   String value,
                                   Boolean boottime)

execute

public void execute(OperationContext context,
           org.jboss.dmr.ModelNode operation)
             throws OperationFailedException

Description copied from interface: OperationStepHandler

Execute this step. If the operation fails, context.getFailureDescroption() must be called, or OperationFailedException must be thrown, before calling context.completeStep(). If the operation succeeded, context.getResult() should be called and the result populated with the outcome, after which context.completeStep() must be called.

When this method is invoked the thread context classloader will be set to be the defining class loader of the class that implements this interface.

Specified by:

execute in interface OperationStepHandler

Parameters:

context - the operation context

operation - the operation being executed

Throws:

OperationFailedException - if the operation failed before calling context.completeStep()

requiresRuntimeVerification

protected boolean requiresRuntimeVerification()

getModelDescription

public org.jboss.dmr.ModelNode getModelDescription(Locale locale)

Description copied from interface: DescriptionProvider

Gets the descriptive information (human-friendly description, list of attributes, list of children) describing a single model node or operation.

The implementation must assume that the caller intends to modify the returned ModelNode so it should not hand out a reference to any internal data structures.

Specified by:

getModelDescription in interface DescriptionProvider

Parameters:

locale - the locale to use to generate any localized text used in the description. May be null, in which case Locale.getDefault() should be used

Returns:

ModelNode describing the model node's structure