org.apache.ambari.server.controller.spi

Interface Request

All Known Implementing Classes:

RequestImpl

public interface Request

The request object carries the properties or property ids required to satisfy a resource request. The request object also contains any temporal (date range) information, if any, for each requested property.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECTIVE_DRY_RUN
static String	REQUEST_INFO_BODY_PROPERTY Constant for request info property which contains the raw request body.

Method Summary

Modifier and Type	Method and Description
PageRequest	getPageRequest() Obtain the pagination request information.
Set<Map<String,Object>>	getProperties() Get the property values of the request.
Set<String>	getPropertyIds() Get the set of property ids being requested.
Map<String,String>	getRequestInfoProperties() Get any request info properties of the request.
SortRequest	getSortRequest() Obtain information to order the results by.
TemporalInfo	getTemporalInfo(String id) Get the temporal information for the given property id for this request, if any.
boolean	isDryRunRequest() Is this a dry run request.

Field Detail

REQUEST_INFO_BODY_PROPERTY

static final String REQUEST_INFO_BODY_PROPERTY

Constant for request info property which contains the raw request body.

See Also:

Constant Field Values

DIRECTIVE_DRY_RUN

static final String DIRECTIVE_DRY_RUN

See Also:

Constant Field Values

Method Detail

getPropertyIds

Set<String> getPropertyIds()

Get the set of property ids being requested. Used for requests to get resources. An empty set signifies that all supported properties should be returned (i.e. select * ).

Returns:

the set of property ids being requested

getProperties

Set<Map<String,Object>> getProperties()

Get the property values of the request. Used for requests to update or create resources. Each value in the set is a map of properties for a resource being created/updated. Each map contains property values keyed by property ids.

Returns:

the set of properties being requested

getRequestInfoProperties

Map<String,String> getRequestInfoProperties()

Get any request info properties of the request. These are optional properties that are specific to the request but not related to any resource.

getTemporalInfo

TemporalInfo getTemporalInfo(String id)

Get the temporal information for the given property id for this request, if any.

Parameters:

id - the property id

Returns:

the temporal information for the given property id; null if noe exists

getPageRequest

PageRequest getPageRequest()

Obtain the pagination request information. This structure can be used for the concrete ResourceProvider to instruct the caller that the result set has already been paginated.

Returns:

the page request information.

getSortRequest

SortRequest getSortRequest()

Obtain information to order the results by. This structure can be used for the concrete ResourceProvider to instruct the caller that the result set has already been sorted.

Returns:

the sort request information.

isDryRunRequest

boolean isDryRunRequest()

Is this a dry run request.

Returns:

true - if request is dry run request, false otherwise.