|
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 ConfigMXBean
Config MBean to manage Server properties; contains Property, PropertiesList and PropertiesMap elements.
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 |
---|
javax.management.ObjectName getParent()
java.lang.String getName()
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 config, 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 longjava.lang.String retrievePropertyType(java.lang.String name)
name
- The name of the Propertyboolean hasProperty(java.lang.String name)
boolean hasPropertiesList(java.lang.String name)
boolean hasPropertiesMap(java.lang.String name)
boolean removeProperty(java.lang.String name)
name
- The name of the Property to be removed.void removeAllProperties()
javax.management.ObjectName createPropertiesList(java.lang.String name)
name
- The name of the PropertiesList to be created. Cannot be null or an empty string.java.lang.NullPointerException
- if the name is nulljava.lang.IllegalArgumentException
- if the name is an empty string, or if there already exists a PropertiesList in this Config with the specified name.javax.management.ObjectName createPropertiesMap(java.lang.String name)
name
- The name of the PropertiesMap to be created. Cannot be null or an empty string.java.lang.NullPointerException
- if name is null or if type is nulljava.lang.IllegalArgumentException
- if name is an empty string, if there already exists a PropertiesMap in this Config with the specified name.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()
javax.management.ObjectName[] retrieveAllPropertiesLists()
javax.management.ObjectName[] retrieveAllPropertiesMaps()
javax.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 retrievePropertyValue(java.lang.String name)
name
- The name of the Property
|
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 |