com.ibm.net.ssl
Interface X509KeyManager


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.


Method Summary
 java.lang.String chooseClientAlias(java.lang.String keyType, java.security.Principal[] issuers)
          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).
 java.lang.String chooseServerAlias(java.lang.String keyType, java.security.Principal[] issuers)
          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).
 java.security.cert.X509Certificate[] getCertificateChain(java.lang.String alias)
          Returns the certificate chain associated with the given alias.
 java.lang.String[] getClientAliases(java.lang.String keyType, java.security.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).
 java.security.PrivateKey getPrivateKey(java.lang.String alias)
          Returns the key associated with the given alias.
 java.lang.String[] getServerAliases(java.lang.String keyType, java.security.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

public java.lang.String[] getClientAliases(java.lang.String keyType,
                                           java.security.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 type
issuers - the certificate issuer authorities
Returns:
the matching aliases

chooseClientAlias

public java.lang.String chooseClientAlias(java.lang.String keyType,
                                          java.security.Principal[] issuers)
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 type
issuers - the certificate issuer authorities
Returns:
the selected alias

getServerAliases

public java.lang.String[] getServerAliases(java.lang.String keyType,
                                           java.security.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 type
issuers - the certificate issuer authorities
Returns:
the matching aliases

chooseServerAlias

public java.lang.String chooseServerAlias(java.lang.String keyType,
                                          java.security.Principal[] issuers)
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 type
issuers - the certificate issuer authorities
Returns:
the selected alias

getCertificateChain

public java.security.cert.X509Certificate[] getCertificateChain(java.lang.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)

getPrivateKey

public java.security.PrivateKey getPrivateKey(java.lang.String alias)
Returns the key associated with the given alias.
Parameters:
alias - the alias name
Returns:
the requested key