com.sun.appserv.management.config
Interface SystemPropertiesAccess

All Known Subinterfaces:

ClusterConfig, ClusteredServerConfig, ConfigConfig, DomainConfig, ServerConfig, StandaloneServerConfig

public interface SystemPropertiesAccess

All MBeans that have system Properties must extend this interface.

Properties are always Strings. Property names are required to be unique.

See Also:

ClusterConfig, ConfigConfig, DomainConfig, ClusteredServerConfig, StandaloneServerConfig

Field Summary

static String

SYSTEM_PROPERTY_PREFIX When a key is required for a system property in a Map, its name must consist of this prefix plus the actual name.

Method Summary

void	createSystemProperty(String propertyName, String propertyValue) Create a new system property.
boolean	existsSystemProperty(String propertyName) Return true if any system properties exist with the specified name.
Map<String,String>	getSystemProperties()
String[]	getSystemPropertyNames() Get the names of all system properties.
String	getSystemPropertyValue(String propertyName) Get the value of a property.
void	removeSystemProperty(String propertyName) Remove a system property with the specified name.
void	setSystemPropertyValue(String propertyName, String propertyValue) Set the value of a system property.

Field Detail

SYSTEM_PROPERTY_PREFIX

static final String SYSTEM_PROPERTY_PREFIX

When a key is required for a system property in a Map, its name must consist of this prefix plus the actual name. When accessing a property directly, this prefix must not be used.

See Also:

Constant Field Values

Method Detail

getSystemPropertyNames

String[] getSystemPropertyNames()

Get the names of all system properties.

getSystemProperties

Map<String,String> getSystemProperties()

Returns:

Map containing all properties, keyed by name

getSystemPropertyValue

String getSystemPropertyValue(String propertyName)

Get the value of a property.

Parameters:

propertyName - the name of the property

setSystemPropertyValue

void setSystemPropertyValue(String propertyName,
                            String propertyValue)

Set the value of a system property. The property must already exist. The existing description is retained.

Parameters:

propertyName - the name of the property

propertyValue - the value of the property

existsSystemProperty

boolean existsSystemProperty(String propertyName)

Return true if any system properties exist with the specified name.

Parameters:

propertyName - the name of the property

createSystemProperty

void createSystemProperty(String propertyName,
                          String propertyValue)

Create a new system property.

Parameters:

propertyName - the name of the property

propertyValue - the value of the property

removeSystemProperty

void removeSystemProperty(String propertyName)

Remove a system property with the specified name.

Parameters:

propertyName - the name of the property