- java.lang.Object
-
- javax.security.auth.message.callback.SecretKeyCallback
-
- All Implemented Interfaces:
- Callback
public class SecretKeyCallback extends Object implements 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 empoyed byClientAuthModules
invoked from intermediate components that need to acquire a password to authenticate to their target service.
-
-
Nested Class Summary
Nested Classes 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 Summary
Constructors Constructor and Description SecretKeyCallback(SecretKeyCallback.Request request)
Constructs this SecretKeyCallback with a secret key Request object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description 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(SecretKey key)
Used by the CallbackHandler to set the requested secret key within the Callback.
-
-
-
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(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 SecretKey getKey()
Used to obtain the secret key set within the Callback.- Returns:
- The secret key, or null if no key was found.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/security/auth/message/callback/SecretKeyCallback.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.