Oracle Entitlements Server Provider SSPI 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.

Author:

Copyright © 2004-2008, Oracle and/or its affiliates. All rights reserved.

Field Summary

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

java.lang.Object	getCredential(javax.security.auth.Subject requestor, java.lang.String alias, ContextHandler handler, java.lang.String credType) Returns credential of the specified type stored under the specified alias.
java.lang.Object	getCredential(javax.security.auth.Subject requestor, java.lang.String initiator, Resource resource, ContextHandler handler, java.lang.String credType) Returns credential of the specified type from the target resource associated with the specified initiator.
java.lang.Object[]	getCredentials(javax.security.auth.Subject requestor, javax.security.auth.Subject initiator, Resource resource, ContextHandler handler, java.lang.String credType) Returns credentials of the specified type from the target resource associated with the specified initiator.

Field Detail

PASSWORD_TYPE

public static final java.lang.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[]

USER_PASSWORD_TYPE

public static final java.lang.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

Method Detail

getCredential

public java.lang.Object getCredential(javax.security.auth.Subject requestor,
                                      java.lang.String alias,
                                      ContextHandler handler,
                                      java.lang.String credType)

Returns credential of the specified type stored under the specified alias.

Parameters:

requestor - Subject requesting credential

alias - Credential alias

handler - a ContextHandler with optional extra data

credType - Credential type

Returns:

Credential of the specified type stored under the specified alias.

getCredential

public java.lang.Object getCredential(javax.security.auth.Subject requestor,
                                      java.lang.String initiator,
                                      Resource resource,
                                      ContextHandler handler,
                                      java.lang.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 - Resource 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 java.lang.Object[] getCredentials(javax.security.auth.Subject requestor,
                                         javax.security.auth.Subject initiator,
                                         Resource resource,
                                         ContextHandler handler,
                                         java.lang.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 - Resource 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.