X509KeyManager

TopBlend: Here is the first difference. There are 5 differences.

~~is old.~~

is new.

javax.net.ssl
Interface X509KeyManager

All Superinterfaces:: KeyManager

public interface X509KeyManager
extends KeyManager

Instances of this interface manage which X509 certificate-based key pairs are used to authenticate the local side of a secure socket.

During secure socket negotiations, implentations call methods in this interface to:

determine the set of aliases that are available for negotiations based on the criteria presented,
select the best alias based on the criteria presented, and
obtain the corresponding key material for given aliases.

Since:: 1.4

Method Summary

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 chooseEngineClientAlias ( String [] keyType, Principal [] issuers, SSLEngine
          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
          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).

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

Method Summary
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*	*chooseEngineClientAlias* ( *String* *[] keyType,* *Principal* *[] issuers,* *SSLEngine* *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* *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).*
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).

Method Detail

getClientAliases


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

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.
Returns:: an array of the matching alias names, or null if there were no matches.

chooseClientAlias


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

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.; socket - the socket to be used for this connection. This parameter can be null, which indicates that implementations are free to select an alias applicable to any socket. ~~This parameter can be null, in which case this method will return the most generic alias to use.~~
Returns:: the alias name for the desired key, or null if there are no matches.

chooseEngineClientAlias

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

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.
Since:: 1.5

getServerAliases


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

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.
Returns:: an array of the matching alias names, or null if there were no matches.

chooseServerAlias


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

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.; socket - the socket to be used for this connection. This parameter can be null, which indicates that implementations are free to select an alias applicable to any socket. ~~This parameter can be null, in which case this method will return the most generic alias to use.~~
Returns:: the alias name for the desired key, or null if there are no matches.

chooseEngineServerAlias

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

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.
Since:: 1.5

getCertificateChain


X509Certificate[] getCertificateChain(String alias)

Returns the certificate chain associated with the given alias.

Parameters:: alias - the alias name
Returns:: the certificate chain (ordered with the user's certificate first and the root certificate authority last), or null if the alias can't be found.

getPrivateKey


PrivateKey getPrivateKey(String alias)

Returns the key associated with the given alias.

Parameters:: alias - the alias name
Returns:: the requested key, or null if the alias can't be found.

javax.net.ssl Interface X509KeyManager