Skip navigation links

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

public interface PeerProviderMXBean

Config MBean to manage Circle Of Trust properties; contains a single Config element.

Since:

11.1.1.1.0

Method Summary

java.lang.String	getDescription() Returns the description of this PeerProvider
javax.management.ObjectName	getParent() Returns the Object Name of the parent MBean of this PeerProvider MBean.
java.lang.String	getProviderID() Returns the providerID of this PeerProvider
java.lang.String	getProviderType() Returns the providerType of this PeerProvider
java.lang.String	getSuccinctID() Returns the succinctID of this PeerProvider
java.lang.String	getVersion() Returns the version of this PeerProvider
javax.management.ObjectName	retrieveConfig() Returns the ObjectName with which the Config in this PeerProvider is registered in the MBean server, or null in this PeerProvider does not have a Config
java.lang.String	retrieveMetaData() Returns the metadata of this PeerProvider
void	setDescription(java.lang.String description) Sets the value of the description attribute of this PeerProvider to the specified value.
void	setProviderType(java.lang.String providerType) Sets the value of the providerType attribute of this PeerProvider to the specified value.
void	setSuccinctID(java.lang.String succinctID) Sets the value of the succinctID attribute of this PeerProvider to the specified value.
void	setVersion(java.lang.String version) Sets the value of the version attribute of this PeerProvider to the specified value.
void	updateMetaData(java.lang.String metadata) Sets the value of the metadata attribute of this PeerProvider to the specified value.

Method Detail

getParent

javax.management.ObjectName getParent()

Returns the Object Name of the parent MBean of this PeerProvider MBean.

Returns:

the Object Name of the parent MBean of this PeerProvider MBean.

getDescription

java.lang.String getDescription()

Returns the description of this PeerProvider

Returns:

The description of this PeerProvider

setDescription

void setDescription(java.lang.String description)

Sets the value of the description attribute of this PeerProvider to the specified value. The new value cannot be null.

Parameters:

description - The value to which the description attribute of this PeerProvider is to be set to.

Throws:

java.lang.NullPointerException - if the new description is null.

getProviderID

java.lang.String getProviderID()

Returns the providerID of this PeerProvider

Returns:

The providerID of this PeerProvider

getSuccinctID

java.lang.String getSuccinctID()

Returns the succinctID of this PeerProvider

Returns:

The succinctID of this PeerProvider

setSuccinctID

void setSuccinctID(java.lang.String succinctID)

Sets the value of the succinctID attribute of this PeerProvider to the specified value. The new value cannot be null or the empty string.

Parameters:

succinctID - The value to which the succinct attribute of this PeerProvider is to be set to. Cannot be null or the empty string

Throws:

java.lang.NullPointerException - if the new succinctID is null.

java.lang.IllegalArgumentException - if the new succinctID is the empty string

getProviderType

java.lang.String getProviderType()

Returns the providerType of this PeerProvider

Returns:

The providerType of this PeerProvider

setProviderType

void setProviderType(java.lang.String providerType)

Sets the value of the providerType attribute of this PeerProvider to the specified value. The new value cannot be null. It 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.

Parameters:

providerType - The value to which the providerType attribute of this PeerProvider is to be set to. 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.

Throws:

java.lang.NullPointerException - if providerType is null.

java.lang.IllegalArgumentException - 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.

getVersion

java.lang.String getVersion()

Returns the version of this PeerProvider

Returns:

The version of this PeerProvider

setVersion

void setVersion(java.lang.String version)

Sets the value of the version attribute of this PeerProvider to the specified value. The new value cannot be null. It must be one of: "SAML1.0", "SAML1.1", "SAML2.0", "Liberty1.1", "Liberty1.2", "WS-Fed1.1"

Parameters:

version - The value to which the version attribute of this PeerProvider is to be set to. Cannot be null or the empty string

Throws:

java.lang.NullPointerException - if version is null.

java.lang.IllegalArgumentException - if version not one of "SAML1.0", "SAML1.1", "SAML2.0", "Liberty1.1", "Liberty1.2", "WS-Fed1.1".

retrieveMetaData

java.lang.String retrieveMetaData()

Returns the metadata of this PeerProvider

Returns:

The metadata of this PeerProvider

retrieveConfig

javax.management.ObjectName retrieveConfig()

Returns the ObjectName with which the Config in this PeerProvider is registered in the MBean server, or null in this PeerProvider does not have a Config

Returns:

The ObjectName with which the Config in this PeerProvider is registered in the MBean server, or null in this PeerProvider does not have a Config

updateMetaData

void updateMetaData(java.lang.String metadata)

Sets the value of the metadata attribute of this PeerProvider to the specified value. The new value cannot be null. Metadata must be in XML format. DOES NOT PERFORM VALIDITY CHECKS ON THE METADATA AND DOES NOT VERIFY SIGNATURES, IF ANY. Use CircleOfTrustMXBean.loadMetadata() instead.

Parameters:

metadata - The value to which the metadata attribute of this Peer Provider is to be set to. Cannot be null. Must be in XML formalt.

Throws:

java.lang.NullPointerException - if metadata is null.

Skip navigation links