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 |
|---|---|
| public static class | SecretKeyCallback.AliasRequest
Request type for secret keys that are identified using an alias. |
| public static interface | SecretKeyCallback.Request
Marker interface for secret key request types. |
| Modifier and Type | Field and Description |
|---|---|
| private SecretKey | |
| private SecretKeyCallback. |
| Access | Constructor and Description |
|---|---|
| public | SecretKeyCallback(SecretKeyCallback.
Request object identifying the secret key, or null. requestConstructs this SecretKeyCallback with a secret key Request object. |
| Modifier and Type | Method and Description |
|---|---|
| public SecretKey | Returns: The secret key, or null if no key was found.Used to obtain the secret key set within the Callback. |
| public SecretKeyCallback. | 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.Used by the CallbackHandler to get the Request object which identifies the secret key to be returned. |
| public void |
| key | back to summary |
|---|---|
| private SecretKey key | |
| request | back to summary |
|---|---|
| private SecretKeyCallback. | |
| SecretKeyCallback | back to summary |
|---|---|
| public SecretKeyCallback(SecretKeyCallback. 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.
| |
| getKey | back to summary |
|---|---|
| public SecretKey getKey() Used to obtain the secret key set within the Callback.
| |
| getRequest | back to summary |
|---|---|
| public SecretKeyCallback. Used by the CallbackHandler to get the Request object which identifies the secret key to be returned.
| |
| setKey | back to summary |
|---|---|
| public void setKey(SecretKey key) Used by the CallbackHandler to set the requested secret key within the Callback.
| |
| Access | Constructor and Description |
|---|---|
| public | AliasRequest(String
Name identifier for the secret key, or null. alias)Construct an AliasRequest with an alias. |
| Modifier and Type | Method and Description |
|---|---|
| public String |
| alias | back to summary |
|---|---|
| private String alias | |
| AliasRequest | back to summary |
|---|---|
| public AliasRequest(String alias) Construct an AliasRequest with an alias. The alias is used to directly identify the secret key to be returned. If the alias is null, the handler of the callback relies on its own default.
| |
| getAlias | back to summary |
|---|---|
| public String getAlias() Get the alias.
| |