Java Doc for MuleMessage.java in  » ESB » mule » org » mule » api » 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 » ESB » mule » org.mule.api 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.mule.api.MuleMessage

All known Subclasses:   org.mule.DefaultMuleMessage,
MuleMessage
public interface MuleMessage extends MessageAdapter(Code)
MuleMessage represents a message payload. The Message comprises of the payload itself and properties associated with the payload.




Method Summary
public  voidapplyTransformers(List transformers)
     Will apply a list of transformers to the payload of the message.
public  voidapplyTransformers(List transformers, Class outputType)
     Will apply a list of transformers to the payload of the message.
 MessageAdaptergetAdapter()
     Returns the currently edited Message adapter for this message.
 ObjectgetOrginalPayload()
     Returns the original payload used to create this message.
 MessageAdaptergetOriginalAdapter()
     Returns the original payload used to create this message.
 ObjectgetPayload(Class outputType)
     Will attempt to obtain the payload of this message with the desired Class type.
 byte[]getPayloadAsBytes()
    
 StringgetPayloadAsString(String encoding)
     Converts the message implementation into a String representation
Parameters:
  encoding - The encoding to use when transforming the message (ifnecessary).
 StringgetPayloadAsString()
     Converts the message implementation into a String representation.
 voidsetPayload(Object payload)
     Update the message payload.



Method Detail
applyTransformers
public void applyTransformers(List transformers) throws TransformerException(Code)
Will apply a list of transformers to the payload of the message. This *Will* change the payload of the message. This method provides the only way to alter the paylaod of this message without recreating a copy of the message
Parameters:
  transformers - the transformers to apply to the message payload
throws:
  TransformerException - if a transformation error occurs or one or more of the transformers passed in aare incompatible with the message payload



applyTransformers
public void applyTransformers(List transformers, Class outputType) throws TransformerException(Code)
Will apply a list of transformers to the payload of the message. This *Will* change the payload of the message. This method provides the only way to alter the paylaod of this message without recreating a copy of the message
Parameters:
  transformers - the transformers to apply to the message payload
Parameters:
  outputType - the required output type for this transformation. by adding this parameter some additionaltransformations will occur on the message payload to ensure that the final payload is of the specified type.If no transformers can be found in the registry that can transform from the return type of the transformationlist to the outputType and exception will be thrown
throws:
  TransformerException - if a transformation error occurs or one or more of the transformers passed in aare incompatible with the message payload



getAdapter
MessageAdapter getAdapter()(Code)
Returns the currently edited Message adapter for this message. If no edits have been made this methd will return the same as MuleMessage.getOriginalAdapter()



getOrginalPayload
Object getOrginalPayload()(Code)
Returns the original payload used to create this message. The payload of the message can change if MuleMessage.applyTransformers(java.util.List) or MuleMessage.applyTransformers(java.util.List,Class) is called. the original payload used to create this message



getOriginalAdapter
MessageAdapter getOriginalAdapter()(Code)
Returns the original payload used to create this message. The payload of the message can change if MuleMessage.applyTransformers(java.util.List) or MuleMessage.applyTransformers(java.util.List,Class) is called. the original payload used to create this message



getPayload
Object getPayload(Class outputType) throws TransformerException(Code)
Will attempt to obtain the payload of this message with the desired Class type. This will try and resolve a trnsformr that can do this transformation. If a transformer cannot be found an exception is thrown. Any transfromers added to the reqgistry will be checked for compatability
Parameters:
  outputType - the desired return type The converted payload of this message. Note that this method will not alter the payload of thismessage *unless* the payload is an inputstream in which case the stream will be read and the payload will becomethe fully read stream.
throws:
  TransformerException - if a transformer cannot be found or there is an error during transformation of thepayload



getPayloadAsBytes
byte[] getPayloadAsBytes() throws Exception(Code)
Converts the message implementation into a byte array representation byte array of the message
throws:
  Exception - Implemetation may throw an endpoint specific exception



getPayloadAsString
String getPayloadAsString(String encoding) throws Exception(Code)
Converts the message implementation into a String representation
Parameters:
  encoding - The encoding to use when transforming the message (ifnecessary). The parameter is used when converting from a byte array String representation of the message payload
throws:
  Exception - Implementation may throw an endpoint specific exception



getPayloadAsString
String getPayloadAsString() throws Exception(Code)
Converts the message implementation into a String representation. If encoding is required it will use the encoding set on the message String representation of the message payload
throws:
  Exception - Implementation may throw an endpoint specific exception



setPayload
void setPayload(Object payload)(Code)
Update the message payload. This is typically only called if the payload was originally an InputStream. In which case, if the InputStream is consumed, it needs to be replaced for future access.
Parameters:
  payload - the object to assign as the message payload



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