Skip navigation links

oracle.security.fed.admin.config.mbeans
Interface ConfigMXBean

public interface ConfigMXBean

Config MBean to manage Server properties; contains Property, PropertiesList and PropertiesMap elements.

Since:

11.1.1.1.0

Method Summary

javax.management.ObjectName	createPropertiesList(java.lang.String name) Creates a PropertiesList element with the specified name, and registers its corresponding MBean in the MBean server.
javax.management.ObjectName	createPropertiesMap(java.lang.String name) Creates a PropertiesMap object with the specified name, and registers its corresponding MBean in the MBean server.
void	destroyAllPropertiesLists() Removes all PropertiesList elements from this Config and unregisters their corresponding MBeans from the MBean server.
void	destroyAllPropertiesMaps() Removes all PropertiesMap elements from this Config and unregisters their corresponding MBeans from the MBean server.
boolean	destroyPropertiesList(java.lang.String name) Removes the PropertiesList element with the specified name from this Config, and unregisters its corresponding MBean from the MBean server.
boolean	destroyPropertiesMap(java.lang.String name) Removes the PropertiesMap element with the specified name from this Config, and unregisters its corresponding MBean from the MBean server.
java.lang.String	getName() Returns the name attribute of the Config object.
javax.management.ObjectName	getParent() Returns the Object Name of the parent MBean of this Config MBean.
boolean	hasPropertiesList(java.lang.String name) Returns true if there exists a PropertiesList element in this Config with the specified name; returns false otherwise.
boolean	hasPropertiesMap(java.lang.String name) Returns true if there exists a PropertiesMap element in this Config with the specified name; returns false otherwise.
boolean	hasProperty(java.lang.String name) Returns true if there exists a Property in this Config with the specified name; returns false otherwise.
java.lang.String	putProperty(java.lang.String name, java.lang.String value, java.lang.String type) If there exists a Property element in this Config with the specified name, sets the value of the Property to the specified value.
void	removeAllProperties() Removes all Property objects in this Config.
boolean	removeProperty(java.lang.String name) Removes the Property with the specified name in this Config.
javax.management.ObjectName[]	retrieveAllPropertiesLists() Returns the ObjectNames of all PropertiesLists in this Config registered on the MBean server
javax.management.ObjectName[]	retrieveAllPropertiesMaps() Returns the ObjectNames of all PropertyMaps in this Config registered on the MBean server
javax.management.ObjectName	retrievePropertiesList(java.lang.String name) Returns the ObjectName with which the PropertiesList with the specified name is registered on the MBean server, or null if no such PropertiesList exists in this Config.
javax.management.ObjectName	retrievePropertiesMap(java.lang.String name) Returns the ObjectName with which the PropertiesMap with the specified name is registered on the MBean server, or null if no such PropertiesMap exists.
java.lang.String	retrievePropertyType(java.lang.String name) Returns the type of the Property with the specified name.
java.lang.String	retrievePropertyValue(java.lang.String name) Returns the value of the Property with the specified name.

Method Detail

getParent

javax.management.ObjectName getParent()

Returns the Object Name of the parent MBean of this Config MBean.

Returns:

the Object Name of the parent MBean of this Config MBean.

getName

java.lang.String getName()

Returns the name attribute of the Config object.

Returns:

The name attribute of the Config object

putProperty

java.lang.String putProperty(java.lang.String name,
                             java.lang.String value,
                             java.lang.String type)

If there exists a Property element in this Config with the specified name, sets the value of the Property to the specified value. Otherwise, creates a Property with the given name, value, and type. If there exists a Property element in this Config with the specified name, the type of the existing Property must be equal to the specified type. The name and the type cannot be null or an empty string. The type must be one of: string, long, boolean. If the type is long, the value must be either the empty string or a long, as decided by Long.parseLong. If the type is boolean, the value must be one of: true, false.

Parameters:

name - The name of the Property to be set. Cannot be null or an empty string.

value - The value of the Property to be set. Cannot be null.

type - The type of the Property to be set. Cannot be null. Must be one of: string, long, boolean. If a Property with the specified name already exists in this config, this parameter must equal the type of the existing property.

Returns:

The previous value of the existing Property if one existed; null otherwise.

Throws:

java.lang.NullPointerException - if name, value, or type is null

java.lang.IllegalArgumentException - if a Property with the specified name already exists and its type is not equal to the specified type, or if the name is an empty string, or if the type is not one of: string, long, boolean, or if the type is boolean and the value is not one of: true, false.

java.lang.NumberFormatException - if the type specified is long and the value is neither an empty string nor a parsable long

retrievePropertyType

java.lang.String retrievePropertyType(java.lang.String name)

Returns the type of the Property with the specified name. Returns null if no such Property exists.

Parameters:

name - The name of the Property

Returns:

the type of the Property with the specified name or null if no Property exists in this Config with the specified name.

hasProperty

boolean hasProperty(java.lang.String name)

Returns true if there exists a Property in this Config with the specified name; returns false otherwise.

Returns:

true if there exists a Property in this Config with the specified name; false otherwise.

hasPropertiesList

boolean hasPropertiesList(java.lang.String name)

Returns true if there exists a PropertiesList element in this Config with the specified name; returns false otherwise.

Returns:

true if there exists a PropertiesList element in this Config with the specified name; false otherwise.

hasPropertiesMap

boolean hasPropertiesMap(java.lang.String name)

Returns true if there exists a PropertiesMap element in this Config with the specified name; returns false otherwise.

Returns:

true if there exists a PropertiesMap element in this Config with the specified name; false otherwise.

removeProperty

boolean removeProperty(java.lang.String name)

Removes the Property with the specified name in this Config. Does nothing if no such Property exits.

Parameters:

name - The name of the Property to be removed.

Returns:

true if a Property was removed, false otherwise

removeAllProperties

void removeAllProperties()

Removes all Property objects in this Config.

createPropertiesList

javax.management.ObjectName createPropertiesList(java.lang.String name)

Creates a PropertiesList element with the specified name, and registers its corresponding MBean in the MBean server. The given name cannot be null or an empty string. An IllegalArgumentException is thrown if there already exists a PropertiesList element in this Config with the specified name.

Parameters:

name - The name of the PropertiesList to be created. Cannot be null or an empty string.

Returns:

The ObjectName with which the PropertiesList MBean was registered on the MBean server

Throws:

java.lang.NullPointerException - if the name is null

java.lang.IllegalArgumentException - if the name is an empty string, or if there already exists a PropertiesList in this Config with the specified name.

createPropertiesMap

javax.management.ObjectName createPropertiesMap(java.lang.String name)

Creates a PropertiesMap object with the specified name, and registers its corresponding MBean in the MBean server. The name cannot be null or an empty string. An IllegalArgumentException is thrown if there already exists a PropertiesMap element in this Config with the specified name.

Parameters:

name - The name of the PropertiesMap to be created. Cannot be null or an empty string.

Returns:

The ObjectName with which the PropertiesMap MBean was registered on the MBean server

Throws:

java.lang.NullPointerException - if name is null or if type is null

java.lang.IllegalArgumentException - if name is an empty string, if there already exists a PropertiesMap in this Config with the specified name.

destroyPropertiesList

boolean destroyPropertiesList(java.lang.String name)

Removes the PropertiesList element with the specified name from this Config, and unregisters its corresponding MBean from the MBean server. Does nothing if no such PropertiesList exists.

Parameters:

name - The name of the PropertiesList object to be removed.

Returns:

true if a PropertiesList object was removed, false otherwise

destroyPropertiesMap

boolean destroyPropertiesMap(java.lang.String name)

Removes the PropertiesMap element with the specified name from this Config, and unregisters its corresponding MBean from the MBean server. Does nothing if no such PropertiesMap exists.

Parameters:

name - The name of the PropertiesMap object to be removed.

Returns:

true if a PropertiesMap object was removed, false otherwise

destroyAllPropertiesLists

void destroyAllPropertiesLists()

Removes all PropertiesList elements from this Config and unregisters their corresponding MBeans from the MBean server.

destroyAllPropertiesMaps

void destroyAllPropertiesMaps()

Removes all PropertiesMap elements from this Config and unregisters their corresponding MBeans from the MBean server.

retrieveAllPropertiesLists

javax.management.ObjectName[] retrieveAllPropertiesLists()

Returns the ObjectNames of all PropertiesLists in this Config registered on the MBean server

Returns:

An ObjectName[] containg all PropertyLists in this Config registered on the MBean server

retrieveAllPropertiesMaps

javax.management.ObjectName[] retrieveAllPropertiesMaps()

Returns the ObjectNames of all PropertyMaps in this Config registered on the MBean server

Returns:

An ObjectName[] containg all PropertyMaps in this Config registered on the MBean server

retrievePropertiesList

javax.management.ObjectName retrievePropertiesList(java.lang.String name)

Returns the ObjectName with which the PropertiesList with the specified name is registered on the MBean server, or null if no such PropertiesList exists in this Config.

Parameters:

name - The name of the PropertiesList

Returns:

the ObjectName with which the PropertiesList with the specified name is registered on the MBean server, or null if there is no PropertiesList in this Config with the specified name.

retrievePropertiesMap

javax.management.ObjectName retrievePropertiesMap(java.lang.String name)

Returns the ObjectName with which the PropertiesMap with the specified name is registered on the MBean server, or null if no such PropertiesMap exists.

Parameters:

name - The name of the PropertiesMap

Returns:

the ObjectName with which the PropertiesMap with the specified name is registered on the MBean server, or null if there is no PropertiesMap in this Config with the specified name.

retrievePropertyValue

java.lang.String retrievePropertyValue(java.lang.String name)

Returns the value of the Property with the specified name. Returns null if no Property exists with the given name.

Parameters:

name - The name of the Property

Returns:

the value of the Property with the specified name or null if no Property exists in this Config with the given name.

Skip navigation links