org.jboss.as.controller.operations.common

Interface ProcessEnvironmentSystemPropertyUpdater

public interface ProcessEnvironmentSystemPropertyUpdater

Author:

Kabir Khan

Method Summary

Modifier and Type	Method and Description
boolean	isRuntimeSystemPropertyUpdateAllowed(String propertyName, String propertyValue, boolean bootTime) Gets whether updating the runtime system properties with the given property is allowed.
void	systemPropertyUpdated(String propertyName, String propertyValue) Notifies this ProcessEnvironment that the runtime value of the given system property has been updated, allowing it to update any state that was originally set via the system property during primordial process boot.

Method Detail

isRuntimeSystemPropertyUpdateAllowed

boolean isRuntimeSystemPropertyUpdateAllowed(String propertyName,
                                             String propertyValue,
                                             boolean bootTime)
                                      throws OperationFailedException

Gets whether updating the runtime system properties with the given property is allowed.

Parameters:

propertyName - the name of the property. Cannot be null

propertyValue - the value of the property. May be null

bootTime - true if the process is currently booting

Returns:

true if the update can be applied to the runtime system properties; false if it should just be stored in the persistent configuration and the process should be put into reload-required state.

Throws:

OperationFailedException - if a change to the given property is not allowed at all; e.g. changing jboss.server.base.dir after primordial boot is not allowed; the property can only be set from the command line

systemPropertyUpdated

void systemPropertyUpdated(String propertyName,
                           String propertyValue)

Notifies this ProcessEnvironment that the runtime value of the given system property has been updated, allowing it to update any state that was originally set via the system property during primordial process boot. This method should only be invoked after a call to isRuntimeSystemPropertyUpdateAllowed(String, String, boolean) has returned true.

Parameters:

propertyName - the name of the property. Cannot be null

propertyValue - the value of the property. May be null