com.sap.cloud.sdk.service.prov.api.request

Class GenericRequest

java.lang.Object

com.sap.cloud.sdk.service.prov.api.request.GenericRequest

Direct Known Subclasses:

OperationRequest, Request

public abstract class GenericRequest
extends Object

Provides the request information for an operation.

Constructor Summary

Constructors

Constructor and Description
GenericRequest()

Method Summary

Modifier and Type	Method and Description
boolean	containsHeader(String name) Returns true if the header is present in the request, otherwise, it returns false.
EntityMetadata	getEntityMetadata() Returns the metadata of the requested entity.
String	getHeader(String name) Returns the first value of the specified request header as String object.
Enumeration<String>	getHeaderNames() Returns a collection of all the header names that the request contains.
Enumeration<String>	getHeaders(String name) Returns all the values of the specified request header as a collection of String objects.
String	getHttpMethod() Returns the name of the HTTP method with which this request was triggered.
Locale	getLocale() Returns the language specified in the Accept-Language header of the request.
MessageContainer	getMessageContainer() Gets the message container.
RequestContext	getRequestContext() Returns the additional request information in the context of the request protocol.
String	getServiceName() Returns the of the service
void	setServiceName(String serviceName)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericRequest

public GenericRequest()

Method Detail

getLocale

public Locale getLocale()

Returns the language specified in the Accept-Language header of the request.

Returns:

A Locale object representing the preferred language

getHeaderNames

public Enumeration<String> getHeaderNames()

Returns a collection of all the header names that the request contains.

Returns:

An Enumeration object containing header names

getHeaders

public Enumeration<String> getHeaders(String name)

Returns all the values of the specified request header as a collection of String objects. Please note that header name is case-insensitive.

Parameters:

name - A String containing the header name

Returns:

An Enumeration object containing header values

getHeader

public String getHeader(String name)

Returns the first value of the specified request header as String object. Please note that header name is case-insensitive.

Parameters:

name - A String containing the header name

Returns:

A String containing header value

containsHeader

public boolean containsHeader(String name)

Returns true if the header is present in the request, otherwise, it returns false. Please note that header name is case-insensitive.

Returns:

A boolean indicating the presence of the header

getHttpMethod

public String getHttpMethod()

Returns the name of the HTTP method with which this request was triggered. For example, GET, POST, or PUT.

Returns:

A String returning the name of the HTTP method

getRequestContext

public RequestContext getRequestContext()

Returns the additional request information in the context of the request protocol. For example, in the following code snippet this method returns an ODataRequestContext, using which an ODataRequest object is returned. ((ODataRequestContext)this.getRequestContext).getODataRequest()

Returns:

A RequestContext object containing the additional request information

getEntityMetadata

public EntityMetadata getEntityMetadata()

Returns the metadata of the requested entity.

Returns:

An EntityMetadata object containing metadata information

getMessageContainer

public MessageContainer getMessageContainer()

Gets the message container. Through the message container one can add info, warning, error messages, which can either come as the value of sap-message header, or can come as error-details in case of an error based on the calls the developer make.

Returns:

MessageContainer object for this request.

getServiceName

public String getServiceName()

Returns the of the service

Returns:

A String containing the name of the service

setServiceName

public void setServiceName(String serviceName)