|
Oracle Fusion Middleware Configuration MBean Java API Reference for Oracle Identity Federation 11g Release 1 (11.1.1) E14683-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertiesMapMXBean
Config MBean to manage Server properties; contains Property, PropertiesList and PropertyMap elements.
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 |
---|
javax.management.ObjectName getParent()
java.lang.String getName()
javax.management.ObjectName[] retrieveAllPropertiesLists()
javax.management.ObjectName[] retrieveAllPropertiesMaps()
javax.management.ObjectName createPropertiesList(java.lang.String name)
name
- The name of the PropertiesList element to be created. Cannot be null or the empty string.java.lang.NullPointerException
- if the name is nulljava.lang.IllegalArgumentException
- if the name is an empty string or if a PropertiesList object with the specified name already exists in this PropertiesMap.javax.management.ObjectName createPropertiesMap(java.lang.String name)
name
- The name of the PropertiesMap element to be created. Cannot be null or the empty string.java.lang.NullPointerException
- if the name is nulljava.lang.IllegalArgumentException
- if the name is an empty string or if a PropertiesMap object with the specified name already exists in this PropertiesMap.boolean destroyPropertiesList(java.lang.String name)
name
- The name of the PropertiesList object to be removed.boolean destroyPropertiesMap(java.lang.String name)
name
- The name of the PropertiesMap object to be removed.void destroyAllPropertiesLists()
void destroyAllPropertiesMaps()
java.lang.String putProperty(java.lang.String name, java.lang.String value, java.lang.String type)
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.java.lang.NullPointerException
- if name, value, or type is nulljava.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 longboolean removeProperty(java.lang.String name)
name
- The name of the Property to be removed.boolean hasProperty(java.lang.String name)
name
- The name of the Propertyboolean hasPropertiesList(java.lang.String name)
name
- The name of the PropertiesListboolean hasPropertiesMap(java.lang.String name)
name
- The name of the PropertiesMapvoid removeAllProperties()
java.lang.String retrievePropertyValue(java.lang.String name)
name
- The name of the Propertyjava.lang.String retrievePropertyType(java.lang.String name)
name
- The name of the Propertyjavax.management.ObjectName retrievePropertiesList(java.lang.String name)
name
- The name of the PropertiesListjavax.management.ObjectName retrievePropertiesMap(java.lang.String name)
name
- The name of the PropertiesMapjava.lang.String[] retrieveAllPropertyNames()
|
Oracle Fusion Middleware Configuration MBean Java API Reference for Oracle Identity Federation 11g Release 1 (11.1.1) E14683-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |