Skip navigation links

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

public interface DatastoreMXBean

Config MBean to manage Data Store properties; contains DiscoveryProvider elements

Since:

11.1.1.1.0

Method Summary

void	activate() Activates the changes made to the data-store.xml file since the last activation so that the OIF server picks up the changes.
void	changeConfigFile(java.lang.String newFile) Given a properly formatted data-store.xml (as a String), sets the current data-store.xml file to the given value.
javax.management.ObjectName	createDiscoveryProvider(java.lang.String classname, java.lang.String dependsOn, java.lang.String setter, java.lang.String type) Creates a DiscoveryProvider with the speficied classname, dependsOn, setter, and type, and empty Dependencies, and registers its corresponding MBean on the MBean server.
boolean	destroyDiscoveryProvider(java.lang.String type) Removes the DiscoveryProvider with the specified type, and unregisters its corresponding MBean from the MBean server.
java.lang.String	getDefaultPackage() Returns the default package of this Datastore.
javax.management.ObjectName	getParent() Returns null.
boolean	hasDiscoveryProvider(java.lang.String type) Returns true if there exists a DiscoveryProvider in this Datastore with the specified type.
java.lang.String	retrieveConfigFile() Returns a String representation of the data-store.xml configuration file.
javax.management.ObjectName	retrieveDiscoveryProvider(java.lang.String type) Returns the ObjectName with which the DiscoveryProvider with the specified type is registered on the MBean server.
javax.management.ObjectName[]	retrieveDiscoveryProviders() Returns the ObjectNames of all DiscoveryProviders in this Datastore registered on the MBean server.

Method Detail

getParent

javax.management.ObjectName getParent()

Returns null.

Returns:

null

getDefaultPackage

java.lang.String getDefaultPackage()

Returns the default package of this Datastore.

Returns:

The the default package of this Datastore.

createDiscoveryProvider

javax.management.ObjectName createDiscoveryProvider(java.lang.String classname,
                                                    java.lang.String dependsOn,
                                                    java.lang.String setter,
                                                    java.lang.String type)

Creates a DiscoveryProvider with the speficied classname, dependsOn, setter, and type, and empty Dependencies, and registers its corresponding MBean on the MBean server. The classname, type, dependsOn, and setter given cannot be null. The classname and the type cannot be an empty string. An IllegalArgumentException is thrown if there already exists a DiscoveryProvider with the specified type.

Parameters:

classname - The classname of the DiscoveryProvider to be created. Cannot be null or the empty string.

dependsOn - The dependsOn value of the DiscoveryProvider to be created. Cannot be null.

setter - The setter of the DiscoveryProvider to be created. Cannot be null.

type - The type of the DiscoveryProvider to be created. Cannot be null or the empty string.

Returns:

The ObjectName with which the DiscoveryProvider MBean was registered on the MBean server or null if no DiscoveryProvider was created.

Throws:

java.lang.NullPointerException - if classname, dependsOn, setter,or type is null.

java.lang.IllegalArgumentException - if the classname or the type is an empty string, or if there already exists a DiscoveryProvider is this Datastore with the specified type.

destroyDiscoveryProvider

boolean destroyDiscoveryProvider(java.lang.String type)

Removes the DiscoveryProvider with the specified type, and unregisters its corresponding MBean from the MBean server. Does nothing if no such DiscoveryProvider exists in this Datastore.

Parameters:

type - The type of the DiscoveryProvider to be removed.

Returns:

true if the DiscoveryProvider was removed, false otherwise

retrieveDiscoveryProviders

javax.management.ObjectName[] retrieveDiscoveryProviders()

Returns the ObjectNames of all DiscoveryProviders in this Datastore registered on the MBean server.

Returns:

An ObjectName[] containing all DiscoveryProviders in this Datastore registered on the MBean server.

retrieveDiscoveryProvider

javax.management.ObjectName retrieveDiscoveryProvider(java.lang.String type)

Returns the ObjectName with which the DiscoveryProvider with the specified type is registered on the MBean server.

Parameters:

type - The type of the DiscoveryProvider

Returns:

The ObjectName with which the DiscoveryProvider with the specified type is registered on the MBean server, or null if there is no DiscoveryProvider in this Datastore with the given type.

hasDiscoveryProvider

boolean hasDiscoveryProvider(java.lang.String type)

Returns true if there exists a DiscoveryProvider in this Datastore with the specified type. Returns false otherwise.

Parameters:

type - The type of the DiscoveryProvider element.

Returns:

true if there exists a DiscoveryProvider in this Datastore with the specified type; false otherwise.

retrieveConfigFile

java.lang.String retrieveConfigFile()

Returns a String representation of the data-store.xml configuration file.

Returns:

A String representation of the data-store.xml configuration file.

changeConfigFile

void changeConfigFile(java.lang.String newFile)

Given a properly formatted data-store.xml (as a String), sets the current data-store.xml file to the given value.

Parameters:

newFile - The file to be set

activate

void activate()

Activates the changes made to the data-store.xml file since the last activation so that the OIF server picks up the changes.

Skip navigation links