org.apache.ambari.server.api.services

Interface Request

All Known Implementing Classes:

BaseRequest, DeleteRequest, GetRequest, PostRequest, PutRequest, QueryPostRequest

public interface Request

Provides information on the current request.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Request.Type Enum of request types.

Method Summary

Modifier and Type	Method and Description
int	getAPIVersion() Obtain the api version of the request.
RequestBody	getBody() Obtain the request body data.
Map<String,TemporalInfo>	getFields() Obtain the partial response fields and associated temporal information which were provided in the query string of the request uri.
Map<String,List<String>>	getHttpHeaders() Obtain the http headers associated with the request.
PageRequest	getPageRequest() Obtain the pagination request information.
Predicate	getQueryPredicate() Obtain the query predicate that was built from the user provided predicate fields in the query string.
String	getRemoteAddress() Returns the remote address for the request
Renderer	getRenderer() Obtain the renderer for the request.
Request.Type	getRequestType() Obtain the http request type.
ResourceInstance	getResource() Obtain the resource definition which corresponds to the resource being operated on by the request.
SortRequest	getSortRequest() Obtain information to order the results by.
String	getURI() Obtain the URI of this request.
Result	process() Process the request.

Method Detail

process

Result process()

Process the request.

Returns:

the result

getResource

ResourceInstance getResource()

Obtain the resource definition which corresponds to the resource being operated on by the request. The resource definition provides information about the resource type;

Returns:

the associated ResourceDefinition

getURI

String getURI()

Obtain the URI of this request.

Returns:

the request uri

getRequestType

Request.Type getRequestType()

Obtain the http request type. Type is one of Request.Type.

Returns:

the http request type

getAPIVersion

int getAPIVersion()

Obtain the api version of the request. The api version is specified in the request URI.

Returns:

the api version of the request

getQueryPredicate

Predicate getQueryPredicate()

Obtain the query predicate that was built from the user provided predicate fields in the query string. If multiple predicates are supplied, then they will be combined using the appropriate logical grouping predicate such as 'AND'.

Returns:

the user defined predicate

getFields

Map<String,TemporalInfo> getFields()

Obtain the partial response fields and associated temporal information which were provided in the query string of the request uri.

Returns:

map of partial response propertyId to temporal information

getBody

RequestBody getBody()

Obtain the request body data.

getHttpHeaders

Map<String,List<String>> getHttpHeaders()

Obtain the http headers associated with the request.

Returns:

the http headers

getPageRequest

PageRequest getPageRequest()

Obtain the pagination request information.

Returns:

the page request

getSortRequest

SortRequest getSortRequest()

Obtain information to order the results by.

Returns:

the order request

getRenderer

Renderer getRenderer()

Obtain the renderer for the request.

Returns:

renderer instance

getRemoteAddress

String getRemoteAddress()

Returns the remote address for the request

Returns:

the remote address for the request