Skip navigation links

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

public interface PropertiesMapMXBean

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

Since:

11.1.1.1.0

Method Summary

javax.management.ObjectName	createPropertiesList(java.lang.String name) Creates a PropertiesList object with the specified name and registers its corresponding MBean on the MBean server.
javax.management.ObjectName	createPropertiesMap(java.lang.String name) Creates a PropertiesMap object with the specified name and registers its corresponding MBean on the MBean server.
void	destroyAllPropertiesLists() Removes all PropertiesList elements from this PropertiesMap and unregisters their corresponding MBeans from the MBean server.
void	destroyAllPropertiesMaps() Removes all PropertiesMap elements from this PropertiesMap 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 PropertiesMap, 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 PropertiesMap, and unregisters its corresponding MBean from the MBean server.
java.lang.String	getName() Returns the name of this PropertiesMap object
javax.management.ObjectName	getParent() Returns the Object Name of the parent MBean of this PropertiesMap MBean.
boolean	hasPropertiesList(java.lang.String name) Returns true if there exists a PropertiesList in this PropertiesMap with the specified name.
boolean	hasPropertiesMap(java.lang.String name) Returns true if there exists a PropertiesMap in this PropertiesMap with the specified name.
boolean	hasProperty(java.lang.String name) Returns true if there exists a Property in this PropertiesMap with the specified name.
java.lang.String	putProperty(java.lang.String name, java.lang.String value, java.lang.String type) If there exists a Property element in this PropertiesMap with the specified name, sets the value of the Property to the specified value.
void	removeAllProperties() Removes all Property elements from this PropertiesMap.
boolean	removeProperty(java.lang.String name) Removes the Property with the specified name from this PropertiesMap .
javax.management.ObjectName[]	retrieveAllPropertiesLists() Returns the ObjectNames of all PropertiesList elements in this PropertiesMap registered in the MBean server.
javax.management.ObjectName[]	retrieveAllPropertiesMaps() Returns the ObjectNames of all PropertiesMap elements in this PropertiesMap registered in the MBean server.
java.lang.String[]	retrieveAllPropertyNames() Returns a String[] containg the names of all Property elements in this PropertiesMap.
javax.management.ObjectName	retrievePropertiesList(java.lang.String name) Returns the ObjectName with which the PropertiesList in this PropertiesMap with the specified name is registered on the MBean server.
javax.management.ObjectName	retrievePropertiesMap(java.lang.String name) Returns the ObjectName with which the PropertiesMap in this PropertiesMap with the specified name is registered on the MBean server.
java.lang.String	retrievePropertyType(java.lang.String name) Returns the type of the Property in this PropertiesMap with the specified name.
java.lang.String	retrievePropertyValue(java.lang.String name) Returns the value of the Property in this PropertiesMap with the specified name.

Method Detail

getParent

javax.management.ObjectName getParent()

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

Returns:

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

getName

java.lang.String getName()

Returns the name of this PropertiesMap object

Returns:

The name of this PropertiesMap object

retrieveAllPropertiesLists

javax.management.ObjectName[] retrieveAllPropertiesLists()

Returns the ObjectNames of all PropertiesList elements in this PropertiesMap registered in the MBean server.

Returns:

An ObjectName[] containg the object names of all PropertiesList elements in this PropertiesMap registered in the MBean server.

retrieveAllPropertiesMaps

javax.management.ObjectName[] retrieveAllPropertiesMaps()

Returns the ObjectNames of all PropertiesMap elements in this PropertiesMap registered in the MBean server.

Returns:

An ObjectName[] containg the object names of all PropertiesMap elements in this PropertiesMap registered in the MBean server.

createPropertiesList

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

Creates a PropertiesList object with the specified name and registers its corresponding MBean on the MBean server. The name cannot be null or the empty string. An IllegalArgumentException is thown if a PropertiesList element with the specified name already exists in this PropertiesMap.

Parameters:

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

Returns:

The ObjectName with which the PropertiesList object 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 a PropertiesList object with the specified name already exists in this PropertiesMap.

createPropertiesMap

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

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

Parameters:

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

Returns:

The ObjectName with which the PropertiesMap object 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 a PropertiesMap object with the specified name already exists in this PropertiesMap.

destroyPropertiesList

boolean destroyPropertiesList(java.lang.String name)

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

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 PropertiesMap, and unregisters its corresponding MBean from the MBean server. Does nothing if no such Properties exist.

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 PropertiesMap and unregisters their corresponding MBeans from the MBean server.

destroyAllPropertiesMaps

void destroyAllPropertiesMaps()

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

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 PropertiesMap 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 PropertiesMap 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 PropertiesMap, 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

removeProperty

boolean removeProperty(java.lang.String name)

Removes the Property with the specified name from this PropertiesMap . 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

hasProperty

boolean hasProperty(java.lang.String name)

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

Parameters:

name - The name of the Property

Returns:

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

hasPropertiesList

boolean hasPropertiesList(java.lang.String name)

Returns true if there exists a PropertiesList in this PropertiesMap with the specified name. Returns false otherwise.

Parameters:

name - The name of the PropertiesList

Returns:

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

hasPropertiesMap

boolean hasPropertiesMap(java.lang.String name)

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

Parameters:

name - The name of the PropertiesMap

Returns:

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

removeAllProperties

void removeAllProperties()

Removes all Property elements from this PropertiesMap.

retrievePropertyValue

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

Returns the value of the Property in this PropertiesMap with the specified name. Returns null if no such Property exists.

Parameters:

name - The name of the Property

Returns:

the value of the Property in this PropertiesMap with the specified name, or null if no such Property exists.

retrievePropertyType

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

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

Parameters:

name - The name of the Property

Returns:

the type of the Property in this PropertiesMap with the specified name, or null if no such Property exists.

retrievePropertiesList

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

Returns the ObjectName with which the PropertiesList in this PropertiesMap with the specified name is registered on the MBean server.

Parameters:

name - The name of the PropertiesList

Returns:

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

retrievePropertiesMap

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

Returns the ObjectName with which the PropertiesMap in this PropertiesMap with the specified name is registered on the MBean server.

Parameters:

name - The name of the PropertiesMap

Returns:

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

retrieveAllPropertyNames

java.lang.String[] retrieveAllPropertyNames()

Returns a String[] containg the names of all Property elements in this PropertiesMap.

Returns:

a String[] containg the names of all Property elements in this PropertiesMap

Skip navigation links