com.ibm.wsspi.wssecurity.config

Class KeyStoreKeyLocator

  • java.lang.Object
    • com.ibm.wsspi.wssecurity.config.KeyStoreKeyLocator
  • All Implemented Interfaces:
    KeyLocator, Initializable
    Direct Known Subclasses:
    WSIdKeyStoreMapKeyLocator

    Deprecated.

    public class KeyStoreKeyLocator
    extends java.lang.Object
    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

      Constructors 
      Constructor and Description
      KeyStoreKeyLocator()
      Deprecated. 
      Invoked by WS-Security runtime.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      protected void doInit()
      Deprecated. 
       
      static java.lang.String encodedName(java.lang.String dn)
      Deprecated. 
      Encodes and normalizes a DName string to some degree.
      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".
      protected java.security.Key getConfidentialKey(java.lang.String name, java.lang.Object context)
      Deprecated. 
      Returns either private key or shared key.
      java.security.Key getDecryptionKey(java.lang.String name, java.lang.Object context)
      Deprecated. 
      Returns an decryption key.
      protected java.lang.String getDefaultBasePath()
      Deprecated. 
      Reserved for the future use.
      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.
      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

        public KeyStoreKeyLocator()
        Deprecated. 
        Invoked by WS-Security runtime.
    • Method Detail

      • getDefaultBasePath

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

        public void init(java.util.Map map)
                  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:
        SoapSecurityException
      • getNames

        public java.util.Set getNames(java.lang.Object context)
                               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:
        KeyLocatorException
      • getConfidentialKey

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

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

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

        public java.security.Key getVerificationKey(java.lang.String name)
                                             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:
        getVerificationKey in interface KeyLocator
        Parameters:
        name - An abstract or concrete key "name".
        Returns:
        A verification key.
        Throws:
        KeyLocatorException
      • getName

        public java.lang.String getName(java.security.Key key)
                                 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:
        KeyLocatorException
      • getCertificate

        public java.security.cert.Certificate getCertificate(java.security.Key key)
                                                      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:
        KeyLocatorException
      • getCertificate

        public java.security.cert.Certificate getCertificate(java.lang.String name)
                                                      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:
        KeyLocatorException
      • encodedName

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

        public 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.
        Specified by:
        getName in interface KeyLocator
        Parameters:
        name - An abstract key "name".
        Returns:
        A concrete key "name".
        Throws:
        KeyLocatorException
IBM WebSphere Application ServerTM
Release 8.5