com.bea.wli.sb.transports

Class ResponseMetaData<T extends ResponseHeaders>

java.lang.Object

com.bea.wli.sb.transports.ResponseMetaData<T>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DefaultResponseMetaData

public abstract class ResponseMetaData<T extends ResponseHeaders>
extends java.lang.Object
implements java.io.Serializable

Represents inbound or outbound response message meta-data information (e.g. headers, request character set encoding, etc.) Transport Providers will provide an extension of this class that adds meta-data information applicable to the transport provider. For example, HTTP transport provider will add get/setHttpResponseCode() and other methods.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getCacheOriginated()
java.lang.String	getCacheToken()
java.lang.String	getCharacterEncoding()
T	getHeaders()
int	getResponseCode()
java.lang.String	getResponseMessage()
boolean	isSetResponseMessage()
void	setCacheOriginated(java.lang.Boolean cacheOriginated) sets whether this response originated from the cache or not (only set if caching enabled)
void	setCacheToken(java.lang.String cacheToken) sets the cache token used for this response
void	setCharacterEncoding(java.lang.String encoding) sets character encoding to use for message payload
void	setHeaders(T headers) sets provider-specific response headers POJO that represents transport-level headers for the message
void	setResponseCode(int code) Sets response code to indicate success/failure.
void	setResponseMessage(java.lang.String message) sets provider-specific response message
abstract ResponseMetaDataXML	toXML()

Methods inherited from class java.lang.Object

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

Method Detail

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Returns:

character encoding to use for message payload

setCharacterEncoding

public void setCharacterEncoding(java.lang.String encoding)

sets character encoding to use for message payload

getResponseCode

public int getResponseCode()

Returns:

response code to indicate success/failure. See TransportManager for response code constants

setResponseCode

public void setResponseCode(int code)

Sets response code to indicate success/failure. See TransportManager for response code constants

getResponseMessage

public java.lang.String getResponseMessage()

Returns:

provider-specific response message

setResponseMessage

public void setResponseMessage(java.lang.String message)

sets provider-specific response message

isSetResponseMessage

public boolean isSetResponseMessage()

Returns:

whether or not there is a provider-specific response message in meta data

getHeaders

public T getHeaders()

Returns:

provider-specific response headers POJO that represents transport-level headers for the message

setHeaders

public void setHeaders(T headers)

sets provider-specific response headers POJO that represents transport-level headers for the message

getCacheToken

public java.lang.String getCacheToken()

Returns:

the cache token used for this response or null

setCacheToken

public void setCacheToken(java.lang.String cacheToken)

sets the cache token used for this response

Parameters:

cacheToken -

getCacheOriginated

public java.lang.Boolean getCacheOriginated()

Returns:

whether this response originated from the cache or not (can be null if caching is not enabled)

setCacheOriginated

public void setCacheOriginated(java.lang.Boolean cacheOriginated)

sets whether this response originated from the cache or not (only set if caching enabled)

Parameters:

cacheOriginated -

toXML

public abstract ResponseMetaDataXML toXML()
                                   throws TransportException

Returns:

XMLBean representation of this response meta data object

Throws:

TransportException