X509ExtendedKeyManager

public abstract class X509ExtendedKeyManager
extends Object implements X509KeyManager

java.lang.Object
   ↳ javax.net.ssl.X509ExtendedKeyManager


Abstract class that provides for extension of the X509KeyManager interface.

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

Summary

Protected constructors

X509ExtendedKeyManager()

Constructor used by subclasses only.

Public methods

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).

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract 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).

abstract 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).

abstract X509Certificate[] getCertificateChain(String alias)

Returns the certificate chain associated with the given alias.

abstract 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).

abstract PrivateKey getPrivateKey(String alias)

Returns the key associated with the given alias.

abstract 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).

Protected constructors

X509ExtendedKeyManager

Added in API level 1
protected X509ExtendedKeyManager ()

Constructor used by subclasses only.

Public methods

chooseEngineClientAlias

Added in API level 1
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 String: the key algorithm type name(s), ordered with the most-preferred key type first.

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

engine SSLEngine: 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
String the alias name for the desired key, or null if there are no matches.

chooseEngineServerAlias

Added in API level 1
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 String: the key algorithm type name.

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

engine SSLEngine: 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
String the alias name for the desired key, or null if there are no matches.