javax.security.auth.message.callback

Class PrivateKeyCallback

Contents
  • All Implemented Interfaces:
    Callback

    public class PrivateKeyCallback
extends Object
implements Callback
    Callback for acquiring a Public Key Infrastructure (PKI) private key and its corresponding certificate chain. This Callback may be used by client or server authentication modules to obtain private keys or private key references, from key repositories available to the CallbackHandler that processes the Callback.

    • Constructor Detail

      • PrivateKeyCallback

        public PrivateKeyCallback(PrivateKeyCallback.Request request)
        Constructs this PrivateKeyCallback with a private key Request object.

        The request object identifies the private key to be returned. The corresponding certificate chain for the private key is also returned.

        If the request object is null, the handler of the callback relies on its own default.

        Parameters:
        request - Identifier for the private key, or null.

    • Method Detail

      • getRequest

        public PrivateKeyCallback.Request getRequest()
        Used by the CallbackHandler to get the Request object that identifies the private 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(PrivateKey key,
                   Certificate[] chain)
        Used by the CallbackHandler to set the requested private key and the corresponding certificate chain within the Callback.

        If the requested private key or chain could not be found, then both values must be set to null.

        Parameters:
        key - The private key, or null.
        chain - The corresponding certificate chain, or null.

      • getKey

        public PrivateKey getKey()
        Used to obtain the private key set within the Callback.
        Returns:
        The private key, or null if the key could not be found.

      • getChain

        public Certificate[] getChain()
        Used to obtain the certicicate chain set within the Callback.
        Returns:
        The certificate chain, or null if the chain could not be 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/privatekeycallback.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

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com/en/java/, Class PrivateKeyCallback

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.