| org.apache.axis2.jaxws.message.impl.XMLSpine
All known Subclasses: org.apache.axis2.jaxws.message.impl.XMLSpineImpl,
| XMLSpine | | interface XMLSpine (Code) | | XMLSpine
An XMLSpine is an optimized form of the xml part of the message. Currently there is only one
implementation (XMLSpineImpl).
See Also: XMLSpineImpl
See Also: for more details |
| Method Summary | |
| public OMElement | getAsOMElement()
| | public Block | getBodyBlock(int index, Object context, BlockFactory blockFactory)
getBodyBlock Get the body block at the specificed index. | | public Block | getBodyBlock(Object context, BlockFactory blockFactory)
getBodyBlock Get the single Body Block. | | public Block | getHeaderBlock(String namespace, String localPart, 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. | | public int | getNumBodyBlocks()
| | public int | getNumHeaderBlocks()
| | public QName | getOperationElement()
the QName of the operation element if Style.rpc. | | public Protocol | getProtocol()
| | public Style | getStyle()
| | public XMLFault | getXMLFault()
| | public XMLStreamReader | getXMLStreamReader(boolean consume)
| | public boolean | isConsumed()
isConsumed Return true if the part is consumed. | | public boolean | isFault()
| | public void | outputTo(XMLStreamWriter writer, boolean consume)
| | public void | removeBodyBlock(int index)
| | public void | removeHeaderBlock(String namespace, String localPart)
| | public void | setBodyBlock(int index, Block block)
setBodyBlock Set the block at the specified index Once set, the Message owns the block. | | public void | setBodyBlock(Block block)
setBodyBlock Set this as block as the single block for the message. | | public void | setHeaderBlock(String namespace, String localPart, Block block)
appendHeaderBlock Append the block to the list of header blocks. | | public void | setOperationElement(QName operationQName)
Set the operation element qname. | | public void | setParent(Message msg)
| | public void | setXMLFault(XMLFault xmlFault)
| | public 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. |
| getBodyBlock | | public Block getBodyBlock(int index, Object context, BlockFactory blockFactory) throws WebServiceException(Code) | | getBodyBlock Get the body block at the specificed index. The BlockFactory and object
context are passed in to help create the proper kind of block. Calling this method
will cache the OM.
Avoid it in performant situations.
Parameters:
index -
Parameters:
context -
Parameters:
blockFactory - Block or null
throws:
WebServiceException -
See Also: getBodyBlock |
| getBodyBlock | | public Block getBodyBlock(Object context, BlockFactory blockFactory) throws WebServiceException(Code) | | getBodyBlock Get the single Body Block. The BlockFactory and object context are passed in to
help create the proper kind of block. This method should only be invoked when it is known
that there is zero or one block.
Parameters:
index -
Parameters:
context -
Parameters:
blockFactory - Block or null
throws:
WebServiceException - |
| getHeaderBlock | | public Block getHeaderBlock(String namespace, String localPart, Object context, BlockFactory blockFactory) throws WebServiceException(Code) | | 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.
Parameters:
namespace -
Parameters:
localPart -
Parameters:
context -
Parameters:
blockFactory - Block
throws:
WebServiceException - |
| getOperationElement | | public QName getOperationElement() throws WebServiceException(Code) | | the QName of the operation element if Style.rpc. Otherwise null |
| getProtocol | | public Protocol getProtocol()(Code) | | Get the protocol for this Message (soap11, soap12, etc.)
Protocl |
| getStyle | | public Style getStyle()(Code) | | the Style (document or rpc) |
| getXMLFault | | public XMLFault getXMLFault() throws WebServiceException(Code) | | If the XMLPart represents a fault, an XMLFault is returned which describes the fault in a
protocol agnostic manner
the XMLFault object or null
See Also: XMLFault |
| isConsumed | | public boolean isConsumed()(Code) | | isConsumed Return true if the part is consumed. Once consumed, the information in the part
is no longer available.
true if the block is consumed (a method was called with consume=true) |
| isFault | | public boolean isFault() throws WebServiceException(Code) | | Determines whether the XMLPart represents a Fault
true if the message represents a fault |
| setBodyBlock | | public void setBodyBlock(int index, Block block) throws WebServiceException(Code) | | setBodyBlock Set the block at the specified index Once set, the Message owns the block. You
must use the getBodyBlock method to access it.
Parameters:
index -
Parameters:
block -
throws:
WebServiceException - |
| setHeaderBlock | | public void setHeaderBlock(String namespace, String localPart, Block block) throws WebServiceException(Code) | | appendHeaderBlock Append the block to the list of header blocks. The Message owns the block.
You must use the getHeaderBlock method to access it.
Parameters:
namespace -
Parameters:
localPart -
Parameters:
block -
throws:
WebServiceException - |
| setOperationElement | | public void setOperationElement(QName operationQName) throws WebServiceException(Code) | | Set the operation element qname. The operation qname is only used if Style.rpc
Parameters:
operationQName - |
| setParent | | public void setParent(Message msg)(Code) | | Used to identify the Message parent of the XMLSpine
Parameters:
msg - |
| traceString | | public String traceString(String indent)(Code) | | Get a traceString...the trace string dumps the contents of the Block without forcing an
underlying ill-performant transformation of the message.
String containing trace information |
|
|