|
Oracle Fusion Middleware Configuration MBean Java API Reference for Oracle Identity Federation 11g Release 1 (11.1.1) E14683-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CircleOfTrustMXBean
Config MBean to manage Circle Of Trust properties; contains PeerProvider elements.
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 |
---|
javax.management.ObjectName getParent()
javax.management.ObjectName createPeerProvider(java.lang.String description, java.lang.String providerID, java.lang.String providerType, java.lang.String version)
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.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".boolean destroyPeerProvider(java.lang.String providerID)
providerID
- The providerID of the PeerProvider to be removed.javax.management.ObjectName[] retrievePeerProviders()
javax.management.ObjectName retrievePeerProvider(java.lang.String providerID)
providerID
- The providerID of the PeerProviderjavax.management.ObjectName[] loadMetadata(java.lang.String metadata, java.lang.String description)
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 modifiedboolean hasPeerProvider(java.lang.String providerID)
providerID
- The providerID of the PeerProvider elementjava.lang.String retrieveConfigFile()
void changeConfigFile(java.lang.String newFile)
newFile
- The file to be setvoid activate()
|
Oracle Fusion Middleware Configuration MBean Java API Reference for Oracle Identity Federation 11g Release 1 (11.1.1) E14683-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |