org.apache.olingo.client.api.communication.request

Interface ODataRequest

All Known Subinterfaces:

EdmMetadataRequest, ODataBasicRequest<T>, ODataBatchableRequest, ODataBatchRequest, ODataBatchRequest, ODataDeleteRequest, ODataDeltaRequest, ODataEntityCreateRequest<E>, ODataEntityRequest<E>, ODataEntitySetIteratorRequest<ES,E>, ODataEntitySetRequest<ES>, ODataEntityUpdateRequest<E>, ODataInvokeRequest<T>, ODataLinkCollectionRequest, ODataLinkCreateRequest, ODataLinkUpdateRequest, ODataMediaEntityCreateRequest<E>, ODataMediaEntityUpdateRequest<E>, ODataMediaRequest, ODataPropertyRequest<T>, ODataPropertyUpdateRequest, ODataRawRequest, ODataReferenceAddingRequest, ODataRetrieveRequest<T>, ODataServiceDocumentRequest, ODataStreamedEntityRequest<V,T>, ODataStreamedRequest<V,T>, ODataStreamUpdateRequest, ODataValueRequest, ODataValueUpdateRequest, XMLMetadataRequest

public interface ODataRequest

Abstract representation of an OData request. Get instance by using factories.

See Also:

CUDRequestFactory, CUDRequestFactory, BatchRequestFactory, BatchRequestFactory, InvokeRequestFactory, org.apache.olingo.client.api.communication.request.streamed.StreamedRequestFactory

Method Summary

Methods

Modifier and Type	Method and Description
ODataRequest	addCustomHeader(HeaderName name, String value) Adds a custom OData request header.
ODataRequest	addCustomHeader(String name, String value) Adds a custom OData request header.
String	getAccept() Gets Accept OData request header.
String	getContentType() Gets contentType OData request header.
String	getHeader(String name) Gets the value of the OData request header identified by the given name.
Collection<String>	getHeaderNames() Gets all OData request header names.
String	getIfMatch() Gets If-Match OData request header.
String	getIfNoneMatch() Gets If-None-Match OData request header.
HttpMethod	getMethod() Returns HTTP request method.
String	getPrefer() Gets Prefer OData request header.
URI	getURI() Returns OData request target URI.
InputStream	rawExecute() Request raw execute.
ODataRequest	setAccept(String value) Adds Accept OData request header.
ODataRequest	setContentType(String value) Adds contentType OData request header.
ODataRequest	setIfMatch(String value) Adds If-Match OData request header.
ODataRequest	setIfNoneMatch(String value) Adds If-None-Match OData request header.
ODataRequest	setPrefer(String value) Adds Prefer OData request header.
ODataRequest	setSlug(String value) Adds Slug OData request header.
void	setURI(URI uri) Sets OData request target URI.
ODataRequest	setXHTTPMethod(String value) Adds X-HTTP-METHOD OData request header.
byte[]	toByteArray() Gets byte array representation of the full request header.

Method Detail

getURI

URI getURI()

Returns OData request target URI.

Returns:

OData request target URI.

setURI

void setURI(URI uri)

Sets OData request target URI.

Parameters:

uri - target URI.

getMethod

HttpMethod getMethod()

Returns HTTP request method.

Returns:

HTTP request method.

getHeaderNames

Collection<String> getHeaderNames()

Gets all OData request header names.

Returns:

all request header names.

getHeader

String getHeader(String name)

Gets the value of the OData request header identified by the given name.

Parameters:

name - name of the OData request header to be retrieved.

Returns:

header value.

setAccept

ODataRequest setAccept(String value)

Adds Accept OData request header.

Parameters:

value - header value.

Returns:

current object

See Also:

HeaderName.accept

getAccept

String getAccept()

Gets Accept OData request header.

Returns:

header value.

See Also:

HeaderName.accept

setIfMatch

ODataRequest setIfMatch(String value)

Adds If-Match OData request header.

Parameters:

value - header value.

Returns:

current object

See Also:

HeaderName.ifMatch

getIfMatch

String getIfMatch()

Gets If-Match OData request header.

Returns:

header value.

See Also:

HeaderName.ifMatch

setIfNoneMatch

ODataRequest setIfNoneMatch(String value)

Adds If-None-Match OData request header.

Parameters:

value - header value.

Returns:

current object

See Also:

HeaderName.ifNoneMatch

getIfNoneMatch

String getIfNoneMatch()

Gets If-None-Match OData request header.

Returns:

header value.

See Also:

HeaderName.ifNoneMatch

setPrefer

ODataRequest setPrefer(String value)

Adds Prefer OData request header.

Parameters:

value - header value.

Returns:

current object

See Also:

HeaderName.prefer

getPrefer

String getPrefer()

Gets Prefer OData request header.

Returns:

header value.

See Also:

HeaderName.prefer

setContentType

ODataRequest setContentType(String value)

Adds contentType OData request header.

Parameters:

value - header value.

Returns:

current object

See Also:

HeaderName.contentType

getContentType

String getContentType()

Gets contentType OData request header.

Returns:

header value.

See Also:

HeaderName.contentType

setSlug

ODataRequest setSlug(String value)

Adds Slug OData request header.

Parameters:

value - header value.

Returns:

current object

See Also:

HeaderName.slug

setXHTTPMethod

ODataRequest setXHTTPMethod(String value)

Adds X-HTTP-METHOD OData request header.

Parameters:

value - header value.

Returns:

current object

See Also:

HeaderName.xHttpMethod

addCustomHeader

ODataRequest addCustomHeader(String name,
                           String value)

Adds a custom OData request header.

Parameters:

name - header name.

value - header value.

Returns:

current object

addCustomHeader

ODataRequest addCustomHeader(HeaderName name,
                           String value)

Adds a custom OData request header. The method fails in case of the header name is not supported by the current working version.

Parameters:

name - header name.

value - header value.

Returns:

current object

toByteArray

byte[] toByteArray()

Gets byte array representation of the full request header.

Returns:

full request header.

rawExecute

InputStream rawExecute()

Request raw execute.

Returns:

raw input stream response.