com.ibm.cics.server

Class SoapFault

  • java.lang.Object
    • com.ibm.cics.server.SoapFault


  • public class SoapFault
    extends java.lang.Object

    This class provides the Java interface to CICS SOAPFAULT API.

    Since CICS TS version:
    3.1
    Since package version:
    1.0
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int CLIENT
      Use for the faultcode when the fault is caused by the Client
      static int RECEIVER
      Use for the faultcode when the fault is caused by the Receiver
      static int SENDER
      Use for the faultcode when the fault is caused by the Sender
      static int SERVER
      Use for the faultcode when the fault is caused by the Server
    • Constructor Summary

      Constructors 
      Constructor and Description
      SoapFault() 
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method and Description
      static void addFaultstring(java.lang.String faultstring, java.lang.String natlang)
      Add a new faultstring to the fault that has been created.
      static void addSubcode(java.lang.String subcode)
      Add a new subcode to the fault that has been created.
      static void create(int faultcode, java.lang.String faultstring)
      Create a new SOAPFault.
      static void create(int faultcode, java.lang.String faultstring, java.lang.String detail)
      Create a new SOAPFault.
      static void create(int faultcode, java.lang.String faultstring, java.lang.String natlang, java.lang.String detail)
      Create a new SOAPFault.
      static void create(int faultcode, java.lang.String faultstring, java.lang.String natlang, java.lang.String faultactor, java.lang.String role, java.lang.String detail)
      Create a new SOAPFault.
      static void create(java.lang.String faultcodeString, java.lang.String faultstring, java.lang.String natlang, java.lang.String faultactor, java.lang.String role, java.lang.String detail)
      Create a new SOAPFault.
      static void delete()
      Delete deletes a SOAPFault
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • SENDER

        public static final int SENDER
        Use for the faultcode when the fault is caused by the Sender
        See Also:
        Constant Field Values
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • RECEIVER

        public static final int RECEIVER
        Use for the faultcode when the fault is caused by the Receiver
        See Also:
        Constant Field Values
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • CLIENT

        public static final int CLIENT
        Use for the faultcode when the fault is caused by the Client
        See Also:
        Constant Field Values
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • SERVER

        public static final int SERVER
        Use for the faultcode when the fault is caused by the Server
        See Also:
        Constant Field Values
        Since CICS TS version:
        3.1
        Since package version:
        1.0
    • Constructor Detail

      • SoapFault

        public SoapFault()
    • Method Detail

      • create

        public static void create(int faultcode,
                                  java.lang.String faultstring,
                                  java.lang.String natlang,
                                  java.lang.String faultactor,
                                  java.lang.String role,
                                  java.lang.String detail)
                           throws InvalidRequestException,
                                  CCSIDErrorException,
                                  LengthErrorException
        Create a new SOAPFault.
        Parameters:
        faultcode - Use one of SENDER, RECEIVER, CLIENT or SERVER to specify the SOAP fault code.
        faultstring - String describing the fault
        natlang - the national language of the faultstring, xml:lang value.
        faultactor - The soap actor that created the fault
        role - The role a SOAP node was acting in when a fault occurs. This only appears in a SOAP 1.2 fault
        detail - The application specific error data in name-space qualified tags.
        Throws:
        InvalidRequestException - An INVREQ occurred
        CCSIDErrorException - CCSIDERR
        LengthErrorException - The length of one of the parameters was too large
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • create

        public static void create(int faultcode,
                                  java.lang.String faultstring,
                                  java.lang.String natlang,
                                  java.lang.String detail)
                           throws InvalidRequestException,
                                  CCSIDErrorException,
                                  LengthErrorException
        Create a new SOAPFault.
        Parameters:
        faultcode - Use one of SENDER, RECEIVER, CLIENT or SERVER to specify the SOAP fault code.
        faultstring - String describing the fault
        natlang - the national language of the faultstring, xml:lang value.
        detail - The application specific error data in name-space qualified tags.
        Throws:
        InvalidRequestException - An INVREQ occurred
        CCSIDErrorException - CCSIDERR
        LengthErrorException - The length of one of the parameters was too large
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • create

        public static void create(int faultcode,
                                  java.lang.String faultstring,
                                  java.lang.String detail)
                           throws InvalidRequestException,
                                  CCSIDErrorException,
                                  LengthErrorException
        Create a new SOAPFault.
        Parameters:
        faultcode - Use one of SENDER, RECEIVER, CLIENT or SERVER to specify the SOAP fault code.
        faultstring - String describing the fault
        detail - The application specific error data in name-space qualified tags.
        Throws:
        InvalidRequestException - An INVREQ occurred
        CCSIDErrorException - CCSIDERR
        LengthErrorException - The length of one of the parameters was too large
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • create

        public static void create(java.lang.String faultcodeString,
                                  java.lang.String faultstring,
                                  java.lang.String natlang,
                                  java.lang.String faultactor,
                                  java.lang.String role,
                                  java.lang.String detail)
                           throws InvalidRequestException,
                                  CCSIDErrorException,
                                  LengthErrorException
        Create a new SOAPFault.
        Parameters:
        faultcodeString - String for faultcode to use
        faultstring - String describing the fault
        natlang - the national language of the faultstring, xml:lang value.
        faultactor - The soap actor that created the fault
        role - The role a SOAP node was acting in when a fault occurs. This only appears in a SOAP 1.2 fault
        detail - The application specific error data in name-space qualified tags.
        Throws:
        InvalidRequestException - An INVREQ occurred
        CCSIDErrorException - CCSIDERR
        LengthErrorException - The length of one of the parameters was too large
        Since CICS TS version:
        3.1
        Since package version:
        1.0