|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XMLPart
Method Summary | |
---|---|
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,
java.lang.Object context,
BlockFactory blockFactory)
getBodyBlock Get the body block at the specificed index. |
Block |
getBodyBlock(java.lang.Object context,
BlockFactory blockFactory)
getBodyBlock Get the single Body Block. |
Block |
getHeaderBlock(java.lang.String namespace,
java.lang.String localPart,
java.lang.Object context,
BlockFactory blockFactory)
getHeaderBlock Get the header block with the specified name The BlockFactory and object context are passed in to help create the proper kind of block. |
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 |
java.lang.String |
getXMLPartContentType()
The representation of the XMLPart may be in a number of different forms. |
javax.xml.stream.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(javax.xml.stream.XMLStreamWriter writer,
boolean consume)
Write out the Message |
void |
removeBodyBlock(int index)
removeBodyBlock Removes the indicated BodyBlock |
void |
removeHeaderBlock(java.lang.String namespace,
java.lang.String localPart)
removePayload Removes the indicated block |
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(java.lang.String namespace,
java.lang.String localPart,
Block block)
appendHeaderBlock Append the block to the list of header blocks. |
void |
setIndirection(int indirection)
Set indirection. |
void |
setOperationElement(QName operationQName)
Set the operation element qname. |
void |
setParent(Message m)
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 |
java.lang.String |
traceString(java.lang.String indent)
Get a traceString...the trace string dumps the contents of the Block without forcing an underlying ill-performant transformation of the message. |
Method Detail |
---|
Protocol getProtocol()
void outputTo(javax.xml.stream.XMLStreamWriter writer, boolean consume) throws javax.xml.stream.XMLStreamException, WebServiceException
writer
- XMLStreamWriterconsume
- true if this is the last request on the block.
WebServiceException
javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamReader getXMLStreamReader(boolean consume) throws WebServiceException
consume
- true if this is the last request on the Message
WebServiceException
javax.xml.stream.XMLStreamException
SOAPBinding.Style getStyle()
void setStyle(SOAPBinding.Style style) throws WebServiceException
style
- Style
WebServiceException
indirection
void setIndirection(int indirection)
indirection
- (0 or 1)int getIndirection()
QName getOperationElement() throws WebServiceException
WebServiceException
void setOperationElement(QName operationQName) throws WebServiceException
operationQName
-
WebServiceException
boolean isConsumed()
boolean isFault() throws WebServiceException
WebServiceException
XMLFault getXMLFault() throws WebServiceException
WebServiceException
XMLFault
void setXMLFault(XMLFault xmlFault) throws WebServiceException
xmlfault
-
WebServiceException
XMLFault
Message getParent()
void setParent(Message m)
m
- SOAPEnvelope getAsSOAPEnvelope() throws WebServiceException
WebServiceException
org.apache.axiom.om.OMElement getAsOMElement() throws WebServiceException
WebServiceException
int getNumBodyBlocks() throws WebServiceException
WebServiceException
Block getBodyBlock(int index, java.lang.Object context, BlockFactory blockFactory) throws WebServiceException
index
- context
- blockFactory
-
WebServiceException
getBodyBlock
Block getBodyBlock(java.lang.Object context, BlockFactory blockFactory) throws WebServiceException
index
- context
- blockFactory
-
WebServiceException
void setBodyBlock(int index, Block block) throws WebServiceException
index
- block
-
WebServiceException
void setBodyBlock(Block block) throws WebServiceException
index
- block
-
WebServiceException
void removeBodyBlock(int index) throws WebServiceException
index
-
WebServiceException
int getNumHeaderBlocks() throws WebServiceException
WebServiceException
Block getHeaderBlock(java.lang.String namespace, java.lang.String localPart, java.lang.Object context, BlockFactory blockFactory) throws WebServiceException
namespace
- localPart
- context
- blockFactory
-
WebServiceException
void setHeaderBlock(java.lang.String namespace, java.lang.String localPart, Block block) throws WebServiceException
namespace
- localPart
- block
-
WebServiceException
void removeHeaderBlock(java.lang.String namespace, java.lang.String localPart) throws WebServiceException
namespace
- localPart
-
WebServiceException
java.lang.String traceString(java.lang.String indent)
java.lang.String getXMLPartContentType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |