com.ibm.websphere.wssecurity.wssapi

Class WSSException

  • java.lang.Object
    • java.lang.Throwable
      • java.lang.Exception
        • com.ibm.websphere.wssecurity.wssapi.WSSException
  • All Implemented Interfaces:
    java.io.Serializable


    public class WSSException
    extends java.lang.Exception
    Represents an exception while processing WS-Security.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      WSSException()
      Creates a WSSException.
      WSSException(javax.xml.namespace.QName fault, java.lang.String message)
      Creates a WSSException.
      WSSException(javax.xml.namespace.QName fault, java.lang.String message, java.lang.Throwable cause)
      Creates a WSSException.
      WSSException(java.lang.String message)
      Creates a WSSException.
      WSSException(java.lang.String message, java.lang.Throwable cause)
      Creates a WSSException.
      WSSException(java.lang.Throwable cause)
      Creates a WSSException.
      WSSException(java.lang.Throwable cause, boolean rethrow) 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static WSSException format(javax.xml.namespace.QName fault, java.lang.String key)
      Creates a WSSException.
      static WSSException format(javax.xml.namespace.QName fault, java.lang.String key, org.apache.axiom.om.OMDocument doc)
      Creates a WSSException.
      static WSSException format(javax.xml.namespace.QName fault, java.lang.String key, java.lang.String arg1)
      Creates a WSSException.
      static WSSException format(javax.xml.namespace.QName fault, java.lang.String key, java.lang.String[] args)
      Creates a WSSException.
      static WSSException format(javax.xml.namespace.QName fault, java.lang.String key, java.lang.String[] args, java.lang.Throwable cause)
      Creates a WSSException.
      static WSSException format(javax.xml.namespace.QName fault, java.lang.String key, java.lang.String arg1, java.lang.String arg2)
      Creates a WSSException.
      static WSSException format(javax.xml.namespace.QName fault, java.lang.String key, java.lang.String arg1, java.lang.Throwable cause)
      Creates a WSSException.
      static WSSException format(javax.xml.namespace.QName fault, java.lang.String key, java.lang.Throwable cause)
      Creates a WSSException.
      static WSSException format(java.lang.String key)
      Creates a WSSException.
      static WSSException format(java.lang.String key, java.lang.String arg1)
      Creates a WSSException.
      static WSSException format(java.lang.String key, java.lang.String[] args)
      Creates a WSSException.
      static WSSException format(java.lang.String key, java.lang.String[] args, java.lang.Throwable cause)
      Creates a WSSException.
      static WSSException format(java.lang.String key, java.lang.String arg1, java.lang.String arg2)
      Creates a WSSException.
      static WSSException format(java.lang.String key, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3, java.lang.String arg4, java.lang.Throwable cause)
      Creates a WSSException.
      static WSSException format(java.lang.String key, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3, java.lang.Throwable cause)
      Creates a WSSException.
      static WSSException format(java.lang.String key, java.lang.String arg1, java.lang.Throwable cause)
      Creates a WSSException.
      static WSSException format(java.lang.String key, java.lang.Throwable cause)
      Creates a WSSException.
      java.lang.Throwable getCauseException()
      Returns a root exception.
      static java.util.ArrayList<org.apache.axiom.om.OMNode> getElementsByTagNameNS(org.apache.axiom.om.OMNode node, java.lang.String nsUri, java.lang.String localName) 
      javax.xml.namespace.QName getFaultCode()
      Returns a SOAP faultcode.
      static java.lang.String getMessage(java.lang.String key)
      Get NLS messages, mainly use for throwing exceptions
      static WSSException rethrow(java.lang.Throwable t) 
      • Methods inherited from class java.lang.Throwable

        fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • WSSException

        public WSSException(java.lang.Throwable cause,
                    boolean rethrow)
      • WSSException

        public WSSException()
        Creates a WSSException.
      • WSSException

        public WSSException(java.lang.String message)
        Creates a WSSException.
        Parameters:
        message - A message.
      • WSSException

        public WSSException(javax.xml.namespace.QName fault,
                    java.lang.String message)
        Creates a WSSException.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        message - A message.
      • WSSException

        public WSSException(javax.xml.namespace.QName fault,
                    java.lang.String message,
                    java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        message - A message.
        cause - The orginal exception
      • WSSException

        public WSSException(java.lang.String message,
                    java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        message - A message.
        cause - A root exception.
      • WSSException

        public WSSException(java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        cause - A root exception.
    • Method Detail

      • format

        public static WSSException format(java.lang.String key)
        Creates a WSSException.
        Parameters:
        key - A resource key for the error message.
      • format

        public static WSSException format(java.lang.String key,
                          java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        key - Resource key for the error message.
        cause - A root exception.
      • format

        public static WSSException format(java.lang.String key,
                          java.lang.String arg1)
        Creates a WSSException.
        Parameters:
        key - Resource key for the error message.
        arg1 - A parameter for the message resource.
      • format

        public static WSSException format(java.lang.String key,
                          java.lang.String arg1,
                          java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        key - Resource key for the error message.
        arg1 - A parameter for the message resource.
        cause - A root exception.
      • format

        public static WSSException format(java.lang.String key,
                          java.lang.String[] args)
        Creates a WSSException.
        Parameters:
        key - Resource key for the error message.
        args - Parameters for the message resource.
      • format

        public static WSSException format(java.lang.String key,
                          java.lang.String[] args,
                          java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        key - Resource key for the error message.
        args - Parameters for the message resource.
        cause - A root exception.
      • format

        public static WSSException format(javax.xml.namespace.QName fault,
                          java.lang.String key)
        Creates a WSSException.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        key - Resource key for the error message.
      • format

        public static WSSException format(javax.xml.namespace.QName fault,
                          java.lang.String key,
                          java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        key - Resource key for the error message.
        cause - A root exception.
      • format

        public static WSSException format(javax.xml.namespace.QName fault,
                          java.lang.String key,
                          java.lang.String arg1)
        Creates a WSSException.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        key - Resource key for the error message.
        arg1 - A parameter for the message resource.
      • format

        public static WSSException format(javax.xml.namespace.QName fault,
                          java.lang.String key,
                          java.lang.String arg1,
                          java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        key - Resource key for the error message.
        arg1 - A parameter for the message resource.
        cause - A root exception.
      • format

        public static WSSException format(javax.xml.namespace.QName fault,
                          java.lang.String key,
                          java.lang.String[] args)
        Creates a WSSException.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        key - Resource key for the error message.
        args - An array which contains the parameters for the message resource.
      • format

        public static WSSException format(javax.xml.namespace.QName fault,
                          java.lang.String key,
                          java.lang.String[] args,
                          java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        key - Resource key for the error message.
        args - An array which contains the parameters for the message resource.
        cause - A root exception.
      • format

        public static WSSException format(java.lang.String key,
                          java.lang.String arg1,
                          java.lang.String arg2)
        Creates a WSSException.
        Parameters:
        key - Resource key for the error message.
        arg1 - First parameter for the message resource.
        arg2 - Second parameter for the message resource.
      • format

        public static WSSException format(java.lang.String key,
                          java.lang.String arg1,
                          java.lang.String arg2,
                          java.lang.String arg3,
                          java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        key - Resource key for the error message.
        arg1 - First parameter for the message resource.
        arg2 - Second parameter for the message resource.
        arg3 - Third parameter for the message resource.
        cause - A root exception
      • format

        public static WSSException format(java.lang.String key,
                          java.lang.String arg1,
                          java.lang.String arg2,
                          java.lang.String arg3,
                          java.lang.String arg4,
                          java.lang.Throwable cause)
        Creates a WSSException.
        Parameters:
        key - Resource key for the error message.
        arg1 - First parameter for the message resource.
        arg2 - Second parameter for the message resource.
        arg3 - Third parameter for the message resource.
        arg4 - Fourth parameter for the message resource.
        cause - A root exception.
      • format

        public static WSSException format(javax.xml.namespace.QName fault,
                          java.lang.String key,
                          java.lang.String arg1,
                          java.lang.String arg2)
        Creates a WSSException.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        key - Resource key for the error message.
        arg1 - First parameter for the message resource.
        arg2 - Second parameter for the message resource.
      • format

        public static WSSException format(javax.xml.namespace.QName fault,
                          java.lang.String key,
                          org.apache.axiom.om.OMDocument doc)
        Creates a WSSException. If the given DOM represents a SOAP fault (that is, a fault is occurred in processing a fault response message), appends the original fault message.
        Parameters:
        fault - A QName object which represents SOAP faultcode.
        key - Resource key for the error message.
        doc - A DOM of the received message.
      • rethrow

        public static WSSException rethrow(java.lang.Throwable t)
      • getCauseException

        public java.lang.Throwable getCauseException()
        Returns a root exception.
        Returns:
        A root exception.
      • getFaultCode

        public javax.xml.namespace.QName getFaultCode()
        Returns a SOAP faultcode.
        Returns:
        A SOAP faultcode.
      • getMessage

        public static java.lang.String getMessage(java.lang.String key)
        Get NLS messages, mainly use for throwing exceptions
        Parameters:
        key - NLS message key
        Returns:
        NLS messages
      • getElementsByTagNameNS

        public static java.util.ArrayList<org.apache.axiom.om.OMNode> getElementsByTagNameNS(org.apache.axiom.om.OMNode node,
                                                                             java.lang.String nsUri,
                                                                             java.lang.String localName)
        Parameters:
        node - node.
        nsUri - namespace URI of the element to match on. The special value "*" matches all namespaces.
        localName - local name of the element to match on. The special value "*" matches all local names.
        Returns:
        all the matched element nodes.
IBM WebSphere Application ServerTM
Release 8.5