Package com.iizix.ws.prop

Class RESTfulInputProps

    • Field Detail

      • PN_URI_PATH_PARAMS

        public static final java.lang.String PN_URI_PATH_PARAMS
        The property name for URI path parameterized with curly bracket enclosed variables.
        See Also:
        Constant Field Values

    • Constructor Detail

      • RESTfulInputProps

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

      • RESTfulInputProps

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

    • Method Detail

      • getURI

        public java.lang.String getURI()
        Gets the URI for the request without the parameters.
        Returns:
        The URI.

      • isURIPathParameterized

        public boolean isURIPathParameterized()
        Returns whether the URI path should be used as is (false = default), or if it contains parameters that are enclosed in curly brackets.
        Returns:
        The flag, default false.

      • getMethod

        public Method getMethod()
        Gets the method.
        Returns:
        The method used.

      • getOverrideMethod

        public Method getOverrideMethod()
        Gets the override method.
        Returns:
        The overridden method in "X-HTTP-Method-Override", null for none.

      • getEncoding

        public java.lang.String getEncoding()
        Gets the encoding.
        Returns:
        The encoding, default "UTF-8".

      • getRequestEncoding

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

      • 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.

      • 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.