Package org.apache.axis2.jaxws.message.databinding.impl

Class SOAPEnvelopeBlockImpl

java.lang.Object

org.apache.axiom.om.ds.AbstractOMDataSource

org.apache.axis2.jaxws.message.impl.BlockImpl<jakarta.xml.soap.SOAPEnvelope,Void>

org.apache.axis2.jaxws.message.databinding.impl.SOAPEnvelopeBlockImpl

All Implemented Interfaces:

org.apache.axiom.om.OMDataSource, org.apache.axiom.om.OMDataSourceExt, Block<jakarta.xml.soap.SOAPEnvelope,Void>, SOAPEnvelopeBlock

public class SOAPEnvelopeBlockImpl
extends BlockImpl<jakarta.xml.soap.SOAPEnvelope,Void>
implements SOAPEnvelopeBlock

Field Summary

Fields inherited from class org.apache.axis2.jaxws.message.impl.BlockImpl

busContext, busObject, consumed, factory, omElement, parent, qName

Constructor Summary

Constructors

Constructor	Description
SOAPEnvelopeBlockImpl(jakarta.xml.soap.SOAPEnvelope busObject, QName qName, BlockFactory factory)	Called by SOAPEnvelopeBlockFactory
SOAPEnvelopeBlockImpl(org.apache.axiom.om.OMElement omElement, QName qName, BlockFactory factory)	Called by SOAPEnvelopeBlockFactory

Method Summary

Modifier and Type	Method	Description
protected jakarta.xml.soap.SOAPEnvelope	_getBOFromOM(org.apache.axiom.om.OMElement omElement, Void busContext)	Default method for getting business object from OM.
protected XMLStreamReader	_getReaderFromBO(jakarta.xml.soap.SOAPEnvelope busObj, Void busContext)	Get an XMLStreamReader for the BusinessObject The derived Block must implement this method
protected void	_outputFromBO(jakarta.xml.soap.SOAPEnvelope busObject, Void busContext, XMLStreamWriter writer)	Output BusinessObject contents to a Writer.
void	close()
Object	getObject()
boolean	isDestructiveRead()
boolean	isDestructiveWrite()
boolean	isElementData()

Methods inherited from class org.apache.axis2.jaxws.message.impl.BlockImpl

_getBOFromBO, _getOMFromBO, _outputFromOM, _outputFromReader, _postPivot_getXMLStreamReader, _postPivot_outputTo, copy, getBlockFactory, getBusinessContext, getBusinessObject, getOMElement, getParent, getQName, getReader, getXMLStreamReader, isBusinessObject, isConsumed, isQNameAvailable, outputTo, serialize, setConsumed, setParent, setQName, traceString

Methods inherited from class org.apache.axiom.om.ds.AbstractOMDataSource

getProperty, getXMLBytes, getXMLInputStream, hasProperty, serialize, serialize, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.axis2.jaxws.message.Block

getBlockFactory, getBusinessContext, getBusinessObject, getOMElement, getParent, getQName, getXMLStreamReader, isConsumed, isQNameAvailable, outputTo, setParent, traceString

Methods inherited from interface org.apache.axiom.om.OMDataSource

getReader, serialize, serialize, serialize

Methods inherited from interface org.apache.axiom.om.OMDataSourceExt

copy, getProperty, getXMLBytes, getXMLInputStream, hasProperty, setProperty

Constructor Details

SOAPEnvelopeBlockImpl

public SOAPEnvelopeBlockImpl(jakarta.xml.soap.SOAPEnvelope busObject,
 QName qName,
 BlockFactory factory)

Called by SOAPEnvelopeBlockFactory

Parameters:

busObject -

busContext -

qName -

factory -

SOAPEnvelopeBlockImpl

public SOAPEnvelopeBlockImpl(org.apache.axiom.om.OMElement omElement,
 QName qName,
 BlockFactory factory)

Called by SOAPEnvelopeBlockFactory

Parameters:

omElement -

busContext -

qName -

factory -

Method Details

_getBOFromOM

protected jakarta.xml.soap.SOAPEnvelope _getBOFromOM(org.apache.axiom.om.OMElement omElement,
 Void busContext)
                                              throws XMLStreamException,
jakarta.xml.ws.WebServiceException

Description copied from class: BlockImpl

Default method for getting business object from OM. Derived classes may override this method to get the business object from a data source.

Specified by:

_getBOFromOM in class BlockImpl<jakarta.xml.soap.SOAPEnvelope,Void>

Returns:

Business Object

Throws:

XMLStreamException

jakarta.xml.ws.WebServiceException

_getReaderFromBO

protected XMLStreamReader _getReaderFromBO(jakarta.xml.soap.SOAPEnvelope busObj,
 Void busContext)
                                    throws XMLStreamException,
jakarta.xml.ws.WebServiceException

Description copied from class: BlockImpl

Get an XMLStreamReader for the BusinessObject The derived Block must implement this method

Specified by:

_getReaderFromBO in class BlockImpl<jakarta.xml.soap.SOAPEnvelope,Void>

Returns:

Throws:

XMLStreamException

jakarta.xml.ws.WebServiceException

_outputFromBO

protected void _outputFromBO(jakarta.xml.soap.SOAPEnvelope busObject,
 Void busContext,
 XMLStreamWriter writer)
                      throws XMLStreamException,
jakarta.xml.ws.WebServiceException

Description copied from class: BlockImpl

Output BusinessObject contents to a Writer. Derived classes must provide this implementation

Specified by:

_outputFromBO in class BlockImpl<jakarta.xml.soap.SOAPEnvelope,Void>

Throws:

XMLStreamException

jakarta.xml.ws.WebServiceException

isElementData

public boolean isElementData()

Specified by:

isElementData in interface Block<jakarta.xml.soap.SOAPEnvelope,Void>

Returns:

true if data is always an element; false if possibly mixed content or multiple elements

close

public void close()

Specified by:

close in interface org.apache.axiom.om.OMDataSourceExt

Overrides:

close in class org.apache.axiom.om.ds.AbstractOMDataSource

getObject

public Object getObject()

Specified by:

getObject in interface org.apache.axiom.om.OMDataSourceExt

Overrides:

getObject in class org.apache.axiom.om.ds.AbstractOMDataSource

isDestructiveRead

public boolean isDestructiveRead()

Specified by:

isDestructiveRead in interface org.apache.axiom.om.OMDataSourceExt

isDestructiveWrite

public boolean isDestructiveWrite()

Specified by:

isDestructiveWrite in interface org.apache.axiom.om.OMDataSourceExt