com.bea.wli.sb.transports

Class ResponseHeaders

java.lang.Object

com.bea.wli.sb.transports.ResponseHeaders

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DefaultResponseHeaders

public abstract class ResponseHeaders
extends java.lang.Object
implements java.io.Serializable

Represents a union of standard and user-defined headers in a given inbound or outbound response message. The set of standard headers is specific to each transport provider. This is an abstract class to be extended by each transport provider to implement their version of response headers.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	_headers
protected static javax.xml.namespace.QName	USER_HEADER_NAME_QNAME
protected static javax.xml.namespace.QName	USER_HEADER_QNAME
protected static javax.xml.namespace.QName	USER_HEADER_VALUE_QNAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResponseHeaders()
protected	ResponseHeaders(ResponseHeadersXML headersXML)

Method Summary

Modifier and Type	Method and Description
boolean	containsHeader(java.lang.String name)
void	deleteHeader(java.lang.String name) removes the header with a given name
java.lang.Object	getHeader(java.lang.String name)
java.util.Iterator<java.lang.String>	getHeaderNames()
protected int	getStandardHeaderTypeInternal(javax.xml.namespace.QName name) will be overridden if needed
protected java.util.Map<java.lang.String,java.lang.Object>	newHeadersInternal() override for different implementation of headers, e.g.
void	setHeader(java.lang.String name, java.lang.Object value) Sets the header with the specified name to the given value
void	setXML(ResponseHeadersXML xml)
abstract ResponseHeadersXML	toXML()

Methods inherited from class java.lang.Object

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

Field Detail

_headers

protected final java.util.Map<java.lang.String,java.lang.Object> _headers

USER_HEADER_QNAME

protected static final javax.xml.namespace.QName USER_HEADER_QNAME

USER_HEADER_NAME_QNAME

protected static final javax.xml.namespace.QName USER_HEADER_NAME_QNAME

USER_HEADER_VALUE_QNAME

protected static final javax.xml.namespace.QName USER_HEADER_VALUE_QNAME

Constructor Detail

ResponseHeaders

protected ResponseHeaders()

ResponseHeaders

protected ResponseHeaders(ResponseHeadersXML headersXML)

Method Detail

newHeadersInternal

protected java.util.Map<java.lang.String,java.lang.Object> newHeadersInternal()

override for different implementation of headers, e.g. to use a TreeMap instead of standard hash map to keep string comparisons between header names case-insensitive

getHeaderNames

public java.util.Iterator<java.lang.String> getHeaderNames()

Returns:

an iterator for all the header names

containsHeader

public boolean containsHeader(java.lang.String name)

Parameters:

name - header name

Returns:

whether or not a header with a given name exists

getHeader

public java.lang.Object getHeader(java.lang.String name)

Parameters:

name - header name

Returns:

the value of the header with a given name or null if it does not exist

setHeader

public void setHeader(java.lang.String name,
                      java.lang.Object value)

Sets the header with the specified name to the given value

Parameters:

name - header name

value - value to set the specified header to

deleteHeader

public void deleteHeader(java.lang.String name)

removes the header with a given name

Parameters:

name - header name

toXML

public abstract ResponseHeadersXML toXML()
                                  throws TransportException

Returns:

XMLBean representation of these request headers

Throws:

TransportException

getStandardHeaderTypeInternal

protected int getStandardHeaderTypeInternal(javax.xml.namespace.QName name)

will be overridden if needed

Parameters:

name -

Returns:

java type code for header (see org.apache.xmlbeans.SchemaProperty for values), -1 if unknown

setXML

public void setXML(ResponseHeadersXML xml)