Package com.iizix.ws.prop

Class SOAPInputProps

    • Field Detail

      • TYPE_HTTP

        public static final int TYPE_HTTP
        The message type: HTTP (= 0).
        See Also:
        Constant Field Values

      • TYPE_SOAP

        public static final int TYPE_SOAP
        The message type: SOAP 1.1 (= 1).
        See Also:
        Constant Field Values

      • TYPE_SOAP12

        public static final int TYPE_SOAP12
        The message type: SOAP 1.2 (= 2).
        See Also:
        Constant Field Values

    • Constructor Detail

      • SOAPInputProps

        public SOAPInputProps()
        Creates a Input Properties container with the specified name with a null value.

      • SOAPInputProps

        public SOAPInputProps​(Atom propertyAtom)
        Creates a Input Properties container with the specified name with a null value.
        Parameters:
        propertyAtom - the property atom.

    • Method Detail

      • getInputMessage

        public SOAPInputMessage getInputMessage()
        Gets the SOAP input message.
        Returns:
        The SOAP input message, or null for none.

      • getOutputMessage

        public SOAPOutputMessage getOutputMessage()
        Gets the SOAP output message.
        Returns:
        The SOAP output message, or null for none.

      • getAddressURI

        public java.lang.String getAddressURI()
        Gets the address URI for ALL types (HTTP, SOAP or SOAP 1.2).
        Returns:
        The address, or null if not defined (error).

      • getMessageType

        public int getMessageType()
        Gets the SOAP message type.
        Returns:
        The type: TYPE_HTTP, TYPE_SOAP or TYPE_SOAP12, or -1 if not defined (error).

      • getTransport

        public java.lang.String getTransport()
        Gets the transport.
        Returns:
        A transport string (verb for HTTP, e.g. "http://schemas.xmlsoap.org/soap/http" for SOAP), null when not defined (error).

      • getActionLocationURI

        public java.lang.String getActionLocationURI()
        Gets the Action URI (absolute) for SOAP or the Location URI for HTTP (relative).
        Returns:
        The URI string, or null if not defined (error).

      • getMessageStyle

        public java.lang.Boolean getMessageStyle()
        Gets the style for the SOAP message.
        Returns:
        Boolean.TRUE if "document", Boolean.FALSE if "rpc", or null if not defined.

      • getMessageInputStyle

        public java.lang.Boolean getMessageInputStyle()
        Gets the style for the SOAP input message.
        Returns:
        Boolean.TRUE if "document", Boolean.FALSE if "rpc", or null if not defined.

      • getMessageOutputStyle

        public java.lang.Boolean getMessageOutputStyle()
        Gets the style for the SOAP output message.
        Returns:
        Boolean.TRUE if "document", Boolean.FALSE if "rpc", or null if not defined.

      • getXMLSchemaValidator

        public javax.xml.validation.Validator getXMLSchemaValidator()
                                                     throws org.xml.sax.SAXException
        Gets the XML Schema validator.
        Returns:
        The validator instance, or null if none is defined.
        Throws:
        org.xml.sax.SAXException - If the validator could not be created.

      • getRequestEncoding

        public IRequestContentEncoding getRequestEncoding()
        Gets the encoding.
        Returns:
        The request encoding instance, or null for none.

      • getEndPoint

        public java.lang.String getEndPoint()
        Gets the end point.
        Returns:
        The end-point name.

      • doExecute

        public IReplyContent doExecute​(IAppSessionGyro appGyro,
                               boolean doPerform)
                        throws PropException,
                               java.io.IOException,
                               java.io.UnsupportedEncodingException,
                               java.net.URISyntaxException
        Executes the Web Service request.
        Specified by:
        doExecute in interface IExecuteWebService
        Specified by:
        doExecute in class AbstractInputProps
        Parameters:
        appGyro - The application session gyro, null for Designer.
        doPerform - Execution flag when true, test when false.
        Returns:
        The contents reply instance, or null when testing.
        Throws:
        PropException - For property errors.
        java.io.IOException - For I/O errors.
        java.io.UnsupportedEncodingException - For unsupported encodings.
        java.net.URISyntaxException - When URI syntax is invalid.

      • getNamespaces

        public java.util.Map<java.lang.String,​java.lang.String> getNamespaces()
        Gets the map of namespaces.
        Returns:
        The map with namespace prefix as key, and namespace URI as value.

      • buildMessage

        public javax.xml.soap.SOAPMessage buildMessage​(boolean isProduction)
                                        throws BuildSchemaException,
                                               PropException,
                                               javax.xml.soap.SOAPException
        Builds the SOAP message.
        Parameters:
        isProduction - Flag for production, false indicates building skeleton.
        Returns:
        The SOAP message to send.
        Throws:
        BuildSchemaException - In case of build schema errors.
        PropException - For property errors.
        javax.xml.soap.SOAPException - For SOAP errors.

      • onVirtualSpaceVirtualized

        public void onVirtualSpaceVirtualized​(IAppSessionGyro appGyro,
                                      VirtualSpace virtualizedVirtualSpace)
        Called when the VirtualSpace has been virtualized, giving the opportunity for e.g. data connectors to prepare it's virtualized counterparts if this is required.

        This call is done to the non-virtualized instance of the VirtualSpace participant.

        Parameters:
        appGyro - The application gyro instance.
        virtualizedVirtualSpace - The virtualized VirtualSpace instance.