Class X509ExtendedKeyManager

java.lang.Object

javax.net.ssl.X509ExtendedKeyManager

All Implemented Interfaces:

KeyManager, X509KeyManager

public abstract class X509ExtendedKeyManager
extends Object
implements X509KeyManager

Abstract class that provides for extension of the X509KeyManager interface.

Methods in this class should be overridden to provide actual implementations.

Since:

1.5

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	X509ExtendedKeyManager()	Constructor used by subclasses only.

Method Summary

Modifier and Type	Method	Description
String	chooseEngineClientAlias(String[] keyType, Principal[] issuers, SSLEngine engine)	Choose an alias to authenticate the client side of an SSLEngine connection given the public key type and the list of certificate issuer authorities recognized by the peer (if any).
String	chooseEngineServerAlias(String keyType, Principal[] issuers, SSLEngine engine)	Choose an alias to authenticate the server side of an SSLEngine connection given the public key type and the list of certificate issuer authorities recognized by the peer (if any).

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Methods declared in interface X509KeyManager

chooseClientAlias, chooseServerAlias, getCertificateChain, getClientAliases, getPrivateKey, getServerAliases

Modifier and Type	Method	Description
String	chooseClientAlias(String[] keyType, Principal[] issuers, Socket socket)	Choose an alias to authenticate the client side of a secure socket given the public key type and the list of certificate issuer authorities recognized by the peer (if any).
String	chooseServerAlias(String keyType, Principal[] issuers, Socket socket)	Choose an alias to authenticate the server side of a secure socket given the public key type and the list of certificate issuer authorities recognized by the peer (if any).
X509Certificate[]	getCertificateChain(String alias)	Returns the certificate chain associated with the given alias.
String[]	getClientAliases(String keyType, Principal[] issuers)	Get the matching aliases for authenticating the client side of a secure socket given the public key type and the list of certificate issuer authorities recognized by the peer (if any).
PrivateKey	getPrivateKey(String alias)	Returns the key associated with the given alias.
String[]	getServerAliases(String keyType, Principal[] issuers)	Get the matching aliases for authenticating the server side of a secure socket given the public key type and the list of certificate issuer authorities recognized by the peer (if any).

Constructor Details

X509ExtendedKeyManager

protected X509ExtendedKeyManager()

Constructor used by subclasses only.

Method Details

chooseEngineClientAlias

public String chooseEngineClientAlias(String[] keyType,
 Principal[] issuers,
 SSLEngine engine)

Choose an alias to authenticate the client side of an SSLEngine connection given the public key type and the list of certificate issuer authorities recognized by the peer (if any).

The default implementation returns null.

Parameters:

keyType - the key algorithm type name(s), ordered with the most-preferred key type first.

issuers - the list of acceptable CA issuer subject names or null if it does not matter which issuers are used.

engine - the SSLEngine to be used for this connection. This parameter can be null, which indicates that implementations of this interface are free to select an alias applicable to any engine.

Returns:

the alias name for the desired key, or null if there are no matches.

chooseEngineServerAlias

public String chooseEngineServerAlias(String keyType,
 Principal[] issuers,
 SSLEngine engine)

Choose an alias to authenticate the server side of an SSLEngine connection given the public key type and the list of certificate issuer authorities recognized by the peer (if any).

The default implementation returns null.

Parameters:

keyType - the key algorithm type name.

issuers - the list of acceptable CA issuer subject names or null if it does not matter which issuers are used.

engine - the SSLEngine to be used for this connection. This parameter can be null, which indicates that implementations of this interface are free to select an alias applicable to any engine.

Returns:

the alias name for the desired key, or null if there are no matches.