com.ibm.ia.runtime.management

Interface GlobalPropertiesMXBean

@MXBean
public interface GlobalPropertiesMXBean

An MBean that represents server configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MXBEAN_OBJECT_NAME The object name by which a JMX client can find the GlobalPropertiesMXBean

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getProperty(java.lang.String name) Retrieves the property value given the name of the attribute.
java.util.List<java.lang.String>	listProperties() Lists the names of the available global properties.
java.lang.String	setProperty(java.lang.String name, java.lang.String value) Writes the property value to the configuration.

Field Detail

MXBEAN_OBJECT_NAME

static final java.lang.String MXBEAN_OBJECT_NAME

The object name by which a JMX client can find the GlobalPropertiesMXBean

See Also:

Constant Field Values

Method Detail

getProperty

java.lang.String getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Retrieves the property value given the name of the attribute.

String value = serverConfig.getProperty("solutionAutoStart");

Throws:

java.lang.IllegalArgumentException - if the property name is not recognized.

Parameters:

name - the attribute name.

Returns:

The value of the property set or null if not set.

setProperty

java.lang.String setProperty(java.lang.String name,
                           java.lang.String value)
                             throws java.lang.IllegalArgumentException,
                                    java.io.IOException

Writes the property value to the configuration.

String previous = serverConfig.setProperty("solutionAutoStart", "true");

Throws:

java.lang.IllegalArgumentException - if the property name is not recognized.

java.io.IOException - if there was a problem updating the server.xml file

Parameters:

name - the attribute name.

value - the value of the property to set.

Returns:

The previous value of the property set or null if not set.

listProperties

java.util.List<java.lang.String> listProperties()

Lists the names of the available global properties.

List<String> properties = serverConfig.listProperties();

Returns:

The list of global property attributes that may be set