com.ibm.wsspi.wssecurity.config

Class KeyStoreKeyLocator

  1. java.lang.Object
  2. extended bycom.ibm.wsspi.wssecurity.config.KeyStoreKeyLocator
All implemented interfaces:
KeyLocator, Initializable
Direct known subclasses:
WSIdKeyStoreMapKeyLocator

Deprecated.
  1. public class KeyStoreKeyLocator
  2. extends java.lang.Object
  3. implements KeyLocator
Maps an abstract key "name" to the actual key in KeyStore object.

This class accepts key store and key information. Key information consists of three pieces: abstract key "name", alias in the key store and optional key password (in case the key is not public one). These values are specified in WS-Security configuration XMI files and passed to init method as encoded name-value pairs.


Constructor Summary

Constructor and Description
KeyStoreKeyLocator()
Deprecated. Invoked by WS-Security runtime.

Method Summary

Modifier and Type Method and Description
  1. protected
  2. void
doInit()
Deprecated.
  1. static
  2. java.lang.String
encodedName(java.lang.String dn)
Deprecated. Encodes and normalizes a DName string to some degree.
  1. java.security.cert.Certificate
getCertificate(java.security.Key key)
Deprecated. Returns a certificate object which corresponds to the specified key.
  1. java.security.cert.Certificate
getCertificate(java.lang.String name)
Deprecated. Returns a certificate object which corresponds to the given abstract or concrete key "name".
  1. protected
  2. java.security.Key
getConfidentialKey(java.lang.String name,java.lang.Object context)
Deprecated. Returns either private key or shared key.
  1. java.security.Key
getDecryptionKey(java.lang.String name,java.lang.Object context)
Deprecated. Returns an decryption key.
  1. protected
  2. java.lang.String
getDefaultBasePath()
Deprecated. Reserved for the future use.
  1. java.security.Key
getEncryptionKey(java.lang.String name,java.lang.Object context)
Deprecated. Returns an encryption key.
  1. java.lang.String
getName(java.security.Key key)
Deprecated. Returns a concrete key "name" which corresponds to the specified key.
  1. 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.
  1. java.util.Set
getNames(java.lang.Object context)
Deprecated. Returns a Set object which contains all the concrete key "name"s.
  1. java.security.Key
getSigningKey(java.lang.String name)
Deprecated. Returns a signing key.
  1. java.security.Key
getVerificationKey(java.lang.String name)
Deprecated. Returns a verification key.
  1. void
init(java.util.Map map)
Deprecated. Initializes the object.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyStoreKeyLocator

  1. public KeyStoreKeyLocator()
Deprecated.
Invoked by WS-Security runtime.

Method Detail

getDefaultBasePath

  1. protected java.lang.String getDefaultBasePath( )
Deprecated.
Reserved for the future use.

init

  1. public void init(java.util.Map map)
  2. throws SoapSecurityException
Deprecated.
Description copied from interface: Initializable
Initializes the object.
Specified by:
init in interface Initializable
Parameters:
map - a Map object which contains name-value pairs. These pairs are specified in <Property> elements in the configuration XMI files.
Throws:

doInit

  1. protected void doInit()
  2. throws KeyLocatorException
Deprecated.
Throws:

getNames

  1. public java.util.Set getNames(java.lang.Object context)
  2. throws KeyLocatorException
Deprecated.
Description copied from interface: KeyLocator
Returns a Set object which contains all the concrete key "name"s.
Specified by:
getNames in interface KeyLocator
Parameters:
context - Reserved for the future use.
Returns:
A Set object which contains all the concrete key "name"s.
Throws:

getConfidentialKey

  1. protected java.security.Key getConfidentialKey( java.lang.String name,
  2. java.lang.Object context)
  3. throws KeyLocatorException
Deprecated.
Returns either private key or shared key.
Parameters:
name - An abstract key "name".
context - Reserved for the future use.
Throws:

getEncryptionKey

  1. public java.security.Key getEncryptionKey( java.lang.String name,
  2. java.lang.Object context)
  3. throws KeyLocatorException
Deprecated.
Description copied from interface: KeyLocator
Returns an encryption key.
Specified by:
Parameters:
name - An abstract or concrete key "name".
context - Reserved for the future use.
Returns:
An encryption key.
Throws:

getDecryptionKey

  1. public java.security.Key getDecryptionKey( java.lang.String name,
  2. java.lang.Object context)
  3. throws KeyLocatorException
Deprecated.
Description copied from interface: KeyLocator
Returns an decryption key.
Specified by:
Parameters:
name - An abstract or concrete key "name".
context - Reserved for the future use.
Returns:
An decryption key.
Throws:

getSigningKey

  1. public java.security.Key getSigningKey( java.lang.String name)
  2. throws KeyLocatorException
Deprecated.
Description copied from interface: KeyLocator
Returns a signing key.
Specified by:
getSigningKey in interface KeyLocator
Parameters:
name - An abstract or concrete key "name".
Returns:
A signing key.
Throws:

getVerificationKey

  1. public java.security.Key getVerificationKey( java.lang.String name)
  2. throws KeyLocatorException
Deprecated.
Description copied from interface: KeyLocator
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>.

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

getName

  1. public java.lang.String getName( java.security.Key key)
  2. throws KeyLocatorException
Deprecated.
Description copied from interface: KeyLocator
Returns a concrete key "name" which corresponds to the specified key.
Specified by:
getName in interface KeyLocator
Parameters:
key - A key which can be retrieved through the KeyLocator object.
Returns:
A concrete key "name".
Throws:

getCertificate

  1. public java.security.cert.Certificate getCertificate( java.security.Key key)
  2. throws KeyLocatorException
Deprecated.
Description copied from interface: KeyLocator
Returns a certificate object which corresponds to the specified key.
Specified by:
getCertificate in interface KeyLocator
Parameters:
key - A key which can be retrieved through the KeyLocator object.
Returns:
A certificate object.
Throws:

getCertificate

  1. public java.security.cert.Certificate getCertificate( java.lang.String name)
  2. throws KeyLocatorException
Deprecated.
Description copied from interface: KeyLocator
Returns a certificate object which corresponds to the given abstract or concrete key "name".
Specified by:
getCertificate in interface KeyLocator
Parameters:
name - An abstract or concrete key "name".
Returns:
A certificate object.
Throws:

encodedName

  1. public static java.lang.String encodedName( java.lang.String dn)
  2. throws KeyLocatorException
Deprecated.
Encodes and normalizes a DName string to some degree.
Parameters:
dn - A DName string.
Returns:
Encoded DName string.
Throws:

getName

  1. public java.lang.String getName( java.lang.String name)
  2. 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.
Specified by:
getName in interface KeyLocator
Parameters:
name - An abstract key "name".
Returns:
A concrete key "name".
Throws: