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 DiscoveryProviderMXBean


public interface DiscoveryProviderMXBean

Config MBean to manage Data Store properties; contains a single Dependencies element, containing Dependency and DiscoveryProvider elements.

Since:
11.1.1.1.0

Method Summary
 void changeClassNameTo(java.lang.String value)
          Sets the classname of this DiscoveryProvider to the specified value.
 javax.management.ObjectName createDiscoveryProviderDependency(java.lang.String classname, java.lang.String dependsOn, java.lang.String setter)
          Creates a DiscoveryProvider in this DiscoveryProvider's Dependencies, with the specified classname, dependsOn, setter, and type of this DiscoveryProvider, and registers its corresponding MBean on the MBean server.
 boolean destroyDiscoveryProviderDependency(java.lang.String setter)
          Removes the DiscoveryProvider with the given setter from this DiscoveryProvider's Dependencies, and unregisters its corresponding MBean from the MBean server.
 java.lang.String getDependsOn()
          Returns the value of the dependsOn attribute of this DiscoveryProvider
 javax.management.ObjectName getParent()
          Returns the Object Name of the parent MBean of this DiscoveryProvider MBean.
 java.lang.String getSetter()
          Returns the value of the setter attribute of this DiscoveryProvider
 java.lang.String getType()
          Returns the value of the type attribute of this DiscoveryProvider
 boolean hasDiscoveryProviderDependency(java.lang.String setter)
          Returns true if there exists a DiscoveryProvider with the specified setter in this DiscoveryProvider's Dependencies.
 java.lang.String retrieveClassName()
          Returns the classname of this DiscoveryProvider.
 javax.management.ObjectName[] retrieveDiscoveryProviderDependencies()
          Returns the ObjectNames of all DiscoveryProviders in this DiscoveryProvider's Dependencies, that are registered on the MBean server.
 javax.management.ObjectName retrieveDiscoveryProviderDependency(java.lang.String setter)
          Returns the ObjectName with which the DiscoveryProvider with the specified setter, in this DiscoveryProvider's Dependencies, is registered in the MBean server.

 

Method Detail

getParent

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

getDependsOn

java.lang.String getDependsOn()
Returns the value of the dependsOn attribute of this DiscoveryProvider
Returns:
The value of the dependsOn attribute of this DiscoveryProvider

getSetter

java.lang.String getSetter()
Returns the value of the setter attribute of this DiscoveryProvider
Returns:
The value of the setter attribute of this DiscoveryProvider

getType

java.lang.String getType()
Returns the value of the type attribute of this DiscoveryProvider
Returns:
The value of the type attribute of this DiscoveryProvider

retrieveClassName

java.lang.String retrieveClassName()
Returns the classname of this DiscoveryProvider.
Returns:
The classname of this DiscoveryProvider.

changeClassNameTo

void changeClassNameTo(java.lang.String value)
Sets the classname of this DiscoveryProvider to the specified value. The new value cannot be null or the empty string.
Parameters:
value - The value to which the classname of this DiscoveryProvider is to be set to. Cannot be null or the empty string.
Throws:
java.lang.NullPointerException - if value is null
java.lang.IllegalArgumentException - if value is the empty string

createDiscoveryProviderDependency

javax.management.ObjectName createDiscoveryProviderDependency(java.lang.String classname,
                                                              java.lang.String dependsOn,
                                                              java.lang.String setter)
Creates a DiscoveryProvider in this DiscoveryProvider's Dependencies, with the specified classname, dependsOn, setter, and type of this DiscoveryProvider, and registers its corresponding MBean on the MBean server. The classname, dependOn, and setter cannot be null. The classname and setter cannot be an empty string. An IllegalArgumentException is thrown if there already exists a DiscoveryProvider in this DiscoveryProvider's Dependencies with the given setter.
Parameters:
classname - The classname of the DiscoveryProvider to be created. Cannot be null or an empty string.
dependsOn - The dependsOn of the DiscoveryProvider to be created. Cannot be null.
setter - The setter of the DiscoveryProvider to be created. Cannot be null or an empty string.
Returns:
The ObjectName with which the DiscoveryProvider was registerd on the MBean server, or null if no DiscoveryProvider was created.
Throws:
java.lang.NullPointerException - if classname, dependsOn, or setter is null.
java.lang.IllegalArgumentException - if classname or setter is an empty string, or if there already exists a DiscoveryProvider in this DiscoveryProvider's Dependencies with the given setter.

destroyDiscoveryProviderDependency

boolean destroyDiscoveryProviderDependency(java.lang.String setter)
Removes the DiscoveryProvider with the given setter from this DiscoveryProvider's Dependencies, and unregisters its corresponding MBean from the MBean server. Does nothing if no such DiscoveryProvider exists.
Parameters:
setter - The setter of the DiscoveryProvider to be removed.
Returns:
true if the DiscoveryProvider was removed, false otherwise.

retrieveDiscoveryProviderDependencies

javax.management.ObjectName[] retrieveDiscoveryProviderDependencies()
Returns the ObjectNames of all DiscoveryProviders in this DiscoveryProvider's Dependencies, that are registered on the MBean server.
Returns:
An ObjectName[] containing all DiscoveryProviders in this DiscoveryProvider's Dependencies registered on the MBean server.

retrieveDiscoveryProviderDependency

javax.management.ObjectName retrieveDiscoveryProviderDependency(java.lang.String setter)
Returns the ObjectName with which the DiscoveryProvider with the specified setter, in this DiscoveryProvider's Dependencies, is registered in the MBean server.
Parameters:
setter - The setter of the DiscoveryProvider
Returns:
The ObjectName with which the DiscoveryProvider with the specified type and setter is registered in the MBean server, or null if there is no DiscoveryProvider in this Discovery Provider's Dependencies with the given setter.

hasDiscoveryProviderDependency

boolean hasDiscoveryProviderDependency(java.lang.String setter)
Returns true if there exists a DiscoveryProvider with the specified setter in this DiscoveryProvider's Dependencies. Returns false otherwise.
Parameters:
setter - The setter of the DiscoveryProvider
Returns:
true if there exists a DiscoveryProvider with the specified setter in this DiscoveryProvider's Dependencies; 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.