com.sage.orion.sdata.servlet
Interface SDataExternalRequest

All Known Implementing Classes:

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

public interface SDataExternalRequest

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.

Method Detail

getContentType

java.lang.String getContentType()

Gets the content type of the payload

Returns:

the content type

getPayloadStream

java.io.InputStream getPayloadStream()

Gets the payload in the SData external request

Returns:

stream

setHeaderField

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

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.

Parameters:

headerKey - - the name of the header

headerValue - - the value to be set

getHeaderFields

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

Get header

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.

getRequestURL

java.lang.String getRequestURL()

String form of requested resource

Returns:

request URL String

getMethod

SDataRequest.SDataMethod getMethod()

Gets the method for the external request.

Returns:

the method