org.restsql.core

Interface HttpRequestAttributes

All Known Implementing Classes:

HttpRequestAttributesImpl

public interface HttpRequestAttributes

Contains HTTP request attributes. Always used by the service, and optionally by Java API clients.

Author:

Mark Sawers

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MEDIA_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
String	getClient() Returns client IP or hostname.
String	getMethod() Returns HTTP method.
String	getRequestBody() Returns request body, if any.
String	getRequestMediaType() Returns request media type.
String	getResponseMediaType() Returns response media type.
String	getUri() Returns URI.
void	setAttributes(String client, String method, String uri, String requestBody, String requestMediaType, String responseMediaType) Sets attributes of an HTTP request.
void	setResponseMediaType(String responseMediaType) Sets response media type.

Field Detail

DEFAULT_MEDIA_TYPE

static final String DEFAULT_MEDIA_TYPE

See Also:

Constant Field Values

Method Detail

getClient

String getClient()

Returns client IP or hostname.

getMethod

String getMethod()

Returns HTTP method.

getRequestBody

String getRequestBody()

Returns request body, if any.

getRequestMediaType

String getRequestMediaType()

Returns request media type.

getResponseMediaType

String getResponseMediaType()

Returns response media type.

getUri

String getUri()

Returns URI.

setAttributes

void setAttributes(String client,
                 String method,
                 String uri,
                 String requestBody,
                 String requestMediaType,
                 String responseMediaType)

Sets attributes of an HTTP request.

Parameters:

client - IP or host name

method - HTTP method

uri - request URI

requestBody - request body

requestMediaType - request body format, use internet media type e.g. application/xml

responseMediaType - request body format, use internet media type e.g. application/xml

setResponseMediaType

void setResponseMediaType(String responseMediaType)

Sets response media type.

Parameters:

responseMediaType - request body format, use internet media type e.g. application/xml