Package com.attivio.sdk.esb

Class CgiRequest

  • All Implemented Interfaces:
    PlatformMessage, java.io.Serializable, java.lang.Cloneable
    public class CgiRequest
extends AbstractPlatformMessage
    Message that represents a request via CGI on a HTTP receiver. Contains CGI parameters and HTTP headers.
    See Also:
    Serialized Form

    • Field Detail

      • OUTPUT_FORMAT_PARAM

        public static final java.lang.String OUTPUT_FORMAT_PARAM
        CGI parameter, specifies the output format
        See Also:
        Constant Field Values

      • WORKFLOWS_PARAM

        public static final java.lang.String WORKFLOWS_PARAM
        CGI parameter to specify any workflows
        See Also:
        Constant Field Values

      • CLIENTID_PARAM

        public static final java.lang.String CLIENTID_PARAM
        CGI parameter to specify any workflows
        See Also:
        Constant Field Values

    • Constructor Detail

      • CgiRequest

        public CgiRequest​(java.util.UUID clientID)
        Constructor with client ID.
        Parameters:
        clientID - clientID

    • Method Detail

      • getCgiParameters

        public java.util.Map<java.lang.String,​java.lang.String[]> getCgiParameters()
        Gets CGI parameters map.

      • setCgiParameters

        public void setCgiParameters​(java.lang.String query,
                             java.lang.String encoding)
                      throws java.io.UnsupportedEncodingException
        Parse CGI query string and set parameters based on the results.
        Throws:
        java.io.UnsupportedEncodingException

      • getQueryString

        public java.lang.String getQueryString()
        Turn the CGI request into a url encoded parseable query string

      • setCgiParameters

        public void setCgiParameters​(java.util.Map<java.lang.String,​java.lang.String[]> cgiParameters)
        Sets CGI parameters.

      • getHttpHeaders

        public java.util.Map<java.lang.String,​java.lang.String> getHttpHeaders()
        Gets HTTP headers.

      • setHttpHeaders

        public void setHttpHeaders​(java.util.Map<java.lang.String,​java.lang.String> httpHeaders)
        Set HTTP headers map.

      • getInputStream

        public java.io.InputStream getInputStream()
        Get the InputStream associated with the request.

      • setInputStream

        public void setInputStream​(java.io.InputStream inputStream)
                    throws java.io.IOException
        Sets the InputStream associated with the request.
        Throws:
        java.io.IOException

      • getMethod

        public java.lang.String getMethod()
        Gets the HTTP method from the request.

      • setMethod

        public void setMethod​(java.lang.String method)
        Sets the HTTP method from teh request.

      • getCgiWorkflowQueue

        public WorkflowQueue getCgiWorkflowQueue()
        Gets the workflow queue parsed from the CGI parameters.

      • setCgiWorkflowQueue

        public void setCgiWorkflowQueue​(WorkflowQueue workflowQueue)
        Force set the CGI workflow queue.

      • getCgiClientId

        public java.util.UUID getCgiClientId()
        Gets the CGI Client ID.

      • setCgiClientId

        public void setCgiClientId​(java.util.UUID value)
        Force set the CGI Client ID.

      • setCgiParameter

        public void setCgiParameter​(java.lang.String parameter,
                            java.lang.String... values)
        Set a value for a CGI parameter.

      • getCgiParameter

        public java.lang.String getCgiParameter​(java.lang.String key)
        Get the first value for a CGI Parameter.

      • getCgiParameter

        public java.lang.String getCgiParameter​(java.lang.String parameter,
                                        java.lang.String defaultValue)
        Get the first value for a CGI Parameter.

      • getCgiParameter

        public int getCgiParameter​(java.lang.String parameter,
                           int defaultValue)
        Get the first value for a CGI Parameter as an int.

      • getCgiParameter

        public long getCgiParameter​(java.lang.String parameter,
                            long defaultValue)
        Get the first value for a CGI Parameter as a long.

      • getCgiParameter

        public float getCgiParameter​(java.lang.String parameter,
                             float defaultValue)
        Get the first value for a CGI Parameter as a float.

      • getCgiParameter

        public double getCgiParameter​(java.lang.String parameter,
                              double defaultValue)
        Get the first value for a CGI Parameter as a double.

      • getCgiWorkflows

        public WorkflowQueue getCgiWorkflows​(java.lang.String parameter)
        Parse a parameter that contains a list of workflows.

      • setCgiWorkflows

        public void setCgiWorkflows​(java.lang.String parameter,
                            WorkflowQueue workflowQueue)
        Set the CGI workflows from a workflow queue

      • create

        public static CgiRequest create​(QueryRequest qreq)
        Creates a CgiRequest from a QueryRequest. This is the inverse operation of the QueryRequest create method.

        Not all queries and filters are guaranteed to have equivalent parseable string representations; this method cannot guarantee an equivalent CGI Request for such cases.