Java Doc for XMLSpine.java in  » Web-Services-AXIS2 » jax-ws » org » apache » axis2 » jaxws » message » impl » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Services AXIS2 » jax ws » org.apache.axis2.jaxws.message.impl 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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  OMElementgetAsOMElement()
    
public  BlockgetBodyBlock(int index, Object context, BlockFactory blockFactory)
     getBodyBlock Get the body block at the specificed index.
public  BlockgetBodyBlock(Object context, BlockFactory blockFactory)
     getBodyBlock Get the single Body Block.
public  BlockgetHeaderBlock(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  intgetNumBodyBlocks()
    
public  intgetNumHeaderBlocks()
    
public  QNamegetOperationElement()
     the QName of the operation element if Style.rpc.
public  ProtocolgetProtocol()
    
public  StylegetStyle()
    
public  XMLFaultgetXMLFault()
    
public  XMLStreamReadergetXMLStreamReader(boolean consume)
    
public  booleanisConsumed()
     isConsumed Return true if the part is consumed.
public  booleanisFault()
    
public  voidoutputTo(XMLStreamWriter writer, boolean consume)
    
public  voidremoveBodyBlock(int index)
    
public  voidremoveHeaderBlock(String namespace, String localPart)
    
public  voidsetBodyBlock(int index, Block block)
     setBodyBlock Set the block at the specified index Once set, the Message owns the block.
public  voidsetBodyBlock(Block block)
     setBodyBlock Set this as block as the single block for the message.
public  voidsetHeaderBlock(String namespace, String localPart, Block block)
     appendHeaderBlock Append the block to the list of header blocks.
public  voidsetOperationElement(QName operationQName)
     Set the operation element qname.
public  voidsetParent(Message msg)
    
public  voidsetXMLFault(XMLFault xmlFault)
    
public  StringtraceString(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
getAsOMElement
public OMElement getAsOMElement() throws WebServiceException(Code)
getAsOMElement Get the xml part as a read/write OM OMElement (probably OM SOAPEnvelope)
throws:
  WebServiceException -



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 -



getNumBodyBlocks
public int getNumBodyBlocks() throws WebServiceException(Code)
getNumBodyBlocks number of body blocks
throws:
  WebServiceException -



getNumHeaderBlocks
public int getNumHeaderBlocks() throws WebServiceException(Code)
getNumHeaderBlocks number of header blocks
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



getXMLStreamReader
public XMLStreamReader getXMLStreamReader(boolean consume) throws WebServiceException(Code)
Get the XMLStreamReader represented by this Message for the xml part
Parameters:
  consume - true if this is the last request on the Message XMLStreamReader
throws:
  WebServiceException -
throws:
  XMLStreamException -



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



outputTo
public void outputTo(XMLStreamWriter writer, boolean consume) throws XMLStreamException, WebServiceException(Code)
Write out the Message
Parameters:
  writer - XMLStreamWriter
Parameters:
  consume - true if this is the last request on the block.
throws:
  WebServiceException -



removeBodyBlock
public void removeBodyBlock(int index) throws WebServiceException(Code)
removeBodyBlock Removes the indicated BodyBlock
Parameters:
  index -
throws:
  WebServiceException -



removeHeaderBlock
public void removeHeaderBlock(String namespace, String localPart) throws WebServiceException(Code)
removePayload Removes the indicated block
Parameters:
  namespace -
Parameters:
  localPart -
throws:
  WebServiceException -



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 -



setBodyBlock
public void setBodyBlock(Block block) throws WebServiceException(Code)
setBodyBlock Set this as block as the single block for the message.
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 -



setXMLFault
public void setXMLFault(XMLFault xmlFault) throws WebServiceException(Code)
Change the XMLPart so that it represents the fault described by XMLFault
Parameters:
  xmlfault -
See Also:   XMLFault



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



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.