Skip navigation links

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

public interface CircleOfTrustMXBean

Config MBean to manage Circle Of Trust properties; contains PeerProvider elements.

Since:

11.1.1.1.0

Method Summary

void	activate() Activates the changes made to the cot.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 cot.xml (as a String), sets the current cot.xml file to the given value.
javax.management.ObjectName	createPeerProvider(java.lang.String description, java.lang.String providerID, java.lang.String providerType, java.lang.String version) Creates a PeerProvider object with the specified description, providerID, providerType, and version, no Metadata and empty Config, and registers its corresponding MBean on the MBean server.
boolean	destroyPeerProvider(java.lang.String providerID) Removes the PeerProvider with the specified providerID and unregisters its corresponding MBean from the MBean server.
javax.management.ObjectName	getParent() Returns null.
boolean	hasPeerProvider(java.lang.String providerID) Returns true if there exists a PeerProvider element in this CircleOfTrust with the specified providerID.
javax.management.ObjectName[]	loadMetadata(java.lang.String metadata, java.lang.String description) Parses the given metadata and creates a PeerProvider with the providerID, providerType, and version found in the metadata, the given description, and the given metadata.
java.lang.String	retrieveConfigFile() Returns a String representation of the cot.xml configuration file.
javax.management.ObjectName	retrievePeerProvider(java.lang.String providerID) Returns the ObjectName with which the PeerProvider with the specified providerID is registered on the MBean server.
javax.management.ObjectName[]	retrievePeerProviders() Returns the ObjectNames of all PeerProviders registered on the MBean server

Method Detail

getParent

javax.management.ObjectName getParent()

Returns null.

Returns:

null

createPeerProvider

javax.management.ObjectName createPeerProvider(java.lang.String description,
                                               java.lang.String providerID,
                                               java.lang.String providerType,
                                               java.lang.String version)

Creates a PeerProvider object with the specified description, providerID, providerType, and version, no Metadata and empty Config, and registers its corresponding MBean on the MBean server. The description, the providerID, the providerType, and the version cannot be null. The providerID cannot be the empty string. The providerType must be one of: "idp", "sp", "affiliation", "attr-auth", "attr-req", "authn-req", "authz-req", or a space separated list of a subset of these values. The version must be one of: "SAML1.0", "SAML1.1", "SAML2.0", "Liberty1.1", "Liberty1.2", "WS-Fed1.1" If there already exists a PeerProvider with the specified providerID, sets the values of the description, providerType, and version to the provided values, and removes the PeerProvider's metadata.

Parameters:

description - The description of the PeerProvider to be created. Cannot be null.

providerID - The providerID of the PeerProvider to be created. Cannot be null or the empty string.

providerType - The providerType of the PeerProvider to be created. Cannot be null. Must be one of "idp", "sp", "affiliation", "attr-auth", "attr-req", "authn-req", "authz-req", or a space separated list of a subset of these values.

version - The version of the PeerProvider to be created. Cannot be null or the empty string.

Returns:

The ObjectName with which the PeerProvider MBean was registerd on the MBean server or null if no PeerProvider was created and registered

Throws:

java.lang.NullPointerException - if the description, providerID, the providerType, or the version is null.

java.lang.IllegalArgumentException - if the providerID is the empty string, or if the providerType is not one of "idp", "sp", "affiliation", "attr-auth", "attr-req", "authn-req", "authz-req", or a space separated list of a subset of these values, or if the version is not one of "SAML1.0", "SAML1.1", "SAML2.0", "Liberty1.1", "Liberty1.2", "WS-Fed1.1".

destroyPeerProvider

boolean destroyPeerProvider(java.lang.String providerID)

Removes the PeerProvider with the specified providerID and unregisters its corresponding MBean from the MBean server. Does nothing if no such PeerProvider exists.

Parameters:

providerID - The providerID of the PeerProvider to be removed.

Returns:

true if a PeerProvider was removed, false otherwise

retrievePeerProviders

javax.management.ObjectName[] retrievePeerProviders()

Returns the ObjectNames of all PeerProviders registered on the MBean server

Returns:

An ObjectName[] containg all PeerProviders registerd on the MBean server

retrievePeerProvider

javax.management.ObjectName retrievePeerProvider(java.lang.String providerID)

Returns the ObjectName with which the PeerProvider with the specified providerID is registered on the MBean server.

Parameters:

providerID - The providerID of the PeerProvider

Returns:

The ObjectName with which the PeerProvider with the specified providerID is registered on the MBean server, or null if there is no PeerProvider in this CircleOfTrust with the given providerID.

loadMetadata

javax.management.ObjectName[] loadMetadata(java.lang.String metadata,
                                           java.lang.String description)

Parses the given metadata and creates a PeerProvider with the providerID, providerType, and version found in the metadata, the given description, and the given metadata. If a PeerProvider already exists with the providerID found in the metadata, it is removed and a new PeerProvider is created as described above. The metadata must be an XML document following SAML or Liberty specifications.

Parameters:

metadata - A String of the PeerProvider's Metadata. Must be an XML document following SAML or Liberty specifications.

description - The description of the PeerProvider to be created or modified

Returns:

The ObjectName with which the PeerProvided that was created or modified, is registered on the MBean server

hasPeerProvider

boolean hasPeerProvider(java.lang.String providerID)

Returns true if there exists a PeerProvider element in this CircleOfTrust with the specified providerID. Returns false, otherwise.

Parameters:

providerID - The providerID of the PeerProvider element

Returns:

true if there exists a PeerProvider element in this CircleOfTrust with the specified providerID; false otherwise.

retrieveConfigFile

java.lang.String retrieveConfigFile()

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

Returns:

A String representation of the cot.xml configuration file.

changeConfigFile

void changeConfigFile(java.lang.String newFile)

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

Parameters:

newFile - The file to be set

activate

void activate()

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

Skip navigation links