APIdia Launch Partner
Top Description Methods
javax.net.ssl

public Interface X509KeyManager

extends KeyManager
Known Direct Implementers
javax.net.ssl.X509ExtendedKeyManager
Imports
java.security.PrivateKey, .Principal, java.security.cert.X509Certificate, java.net.Socket

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, implementations call methods in this interface to:

Note

the X509ExtendedKeyManager should be used in favor of this class.

Since
1.4

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the alias name for the desired key, or null if there are no matches.
chooseClientAlias
(String[]
the key algorithm type name(s), ordered with the most-preferred key type first.
keyType
,
Principal[]
the list of acceptable CA issuer subject names or null if it does not matter which issuers are used.
issuers
,
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.
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).

public String

Returns:

the alias name for the desired key, or null if there are no matches.
chooseServerAlias
(String
the key algorithm type name.
keyType
,
Principal[]
the list of acceptable CA issuer subject names or null if it does not matter which issuers are used.
issuers
,
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.
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).

public X509Certificate[]

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.
getCertificateChain
(String
the alias name
alias
)

Returns the certificate chain associated with the given alias.

public String[]

Returns:

an array of the matching alias names, or null if there were no matches.
getClientAliases
(String
the key algorithm type name
keyType
,
Principal[]
the list of acceptable CA issuer subject names, or null if it does not matter which issuers are used.
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).

public PrivateKey

Returns:

the requested key, or null if the alias can't be found.
getPrivateKey
(String
the alias name
alias
)

Returns the key associated with the given alias.

public String[]

Returns:

an array of the matching alias names, or null if there were no matches.
getServerAliases
(String
the key algorithm type name
keyType
,
Principal[]
the list of acceptable CA issuer subject names or null if it does not matter which issuers are used.
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

chooseClientAliasback to summary
public 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: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.

socket: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:String

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

chooseServerAliasback to summary
public 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: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.

socket: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:String

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

getCertificateChainback to summary
public X509Certificate[] getCertificateChain(String alias)

Returns the certificate chain associated with the given alias.

Parameters
alias:String

the alias name

Returns:X509Certificate[]

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.

getClientAliasesback to summary
public 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: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.

Returns:String[]

an array of the matching alias names, or null if there were no matches.

getPrivateKeyback to summary
public PrivateKey getPrivateKey(String alias)

Returns the key associated with the given alias.

Parameters
alias:String

the alias name

Returns:PrivateKey

the requested key, or null if the alias can't be found.

getServerAliasesback to summary
public 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: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.

Returns:String[]

an array of the matching alias names, or null if there were no matches.