org.apache.ambari.server.api.services

Class RequestBody

java.lang.Object

org.apache.ambari.server.api.services.RequestBody

public class RequestBody
extends Object

Represents the http body of the request.

Constructor Summary

Constructors

Constructor and Description
RequestBody()

Method Summary

Modifier and Type	Method and Description
void	addPropertySet(NamedPropertySet propertySet) Add a property set.
void	addRequestInfoProperty(String key, String val) Add a request info property.
String	getBody() Obtain the request body.
Set<NamedPropertySet>	getNamedPropertySets() Obtain all property sets or an empty set if no properties were specified in the body.
String	getPartialResponseFields() Obtain the partial response fields that were specified in the body.
Set<Map<String,Object>>	getPropertySets() Obtain all property sets as a set of maps.
String	getQueryString() Obtain that query that was specified in the body.
Map<String,String>	getRequestInfoProperties() Return a map of request info properties.
void	setBody(String body) Set the body from the request.
void	setPartialResponseFields(String fields) Set the partial response fields from the body.
void	setQueryString(String query) Set the query string.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestBody

public RequestBody()

Method Detail

setQueryString

public void setQueryString(String query)

Set the query string.

Parameters:

query - the query string from the body

getQueryString

public String getQueryString()

Obtain that query that was specified in the body.

Returns:

the query from the body or null if no query was present in the body

setPartialResponseFields

public void setPartialResponseFields(String fields)

Set the partial response fields from the body.

Parameters:

fields - the partial response fields

getPartialResponseFields

public String getPartialResponseFields()

Obtain the partial response fields that were specified in the body.

Returns:

the partial response fields or null if not specified in the body

addPropertySet

public void addPropertySet(NamedPropertySet propertySet)

Add a property set. A property set is a set of related properties and values. For example, if the body contained properties for three different resources to be created, each would be represented as distinct property set.

Parameters:

propertySet - the property set to add

getNamedPropertySets

public Set<NamedPropertySet> getNamedPropertySets()

Obtain all property sets or an empty set if no properties were specified in the body.

Returns:

all property sets or an empty set

getPropertySets

public Set<Map<String,Object>> getPropertySets()

Obtain all property sets as a set of maps. Convenience method that converts a Set to a Set>.

Returns:

a set of property maps for the request

getRequestInfoProperties

public Map<String,String> getRequestInfoProperties()

Return a map of request info properties. These properties are meta-data for the request.

addRequestInfoProperty

public void addRequestInfoProperty(String key,
                                   String val)

Add a request info property.

setBody

public void setBody(String body)

Set the body from the request. Also sets the body as a request info property.

Parameters:

body - the request body

getBody

public String getBody()

Obtain the request body.

Returns:

the request body