javax.security.auth.message.callback

Class SecretKeyCallback

java.lang.Object

javax.security.auth.message.callback.SecretKeyCallback

All Implemented Interfaces:

javax.security.auth.callback.Callback

public class SecretKeyCallback
extends java.lang.Object
implements javax.security.auth.callback.Callback

Callback for acquiring a shared secret from a key repository. This Callback may be used by client or server authentication modules to obtain shared secrets (for example, passwords) without relying on a user during the Callback processing. This Callback is typically employed by ClientAuthModules invoked from intermediate components that need to acquire a password to authenticate to their target service.

Since:

May 11, 2006

Version:

$Revision$

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecretKeyCallback.AliasRequest Request type for secret keys that are identified via an alias.
static interface	SecretKeyCallback.Request Marker interface for secret key request types.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.crypto.SecretKey	key
private SecretKeyCallback.Request	request

Constructor Summary

Constructors

Constructor and Description
SecretKeyCallback(SecretKeyCallback.Request request) Constructs this SecretKeyCallback with a secret key Request object.

Method Summary

Modifier and Type	Method and Description
javax.crypto.SecretKey	getKey() Used to obtain the secret key set within the Callback.
SecretKeyCallback.Request	getRequest() Used by the CallbackHandler to get the Request object which identifies the secret key to be returned.
void	setKey(javax.crypto.SecretKey key) Used by the CallbackHandler to set the requested secret key within the Callback.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

request

private SecretKeyCallback.Request request

key

private javax.crypto.SecretKey key

Constructor Detail

SecretKeyCallback

public SecretKeyCallback(SecretKeyCallback.Request request)

Constructs this SecretKeyCallback with a secret key Request object.

The request object identifies the secret key to be returned. If the alias is null, the handler of the callback relies on its own default.

Parameters:

request - Request object identifying the secret key, or null.

Method Detail

getRequest

public SecretKeyCallback.Request getRequest()

Used by the CallbackHandler to get the Request object which identifies the secret key to be returned.

Returns:

The Request object which identifies the private key to be returned, or null. If null, the handler of the callback relies on its own default.

setKey

public void setKey(javax.crypto.SecretKey key)

Used by the CallbackHandler to set the requested secret key within the Callback.

Parameters:

key - The secret key, or null if no key was found.

getKey

public javax.crypto.SecretKey getKey()

Used to obtain the secret key set within the Callback.

Returns:

The secret key, or null if no key was found.