public class SecretKeyCallback
extends java.lang.Object
implements javax.security.auth.callback.Callback
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 called by
ClientAuthModules invoked from intermediate components that need to acquire a password to authenticate
to their target service.
| Modifier and Type | Class and Description |
|---|---|
static class |
SecretKeyCallback.AliasRequest
Request type for secret keys that are identified using an alias.
|
static interface |
SecretKeyCallback.Request
Marker interface for secret key request types.
|
| Constructor and Description |
|---|
SecretKeyCallback(SecretKeyCallback.Request request)
Constructs this SecretKeyCallback with a secret key Request object.
|
| 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.
|
public SecretKeyCallback(SecretKeyCallback.Request request)
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.
request - Request object identifying the secret key, or null.public SecretKeyCallback.Request getRequest()
public void setKey(javax.crypto.SecretKey key)
key - The secret key, or null if no key was found.public javax.crypto.SecretKey getKey()