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

Class SourceBlockImpl

java.lang.Object

org.apache.axis2.jaxws.message.impl.BlockImpl

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

All Implemented Interfaces:

org.apache.axiom.om.OMDataSource, org.apache.axiom.om.OMDataSourceExt, Block, SourceBlock

public class SourceBlockImpl
extends BlockImpl
implements SourceBlock

SourceBlock

Block containing a business object that is a javax.xml.transform.Source.

The javax.xml.transform.Source is an interface. The actual concrete class may be one of the following: - StreamSource - DOMSource - JAXBSource - SAXSource - StAXSource

During processing of the block, the block is free to change the representation from one source to another. (i.e. if you initially seed this with a SAXSource, but a later access may give you a StAXSource).

A Source is consumed when read. The block will make a copy of the source if a non-consumable request is made.

Field Summary

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

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

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

LOSSY_PREFIX

Constructor Summary

Constructors

Constructor and Description
SourceBlockImpl(org.apache.axiom.om.OMElement omElement, QName qName, BlockFactory factory) Constructor called from factory

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	_getBOFromBO(Object busObject, Object busContext, boolean consume) The default implementation is to return the business object.
protected Object	_getBOFromOM(org.apache.axiom.om.OMElement omElement, Object busContext) Default method for getting business object from OM.
protected Object	_getBOFromReader(javax.xml.stream.XMLStreamReader reader, Object busContext) The derived class must provide an implementation that builds the business object from the reader
protected javax.xml.stream.XMLStreamReader	_getReaderFromBO(Object busObj, Object busContext) Get an XMLStreamReader for the BusinessObject The derived Block must implement this method
protected void	_outputFromBO(Object busObject, Object busContext, javax.xml.stream.XMLStreamWriter writer) Output BusinessObject contents to a Writer.
void	close()
Object	getObject()
byte[]	getXMLBytes(String encoding)
InputStream	getXMLInputStream(String encoding)
boolean	isDestructiveRead()
boolean	isDestructiveWrite()
boolean	isElementData()

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

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

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.OMDataSourceExt

copy, getProperty, hasProperty, setProperty

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

getReader, serialize, serialize, serialize

Constructor Detail

SourceBlockImpl

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

Constructor called from factory

Parameters:

reader -

qName -

factory -

Method Detail

_getBOFromReader

protected Object _getBOFromReader(javax.xml.stream.XMLStreamReader reader,
                      Object busContext)
                           throws javax.xml.stream.XMLStreamException

Description copied from class: BlockImpl

The derived class must provide an implementation that builds the business object from the reader

Specified by:

_getBOFromReader in class BlockImpl

Parameters:

reader - XMLStreamReader, which is consumed

Returns:

Throws:

javax.xml.stream.XMLStreamException

_getBOFromOM

protected Object _getBOFromOM(org.apache.axiom.om.OMElement omElement,
                  Object busContext)
                       throws javax.xml.stream.XMLStreamException,
                              javax.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.

Overrides:

_getBOFromOM in class BlockImpl

Returns:

Business Object

Throws:

javax.xml.stream.XMLStreamException

javax.xml.ws.WebServiceException

_getReaderFromBO

protected javax.xml.stream.XMLStreamReader _getReaderFromBO(Object busObj,
                                                Object busContext)
                                                     throws javax.xml.stream.XMLStreamException,
                                                            javax.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

Returns:

Throws:

javax.xml.stream.XMLStreamException

javax.xml.ws.WebServiceException

_outputFromBO

protected void _outputFromBO(Object busObject,
                 Object busContext,
                 javax.xml.stream.XMLStreamWriter writer)
                      throws javax.xml.stream.XMLStreamException,
                             javax.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

Throws:

javax.xml.stream.XMLStreamException

javax.xml.ws.WebServiceException

_getBOFromBO

protected Object _getBOFromBO(Object busObject,
                  Object busContext,
                  boolean consume)

Description copied from class: BlockImpl

The default implementation is to return the business object. A derived block may want to override this class if the business object is consumed when read (thus the dervived block may want to make a buffered copy) (An example use case for overriding this method is the businessObject is an InputSource)

Overrides:

_getBOFromBO in class BlockImpl

Returns:

isElementData

public boolean isElementData()

Specified by:

isElementData in interface Block

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

getXMLInputStream

public InputStream getXMLInputStream(String encoding)
                              throws UnsupportedEncodingException

Specified by:

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

Throws:

UnsupportedEncodingException

getObject

public Object getObject()

Specified by:

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

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

getXMLBytes

public byte[] getXMLBytes(String encoding)
                   throws UnsupportedEncodingException

Specified by:

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

Throws:

UnsupportedEncodingException