SAMLCredentialMapperV2MBean

Overview

This MBean represents configuration information for the SAML Credential Mapper V2 provider.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.

Related MBeans

This section describes attributes that provide access to other MBeans.

Realm

Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.

Attributes

This section describes the following attributes:

CredCacheMinViableTTL

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.

CredCacheSize

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.

DefaultTimeToLive

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.

DefaultTimeToLiveDelta

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.

Description

A short description of the SAML Credential Mapper V2 provider.

IssuerURI

The Issuer URI (name) of this SAML Authority.

MinimumParserPoolSize

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

Name

NameMapperClassName

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.

NameQualifier

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.

ProviderClassName

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

SigningKeyAlias

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

SigningKeyPassPhrase

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

SigningKeyPassPhraseEncrypted

SupportedExportConstraints

A SAML Partner Registry can export all partners, no partners, only enabled partners, only disabled partners or a list of partners. It can export all certificates, no certificates, only certificates referenced by partners, or a list of certificates.

SupportedExportFormats

A SAML Partner Registry may be exported as an XML document.

SupportedImportConstraints

A SAML Partner Registry can import all partners, no partners, only enabled partners, only disabled partners or a list of partners. It can import all certificates, no certificates, only certificates referenced by partners, or a list of certificates. The import mode can be rename, replace or fail for conflict resolution.

SupportedImportFormats

A SAML Partner Registry can import partner information and certificates from an XML document.

Version

The version number of the SAML Credential Mapper V2 provider.

Operations

This section describes the following operations:

addRelyingParty

Adds a new SAMLRelyingParty to the registry. <p> Throws InvalidParameterException if the partner object fails validation. Throws CreateException if an error occurs during creation of the object.

advance

Advances the list to the next element in the list.

certificateExists

Determines whether or not a certificate has been registered under the given alias. <p> Returns true if a certificate is registered under that alias, false if not. <p> Throws InvalidParameterException if alias is empty or null.

close

Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.

copyToDER

Writes a certificate in the registry to a file in DER binary format. <p> Throws NotFoundException if the alias does not exist in the registry. <p> Throws InvalidParameterException if alias or certificateFile is empty or null or if the file cannot be written to.

copyToPEM

Writes a certificate in the registry to a file in PEM base64 encoded format. <p> Throws NotFoundException if the alias does not exist in the registry. <p> Throws InvalidParameterException if alias or certificateFile is empty or null or if the file cannot be written to.

exportData

Exports provider specific data in a specified format. When errors occur, the MBean throws an ErrorCollectionException containing a list of java.lang.Exceptions, where the text of each exception describes the error.

getCertificate

Retrieves a certificate from the registry. <p> Returns the certificate. <p> Throws NotFoundException if alias does not exist in the registry. <p> Throws InvalidParameterException if alias is empty or null.

getCurrentName

The name of the current item in the list. Returns null if there is no current item.

getRelyingParty

Gets the SAMLRelyingParty corresponding to a partnerId. <p> Throws NotFoundException if the relying party is not found. Throws InvalidParameterException if partnerId is empty or null.

haveCurrent

Returns true if there are more objects in the list, and false otherwise.

importData

Imports provider specific data from a specified format. When errors occur, the MBean throws an ErrorCollectionException containing a list of java.lang.Exceptions, where the text of each exception describes the error.

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

listCertificates

Lists the registered certificate aliases that match a wild card. <p> It follows the NameListerMBean cursor pattern. The results are not sorted. <p> Returns a String containing a cursor that may be passed into the NameListerMBean methods to read the list. The getCurrentName method returns the current alias on the list. <p> Throws InvalidParameterException if aliasWildcard is empty or null or if maxToReturn is less than zero.

listRelyingParties

Lists the registered partnerIds that match a wild card. <p> It follows the NameListerMBean cursor pattern. The results are not sorted. <p> Returns a String containing a cursor that may be passed into the NameListerMBean methods to read the list. The getCurrentName method returns the current alias on the list. <p> Throws InvalidParameterException if partnerIdWildcard is empty or null or if maxToReturn is less than zero.

newRelyingParty

Returns a new SAMLRelyingParty object. Caller can set the fields of this object and then call addRelyingParty() to add the new relying party to the registry. <p> Relying party objects obtained from this method should not be passed to updateRelyingParty() -- call getRelyingParty() to fetch an existing relying party for update.

registerCertificate

Registers an end certificate in the registry under an alias. <p> Throws AlreadyExistsException if the alias is already in the registry or if another certificate with the same subject dn, or issuer dn + serial number, or subject key identifier is already in the registry. <p> Throws InvalidParameterException if the alias or certificateFile is empty or null or if the file does not exist or cannot be read.

relyingPartyExists

Determines whether or not a relying party exists for the given partnerId. <p> Returns true if the relying party is found, false if not. <p> Throws InvalidParameterException if partnerId is empty or null.

removeRelyingParty

Removes a SAMLRelyingParty from the registry. <p> Throws NotFoundException if the relying party does not exist. Throws InvalidParameterException if the partnerId is empty or null.

unregisterCertificate

Unregisters an end certificate from the registry. <p> Throws NotFoundException if alias does not exist in the registry. <p> Throws InvalidParameterException if alias is empty or null.

unSet

Restore the given property to its default value.

updateRelyingParty

Updates a SAMLRelyingParty in the registry. <p> Throws NotFoundException if the relying party does not exist. Throws InvalidParameterException if the partner object fails validation.

wls_getDisplayName

Returns the display name of an MBean.

Deprecated 9.0.0.0