org.apache.olingo.client.core.communication.request

Class AbstractODataRequest

java.lang.Object

org.apache.olingo.client.core.communication.request.AbstractRequest

org.apache.olingo.client.core.communication.request.AbstractODataRequest

All Implemented Interfaces:

ODataRequest

Direct Known Subclasses:

AbstractODataBasicRequest, AbstractODataStreamedRequest, ODataRawRequestImpl

public abstract class AbstractODataRequest
extends AbstractRequest
implements ODataRequest

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

See Also:

CUDRequestFactory, BatchRequestFactory, InvokeRequestFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.client.HttpClient	httpClient HTTP client.
protected HttpMethod	method OData request method.
protected ODataClient	odataClient
protected ODataHeaders	odataHeaders OData request header.
protected org.apache.http.client.methods.HttpUriRequest	request HTTP request.
protected URI	uri Target URI.

Fields inherited from class org.apache.olingo.client.core.communication.request.AbstractRequest

LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractODataRequest(ODataClient odataClient, HttpMethod method, URI uri) Constructor.

Method Summary

Modifier and Type	Method and Description
ODataRequest	addCustomHeader(String name, String value) Adds a custom OData request header.
protected org.apache.http.HttpResponse	doExecute() Builds the request and execute it.
String	getAccept() Gets Accept OData request header.
String	getContentType() Gets contentType OData request header.
abstract ContentType	getDefaultFormat()
ODataHeaders	getHeader() Gets request headers.
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.
org.apache.http.client.methods.HttpUriRequest	getHttpRequest() Returns Http request Object.
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.
<V extends ODataResponse> V	getResponseTemplate() Gets an empty response that can be initialized by a stream.
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.
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.

Methods inherited from class org.apache.olingo.client.core.communication.request.AbstractRequest

checkRequest, checkResponse

Methods inherited from class java.lang.Object

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

Field Detail

odataClient

protected final ODataClient odataClient

method

protected final HttpMethod method

OData request method.

odataHeaders

protected final ODataHeaders odataHeaders

OData request header.

uri

protected URI uri

Target URI.

httpClient

protected org.apache.http.client.HttpClient httpClient

HTTP client.

request

protected org.apache.http.client.methods.HttpUriRequest request

HTTP request.

Constructor Detail

AbstractODataRequest

protected AbstractODataRequest(ODataClient odataClient,
                               HttpMethod method,
                               URI uri)

Constructor.

Parameters:

odataClient - client instance getting this request

method - HTTP request method. If configured X-HTTP-METHOD header will be used.

uri - OData request URI.

Method Detail

getDefaultFormat

public abstract ContentType getDefaultFormat()

getURI

public URI getURI()

Description copied from interface: ODataRequest

Returns OData request target URI.

Specified by:

getURI in interface ODataRequest

Returns:

OData request target URI.

getHttpRequest

public org.apache.http.client.methods.HttpUriRequest getHttpRequest()

Description copied from interface: ODataRequest

Returns Http request Object.

Specified by:

getHttpRequest in interface ODataRequest

Returns:

HttpUriRequest.

setURI

public void setURI(URI uri)

Description copied from interface: ODataRequest

Sets OData request target URI.

Specified by:

setURI in interface ODataRequest

Parameters:

uri - target URI.

getHeaderNames

public Collection<String> getHeaderNames()

Description copied from interface: ODataRequest

Gets all OData request header names.

Specified by:

getHeaderNames in interface ODataRequest

Returns:

all request header names.

getHeader

public String getHeader(String name)

Description copied from interface: ODataRequest

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

Specified by:

getHeader in interface ODataRequest

Parameters:

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

Returns:

header value.

setAccept

public ODataRequest setAccept(String value)

Description copied from interface: ODataRequest

Adds Accept OData request header.

Specified by:

setAccept in interface ODataRequest

Parameters:

value - header value.

Returns:

current object

See Also:

HttpHeader.ACCEPT

setIfMatch

public ODataRequest setIfMatch(String value)

Description copied from interface: ODataRequest

Adds If-Match OData request header.

Specified by:

setIfMatch in interface ODataRequest

Parameters:

value - header value.

Returns:

current object

See Also:

HttpHeader.IF_MATCH

setIfNoneMatch

public ODataRequest setIfNoneMatch(String value)

Description copied from interface: ODataRequest

Adds If-None-Match OData request header.

Specified by:

setIfNoneMatch in interface ODataRequest

Parameters:

value - header value.

Returns:

current object

See Also:

HttpHeader.IF_NONE_MATCH

setPrefer

public ODataRequest setPrefer(String value)

Description copied from interface: ODataRequest

Adds Prefer OData request header.

Specified by:

setPrefer in interface ODataRequest

Parameters:

value - header value.

Returns:

current object

See Also:

HttpHeader.PREFER

setXHTTPMethod

public ODataRequest setXHTTPMethod(String value)

Description copied from interface: ODataRequest

Adds X-HTTP-METHOD OData request header.

Specified by:

setXHTTPMethod in interface ODataRequest

Parameters:

value - header value.

Returns:

current object

See Also:

HttpHeader.X_HTTP_METHOD

setContentType

public ODataRequest setContentType(String value)

Description copied from interface: ODataRequest

Adds contentType OData request header.

Specified by:

setContentType in interface ODataRequest

Parameters:

value - header value.

Returns:

current object

See Also:

HttpHeader.CONTENT_TYPE

addCustomHeader

public ODataRequest addCustomHeader(String name,
                                    String value)

Description copied from interface: ODataRequest

Adds a custom OData request header.

Specified by:

addCustomHeader in interface ODataRequest

Parameters:

name - header name.

value - header value.

Returns:

current object

getAccept

public String getAccept()

Description copied from interface: ODataRequest

Gets Accept OData request header.

Specified by:

getAccept in interface ODataRequest

Returns:

header value.

See Also:

HttpHeader.ACCEPT

getIfMatch

public String getIfMatch()

Description copied from interface: ODataRequest

Gets If-Match OData request header.

Specified by:

getIfMatch in interface ODataRequest

Returns:

header value.

See Also:

HttpHeader.IF_MATCH

getIfNoneMatch

public String getIfNoneMatch()

Description copied from interface: ODataRequest

Gets If-None-Match OData request header.

Specified by:

getIfNoneMatch in interface ODataRequest

Returns:

header value.

See Also:

HttpHeader.IF_NONE_MATCH

getPrefer

public String getPrefer()

Description copied from interface: ODataRequest

Gets Prefer OData request header.

Specified by:

getPrefer in interface ODataRequest

Returns:

header value.

See Also:

HttpHeader.PREFER

getContentType

public String getContentType()

Description copied from interface: ODataRequest

Gets contentType OData request header.

Specified by:

getContentType in interface ODataRequest

Returns:

header value.

See Also:

HttpHeader.CONTENT_TYPE

getMethod

public HttpMethod getMethod()

Description copied from interface: ODataRequest

Returns HTTP request method.

Specified by:

getMethod in interface ODataRequest

Returns:

HTTP request method.

getHeader

public ODataHeaders getHeader()

Gets request headers.

Returns:

request headers.

toByteArray

public byte[] toByteArray()

Description copied from interface: ODataRequest

Gets byte array representation of the full request header.

Specified by:

toByteArray in interface ODataRequest

Returns:

full request header.

rawExecute

public InputStream rawExecute()

Description copied from interface: ODataRequest

Request raw execute.

Specified by:

rawExecute in interface ODataRequest

Returns:

raw input stream response.

doExecute

protected org.apache.http.HttpResponse doExecute()

Builds the request and execute it.

Returns:

HttpReponse object.

getResponseTemplate

public <V extends ODataResponse> V getResponseTemplate()

Gets an empty response that can be initialized by a stream.
This method has to be used to build response items about a batch request.

Type Parameters:

V - ODataResponse type.

Returns:

empty OData response instance.