org.jboss.as.server

Class ServerEnvironmentSystemPropertyUpdater

java.lang.Object

org.jboss.as.server.ServerEnvironmentSystemPropertyUpdater

All Implemented Interfaces:

ProcessEnvironmentSystemPropertyUpdater

public class ServerEnvironmentSystemPropertyUpdater
extends Object
implements ProcessEnvironmentSystemPropertyUpdater

Author:

Kabir Khan

Constructor Summary

Constructors

Constructor and Description
ServerEnvironmentSystemPropertyUpdater(ServerEnvironment serverEnvironment)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerEnvironmentSystemPropertyUpdater

public ServerEnvironmentSystemPropertyUpdater(ServerEnvironment serverEnvironment)

Method Detail

isRuntimeSystemPropertyUpdateAllowed

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

Description copied from interface: ProcessEnvironmentSystemPropertyUpdater

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

Specified by:

isRuntimeSystemPropertyUpdateAllowed in interface ProcessEnvironmentSystemPropertyUpdater

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

public void systemPropertyUpdated(String propertyName,
                                  String propertyValue)

Description copied from interface: ProcessEnvironmentSystemPropertyUpdater

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 ProcessEnvironmentSystemPropertyUpdater.isRuntimeSystemPropertyUpdateAllowed(String, String, boolean) has returned true.

Specified by:

systemPropertyUpdated in interface ProcessEnvironmentSystemPropertyUpdater

Parameters:

propertyName - the name of the property. Cannot be null

propertyValue - the value of the property. May be null