Class WSHandler


  • public abstract class WSHandler
    extends Object
    Extracted from WSDoAllReceiver and WSDoAllSender Extended to all passwordless UsernameTokens and configurable identities.
    • Field Detail

      • cryptos

        protected Map<String,​org.apache.wss4j.common.crypto.Crypto> cryptos
    • Constructor Detail

      • WSHandler

        public WSHandler()
    • Method Detail

      • doSenderAction

        protected void doSenderAction​(Document doc,
                                      RequestData reqData,
                                      List<HandlerAction> actions,
                                      boolean isRequest)
                               throws org.apache.wss4j.common.ext.WSSecurityException
        Performs all defined security actions to set-up the SOAP request.
        Parameters:
        doc - the request as DOM document
        reqData - a data storage to pass values around between methods
        actions - a list holding the actions to do in the order defined in the deployment file or property, plus an optional associated SecurityActionToken object for that Action
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • doReceiverAction

        protected void doReceiverAction​(List<Integer> actions,
                                        RequestData reqData)
                                 throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • checkSignatureConfirmation

        protected void checkSignatureConfirmation​(RequestData reqData,
                                                  WSHandlerResult handlerResults)
                                           throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • decodeUTParameter

        protected void decodeUTParameter​(RequestData reqData)
                                  throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • decodeSignatureParameter

        protected void decodeSignatureParameter​(RequestData reqData)
                                         throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • decodeAlgorithmSuite

        protected void decodeAlgorithmSuite​(RequestData reqData)
                                     throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • decodeEncryptionParameter

        protected void decodeEncryptionParameter​(RequestData reqData)
                                          throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • decodeTimeToLive

        public int decodeTimeToLive​(RequestData reqData,
                                    boolean timestamp)
        Decode the TimeToLive parameter for either a Timestamp or a UsernameToken Created element, depending on the boolean argument
      • decodeFutureTimeToLive

        protected int decodeFutureTimeToLive​(RequestData reqData,
                                             boolean timestamp)
        Decode the FutureTimeToLive parameter for either a Timestamp or a UsernameToken Created element, depending on the boolean argument
      • decodePasswordType

        protected String decodePasswordType​(RequestData reqData)
                                     throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • decodeBooleanConfigValue

        protected boolean decodeBooleanConfigValue​(Object messageContext,
                                                   String configTag,
                                                   boolean defaultToTrue)
                                            throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • loadSignatureCrypto

        public org.apache.wss4j.common.crypto.Crypto loadSignatureCrypto​(RequestData requestData)
                                                                  throws org.apache.wss4j.common.ext.WSSecurityException
        Hook to allow subclasses to load their Signature creation Crypto however they see fit.
        Parameters:
        requestData - the RequestData object
        Returns:
        a Crypto instance to use for Signature creation
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • loadSignatureVerificationCrypto

        public org.apache.wss4j.common.crypto.Crypto loadSignatureVerificationCrypto​(RequestData requestData)
                                                                              throws org.apache.wss4j.common.ext.WSSecurityException
        Hook to allow subclasses to load their Signature verification Crypto however they see fit.
        Parameters:
        requestData - the RequestData object
        Returns:
        a Crypto instance to use for Signature verification
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • loadDecryptionCrypto

        protected org.apache.wss4j.common.crypto.Crypto loadDecryptionCrypto​(RequestData requestData)
                                                                      throws org.apache.wss4j.common.ext.WSSecurityException
        Hook to allow subclasses to load their Decryption Crypto however they see fit.
        Parameters:
        requestData - the RequestData object
        Returns:
        a Crypto instance to use for Decryption creation/verification
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • loadEncryptionCrypto

        protected org.apache.wss4j.common.crypto.Crypto loadEncryptionCrypto​(RequestData requestData)
                                                                      throws org.apache.wss4j.common.ext.WSSecurityException
        Hook to allow subclasses to load their Encryption Crypto however they see fit.
        Parameters:
        requestData - the RequestData object
        Returns:
        a Crypto instance to use for Encryption creation/verification
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • loadCrypto

        protected org.apache.wss4j.common.crypto.Crypto loadCrypto​(String cryptoPropertyFile,
                                                                   String cryptoPropertyRefId,
                                                                   RequestData requestData)
                                                            throws org.apache.wss4j.common.ext.WSSecurityException
        Load a Crypto instance. Firstly, it tries to use the cryptoPropertyRefId tag to retrieve a Crypto object via a custom reference Id. Failing this, it tries to load the crypto instance via the cryptoPropertyFile tag.
        Parameters:
        requestData - the RequestData object
        Returns:
        a Crypto instance to use for Encryption creation/verification
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • loadCryptoFromPropertiesFile

        protected org.apache.wss4j.common.crypto.Crypto loadCryptoFromPropertiesFile​(String propFilename,
                                                                                     RequestData reqData)
                                                                              throws org.apache.wss4j.common.ext.WSSecurityException
        A hook to allow subclass to load Crypto instances from property files in a different way.
        Parameters:
        propFilename - The property file name
        reqData - The RequestData object
        Returns:
        A Crypto instance that has been loaded
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • getCallbackHandler

        public CallbackHandler getCallbackHandler​(String callbackHandlerClass,
                                                  String callbackHandlerRef,
                                                  RequestData requestData)
                                           throws org.apache.wss4j.common.ext.WSSecurityException
        Get a CallbackHandler instance. First try to get an instance via the callbackHandlerRef on the message context. Failing that, try to load a new instance of the CallbackHandler via the callbackHandlerClass argument.
        Parameters:
        callbackHandlerClass - The class name of the CallbackHandler instance
        callbackHandlerRef - The reference name of the CallbackHandler instance
        requestData - The RequestData which supplies the message context
        Returns:
        a CallbackHandler instance
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • getPasswordCallbackHandler

        public CallbackHandler getPasswordCallbackHandler​(RequestData reqData)
                                                   throws org.apache.wss4j.common.ext.WSSecurityException
        Get a CallbackHandler instance to obtain passwords.
        Parameters:
        reqData - The RequestData which supplies the message context
        Returns:
        the CallbackHandler instance to obtain passwords.
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • getPasswordEncryptor

        protected org.apache.wss4j.common.crypto.PasswordEncryptor getPasswordEncryptor​(RequestData requestData)
      • getPasswordCB

        public org.apache.wss4j.common.ext.WSPasswordCallback getPasswordCB​(String username,
                                                                            int doAction,
                                                                            CallbackHandler callbackHandler,
                                                                            RequestData requestData)
                                                                     throws org.apache.wss4j.common.ext.WSSecurityException
        Get a password callback (WSPasswordCallback object) from a CallbackHandler instance
        Parameters:
        username - The username to supply to the CallbackHandler
        doAction - The action to perform
        callbackHandler - The CallbackHandler instance
        requestData - The RequestData which supplies the message context
        Returns:
        the WSPasswordCallback object containing the password
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • decodeSignatureParameter2

        protected void decodeSignatureParameter2​(RequestData reqData)
                                          throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • decodeDecryptionParameter

        protected void decodeDecryptionParameter​(RequestData reqData)
                                          throws org.apache.wss4j.common.ext.WSSecurityException
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • getStringOption

        public String getStringOption​(String key)
        Returns the option on name.
        Parameters:
        key - the non-null key of the option.
        Returns:
        the option on key if key exists and is of type java.lang.String; otherwise null.
      • getClassLoader

        public ClassLoader getClassLoader()
        Returns the classloader to be used for loading the callback class
        Returns:
        class loader
      • getOption

        public abstract Object getOption​(String key)
      • setProperty

        public abstract void setProperty​(Object msgContext,
                                         String key,
                                         Object value)
      • getPassword

        public abstract String getPassword​(Object msgContext)
      • setPassword

        public abstract void setPassword​(Object msgContext,
                                         String password)