Type-Safe Access to BEA WebLogic Server 9.2 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.security.providers.saml
Interface SAMLCredentialMapperV2MBean

All Superinterfaces:

ApplicationVersionerMBean, CredentialMapperMBean, weblogic.descriptor.DescriptorBean, ExportMBean, ImportMBean, ListerMBean, NameListerMBean, ProviderMBean, SAMLPartnerRegistryMBean, SAMLRelyingPartyRegistryMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface

public interface SAMLCredentialMapperV2MBean

extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, CredentialMapperMBean, SAMLRelyingPartyRegistryMBean, ApplicationVersionerMBean

No description provided.

Method Summary

int	getCredCacheMinViableTTL() If an entry in the cache has less time to live than this value, the corresponding assertion will not be used.
int	getCredCacheSize() The size of the cache used to store assertion credentials.
int	getDefaultTimeToLive() Time in seconds that, by default, an assertion should remain valid.
int	getDefaultTimeToLiveDelta() A time factor you can use to allow the Credential Mapper to compensate for clock differences between the source and destination sites.
String	getDescription() A short description of the SAML Credential Mapper V2 provider.
String	getIssuerURI() The Issuer URI (name) of this SAML Authority.
int	getMinimumParserPoolSize() The minimum number of parsers to maintain in the parser pool.
String	getName() The name of this configuration.
String	getNameMapperClassName() The name of the Java class that maps Subjects to SAML Assertion name information.
String	getNameQualifier() The Name Qualifier value used by the Name Mapper.
String	getProviderClassName() The name of the Java class used to load the SAML Credential Mapper V2 provider.
String	getSigningKeyAlias() The alias used to retrieve from the keystore the key that is used to sign assertions.
String	getSigningKeyPassPhrase() The credential (password) used to retrieve from the keystore the keys used to sign assertions.
byte[]	getSigningKeyPassPhraseEncrypted()
String	getVersion() The version number of the SAML Credential Mapper V2 provider.
void	setCredCacheMinViableTTL(int newValue) If an entry in the cache has less time to live than this value, the corresponding assertion will not be used.
void	setCredCacheSize(int newValue) The size of the cache used to store assertion credentials.
void	setDefaultTimeToLive(int newValue) Time in seconds that, by default, an assertion should remain valid.
void	setDefaultTimeToLiveDelta(int newValue) A time factor you can use to allow the Credential Mapper to compensate for clock differences between the source and destination sites.
void	setIssuerURI(String newValue) The Issuer URI (name) of this SAML Authority.
void	setMinimumParserPoolSize(int newValue) The minimum number of parsers to maintain in the parser pool.
void	setNameMapperClassName(String newValue) The name of the Java class that maps Subjects to SAML Assertion name information.
void	setNameQualifier(String newValue) The Name Qualifier value used by the Name Mapper.
void	setSigningKeyAlias(String newValue) The alias used to retrieve from the keystore the key that is used to sign assertions.
void	setSigningKeyPassPhrase(String newValue) The credential (password) used to retrieve from the keystore the keys used to sign assertions.
void	setSigningKeyPassPhraseEncrypted(byte[] _bytes)

Methods inherited from interface weblogic.management.commo.StandardInterface

setName, wls_getDisplayName, wls_getInterfaceClassName, wls_getObjectName

Methods inherited from interface weblogic.descriptor.DescriptorBean

addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Methods inherited from interface weblogic.descriptor.SettableBean

isSet, unSet

Methods inherited from interface weblogic.management.security.ProviderMBean

getRealm

Methods inherited from interface weblogic.security.providers.saml.registry.SAMLRelyingPartyRegistryMBean

addRelyingParty, getRelyingParty, listRelyingParties, newRelyingParty, relyingPartyExists, removeRelyingParty, updateRelyingParty

Methods inherited from interface weblogic.security.providers.saml.registry.SAMLPartnerRegistryMBean

certificateExists, copyToDER, copyToPEM, getCertificate, getSupportedExportConstraints, getSupportedExportFormats, getSupportedImportConstraints, getSupportedImportFormats, listCertificates, registerCertificate, unregisterCertificate

Methods inherited from interface weblogic.management.security.ImportMBean

importData

Methods inherited from interface weblogic.management.security.ExportMBean

exportData

Methods inherited from interface weblogic.management.utils.NameListerMBean

getCurrentName

Methods inherited from interface weblogic.management.utils.ListerMBean

advance, close, haveCurrent

Method Detail

getCredCacheMinViableTTL

public int getCredCacheMinViableTTL()

If an entry in the cache has less time to live than this value, the corresponding assertion will not be used. Instead, a new assertion will be generated.

This attribute avoids the situation where an assertion is returned from the cache but expires before it can be evaluated at its destination. If the cached assertion's remaining time-to-live is too short, it will not be used.

getCredCacheSize

public int getCredCacheSize()

The size of the cache used to store assertion credentials.

The cache stores assertion credentials so that requests for the same assertion may return a result from cache, rather than generate a new assertion. This can improve performance in cases where an application may make multiple requests for the same assertion, for the same user, within a short period of time.

getDefaultTimeToLive

public int getDefaultTimeToLive()

Time in seconds that, by default, an assertion should remain valid.

If the value is zero, then assertions have an infinite lifetime. Using assertions with an infinite lifetime is not recommended, however.

getDefaultTimeToLiveDelta

public int getDefaultTimeToLiveDelta()

A time factor you can use to allow the Credential Mapper to compensate for clock differences between the source and destination sites. The value is a positive or negative integer representing seconds.

Normally, an assertion is valid from the NotBefore time, which defaults to (roughly) the time the assertion was generated, until the NotOnOrAfter time, which is calculated as (NotBefore + TimeToLive). This value is a positive or negative integer indicating how many seconds before or after "now" the assertions NotBefore should be set to. If you set a value for DefaultTimeToLiveDelta, then the assertion lifetime is still calculated as (NotBefore + TimeToLive), but the NotBefore value is set to (now + TimeToLiveDelta). So, an assertion might have a two minute (120 second) lifetime that starts thirty seconds ago, or starts one minute from now. This allows the Credential Mapper to compensate for clock differences between the source and destination sites. The default can be overridden for specific assertions.

getDescription

public String getDescription()

A short description of the SAML Credential Mapper V2 provider.

Specified by:

getDescription in interface ProviderMBean

getIssuerURI

public String getIssuerURI()

The Issuer URI (name) of this SAML Authority.

getMinimumParserPoolSize

public int getMinimumParserPoolSize()

The minimum number of parsers to maintain in the parser pool.

getName

public String getName()

Description copied from interface: ProviderMBean

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:

getName in interface weblogic.management.commo.StandardInterface

getNameMapperClassName

public String getNameMapperClassName()

The name of the Java class that maps Subjects to SAML Assertion name information. When no mapper is specified, the default mapper implementation is used.

When you configure a SAML Relying Party, using the Management tab, you can set a Name Mapper Class specific to that Relying Party, which will override the default value you set here.

getNameQualifier

public String getNameQualifier()

The Name Qualifier value used by the Name Mapper.

The value of the Name Qualifier is the security or administrative domain that qualifies the name of the subject. This provides a means to federate names from disparate user stores while avoiding the possibility of subject name collision.

getProviderClassName

public String getProviderClassName()

The name of the Java class used to load the SAML Credential Mapper V2 provider.

Specified by:

getProviderClassName in interface ProviderMBean

Excluded: Should not appear in public javadocs

Internal: Should not appear in public javadocs

getSigningKeyAlias

public String getSigningKeyAlias()

The alias used to retrieve from the keystore the key that is used to sign assertions.

getSigningKeyPassPhrase

public String getSigningKeyPassPhrase()

The credential (password) used to retrieve from the keystore the keys used to sign assertions.

getSigningKeyPassPhraseEncrypted

public byte[] getSigningKeyPassPhraseEncrypted()

getVersion

public String getVersion()

The version number of the SAML Credential Mapper V2 provider.

Specified by:

getVersion in interface ProviderMBean

setCredCacheMinViableTTL

public void setCredCacheMinViableTTL(int newValue)
                              throws InvalidAttributeValueException

If an entry in the cache has less time to live than this value, the corresponding assertion will not be used. Instead, a new assertion will be generated.

This attribute avoids the situation where an assertion is returned from the cache but expires before it can be evaluated at its destination. If the cached assertion's remaining time-to-live is too short, it will not be used.

Parameters:

newValue - - new value for attribute CredCacheMinViableTTL

Throws:

InvalidAttributeValueException

setCredCacheSize

public void setCredCacheSize(int newValue)
                      throws InvalidAttributeValueException

The size of the cache used to store assertion credentials.

The cache stores assertion credentials so that requests for the same assertion may return a result from cache, rather than generate a new assertion. This can improve performance in cases where an application may make multiple requests for the same assertion, for the same user, within a short period of time.

Parameters:

newValue - - new value for attribute CredCacheSize

Throws:

InvalidAttributeValueException

setDefaultTimeToLive

public void setDefaultTimeToLive(int newValue)
                          throws InvalidAttributeValueException

Time in seconds that, by default, an assertion should remain valid.

If the value is zero, then assertions have an infinite lifetime. Using assertions with an infinite lifetime is not recommended, however.

Parameters:

newValue - - new value for attribute DefaultTimeToLive

Throws:

InvalidAttributeValueException

setDefaultTimeToLiveDelta

public void setDefaultTimeToLiveDelta(int newValue)
                               throws InvalidAttributeValueException

A time factor you can use to allow the Credential Mapper to compensate for clock differences between the source and destination sites. The value is a positive or negative integer representing seconds.

Normally, an assertion is valid from the NotBefore time, which defaults to (roughly) the time the assertion was generated, until the NotOnOrAfter time, which is calculated as (NotBefore + TimeToLive). This value is a positive or negative integer indicating how many seconds before or after "now" the assertions NotBefore should be set to. If you set a value for DefaultTimeToLiveDelta, then the assertion lifetime is still calculated as (NotBefore + TimeToLive), but the NotBefore value is set to (now + TimeToLiveDelta). So, an assertion might have a two minute (120 second) lifetime that starts thirty seconds ago, or starts one minute from now. This allows the Credential Mapper to compensate for clock differences between the source and destination sites. The default can be overridden for specific assertions.

Parameters:

newValue - - new value for attribute DefaultTimeToLiveDelta

Throws:

InvalidAttributeValueException

setIssuerURI

public void setIssuerURI(String newValue)
                  throws InvalidAttributeValueException

The Issuer URI (name) of this SAML Authority.

Parameters:

newValue - - new value for attribute IssuerURI

Throws:

InvalidAttributeValueException

setMinimumParserPoolSize

public void setMinimumParserPoolSize(int newValue)
                              throws InvalidAttributeValueException

The minimum number of parsers to maintain in the parser pool.

Parameters:

newValue - - new value for attribute MinimumParserPoolSize

Throws:

InvalidAttributeValueException

setNameMapperClassName

public void setNameMapperClassName(String newValue)
                            throws InvalidAttributeValueException

The name of the Java class that maps Subjects to SAML Assertion name information. When no mapper is specified, the default mapper implementation is used.

When you configure a SAML Relying Party, using the Management tab, you can set a Name Mapper Class specific to that Relying Party, which will override the default value you set here.

Parameters:

newValue - - new value for attribute NameMapperClassName

Throws:

InvalidAttributeValueException

setNameQualifier

public void setNameQualifier(String newValue)
                      throws InvalidAttributeValueException

The Name Qualifier value used by the Name Mapper.

The value of the Name Qualifier is the security or administrative domain that qualifies the name of the subject. This provides a means to federate names from disparate user stores while avoiding the possibility of subject name collision.

Parameters:

newValue - - new value for attribute NameQualifier

Throws:

InvalidAttributeValueException

setSigningKeyAlias

public void setSigningKeyAlias(String newValue)
                        throws InvalidAttributeValueException

The alias used to retrieve from the keystore the key that is used to sign assertions.

Parameters:

newValue - - new value for attribute SigningKeyAlias

Throws:

InvalidAttributeValueException

setSigningKeyPassPhrase

public void setSigningKeyPassPhrase(String newValue)
                             throws InvalidAttributeValueException

The credential (password) used to retrieve from the keystore the keys used to sign assertions.

Parameters:

newValue - - new value for attribute SigningKeyPassPhrase

Throws:

InvalidAttributeValueException

setSigningKeyPassPhraseEncrypted

public void setSigningKeyPassPhraseEncrypted(byte[] _bytes)