Skip navigation links

Oracle Fusion Middleware Configuration MBean Java API Reference for Oracle Identity Federation
11g Release 1 (11.1.1)

E14683-01


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


public interface PropertiesListMXBean

Config MBean to manage Server properties; contains Property elements.

Since:
11.1.1.1.0

Method Summary
 void addProperty(java.lang.String value, java.lang.String type)
          Creates a Property with the specified value and type and no name, and adds it at the end of the this PropertiesList.
 void addProperty(java.lang.String value, java.lang.String type, int index)
          Creates a Property with the specified value, and type and no name, and adds it at the specified index in this PropertiesList.
 java.lang.String getName()
          Returns the name of this PropertiesList object
 javax.management.ObjectName getParent()
          Returns the Object Name of the parent MBean of this PropertiesList MBean.
 boolean hasPropertyValue(java.lang.String value)
          Returns true if there exists at least one Property in this PropertiesList with the specified value.
 int indexOf(java.lang.String value)
          Returns the index of the first Property in this PropertiesList that has the specified value
 void removeAllProperties()
          Removes all Property elements in this PropertiesList.
 java.lang.String removeProperty(int index)
          Removes the Property at the specified index in this PropertiesList.
 boolean removeProperty(java.lang.String value)
          Removes the first Property in this PropertiesList with the specified value
 java.lang.String[] retrieveAllPropertyValues()
          Returns a String[] containg the values of all Property elements in this PropertiesList.
 int retrieveNumberOfProperties()
          Returns the number of Property elements in this PropertiesList.
 java.lang.String retrievePropertyType(int index)
          Returns the type of the Property at the specified index in this PropertiesList.
 java.lang.String retrievePropertyValue(int index)
          Returns the value of the Property at the specified index in this PropertiesList.

 

Method Detail

getParent

javax.management.ObjectName getParent()
Returns the Object Name of the parent MBean of this PropertiesList MBean.
Returns:
the Object Name of the parent MBean of this PropertiesList MBean.

getName

java.lang.String getName()
Returns the name of this PropertiesList object
Returns:
The Name of this PropertiesList object

addProperty

void addProperty(java.lang.String value,
                 java.lang.String type)
Creates a Property with the specified value and type and no name, and adds it at the end of the this PropertiesList. The value and type cannot be null. The type must be one of: string, long, boolean. If the type is long, the value must be either an empty string or a long, as decided by Long.parseLong. If the type is boolean, the value must be one of: true, false.
Parameters:
value - The value of the Property to be created. Cannot be null.
type - The type of the Property to be created. Cannot be null. Must be one of: string, long, boolean.
Throws:
java.lang.NullPointerException - if the value or the type is null
java.lang.IllegalArgumentException - if the given type is not one of: string, long, boolean, or if the the given 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

addProperty

void addProperty(java.lang.String value,
                 java.lang.String type,
                 int index)
Creates a Property with the specified value, and type and no name, and adds it at the specified index in this PropertiesList. The value and type cannot be null. The type must be one of: string, long, boolean. If the type is long, the value must be either an empty string or a long, as decided by Long.parseLong. If the type is boolean, the value must be one of: true, false.
Parameters:
value - The value of the Property to be created. Cannot be null.
type - The type of the Property to be created. Cannot be null. Must be one of: string, long, boolean.
index - The index at which the Property is to be added.
Throws:
java.lang.NullPointerException - if value, or type is null
java.lang.IllegalArgumentException - if the given type is not one of: string, long, boolean, or if the the given 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
java.lang.IndexOutOfBoundsException - if index < 0 || index > retrieveNumberOfProperties()

removeProperty

java.lang.String removeProperty(int index)
Removes the Property at the specified index in this PropertiesList.
Parameters:
index - The index of the Property to be removed.
Returns:
The value of the Property that was removed
Throws:
java.lang.IndexOutOfBoundsException - if index < 0 || index >= retrieveNumberOfProperties()

removeProperty

boolean removeProperty(java.lang.String value)
Removes the first Property in this PropertiesList with the specified value
Parameters:
value - The value of the Property to be removed
Returns:
true if a Property was removed, false otherwise

indexOf

int indexOf(java.lang.String value)
Returns the index of the first Property in this PropertiesList that has the specified value
Parameters:
value - The value of the Property whose index is to be returned
Returns:
The index of the first Property in this PropertiesList that has the specified value

removeAllProperties

void removeAllProperties()
Removes all Property elements in this PropertiesList.

retrievePropertyType

java.lang.String retrievePropertyType(int index)
Returns the type of the Property at the specified index in this PropertiesList.
Parameters:
index - The index of the Property
Returns:
The type of the Property at the specified index in this PropertiesList.
Throws:
java.lang.IndexOutOfBoundsException - if index < 0 || index > retrieveNumberOfProperties() - 1

retrievePropertyValue

java.lang.String retrievePropertyValue(int index)
Returns the value of the Property at the specified index in this PropertiesList.
Parameters:
index - The index of the Property
Returns:
The value of the Property at the specified index in this PropertiesList.
Throws:
java.lang.IndexOutOfBoundsException - if index < 0 || index > retrieveNumberOfProperties() - 1

retrieveNumberOfProperties

int retrieveNumberOfProperties()
Returns the number of Property elements in this PropertiesList.
Returns:
the number of Property elements in this PropertiesList.

retrieveAllPropertyValues

java.lang.String[] retrieveAllPropertyValues()
Returns a String[] containg the values of all Property elements in this PropertiesList. Values are returned in the same order as their corresponding Property elements in this PropertiesList.
Returns:
a String[] containing the values of all Property elements in this PropertiesList

hasPropertyValue

boolean hasPropertyValue(java.lang.String value)
Returns true if there exists at least one Property in this PropertiesList with the specified value. Returns false otherwise.
Parameters:
value - The value of the Property
Returns:
if there exists at least one Property in this PropertiesList with the specified value; false otherwise.

Skip navigation links

Oracle Fusion Middleware Configuration MBean Java API Reference for Oracle Identity Federation
11g Release 1 (11.1.1)

E14683-01


Copyright © 2009, Oracle. All rights reserved.