com.attivio.sdk.esb

Class CgiRequest

java.lang.Object

com.attivio.sdk.esb.AbstractPlatformMessage

com.attivio.sdk.esb.CgiRequest

All Implemented Interfaces:

PlatformMessage, Serializable, 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 Summary

Fields

Modifier and Type	Field and Description
static String	CLIENTID_PARAM CGI parameter to specify any workflows
static String	OUTPUT_FORMAT_PARAM CGI parameter, specifies the output format
static String	WORKFLOWS_PARAM CGI parameter to specify any workflows

Fields inherited from interface com.attivio.sdk.esb.PlatformMessage

DEFAULT_MAX_LOG_LENGTH, MESSAGE_DROPPED, MESSAGE_SEND_TIME_PROP, PROP_MAX_LOG_LENGTH

Constructor Summary

Constructors

Constructor and Description
CgiRequest(UUID clientID) Constructor with client ID.

Method Summary

Modifier and Type	Method and Description
static CgiRequest	create(QueryRequest qreq) Creates a CgiRequest from a QueryRequest.
boolean	equals(Object other)
UUID	getCgiClientId() Gets the CGI Client ID.
String	getCgiParameter(String key) Get the first value for a CGI Parameter.
double	getCgiParameter(String parameter, double defaultValue) Get the first value for a CGI Parameter as a double.
float	getCgiParameter(String parameter, float defaultValue) Get the first value for a CGI Parameter as a float.
int	getCgiParameter(String parameter, int defaultValue) Get the first value for a CGI Parameter as an int.
long	getCgiParameter(String parameter, long defaultValue) Get the first value for a CGI Parameter as a long.
String	getCgiParameter(String parameter, String defaultValue) Get the first value for a CGI Parameter.
Map<String,String[]>	getCgiParameters() Gets CGI parameters map.
WorkflowQueue	getCgiWorkflowQueue() Gets the workflow queue parsed from the CGI parameters.
WorkflowQueue	getCgiWorkflows(String parameter) Parse a parameter that contains a list of workflows.
Map<String,String>	getHttpHeaders() Gets HTTP headers.
InputStream	getInputStream() Get the InputStream associated with the request.
String	getMethod() Gets the HTTP method from the request.
String	getQueryString() Turn the CGI request into a url encoded parseable query string
int	hashCode()
void	setCgiClientId(UUID value) Force set the CGI Client ID.
void	setCgiParameter(String parameter, String... values) Set a value for a CGI parameter.
void	setCgiParameters(Map<String,String[]> cgiParameters) Sets CGI parameters.
void	setCgiParameters(String query, String encoding) Parse CGI query string and set parameters based on the results.
void	setCgiWorkflowQueue(WorkflowQueue workflowQueue) Force set the CGI workflow queue.
void	setCgiWorkflows(String parameter, WorkflowQueue workflowQueue) Set the CGI workflows from a workflow queue
void	setHttpHeaders(Map<String,String> httpHeaders) Set HTTP headers map.
void	setInputStream(InputStream inputStream) Sets the InputStream associated with the request.
void	setMethod(String method) Sets the HTTP method from teh request.
String	toString()

Methods inherited from class com.attivio.sdk.esb.AbstractPlatformMessage

addMessageHistory, addMessageHistory, clone, getClientId, getEstimatedSize, getMessageHistory, getMessageId, getMetadata, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getWorkflowQueue, getWorkflowQueue, hasProperty, isRedelivered, removeProperty, removeWorkflowQueue, setClientId, setMessageId, setProperty, setRedelivered, setWorkflowQueue, setWorkflowQueue, toMessageString, toString, toString, toString, toString, toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OUTPUT_FORMAT_PARAM

public static final String OUTPUT_FORMAT_PARAM

CGI parameter, specifies the output format

See Also:

Constant Field Values

WORKFLOWS_PARAM

public static final String WORKFLOWS_PARAM

CGI parameter to specify any workflows

See Also:

Constant Field Values

CLIENTID_PARAM

public static final String CLIENTID_PARAM

CGI parameter to specify any workflows

See Also:

Constant Field Values

Constructor Detail

CgiRequest

public CgiRequest(UUID clientID)

Constructor with client ID.

Parameters:

clientID - clientID

Method Detail

getCgiParameters

public Map<String,String[]> getCgiParameters()

Gets CGI parameters map.

setCgiParameters

public void setCgiParameters(String query,
                             String encoding)
                      throws UnsupportedEncodingException

Parse CGI query string and set parameters based on the results.

Throws:

UnsupportedEncodingException

getQueryString

public String getQueryString()

Turn the CGI request into a url encoded parseable query string

toString

public String toString()

Overrides:

toString in class AbstractPlatformMessage

setCgiParameters

public void setCgiParameters(Map<String,String[]> cgiParameters)

Sets CGI parameters.

getHttpHeaders

public Map<String,String> getHttpHeaders()

Gets HTTP headers.

setHttpHeaders

public void setHttpHeaders(Map<String,String> httpHeaders)

Set HTTP headers map.

getInputStream

public InputStream getInputStream()

Get the InputStream associated with the request.

setInputStream

public void setInputStream(InputStream inputStream)
                    throws IOException

Sets the InputStream associated with the request.

Throws:

IOException

getMethod

public String getMethod()

Gets the HTTP method from the request.

setMethod

public void setMethod(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 UUID getCgiClientId()

Gets the CGI Client ID.

setCgiClientId

public void setCgiClientId(UUID value)

Force set the CGI Client ID.

setCgiParameter

public void setCgiParameter(String parameter,
                            String... values)

Set a value for a CGI parameter.

getCgiParameter

public String getCgiParameter(String key)

Get the first value for a CGI Parameter.

getCgiParameter

public String getCgiParameter(String parameter,
                              String defaultValue)

Get the first value for a CGI Parameter.

getCgiParameter

public int getCgiParameter(String parameter,
                           int defaultValue)

Get the first value for a CGI Parameter as an int.

getCgiParameter

public long getCgiParameter(String parameter,
                            long defaultValue)

Get the first value for a CGI Parameter as a long.

getCgiParameter

public float getCgiParameter(String parameter,
                             float defaultValue)

Get the first value for a CGI Parameter as a float.

getCgiParameter

public double getCgiParameter(String parameter,
                              double defaultValue)

Get the first value for a CGI Parameter as a double.

getCgiWorkflows

public WorkflowQueue getCgiWorkflows(String parameter)

Parse a parameter that contains a list of workflows.

setCgiWorkflows

public void setCgiWorkflows(String parameter,
                            WorkflowQueue workflowQueue)

Set the CGI workflows from a workflow queue

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPlatformMessage

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractPlatformMessage

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.