BEA WebLogic Server 9.1 API Reference

weblogic.security.spi
Interface CredentialMapperV2

public interface CredentialMapperV2

The CredentialMapperV2 interface defines the security service provider interface (SSPI) for objects capable of obtaining the appropriate set of credentials for a particular resource that is scoped within an application.

An implementation of the CredentialMapperV2 interface is the part of a Credential Mapping provider that must return at least two specific credential formats:

• Password credentials must be returned as a character array.
• User-Password credentials must be returned as an instance of the javax.resource.spi.security.PasswordCredential class.

Credential Mapping providers may implement other types of objects that represent other types of credentials in addition to the ones listed above.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Field Summary

static String	PASSWORD_TYPE The static credentials type identifier that is used by the WebLogic Security Framework and passed to the WebLogic Credential Mapping provider through the Credential Manager in the getCredential methods.
static String	PKI_KEY_PAIR_TYPE The static credentials type identifier that is used by the WebLogic Security Framework and passed to the WebLogic Credential Mapping provider through the Credential Manager in the getCredential methods.
static String	PKI_TRUSTED_CERTIFICATE_TYPE The static credentials type identifier that is used by the WebLogic Security Framework and passed to the WebLogic Credential Mapping provider through the Credential Manager in the getCredential methods.
static String	SAML_ASSERTION_B64_TYPE The SAML.Assertion64 token is used to identify a SAML token that is a Base64 encoded SAML.Assertion.
static String	SAML_ASSERTION_DOM_TYPE The SAML.Assertion.DOM token is used to identify a SAML token that is a DOM Element representation of a SAML.Assertion.
static String	SAML_ASSERTION_TYPE The SAML.Assertion token is used to identify a SAML token in string XML form.
static String	USER_PASSWORD_TYPE The static credentials type identifier that is used by the WebLogic Security Framework and passed to the WebLogic Credential Mapping provider through the Credential Manager in the getCredential methods.

Method Summary

Object	getCredential(Subject requestor, String initiator, Resource resource, ContextHandler handler, String credType) Returns credential of the specified type from the target resource associated with the specified initiator.
Object[]	getCredentials(Subject requestor, Subject initiator, Resource resource, ContextHandler handler, String credType) Returns credentials of the specified type from the target resource associated with the specified initiator.

Field Detail

PASSWORD_TYPE

public static final String PASSWORD_TYPE

The static credentials type identifier that is used by the WebLogic Security Framework and passed to the WebLogic Credential Mapping provider through the Credential Manager in the getCredential methods. It is associated with credentials of type char[]

See Also:

Constant Field Values

PKI_KEY_PAIR_TYPE

public static final String PKI_KEY_PAIR_TYPE

The static credentials type identifier that is used by the WebLogic Security Framework and passed to the WebLogic Credential Mapping provider through the Credential Manager in the getCredential methods. It is associated with credentials of type PKICredential to retrieve the key pair.

See Also:

Constant Field Values

PKI_TRUSTED_CERTIFICATE_TYPE

public static final String PKI_TRUSTED_CERTIFICATE_TYPE

The static credentials type identifier that is used by the WebLogic Security Framework and passed to the WebLogic Credential Mapping provider through the Credential Manager in the getCredential methods. It is associated with credentials of type PKICredential to retrieve the trusted certificate.

See Also:

Constant Field Values

SAML_ASSERTION_B64_TYPE

public static final String SAML_ASSERTION_B64_TYPE

The SAML.Assertion64 token is used to identify a SAML token that is a Base64 encoded SAML.Assertion.

See Also:

Constant Field Values

SAML_ASSERTION_DOM_TYPE

public static final String SAML_ASSERTION_DOM_TYPE

The SAML.Assertion.DOM token is used to identify a SAML token that is a DOM Element representation of a SAML.Assertion.

See Also:

Constant Field Values

SAML_ASSERTION_TYPE

public static final String SAML_ASSERTION_TYPE

The SAML.Assertion token is used to identify a SAML token in string XML form.

See Also:

Constant Field Values

USER_PASSWORD_TYPE

public static final String USER_PASSWORD_TYPE

The static credentials type identifier that is used by the WebLogic Security Framework and passed to the WebLogic Credential Mapping provider through the Credential Manager in the getCredential methods. It is associated with credentials of type javax.resource.spi.security.PasswordCredential

See Also:

Constant Field Values

Method Detail

getCredential

public Object getCredential(Subject requestor,
                            String initiator,
                            Resource resource,
                            ContextHandler handler,
                            String credType)

Returns credential of the specified type from the target resource associated with the specified initiator. Returns null if no credentials were found.

Parameters:

requestor - subject requesting credentials

initiator - the identity for which credentials are retrieved

resource - the resource for which credentials are requested

handler - a ContextHandler with optional extra data

credType - credential type

Returns:

Credential of the specified type from the target resource associated with the specified subject

getCredentials

public Object[] getCredentials(Subject requestor,
                               Subject initiator,
                               Resource resource,
                               ContextHandler handler,
                               String credType)

Returns credentials of the specified type from the target resource associated with the specified initiator. Returns null if no credentials were found.

Parameters:

requestor - Subject requesting credentials

initiator - the identity for which credentials are retrieved

resource - the resource for which credentials are requested

handler - a ContextHandler with optional extra data

credType - credential type

Returns:

Credentials of the specified type from the target resource associated with the specified subject