Java Doc for WSIFJMSDestination.java in  » Web-Services » wsif » org » apache » wsif » util » jms » 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 » wsif » org.apache.wsif.util.jms 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.wsif.util.jms.WSIFJMSDestination

All known Subclasses:   org.apache.wsif.util.jms.JMS2HTTPBridgeDestination,
WSIFJMSDestination
public class WSIFJMSDestination (Code)
A WSIFJMSDestination is a pair of queues, one that read from and the other that is written to. This class provides various methods for different flavours of reading and writing messages to those queues. This class hides the JMS interface.
author:
   Mark Whitlock


Field Summary
protected  booleanasyncMode
    
protected  QueueConnectionconnection
    
protected  WSIFJMSFinderfinder
    
protected  WSIFJMSPropertiesinProps
    
protected  MessagelastMessage
    
protected  WSIFJMSPropertiesoutProps
    
protected  QueuereadQ
    
protected  StringreplyToName
    
protected  QueueSendersender
    
protected  QueueSessionsession
    
protected  QueuesyncTempQueue
    
protected  longtimeout
    
protected  QueuewriteQ
    

Constructor Summary
public  WSIFJMSDestination(WSIFJMSFinder finder)
     Public constructor.
public  WSIFJMSDestination(WSIFJMSFinder finder, long timeout)
     Public constructor.
public  WSIFJMSDestination(WSIFJMSFinder finder, String altDestName, long timeout)
     Public constructor.

Method Summary
protected  voidareWeClosed()
    
public  voidclose()
     Close all objects.
public static  MessagecreateMessage(Session session, int msgType)
    
public  MessagecreateMessage(int msgType)
    
public  Stringdeep()
    
public  voidfinalize()
     close the destination at finalize.
public  HashMapgetProperties()
     Gets all the JMS properties from the previous message that was received.
public  ObjectgetProperty(String name)
     Gets a JMS property from the previous message that was received.
public  Stringreceive()
    
public  Messagereceive(String id)
    
public  Messagereceive(String id, long timeout)
    
public  StringreceiveString(String id)
    
public  StringreceiveString(String id, long timeout)
    
public  Stringsend(String data)
    
public  Stringsend(String data, String id)
    
public  Stringsend(Serializable data)
    
public  Stringsend(Serializable data, String id)
    
public  Stringsend(Message msg, String id, boolean setReplyTo)
     Sends a message to the write queue.
Parameters:
  message -
Parameters:
  id - Correlation id
Parameters:
  setReplyTo - If true JMSReplyTo is always set.
public  voidsetAsyncMode(boolean b)
     Sets if this destination is to be used for asynchronous requests. If this destination is to be used for asynchronous requests then a WSIFJMSAsyncListener will be created to listen for the async responses.
public  voidsetLastMessage(Message msg)
     The last message is the most recent message that was received by this WSIFJMSDestination.
public  voidsetProperties(HashMap propMap)
     Sets a HashMap of JMS property value pairs.
public  voidsetProperty(String name, Object value)
     Sets a JMS property to a value.
public  voidsetReplyToQueue()
     Set the replyTo queue to a temporary queue.
public  voidsetReplyToQueue(String replyTo)
     Set the replyTo queue.

Field Detail
asyncMode
protected boolean asyncMode(Code)



connection
protected QueueConnection connection(Code)



finder
protected WSIFJMSFinder finder(Code)



inProps
protected WSIFJMSProperties inProps(Code)



lastMessage
protected Message lastMessage(Code)



outProps
protected WSIFJMSProperties outProps(Code)



readQ
protected Queue readQ(Code)



replyToName
protected String replyToName(Code)



sender
protected QueueSender sender(Code)



session
protected QueueSession session(Code)



syncTempQueue
protected Queue syncTempQueue(Code)



timeout
protected long timeout(Code)



writeQ
protected Queue writeQ(Code)




Constructor Detail
WSIFJMSDestination
public WSIFJMSDestination(WSIFJMSFinder finder) throws WSIFException(Code)
Public constructor.
Parameters:
  finder - used to find JMS objects.



WSIFJMSDestination
public WSIFJMSDestination(WSIFJMSFinder finder, long timeout) throws WSIFException(Code)
Public constructor.
Parameters:
  finder - used to find JMS objects.
Parameters:
  timeout - is the maximum time to wait on a synchronous receive



WSIFJMSDestination
public WSIFJMSDestination(WSIFJMSFinder finder, String altDestName, long timeout) throws WSIFException(Code)
Public constructor.
Parameters:
  finder - used to find JMS objects.
Parameters:
  altdestName - is an alterative JMS provider destination name
Parameters:
  timeout - is the maximum time to wait on a synchronous receive




Method Detail
areWeClosed
protected void areWeClosed() throws WSIFException(Code)



close
public void close() throws WSIFException(Code)
Close all objects.



createMessage
public static Message createMessage(Session session, int msgType) throws WSIFException(Code)



createMessage
public Message createMessage(int msgType) throws WSIFException(Code)



deep
public String deep()(Code)



finalize
public void finalize() throws WSIFException(Code)
close the destination at finalize.



getProperties
public HashMap getProperties() throws WSIFException(Code)
Gets all the JMS properties from the previous message that was received.



getProperty
public Object getProperty(String name) throws WSIFException(Code)
Gets a JMS property from the previous message that was received.



receive
public String receive() throws WSIFException(Code)
Blocking receive for the wsif.syncrequest.timeout the received message



receive
public Message receive(String id) throws WSIFException(Code)
Blocking receive waits for a message for the wsif.syncrequest.timeout
Parameters:
  id - is the correlation id that the received message must have the received message



receive
public Message receive(String id, long timeout) throws WSIFException(Code)
Blocking receive waits for a message for the specified timeout
Parameters:
  id - is the correlation id that the received message must have
Parameters:
  timeout - how long in milliseconds to wait the received message



receiveString
public String receiveString(String id) throws WSIFException(Code)
Blocking receive for the wsif.syncrequest.timeout the received message



receiveString
public String receiveString(String id, long timeout) throws WSIFException(Code)
Blocking receive waits for the specified timeout the received message



send
public String send(String data) throws WSIFException(Code)
Send a message to the write queue
Parameters:
  data - is the message the id of the message that was sent.



send
public String send(String data, String id) throws WSIFException(Code)
Send a message to the write queue
Parameters:
  data - is the message
Parameters:
  id - is the correlation id to set on the message the id of the message that was sent.



send
public String send(Serializable data) throws WSIFException(Code)
Send a message to the write queue
Parameters:
  data - is the message the id of the message that was sent.



send
public String send(Serializable data, String id) throws WSIFException(Code)
Send a message to the write queue
Parameters:
  data - is the message
Parameters:
  id - is the correlation id to set on the message the id of the message that was sent.



send
public String send(Message msg, String id, boolean setReplyTo) throws WSIFException(Code)
Sends a message to the write queue.
Parameters:
  message -
Parameters:
  id - Correlation id
Parameters:
  setReplyTo - If true JMSReplyTo is always set. If false JMSReplyTo is only set if the ReplyTo was explicitly set as a property.



setAsyncMode
public void setAsyncMode(boolean b) throws WSIFException(Code)
Sets if this destination is to be used for asynchronous requests. If this destination is to be used for asynchronous requests then a WSIFJMSAsyncListener will be created to listen for the async responses.
Parameters:
  b - true if this destination is to be used for asynchronous requests,otherwise false.



setLastMessage
public void setLastMessage(Message msg)(Code)
The last message is the most recent message that was received by this WSIFJMSDestination. The getProperty(s) methods return the properties that are on the lastMessage. The works fine for sync, but for async user code will have received the message. So the provider must inform the WSIFJMSDestination about the lastMessage explicitly so it can inquire correctly about any jms properties on it.



setProperties
public void setProperties(HashMap propMap)(Code)
Sets a HashMap of JMS property value pairs. The property values will be only be used for the next message that is sent, then all the properties will be reset.



setProperty
public void setProperty(String name, Object value) throws WSIFException(Code)
Sets a JMS property to a value. This property value will be only be used for the next message that is sent, then the property will be reset.



setReplyToQueue
public void setReplyToQueue() throws WSIFException(Code)
Set the replyTo queue to a temporary queue.



setReplyToQueue
public void setReplyToQueue(String replyTo) throws WSIFException(Code)
Set the replyTo queue.
Parameters:
  replyTo - queue name.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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