public abstract class XMLPartBase extends Object implements XMLPart
XMLPart
,
XMLPartImpl
Modifier and Type | Method and Description |
---|---|
protected abstract SOAPEnvelope |
_convertOM2SE(org.apache.axiom.om.OMElement om)
Convert OM tree into a SOAPEnvelope
|
protected abstract org.apache.axis2.jaxws.message.impl.XMLSpine |
_convertOM2Spine(org.apache.axiom.om.OMElement om)
Convert OM into XMLSpine
|
protected abstract org.apache.axiom.om.OMElement |
_convertSE2OM(SOAPEnvelope se)
Convert SOAPEnvelope into an OM tree
|
protected abstract org.apache.axis2.jaxws.message.impl.XMLSpine |
_convertSE2Spine(SOAPEnvelope se)
Convert SOAPEnvelope into XMLSPine
|
protected abstract org.apache.axiom.om.OMElement |
_convertSpine2OM(org.apache.axis2.jaxws.message.impl.XMLSpine spine)
Convert XMLSpine into an OM tree
|
protected abstract SOAPEnvelope |
_convertSpine2SE(org.apache.axis2.jaxws.message.impl.XMLSpine spine)
Convert XMLSpine into a SOAPEnvelope
|
protected static org.apache.axis2.jaxws.message.impl.XMLSpine |
_createSpine(Protocol protocol,
SOAPBinding.Style style,
int indirection,
org.apache.axiom.om.OMElement payload)
Create an empty, default spine for the specificed protocol
|
void |
appendHeaderBlock(String namespace,
String localPart,
Block block)
appendHeaderBlock
Append the block to the list of header blocks.
|
void |
close()
Used primarily to ensure the parser is forwarded to the end so it can be closed.
|
org.apache.axiom.om.OMElement |
getAsOMElement()
getAsOMElement Get the xml part as a read/write OM...note this returns an OM SOAPEnvelope for
all protocols...even REST
|
SOAPEnvelope |
getAsSOAPEnvelope()
getAsEnvelope Get the xml part as a read/write SOAPEnvelope
|
Block |
getBodyBlock(int index,
Object context,
BlockFactory blockFactory)
getBodyBlock Get the body block at the specificed index.
|
Block |
getBodyBlock(Object context,
BlockFactory blockFactory)
getBodyBlock Get the single Body Block.
|
List<QName> |
getBodyBlockQNames()
getBodyBlockQNames
Calling this method will cache the OM.
|
Block |
getHeaderBlock(String namespace,
String localPart,
Object context,
BlockFactory blockFactory)
getHeaderBlock
Get the firstheader block with the specified name.
|
List<Block> |
getHeaderBlocks(String namespace,
String localPart,
Object context,
BlockFactory blockFactory,
org.apache.axiom.soap.RolePlayer rolePlayer)
getHeaderBlock
Get the header blocks with the specified name
The BlockFactory and object context
are passed in to help create the proper kind of block.
|
Set<QName> |
getHeaderQNames() |
int |
getIndirection()
Get indirection.
|
int |
getNumBodyBlocks()
getNumBodyBlocks Calling this method will cache the OM.
|
int |
getNumHeaderBlocks()
getNumHeaderBlocks
|
QName |
getOperationElement() |
Message |
getParent()
getParent Get the Message object that this XMLPart is attached to, if it is attached to one
at all.
|
Protocol |
getProtocol()
Get the protocol for this Message (soap11, soap12, etc.)
|
SOAPBinding.Style |
getStyle() |
XMLFault |
getXMLFault()
If the XMLPart represents a fault, an XMLFault is returned which describes the fault in a
protocol agnostic manner
|
String |
getXMLPartContentType()
The representation of the XMLPart may be in a number of different forms.
|
XMLStreamReader |
getXMLStreamReader(boolean consume)
Get the XMLStreamReader represented by this Message for the xml part
|
boolean |
isConsumed()
isConsumed Return true if the part is consumed.
|
boolean |
isFault()
Determines whether the XMLPart represents a Fault
|
void |
outputTo(XMLStreamWriter writer,
boolean consume)
Write out the Message
|
void |
removeBodyBlock(int index)
removeBodyBlock Removes the indicated BodyBlock
|
void |
removeHeaderBlock(String namespace,
String localPart)
removeHeaderBlock
Removes all header blocks with this namespace/localpart
|
void |
setBodyBlock(Block block)
setBodyBlock Set this as block as the single block for the message.
|
void |
setBodyBlock(int index,
Block block)
setBodyBlock Set the block at the specified index Once set, the Message owns the block.
|
void |
setHeaderBlock(String namespace,
String localPart,
Block block)
setHeaderBlock
replaces the first existing header block with this new block.
|
void |
setIndirection(int indirection)
Set indirection.
|
void |
setOperationElement(QName operationQName)
Set the operation element qname.
|
void |
setParent(Message p)
setParent Set the Message object that will hold this XMLPart
|
void |
setStyle(SOAPBinding.Style style)
Set the Style.
|
void |
setXMLFault(XMLFault xmlFault)
Change the XMLPart so that it represents the fault described by XMLFault
|
String |
traceString(String indent)
Get a traceString...the trace string dumps the contents of the Block without forcing an
underlying ill-performant transformation of the message.
|
public org.apache.axiom.om.OMElement getAsOMElement() throws WebServiceException
XMLPart
getAsOMElement
in interface XMLPart
WebServiceException
public SOAPEnvelope getAsSOAPEnvelope() throws WebServiceException
XMLPart
getAsSOAPEnvelope
in interface XMLPart
WebServiceException
public Protocol getProtocol()
XMLPart
getProtocol
in interface XMLPart
public SOAPBinding.Style getStyle()
public int getIndirection()
XMLPart
getIndirection
in interface XMLPart
public void setStyle(SOAPBinding.Style style) throws WebServiceException
XMLPart
setStyle
in interface XMLPart
style
- StyleWebServiceException
indirection
public void setIndirection(int indirection)
XMLPart
setIndirection
in interface XMLPart
indirection
- (0 or 1)public QName getOperationElement() throws WebServiceException
getOperationElement
in interface XMLPart
WebServiceException
public void setOperationElement(QName operationQName) throws WebServiceException
XMLPart
setOperationElement
in interface XMLPart
WebServiceException
public String getXMLPartContentType()
XMLPart
getXMLPartContentType
in interface XMLPart
public XMLStreamReader getXMLStreamReader(boolean consume) throws WebServiceException
XMLPart
getXMLStreamReader
in interface XMLPart
consume
- true if this is the last request on the MessageWebServiceException
public XMLFault getXMLFault() throws WebServiceException
XMLPart
getXMLFault
in interface XMLPart
WebServiceException
XMLFault
public void setXMLFault(XMLFault xmlFault) throws WebServiceException
XMLPart
setXMLFault
in interface XMLPart
WebServiceException
XMLFault
public boolean isFault() throws WebServiceException
XMLPart
isFault
in interface XMLPart
WebServiceException
public boolean isConsumed()
XMLPart
isConsumed
in interface XMLPart
public void outputTo(XMLStreamWriter writer, boolean consume) throws XMLStreamException, WebServiceException
XMLPart
outputTo
in interface XMLPart
writer
- XMLStreamWriterconsume
- true if this is the last request on the block.WebServiceException
XMLStreamException
public String traceString(String indent)
XMLPart
traceString
in interface XMLPart
public Block getBodyBlock(int index, Object context, BlockFactory blockFactory) throws WebServiceException
XMLPart
getBodyBlock
in interface XMLPart
WebServiceException
getBodyBlock
public Block getBodyBlock(Object context, BlockFactory blockFactory) throws WebServiceException
XMLPart
getBodyBlock
in interface XMLPart
WebServiceException
public Block getHeaderBlock(String namespace, String localPart, Object context, BlockFactory blockFactory) throws WebServiceException
XMLPart
getHeaderBlock
in interface XMLPart
WebServiceException
public Set<QName> getHeaderQNames()
getHeaderQNames
in interface XMLPart
public List<Block> getHeaderBlocks(String namespace, String localPart, Object context, BlockFactory blockFactory, org.apache.axiom.soap.RolePlayer rolePlayer) throws WebServiceException
XMLPart
getHeaderBlocks
in interface XMLPart
namespace
- uri of headerlocalPart
- local name of headercontext
- context for blockFactoryblockFactory
- kind of factory (i.e. JAXB)WebServiceException
public int getNumBodyBlocks() throws WebServiceException
XMLPart
getNumBodyBlocks
in interface XMLPart
WebServiceException
public List<QName> getBodyBlockQNames() throws WebServiceException
getBodyBlockQNames
in interface XMLPart
WebServiceException
public int getNumHeaderBlocks() throws WebServiceException
XMLPart
getNumHeaderBlocks
in interface XMLPart
WebServiceException
public void removeBodyBlock(int index) throws WebServiceException
XMLPart
removeBodyBlock
in interface XMLPart
WebServiceException
public void removeHeaderBlock(String namespace, String localPart) throws WebServiceException
XMLPart
removeHeaderBlock
in interface XMLPart
WebServiceException
public void setBodyBlock(int index, Block block) throws WebServiceException
XMLPart
setBodyBlock
in interface XMLPart
WebServiceException
public void setBodyBlock(Block block) throws WebServiceException
XMLPart
setBodyBlock
in interface XMLPart
WebServiceException
public void setHeaderBlock(String namespace, String localPart, Block block) throws WebServiceException
XMLPart
setHeaderBlock
in interface XMLPart
WebServiceException
public void appendHeaderBlock(String namespace, String localPart, Block block) throws WebServiceException
XMLPart
appendHeaderBlock
in interface XMLPart
WebServiceException
public Message getParent()
XMLPart
public void setParent(Message p)
XMLPart
protected abstract org.apache.axiom.om.OMElement _convertSE2OM(SOAPEnvelope se) throws WebServiceException
se
- SOAPEnvelopeWebServiceException
protected abstract org.apache.axiom.om.OMElement _convertSpine2OM(org.apache.axis2.jaxws.message.impl.XMLSpine spine) throws WebServiceException
spine
- XMLSpineWebServiceException
protected abstract SOAPEnvelope _convertOM2SE(org.apache.axiom.om.OMElement om) throws WebServiceException
om
- WebServiceException
protected abstract SOAPEnvelope _convertSpine2SE(org.apache.axis2.jaxws.message.impl.XMLSpine spine) throws WebServiceException
spine
- WebServiceException
protected abstract org.apache.axis2.jaxws.message.impl.XMLSpine _convertOM2Spine(org.apache.axiom.om.OMElement om) throws WebServiceException
om
- WebServiceException
protected abstract org.apache.axis2.jaxws.message.impl.XMLSpine _convertSE2Spine(SOAPEnvelope se) throws WebServiceException
SOAPEnvelope
- WebServiceException
protected static org.apache.axis2.jaxws.message.impl.XMLSpine _createSpine(Protocol protocol, SOAPBinding.Style style, int indirection, org.apache.axiom.om.OMElement payload) throws WebServiceException
protocol
- WebServiceException
Copyright © 2004-2015 The Apache Software Foundation. All Rights Reserved.