Summary: Methods | [Expand All]
Since: API Level 1
public interface

X509KeyManager

implements KeyManager
javax.net.ssl.X509KeyManager
Known Indirect Subclasses

Class Overview

A Key Manager for X509 certificate-based key pairs.

Summary

Public Methods
abstract String chooseClientAlias(String[] keyType, Principal[] issuers, Socket socket)
Chooses an alias for the client side of an SSL connection to authenticate it with the specified public key type and certificate issuers.
abstract String chooseServerAlias(String keyType, Principal[] issuers, Socket socket)
Chooses an alias for the server side of an SSL connection to authenticate it with the specified public key type and certificate issuers.
abstract X509Certificate[] getCertificateChain(String alias)
Returns the certificate chain for the specified alias.
abstract String[] getClientAliases(String keyType, Principal[] issuers)
Returns the client aliases for the specified public key type and list of certificate issuers.
abstract PrivateKey getPrivateKey(String alias)
Returns the private key for the specified alias.
abstract String[] getServerAliases(String keyType, Principal[] issuers)
Returns the server aliases for the specified public key type and list of certificate issuers.

Public Methods

public abstract String chooseClientAlias (String[] keyType, Principal[] issuers, Socket socket)

Since: API Level 1

Chooses an alias for the client side of an SSL connection to authenticate it with the specified public key type and certificate issuers.

Parameters
keyType the list of public key algorithm names.
issuers the list of certificate issuers, or null if any issuer will do.
socket the socket for the connection, or null if the alias selected does not depend on a specific socket.
Returns
  • the alias name of a matching key or null if there are no matches.

public abstract String chooseServerAlias (String keyType, Principal[] issuers, Socket socket)

Since: API Level 1

Chooses an alias for the server side of an SSL connection to authenticate it with the specified public key type and certificate issuers.

Parameters
keyType the list of public key algorithm type names.
issuers the list of certificate issuers, or null if any issuer will do.
socket the socket for the connection, or null if the alias selected does not depend on a specific socket.
Returns
  • the alias name of a matching key or null if there are no matches.

public abstract X509Certificate[] getCertificateChain (String alias)

Since: API Level 1

Returns the certificate chain for the specified alias.

Parameters
alias the alias to get the certificate chain for.
Returns
  • the certificate chain for the specified alias, or null if the alias cannot be found.

public abstract String[] getClientAliases (String keyType, Principal[] issuers)

Since: API Level 1

Returns the client aliases for the specified public key type and list of certificate issuers.

Parameters
keyType the public key algorithm type name.
issuers the list of certificate issuers, or null if any issuer will do.
Returns
  • the client aliases for the specified public key type, or null if there are no matching aliases.

public abstract PrivateKey getPrivateKey (String alias)

Since: API Level 1

Returns the private key for the specified alias.

Parameters
alias the alias to get the private key for.
Returns
  • the private key for the specified alias, or null if the alias cannot be found.

public abstract String[] getServerAliases (String keyType, Principal[] issuers)

Since: API Level 1

Returns the server aliases for the specified public key type and list of certificate issuers.

Parameters
keyType the public key algorithm type name.
issuers the list of certificate issuers, or null if any issuer will do.
Returns
  • the client aliases for the specified public key type, or null if there are no matching aliases.