org.apache.ambari.server.api.services

Class BaseRequest

java.lang.Object

org.apache.ambari.server.api.services.BaseRequest

All Implemented Interfaces:

Request

Direct Known Subclasses:

DeleteRequest, GetRequest, PostRequest, PutRequest

public abstract class BaseRequest
extends Object
implements Request

Request implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ambari.server.api.services.Request

Request.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASC_ORDER_PROPERTY_KEY Sort order property key.
static int	DEFAULT_PAGE_SIZE Default page size for pagination request.
static String	PAGE_SIZE_PROPERTY_KEY Page size property key

Constructor Summary

Constructors

Constructor and Description
BaseRequest(javax.ws.rs.core.HttpHeaders headers, RequestBody body, javax.ws.rs.core.UriInfo uriInfo, ResourceInstance resource) Constructor.

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.
protected PredicateCompiler	getPredicateCompiler() Obtain the predicate compiler which is used to compile the query string into a predicate.
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.
protected abstract RequestHandler	getRequestHandler() Obtain the underlying request handler for the request.
ResourceInstance	getResource() Obtain the resource definition which corresponds to the resource being operated on by the request.
protected ResultPostProcessor	getResultPostProcessor() Obtain the result post processor for the request.
SortRequest	getSortRequest() Obtain information to order the results by.
String	getURI() Obtain the URI of this request.
Result	process() Process the request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ambari.server.api.services.Request

getRequestType

Field Detail

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

Default page size for pagination request.

See Also:

Constant Field Values

PAGE_SIZE_PROPERTY_KEY

public static final String PAGE_SIZE_PROPERTY_KEY

Page size property key

See Also:

Constant Field Values

ASC_ORDER_PROPERTY_KEY

public static final String ASC_ORDER_PROPERTY_KEY

Sort order property key. (true - ASC , false - DESC)

See Also:

Constant Field Values

Constructor Detail

BaseRequest

public BaseRequest(javax.ws.rs.core.HttpHeaders headers,
                   RequestBody body,
                   javax.ws.rs.core.UriInfo uriInfo,
                   ResourceInstance resource)

Constructor.

Parameters:

headers - http headers

body - http body

uriInfo - uri information

resource - associated resource definition

Method Detail

process

public Result process()

Description copied from interface: Request

Process the request.

Specified by:

process in interface Request

Returns:

the result

getResource

public ResourceInstance getResource()

Description copied from interface: Request

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

Specified by:

getResource in interface Request

Returns:

the associated ResourceDefinition

getURI

public String getURI()

Description copied from interface: Request

Obtain the URI of this request.

Specified by:

getURI in interface Request

Returns:

the request uri

getAPIVersion

public int getAPIVersion()

Description copied from interface: Request

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

Specified by:

getAPIVersion in interface Request

Returns:

the api version of the request

getQueryPredicate

public Predicate getQueryPredicate()

Description copied from interface: Request

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'.

Specified by:

getQueryPredicate in interface Request

Returns:

the user defined predicate

getFields

public Map<String,TemporalInfo> getFields()

Description copied from interface: Request

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

Specified by:

getFields in interface Request

Returns:

map of partial response propertyId to temporal information

getRenderer

public Renderer getRenderer()

Description copied from interface: Request

Obtain the renderer for the request.

Specified by:

getRenderer in interface Request

Returns:

renderer instance

getHttpHeaders

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

Description copied from interface: Request

Obtain the http headers associated with the request.

Specified by:

getHttpHeaders in interface Request

Returns:

the http headers

getPageRequest

public PageRequest getPageRequest()

Description copied from interface: Request

Obtain the pagination request information.

Specified by:

getPageRequest in interface Request

Returns:

the page request

getBody

public RequestBody getBody()

Description copied from interface: Request

Obtain the request body data.

Specified by:

getBody in interface Request

getResultPostProcessor

protected ResultPostProcessor getResultPostProcessor()

Obtain the result post processor for the request.

Returns:

the result post processor

getPredicateCompiler

protected PredicateCompiler getPredicateCompiler()

Obtain the predicate compiler which is used to compile the query string into a predicate.

Returns:

the predicate compiler

getSortRequest

public SortRequest getSortRequest()

Description copied from interface: Request

Obtain information to order the results by.

Specified by:

getSortRequest in interface Request

Returns:

the order request

getRequestHandler

protected abstract RequestHandler getRequestHandler()

Obtain the underlying request handler for the request.

Returns:

the request handler

getRemoteAddress

public String getRemoteAddress()

Description copied from interface: Request

Returns the remote address for the request

Specified by:

getRemoteAddress in interface Request

Returns:

the remote address for the request