public class ParameterContext
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
APPEND_MULTI_VALUES |
static java.lang.String |
APPLICATION_JSON |
static java.lang.String |
APPLICATION_XML |
static java.lang.String |
ARG |
static java.lang.String |
ARG1 |
static java.lang.String |
ATG_REST |
static java.lang.String |
ATG_REST_CHAIN_ID |
static java.lang.String |
CLASS_DESCRIPTOR |
static java.lang.String |
CLASS_TYPE |
static java.lang.String |
CLASS_TYPES_FOR_JSON_INPUT |
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
COLLECTION_VALUES_KEY |
static java.lang.String |
COUNT |
static java.lang.String |
DEPTH |
static java.lang.String |
DESCRIPTOR_COMPONENT_TYPE |
static java.lang.String |
DESCRIPTOR_KEY_TYPE |
static java.lang.String |
DESCRIPTOR_TYPE |
static java.lang.String |
ENABLE_FORM_HANDLER_RETURN_EXCEPTIONS |
static java.lang.String |
ENABLE_FORM_HANDLER_RETURN_PROPERTIES |
static java.lang.String |
FORM_TAG_PRIORITIES |
static java.lang.String |
HTTP_METHOD |
static java.lang.String |
INDEX |
static java.lang.String |
INPUT |
static java.lang.String |
METHOD |
static java.lang.String |
MULTIPART_FORM_DATA |
static java.lang.String |
NULL |
static java.lang.String |
OMIT_CLASS_PROPERTY |
static java.lang.String |
OUTPUT |
static java.lang.String |
PROPERTY_FILTERS |
static java.lang.String |
RESPONSE_KEY |
static java.lang.String |
RQL |
static java.lang.String |
SHOW_PROPERTY_PATHS |
static java.lang.String |
SIMPLE_RESPONSE_CODES |
static java.lang.String |
TEMPLATE_IDS |
static java.lang.String |
TRANSIENT |
static java.lang.String |
TREAT_GENERIC_SERVICE_AS_OBJECT |
static java.lang.String |
USE_JSON_FOR_INPUT |
static java.lang.String |
USER_INPUT |
static java.lang.String |
VIEW |
static java.lang.String |
WWW_FORM_URLENCODED |
Modifier and Type | Method and Description |
---|---|
static void |
clearParameterContext()
removes the value in the thread local parameterContext
|
static ParameterContext |
create(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse) |
java.util.Map<java.lang.String,java.lang.Object> |
getControlParameters()
Returns all the parameters which are control parameters.
|
int |
getCountParameter()
Returns the count parameter from the URL if present
|
java.util.Map<java.lang.String,java.lang.Object> |
getFunctionalParameters()
Returns all the parameters which are not control parameters.
|
int |
getIndexParameter()
Returns the index parameter from the URL if present
|
int |
getMaxNestingDepth()
Returns the maximum allowed nesting depth for this request.
|
java.lang.Object |
getParameter(java.lang.String pName)
Returns the parameter with the given name or null if the parameter does not exist
|
static ParameterContext |
getParameterContext() |
java.util.Map<java.lang.String,java.lang.Object> |
getParameters() |
protected void |
initialize(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Initializes the parameter context object by reading parameters from the input stream and the request
|
protected java.util.Map<java.lang.String,java.lang.Object> |
parseFormUrlEncodedRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns a map of parameters which were read from the input stream of a request whose content type is application/x-www-form-urlencoded
|
protected java.lang.Object |
parseMultiPartRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Parses a multi-part request and returns each item in a List.
|
protected java.lang.String |
readInputStream(java.io.InputStream pInputStream)
Deprecated.
this method has been depreciated
|
protected java.lang.String |
readInputStreamFromRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns the content of the input stream as a string from the given request/response.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
readParametersFromInputStream(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns a map of parameters which were read from the input stream
|
void |
setParameters(java.util.Map<java.lang.String,java.lang.Object> pParameters) |
public static java.lang.String CLASS_VERSION
public static final java.lang.String DEPTH
public static final java.lang.String OUTPUT
public static final java.lang.String INPUT
public static final java.lang.String INDEX
public static final java.lang.String COUNT
public static final java.lang.String RQL
public static final java.lang.String TRANSIENT
public static final java.lang.String METHOD
public static final java.lang.String CLASS_TYPE
public static final java.lang.String CLASS_DESCRIPTOR
public static final java.lang.String HTTP_METHOD
public static final java.lang.String SIMPLE_RESPONSE_CODES
public static final java.lang.String APPEND_MULTI_VALUES
public static final java.lang.String USE_JSON_FOR_INPUT
public static final java.lang.String CLASS_TYPES_FOR_JSON_INPUT
public static final java.lang.String ENABLE_FORM_HANDLER_RETURN_PROPERTIES
public static final java.lang.String ENABLE_FORM_HANDLER_RETURN_EXCEPTIONS
public static final java.lang.String PROPERTY_FILTERS
public static final java.lang.String TEMPLATE_IDS
public static final java.lang.String SHOW_PROPERTY_PATHS
public static final java.lang.String ATG_REST_CHAIN_ID
public static final java.lang.String TREAT_GENERIC_SERVICE_AS_OBJECT
public static final java.lang.String OMIT_CLASS_PROPERTY
public static final java.lang.String VIEW
public static final java.lang.String USER_INPUT
public static final java.lang.String RESPONSE_KEY
public static final java.lang.String FORM_TAG_PRIORITIES
public static final java.lang.String ATG_REST
public static final java.lang.String NULL
public static final java.lang.String ARG
public static final java.lang.String ARG1
public static final java.lang.String MULTIPART_FORM_DATA
public static final java.lang.String WWW_FORM_URLENCODED
public static final java.lang.String APPLICATION_JSON
public static final java.lang.String APPLICATION_XML
public static final java.lang.String DESCRIPTOR_TYPE
public static final java.lang.String DESCRIPTOR_COMPONENT_TYPE
public static final java.lang.String DESCRIPTOR_KEY_TYPE
public static final java.lang.String COLLECTION_VALUES_KEY
public static ParameterContext getParameterContext()
public static void clearParameterContext()
public java.util.Map<java.lang.String,java.lang.Object> getParameters()
public void setParameters(java.util.Map<java.lang.String,java.lang.Object> pParameters)
pParameters
- the parameters to setpublic java.util.Map<java.lang.String,java.lang.Object> getFunctionalParameters()
public java.util.Map<java.lang.String,java.lang.Object> getControlParameters()
public static ParameterContext create(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
RestException
java.io.IOException
protected void initialize(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pRequest
- the servlet requestpResponse
- the servlet responseRestException
- if the parameters could not be read from the stream or the type of data in the stream
could not be handledjava.io.IOException
protected java.util.Map<java.lang.String,java.lang.Object> readParametersFromInputStream(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pRequest
- the servlet requestpResponse
- the servlet responseRestException
- if the parameters could not be read from the stream or the type of data in the stream
could not be handledjava.io.IOException
protected java.util.Map<java.lang.String,java.lang.Object> parseFormUrlEncodedRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException
pRequest
- the servlet requestpResponse
- the servlet responseRestException
- if the parameters could not be read from the stream@Deprecated protected java.lang.String readInputStream(java.io.InputStream pInputStream) throws java.io.IOException
pInputStream
- the input stream to read fromjava.io.IOException
protected java.lang.String readInputStreamFromRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pRequest
- the servlet requestpResponse
- the servlet responseRestException
- If the InputCustomizer can't be found for the mime-typejava.io.IOException
protected java.lang.Object parseMultiPartRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException
pRequest
- the servlet requestpResponse
- the servlet responseRestException
- if the contents could not be read from the stream or the type of data in the stream
could not be handledpublic java.lang.Object getParameter(java.lang.String pName)
pName
- the parameter namepublic int getMaxNestingDepth() throws RestException
RestException
public int getIndexParameter() throws RestException
RestException
public int getCountParameter() throws RestException
pRequest
- the request objectpResponse
- the response objectRestException