smartrics.rest.client
Class RestRequest

java.lang.Object
  smartrics.rest.client.RestData
      smartrics.rest.client.RestRequest

public class RestRequest
extends RestData

Wraps a REST request object.

Nested Class Summary

static class

RestRequest.Method An http verb (those supported).

Nested classes/interfaces inherited from class smartrics.rest.client.RestData

RestData.Header

Field Summary

Fields inherited from class smartrics.rest.client.RestData

DEFAULT_ENCODING, LINE_SEPARATOR

Constructor Summary

RestRequest()

Method Summary

String	getFileName()
RestRequest.Method	getMethod()
String	getMultipartFileName()
String	getMultipartFileParameterName()
String	getQuery()
boolean	isFollowRedirect()
boolean	isResourceUriEscaped()
boolean	isValid() Checks validity of this request.
RestRequest	setFileName(String fileName) Sets the upload file name for this request.
RestRequest	setFollowRedirect(boolean v)
RestRequest	setMethod(RestRequest.Method method) Sets the method for this request.
RestRequest	setMultipartFileName(String multipartFileName) Sets the multipart upload file name for this request.
RestRequest	setMultipartFileParameterName(String multipartFileParameterName) Sets the multipart file form parameter name for this request.
RestRequest	setQuery(String query) Sets the query for this request.
RestRequest	setResourceUriEscaped(boolean escaped)
String	toString() String representation of this request.

Methods inherited from class smartrics.rest.client.RestData

addHeader, addHeaders, addHeaders, getBody, getCharset, getContentLength, getContentType, getHeader, getHeaders, getHeaderValue, getRawBody, getResource, getTransactionId, setBody, setRawBody, setResource, setTransactionId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RestRequest

public RestRequest()

Method Detail

getMethod

public RestRequest.Method getMethod()

Returns:

the method for this request

setMethod

public RestRequest setMethod(RestRequest.Method method)

Sets the method for this request.

Parameters:

method - the method

Returns:

this request

See Also:

RestRequest.Method

getQuery

public String getQuery()

Returns:

the query for this request

setQuery

public RestRequest setQuery(String query)

Sets the query for this request.

Parameters:

query - the query

Returns:

this request

getFileName

public String getFileName()

Returns:

the upload file name for this request

getMultipartFileName

public String getMultipartFileName()

Returns:

the multipart upload file name for this request

getMultipartFileParameterName

public String getMultipartFileParameterName()

Returns:

the multipart file form parameter name for this request

setMultipartFileParameterName

public RestRequest setMultipartFileParameterName(String multipartFileParameterName)

Sets the multipart file form parameter name for this request.

Parameters:

multipartFileParameterName - the multipart file form parameter name

Returns:

this request

setMultipartFileName

public RestRequest setMultipartFileName(String multipartFileName)

Sets the multipart upload file name for this request.

Parameters:

multipartFileName - the multipart file name

Returns:

this request

setFollowRedirect

public RestRequest setFollowRedirect(boolean v)

isFollowRedirect

public boolean isFollowRedirect()

setFileName

public RestRequest setFileName(String fileName)

Sets the upload file name for this request.

Parameters:

fileName - the upload file name

Returns:

this request

isValid

public boolean isValid()

Checks validity of this request. In this implementation a request is valid if both the method and the resource Uri not null

Returns:

true if valid

isResourceUriEscaped

public boolean isResourceUriEscaped()

Returns:

whether resource uri is % escaped (true) or not (false). Defaults to false.

setResourceUriEscaped

public RestRequest setResourceUriEscaped(boolean escaped)

Parameters:

escaped - whether resource uri is % escaped or not

toString

public String toString()

String representation of this request.

Overrides:

toString in class RestData

Returns:

the string representation