public final class

X500PrivateCredential

extends Object
implements Destroyable
java.lang.Object
   ↳ javax.security.auth.x500.X500PrivateCredential

Class Overview

This class represents an X500PrivateCredential. It associates an X.509 certificate, corresponding private key and the KeyStore alias used to reference that exact key pair in the KeyStore. This enables looking up the private credentials for an X.500 principal in a subject.

Summary

Public Constructors
X500PrivateCredential(X509Certificate cert, PrivateKey key)
Creates an X500PrivateCredential that associates an X.509 certificate, a private key and the KeyStore alias.
X500PrivateCredential(X509Certificate cert, PrivateKey key, String alias)
Creates an X500PrivateCredential that associates an X.509 certificate, a private key and the KeyStore alias.
Public Methods
void destroy()
Clears the references to the X.509 certificate, private key and the KeyStore alias in this object.
String getAlias()
Returns the KeyStore alias.
X509Certificate getCertificate()
Returns the X.509 certificate.
PrivateKey getPrivateKey()
Returns the PrivateKey.
boolean isDestroyed()
Determines if the references to the X.509 certificate and private key in this object have been cleared.
[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.security.auth.Destroyable

Public Constructors

public X500PrivateCredential (X509Certificate cert, PrivateKey key)

Creates an X500PrivateCredential that associates an X.509 certificate, a private key and the KeyStore alias.

Parameters
cert X509Certificate
key PrivateKey for the certificate
Throws
IllegalArgumentException if either cert or key is null

public X500PrivateCredential (X509Certificate cert, PrivateKey key, String alias)

Creates an X500PrivateCredential that associates an X.509 certificate, a private key and the KeyStore alias.

Parameters
cert X509Certificate
key PrivateKey for the certificate
alias KeyStore alias
Throws
IllegalArgumentException if either cert, key or alias is null

Public Methods

public void destroy ()

Clears the references to the X.509 certificate, private key and the KeyStore alias in this object.

public String getAlias ()

Returns the KeyStore alias.

Returns
  • the KeyStore alias

public X509Certificate getCertificate ()

Returns the X.509 certificate.

Returns
  • the X509Certificate

public PrivateKey getPrivateKey ()

Returns the PrivateKey.

Returns
  • the PrivateKey

public boolean isDestroyed ()

Determines if the references to the X.509 certificate and private key in this object have been cleared.

Returns
  • true if X509Certificate and the PrivateKey are null