IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.wssecurity.config
Interface KeyLocator

All Superinterfaces:
Initializable
All Known Implementing Classes:
KeyStoreKeyLocator, WSIdKeyStoreMapKeyLocator

Deprecated.

public interface KeyLocator
extends Initializable

Retrieves the key for signature and encryption, either with or without the abstract or concrete key "name" as a clue.


Method Summary
 java.security.cert.Certificate getCertificate(java.security.Key key)
          Deprecated. Returns a certificate object which corresponds to the specified key.
 java.security.cert.Certificate getCertificate(java.lang.String name)
          Deprecated. Returns a certificate object which corresponds to the given abstract or concrete key "name".
 java.security.Key getDecryptionKey(java.lang.String name, java.lang.Object context)
          Deprecated. Returns an decryption key.
 java.security.Key getEncryptionKey(java.lang.String name, java.lang.Object context)
          Deprecated. Returns an encryption key.
 java.lang.String getName(java.security.Key key)
          Deprecated. Returns a concrete key "name" which corresponds to the specified key.
 java.lang.String getName(java.lang.String name)
          Deprecated. Returns a concrete key "name" which corresponds to the given abstract key "name", which is used as a value of the <KeyName> element.
 java.util.Set getNames(java.lang.Object context)
          Deprecated. Returns a Set object which contains all the concrete key "name"s.
 java.security.Key getSigningKey(java.lang.String name)
          Deprecated. Returns a signing key.
 java.security.Key getVerificationKey(java.lang.String name)
          Deprecated. Returns a verification key.
 
Methods inherited from interface com.ibm.wsspi.wssecurity.Initializable
init
 

Method Detail

getNames

java.util.Set getNames(java.lang.Object context)
                       throws KeyLocatorException
Deprecated. 
Returns a Set object which contains all the concrete key "name"s.

Parameters:
context - Reserved for the future use.
Returns:
A Set object which contains all the concrete key "name"s.
Throws:
KeyLocatorException

getEncryptionKey

java.security.Key getEncryptionKey(java.lang.String name,
                                   java.lang.Object context)
                                   throws KeyLocatorException
Deprecated. 
Returns an encryption key.

Parameters:
name - An abstract or concrete key "name".
context - Reserved for the future use.
Returns:
An encryption key.
Throws:
KeyLocatorException

getDecryptionKey

java.security.Key getDecryptionKey(java.lang.String name,
                                   java.lang.Object context)
                                   throws KeyLocatorException
Deprecated. 
Returns an decryption key.

Parameters:
name - An abstract or concrete key "name".
context - Reserved for the future use.
Returns:
An decryption key.
Throws:
KeyLocatorException

getSigningKey

java.security.Key getSigningKey(java.lang.String name)
                                throws KeyLocatorException
Deprecated. 
Returns a signing key.

Parameters:
name - An abstract or concrete key "name".
Returns:
A signing key.
Throws:
KeyLocatorException

getVerificationKey

java.security.Key getVerificationKey(java.lang.String name)
                                     throws KeyLocatorException
Deprecated. 
Returns a verification key.

NOTE: This function is not implemented in current WS-Security runtime, because verification key is always embedded in the received message as <BinarySecurityToken>.

Parameters:
name - An abstract or concrete key "name".
Returns:
A verification key.
Throws:
KeyLocatorException

getName

java.lang.String getName(java.security.Key key)
                         throws KeyLocatorException
Deprecated. 
Returns a concrete key "name" which corresponds to the specified key.

Parameters:
key - A key which can be retrieved through the KeyLocator object.
Returns:
A concrete key "name".
Throws:
KeyLocatorException

getCertificate

java.security.cert.Certificate getCertificate(java.security.Key key)
                                              throws KeyLocatorException
Deprecated. 
Returns a certificate object which corresponds to the specified key.

Parameters:
key - A key which can be retrieved through the KeyLocator object.
Returns:
A certificate object.
Throws:
KeyLocatorException

getCertificate

java.security.cert.Certificate getCertificate(java.lang.String name)
                                              throws KeyLocatorException
Deprecated. 
Returns a certificate object which corresponds to the given abstract or concrete key "name".

Parameters:
name - An abstract or concrete key "name".
Returns:
A certificate object.
Throws:
KeyLocatorException

getName

java.lang.String getName(java.lang.String name)
                         throws KeyLocatorException
Deprecated. 
Returns a concrete key "name" which corresponds to the given abstract key "name", which is used as a value of the <KeyName> element.

Parameters:
name - An abstract key "name".
Returns:
A concrete key "name".
Throws:
KeyLocatorException

IBM WebSphere Application ServerTM
Release 7