Skip navigation links

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

public interface FederationConfigMXBean

Config MBean to manage Server properties; contains Config elements.

Since:

11.1.1.1.0

Method Summary

void	activate() Activates the changes made to the config.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 config.xml (as a String), sets the current config.xml file to the given value.
javax.management.ObjectName	createEmptyConfig(java.lang.String name) Creates a Config with the specified name, and registers its corresponding MBean on the MBean server.
boolean	destroyConfig(java.lang.String name) Removes the Config with the specified name and unregisters its corresponding MBean from the MBean server.
javax.management.ObjectName	getParent() Returns null.
boolean	hasConfig(java.lang.String name) Returns true if there exists a Config element in this FederationConfig with the specified name.
boolean	isActivationEnabled() Returns true if activation is enabled; false otherwise.
javax.management.ObjectName	retrieveConfig(java.lang.String name) Returns the ObjectName with which the Config with the specified name is registered in the MBean server.
java.lang.String	retrieveConfigFile() Returns a String representation of the config.xml configuration file.
javax.management.ObjectName[]	retrieveConfigs() Returns the ObjectNames of all Configs in this FederationConfig registered in the MBean server
void	setActivationEnabled(boolean value) Enables activation is the given value is true; disables activation otherwise.

Method Detail

getParent

javax.management.ObjectName getParent()

Returns null.

Returns:

null

createEmptyConfig

javax.management.ObjectName createEmptyConfig(java.lang.String name)

Creates a Config with the specified name, and registers its corresponding MBean on the MBean server. The name cannot be null. An IllegalArgumentException is thrown if a Config with the given name already exists in this FederationConfig.

Parameters:

name - The name of the Config to be created. Cannot be null or an empty string.

Returns:

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

Throws:

java.lang.NullPointerException - if the name is null

java.lang.IllegalArgumentException - if the name is an empty string, or if a Config with the given name already exists in this FederationConfig.

destroyConfig

boolean destroyConfig(java.lang.String name)

Removes the Config with the specified name and unregisters its corresponding MBean from the MBean server. Does nothing if no such Config exists in this FederationConfig.

Parameters:

name - The name of the Config to be removed.

Returns:

true if the Config was removed, false otherwise

retrieveConfigs

javax.management.ObjectName[] retrieveConfigs()

Returns the ObjectNames of all Configs in this FederationConfig registered in the MBean server

Returns:

An ObjectName[] containing all Configs in this FederationConfig registered in the MBean server

retrieveConfig

javax.management.ObjectName retrieveConfig(java.lang.String name)

Returns the ObjectName with which the Config with the specified name is registered in the MBean server.

Parameters:

name - The name of the Config

Returns:

The ObjectName with which the Config with the specified name is registered in the MBean server, or null if there is no Config in this FederationConfig with the specified name.

hasConfig

boolean hasConfig(java.lang.String name)

Returns true if there exists a Config element in this FederationConfig with the specified name. Returns false otherwise.

Parameters:

name - The name fot the Config element.

Returns:

true if there exists a Config element in this FederationConfig with the specified name; false otherwise.

retrieveConfigFile

java.lang.String retrieveConfigFile()

Returns a String representation of the config.xml configuration file.

Returns:

A String representation of the config.xml configuration file.

changeConfigFile

void changeConfigFile(java.lang.String newFile)

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

Parameters:

newFile - The file to be set

setActivationEnabled

void setActivationEnabled(boolean value)

Enables activation is the given value is true; disables activation otherwise.

Parameters:

value - True if activation is to be enabled; false is activation is to be disabled

isActivationEnabled

boolean isActivationEnabled()

Returns true if activation is enabled; false otherwise.

Returns:

true if activation is enabled; false otherwise.

activate

void activate()

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

Skip navigation links