javax.net.ssl

Interface X509KeyManager

All Superinterfaces:
KeyManager
All known implementing classes:
X509ExtendedKeyManager

  1. public interface X509KeyManager
  2. 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:

Note: the X509ExtendedKeyManager should be used in favor of this class.

Since:
1.4

Method Summary

Modifier and Type Method and Description
  1. 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).
  1. 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).
  1. X509Certificate[]
getCertificateChain(String alias)
Returns the certificate chain associated with the given alias.
  1. 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).
  1. PrivateKey
getPrivateKey(String alias)
Returns the key associated with the given alias.
  1. 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

  1. String[] getClientAliases(String keyType,
  2. 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

  1. String chooseClientAlias(String[] keyType,
  2. Principal[] issuers,
  3. 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.
Returns:
the alias name for the desired key, or null if there are no matches.

getServerAliases

  1. String[] getServerAliases(String keyType,
  2. 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

  1. String chooseServerAlias(String keyType,
  2. Principal[] issuers,
  3. 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.
Returns:
the alias name for the desired key, or null if there are no matches.

getCertificateChain

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

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