com.sage.orion.sdata.servlet
Class AbstractSDataExternalRequest

java.lang.Object
  com.sage.orion.sdata.servlet.AbstractSDataExternalRequest

All Implemented Interfaces:

SDataExternalRequest

Direct Known Subclasses:

SDataExternalDeleteRequest, SDataExternalGetRequest, SDataExternalPostRequest, SDataExternalQueryRequest, SDataExternalSchemaRequest, SDataExternalTemplateRequest, SDataExternalUpdateRequest

public abstract class AbstractSDataExternalRequest
extends java.lang.Object
implements SDataExternalRequest

Abstract class for SData external request

Field Summary

protected java.lang.String	contentType
protected java.util.Map<java.lang.String,java.lang.String>	headers
protected SDataRequest.SDataMethod	method
protected java.lang.String	query
protected java.lang.String	requestURL
protected java.io.InputStream	source

Constructor Summary

AbstractSDataExternalRequest(java.lang.String resourceKind, SDataRequest.SDataMethod method, java.io.InputStream source, java.lang.String contentType)
To create external request

AbstractSDataExternalRequest(java.lang.String resourceKind, SDataRequest.SDataMethod method, java.lang.String query, boolean isSchemaRequest, boolean isTemplateRequest)
TO create external request

Method Summary

java.lang.String	getContentType() Gets the content type of the payload
java.util.Map<java.lang.String,java.lang.String>	getHeaderFields() Get header
SDataRequest.SDataMethod	getMethod() Gets the method for the external request.
java.io.InputStream	getPayloadStream() Gets the payload in the SData external request
java.lang.String	getRequestURL() String form of requested resource
void	setHeaderField(java.lang.String headerKey, java.lang.String headerValue) Sets the value of a header to be sent with this request.

Methods inherited from class java.lang.Object

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

Field Detail

method

protected final SDataRequest.SDataMethod method

requestURL

protected final java.lang.String requestURL

query

protected final java.lang.String query

headers

protected final java.util.Map<java.lang.String,java.lang.String> headers

source

protected final java.io.InputStream source

contentType

protected final java.lang.String contentType

Constructor Detail

AbstractSDataExternalRequest

public AbstractSDataExternalRequest(java.lang.String resourceKind,
                                    SDataRequest.SDataMethod method,
                                    java.io.InputStream source,
                                    java.lang.String contentType)

To create external request

Parameters:

resourceKind -

method -

source -

contentType -

AbstractSDataExternalRequest

public AbstractSDataExternalRequest(java.lang.String resourceKind,
                                    SDataRequest.SDataMethod method,
                                    java.lang.String query,
                                    boolean isSchemaRequest,
                                    boolean isTemplateRequest)

TO create external request

Parameters:

resourceKind -

method -

query -

isSchemaRequest - true if request is schema

isTemplateRequest - true if the request is template

Method Detail

getRequestURL

public java.lang.String getRequestURL()

Description copied from interface: SDataExternalRequest

String form of requested resource

Specified by:

getRequestURL in interface SDataExternalRequest

Returns:

request URL String

getPayloadStream

public java.io.InputStream getPayloadStream()

Description copied from interface: SDataExternalRequest

Gets the payload in the SData external request

Specified by:

getPayloadStream in interface SDataExternalRequest

Returns:

stream

getContentType

public java.lang.String getContentType()

Description copied from interface: SDataExternalRequest

Gets the content type of the payload

Specified by:

getContentType in interface SDataExternalRequest

Returns:

the content type

getMethod

public SDataRequest.SDataMethod getMethod()

Description copied from interface: SDataExternalRequest

Gets the method for the external request.

Specified by:

getMethod in interface SDataExternalRequest

Returns:

the method

getHeaderFields

public java.util.Map<java.lang.String,java.lang.String> getHeaderFields()

Description copied from interface: SDataExternalRequest

Get header

Specified by:

getHeaderFields in interface SDataExternalRequest

Returns:

a non-null unmodifiable Map of the header fields, keyed by a non-null String containing the name of the header and containing for each key a non-null String containing the value of the header.

setHeaderField

public void setHeaderField(java.lang.String headerKey,
                           java.lang.String headerValue)

Description copied from interface: SDataExternalRequest

Sets the value of a header to be sent with this request. If the header name already exists, overwrite its value with the new header value when the request is actually sent.

Specified by:

setHeaderField in interface SDataExternalRequest

Parameters:

headerKey - - the name of the header

headerValue - - the value to be set