X509KeyManager (Java 2 Platform SE v1.4.1_"07")

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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` | `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

    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` - 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

    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` - 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, 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.

### getServerAliases

    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` - 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

    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` - 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, 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.

### getCertificateChain

    public 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

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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.