Module jakarta.security.auth.message

Package jakarta.security.auth.message.callback

Class PrivateKeyCallback

java.lang.Object

jakarta.security.auth.message.callback.PrivateKeyCallback

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrivateKeyCallback.AliasRequest	Request type for private keys that are identified using an alias.
static class	PrivateKeyCallback.DigestRequest	Request type for private keys that are identified using a certificate digest or thumbprint.
static class	PrivateKeyCallback.IssuerSerialNumRequest	Request type for private keys that are identified using an issuer/serial number.
static interface	PrivateKeyCallback.Request	Marker interface for private key request types.
static class	PrivateKeyCallback.SubjectKeyIDRequest	Request type for private keys that are identified using a SubjectKeyID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Certificate[]	getChain()	Used to obtain the certificate chain set within the Callback.
PrivateKey	getKey()	Used to obtain the private key set within the Callback.
PrivateKeyCallback.Request	getRequest()	Used by the CallbackHandler to get the Request object that identifies the private key to be returned.
void	setKey(PrivateKey key, Certificate[] chain)	Used by the CallbackHandler to set the requested private key and the corresponding certificate chain within the Callback.

Methods inherited from class java.lang.Object

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

Constructor Details

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 Details

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 certificate chain set within the Callback.

Returns:

The certificate chain, or null if the chain could not be found.