org.apache.axis.message

Class SOAPEnvelope

public class SOAPEnvelope extends MessageElement implements SOAPEnvelope

Implementation of a SOAP Envelope

Field Summary
protected static Log	log
String	messageType
Vector	trailers

Constructor Summary
	SOAPEnvelope()
	SOAPEnvelope(SOAPConstants soapConstants)
	SOAPEnvelope(SOAPConstants soapConstants, SchemaVersion schemaVersion)
	SOAPEnvelope(boolean registerPrefixes, SOAPConstants soapConstants)
	SOAPEnvelope(boolean registerPrefixes, SOAPConstants soapConstants, SchemaVersion schemaVersion)
	SOAPEnvelope(InputStream input)

Method Summary
SOAPBody	addBody() Add a soap body if one does not exist
void	addBodyElement(SOAPBodyElement element) Add a SOAP Body Element
void	addHeader(SOAPHeaderElement hdr) Add a HeaderElement
SOAPHeader	addHeader() Add a soap header if one does not exist
void	addTrailer(MessageElement element) Add an element to the trailer
protected void	childDeepCloned(NodeImpl oldNode, NodeImpl newNode)
void	clearBody() clear the elements in the soap body
Node	cloneNode(boolean deep)
Name	createName(String localName) create a Name given the local part
Name	createName(String localName, String prefix, String uri) Create a name given local part, prefix and uri
SOAPBody	getBody() Get the soap body
SOAPBodyElement	getBodyByName(String namespace, String localPart) Get a body element given its name
Vector	getBodyElements() Get all the BodyElement's in the soap body
SOAPBodyElement	getFirstBody() Get the first BodyElement in the SOAP Body
SOAPHeader	getHeader() Get the soap header
SOAPHeaderElement	getHeaderByName(String namespace, String localPart) Get a header by name (always respecting the currently in-scope actors list)
SOAPHeaderElement	getHeaderByName(String namespace, String localPart, boolean accessAllHeaders) Get a header by name, filtering for headers targeted at this engine depending on the accessAllHeaders parameter.
Vector	getHeaders() Get Headers
Vector	getHeadersByActor(ArrayList actors) Get all the headers targeted at a list of actors.
Enumeration	getHeadersByName(String namespace, String localPart) Get an enumeration of header elements given the namespace and localpart
Enumeration	getHeadersByName(String namespace, String localPart, boolean accessAllHeaders) Return an Enumeration of headers which match the given namespace and localPart.
String	getMessageType() Get the Message Type (REQUEST/RESPONSE)
SchemaVersion	getSchemaVersion() Get the schema version for this envelope
SOAPConstants	getSOAPConstants() Get the soap constants for this envelope
Vector	getTrailers() Return trailers
void	outputImpl(SerializationContext context) Should make SOAPSerializationException?
void	removeBody() Remove the SOAP Body
void	removeBodyElement(SOAPBodyElement element) Remove a Body Element from the soap body
Node	removeChild(Node oldChild)
void	removeHeader(SOAPHeaderElement hdr) Remove a Header Element from SOAP Header
void	removeHeaders() Remove all headers
void	removeTrailer(MessageElement element) Remove an element from the trailer
void	setBody(SOAPBody body) Set the soap body
void	setHeader(SOAPHeader hdr) Set the SOAP Header
void	setMessageType(String messageType) Set the Message Type (REQUEST/RESPONSE)
void	setOwnerDocument(SOAPPart sp)
void	setSAAJEncodingCompliance(boolean comply)
void	setSchemaVersion(SchemaVersion schemaVersion) Set the schema version for this envelope
void	setSoapConstants(SOAPConstants soapConstants) Set the soap constants for this envelope

Field Detail

Constructor Detail

SOAPEnvelope

public SOAPEnvelope(SOAPConstants soapConstants)

SOAPEnvelope

public SOAPEnvelope(SOAPConstants soapConstants, SchemaVersion schemaVersion)

SOAPEnvelope

public SOAPEnvelope(boolean registerPrefixes, SOAPConstants soapConstants)

SOAPEnvelope

public SOAPEnvelope(boolean registerPrefixes, SOAPConstants soapConstants, SchemaVersion schemaVersion)

Method Detail

addBody

public SOAPBody addBody()

Add a soap body if one does not exist

Returns:

Throws: SOAPException

addBodyElement

public void addBodyElement(SOAPBodyElement element)

Add a SOAP Body Element

Parameters: element

addHeader

public void addHeader(SOAPHeaderElement hdr)

Add a HeaderElement

Parameters: hdr

addHeader

public SOAPHeader addHeader()

Add a soap header if one does not exist

Returns:

Throws: SOAPException

addTrailer

public void addTrailer(MessageElement element)

Add an element to the trailer

Parameters: element

childDeepCloned

protected void childDeepCloned(NodeImpl oldNode, NodeImpl newNode)

clearBody

public void clearBody()

clear the elements in the soap body

createName

public Name createName(String localName)

create a Name given the local part

Parameters: localName

Returns:

Throws: SOAPException

createName

public Name createName(String localName, String prefix, String uri)

Create a name given local part, prefix and uri

Parameters: localName prefix uri

Returns:

Throws: SOAPException

getBody

public SOAPBody getBody()

Get the soap body

Returns:

Throws: SOAPException

getBodyByName

public SOAPBodyElement getBodyByName(String namespace, String localPart)

Get a body element given its name

Parameters: namespace localPart

Returns:

Throws: AxisFault

getBodyElements

public Vector getBodyElements()

Get all the BodyElement's in the soap body

Returns: vector with body elements

Throws: AxisFault

getFirstBody

public SOAPBodyElement getFirstBody()

Get the first BodyElement in the SOAP Body

Returns: first Body Element

Throws: AxisFault

getHeader

public SOAPHeader getHeader()

Get the soap header

Returns:

Throws: SOAPException

getHeaderByName

public SOAPHeaderElement getHeaderByName(String namespace, String localPart)

Get a header by name (always respecting the currently in-scope actors list)

getHeaderByName

public SOAPHeaderElement getHeaderByName(String namespace, String localPart, boolean accessAllHeaders)

Get a header by name, filtering for headers targeted at this engine depending on the accessAllHeaders parameter.

getHeaders

public Vector getHeaders()

Get Headers

Returns: Vector containing Header's

Throws: AxisFault

getHeadersByActor

public Vector getHeadersByActor(ArrayList actors)

Get all the headers targeted at a list of actors.

getHeadersByName

public Enumeration getHeadersByName(String namespace, String localPart)

Get an enumeration of header elements given the namespace and localpart

Parameters: namespace localPart

Returns:

Throws: AxisFault

getHeadersByName

public Enumeration getHeadersByName(String namespace, String localPart, boolean accessAllHeaders)

Return an Enumeration of headers which match the given namespace and localPart. Depending on the value of the accessAllHeaders parameter, we will attempt to filter on the current engine's list of actors. !!! NOTE THAT RIGHT NOW WE ALWAYS ASSUME WE'RE THE "ULTIMATE DESTINATION" (i.e. we match on null actor). IF WE WANT TO FULLY SUPPORT INTERMEDIARIES WE'LL NEED TO FIX THIS.