Package com.iizix.ws.prop

Class RESTfulInputProps

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.ws.prop.AbstractInputProps
com.iizix.ws.prop.RESTfulInputProps
All Implemented Interfaces:
EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, IReferrerParticipant, IVSAccessor, IVSParticipant, IExecuteWebService, Cloneable
Direct Known Subclasses:
EditorRESTfulInputProps
public class RESTfulInputProps extends AbstractInputProps
Input Properties that ties the input to the execution of a RESTful Web Service transaction request to VirtualSpace.
Author:
Christopher Mindus

  • Field Details

    • PN_URI_PATH_PARAMS

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

  • Constructor Details

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

    • clone

      public RESTfulInputProps clone()
      Clones these Input Properties.
      Overrides:
      clone in class AbstractInputProps

    • getURI

      public 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 String getEncoding()
      Gets the encoding.
      Returns:
      The encoding, default "UTF-8".

    • getParticipantType

      public String getParticipantType()
      Returns the given type of the referrer participant.
      Specified by:
      getParticipantType in interface IReferrerParticipant
      Specified by:
      getParticipantType in class AbstractInputProps

    • getRequestEncoding

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

    • getInputProvider

      public IRESTfulRequestProcessor getInputProvider()
      Gets the instance of the IRESTfulRequestProcessor.
      Returns:
      The instance of IWebServiceInput, or null for none.

    • doExecute

      public IReplyContent doExecute(IAppSessionGyro appGyro, boolean doPerform) throws PropException, IOException, UnsupportedEncodingException, 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.
      IOException - For I/O errors.
      UnsupportedEncodingException - For unsupported encodings.
      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.