Package org.symphonyoss.s2.canon.runtime.http

Interface IRequestContext

All Known Subinterfaces:

IAsyncRequestContext

All Known Implementing Classes:

AbstractRequestContext, ServletRequestContext

public interface IRequestContext

Field Summary

Fields

Modifier and Type	Field	Description
static String	FORM_CONTENT_TYPE
static String	JSON_CONTENT_TYPE

Method Summary

Modifier and Type	Method	Description
Boolean	asBoolean(String parameterName, String value)
org.symphonyoss.s2.common.immutable.ImmutableByteArray	asImmutableByteArray(String parameterName, String value)
Integer	asInteger(String parameterName, String value)
Long	asLong(String parameterName, String value)
String	asString(String parameterName, String value)
void	error(String message)
void	error(String format, Object... args)
void	error(Throwable t)
HttpMethod	getMethod()
OutputStream	getOutputStream()	Get an OutputStream or the response.
Boolean	getParameterAsBoolean(String name, ParameterLocation location, boolean required)
org.symphonyoss.s2.common.immutable.ImmutableByteArray	getParameterAsImmutableByteArray(String name, ParameterLocation location, boolean required)
Integer	getParameterAsInteger(String name, ParameterLocation location, boolean required)
Long	getParameterAsLong(String name, ParameterLocation location, boolean required)
String	getParameterAsString(String name, ParameterLocation location, boolean required)
String	getPathInfo()
BufferedReader	getReader()
org.symphonyoss.s2.fugue.core.trace.ITraceContext	getTrace()
PrintWriter	getWriter()	Get a Writer or the response.
<E extends IEntity> List<E>	parseListPayload(Class<E> type)
<M> List<M>	parseListPayload(org.symphonyoss.s2.common.type.provider.IValueProviderBuilder<M> builder)
<E extends IEntity> E	parsePayload(String typeId, Class<E> type)
<M,T> M	parsePayload(TypeDefBuilder<M,T> builder)
<M> M	parsePayload(org.symphonyoss.s2.common.type.provider.IValueProviderBuilder<M> builder)
boolean	preConditionsAreMet()
void	sendError(int scMethodNotAllowed, String string)
void	sendErrorResponse(int statusCode)
void	sendOKResponse()
void	sendOKResponse(List<? extends IBaseEntity> response)
void	sendOKResponse(IBaseEntity response)
void	setContentType(String type)
void	setHeader(String header, String value)
void	setStatus(int sc)

Field Detail

JSON_CONTENT_TYPE

static final String JSON_CONTENT_TYPE

See Also:

Constant Field Values

FORM_CONTENT_TYPE

static final String FORM_CONTENT_TYPE

See Also:

Constant Field Values

Method Detail

getMethod

HttpMethod getMethod()

getTrace

org.symphonyoss.s2.fugue.core.trace.ITraceContext getTrace()

getParameterAsBoolean

Boolean getParameterAsBoolean(String name,
                              ParameterLocation location,
                              boolean required)

getParameterAsLong

Long getParameterAsLong(String name,
                        ParameterLocation location,
                        boolean required)

getParameterAsInteger

Integer getParameterAsInteger(String name,
                              ParameterLocation location,
                              boolean required)

getParameterAsImmutableByteArray

org.symphonyoss.s2.common.immutable.ImmutableByteArray getParameterAsImmutableByteArray(String name,
                                                                                        ParameterLocation location,
                                                                                        boolean required)

getParameterAsString

String getParameterAsString(String name,
                            ParameterLocation location,
                            boolean required)

preConditionsAreMet

boolean preConditionsAreMet()

sendOKResponse

void sendOKResponse()

sendOKResponse

void sendOKResponse(IBaseEntity response)
             throws IOException

Throws:

IOException

sendOKResponse

void sendOKResponse(List<? extends IBaseEntity> response)
             throws IOException

Throws:

IOException

sendErrorResponse

void sendErrorResponse(int statusCode)

error

void error(String message)

error

void error(String format,
           Object... args)

error

void error(Throwable t)

parsePayload

<E extends IEntity> E parsePayload(String typeId,
                                   Class<E> type)

parsePayload

<M,T> M parsePayload(TypeDefBuilder<M,T> builder)

parsePayload

<M> M parsePayload(org.symphonyoss.s2.common.type.provider.IValueProviderBuilder<M> builder)

parseListPayload

<E extends IEntity> List<E> parseListPayload(Class<E> type)

parseListPayload

<M> List<M> parseListPayload(org.symphonyoss.s2.common.type.provider.IValueProviderBuilder<M> builder)

getReader

BufferedReader getReader()
                  throws IOException

Throws:

IOException

getWriter

PrintWriter getWriter()
               throws IOException

Get a Writer or the response. Either a Writer or an OutputStream can be obtained, but not both.

Returns:

A Writer or the response.

Throws:

IOException - If getOutputStream() has previously been called.

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Get an OutputStream or the response. Either a Writer or an OutputStream can be obtained, but not both.

Returns:

A Writer or the response.

Throws:

IOException - If getWriter() has previously been called.

setContentType

void setContentType(String type)

setStatus

void setStatus(int sc)

setHeader

void setHeader(String header,
               String value)

getPathInfo

String getPathInfo()

sendError

void sendError(int scMethodNotAllowed,
               String string)
        throws IOException

Throws:

IOException

asString

String asString(String parameterName,
                String value)

asBoolean

Boolean asBoolean(String parameterName,
                  String value)

asLong

Long asLong(String parameterName,
            String value)

asInteger

Integer asInteger(String parameterName,
                  String value)

asImmutableByteArray

org.symphonyoss.s2.common.immutable.ImmutableByteArray asImmutableByteArray(String parameterName,
                                                                            String value)