001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.jms.client;
023:
024: import java.io.Serializable;
025:
026: import javax.jms.BytesMessage;
027: import javax.jms.Destination;
028: import javax.jms.JMSException;
029: import javax.jms.MapMessage;
030: import javax.jms.Message;
031: import javax.jms.MessageListener;
032: import javax.jms.ObjectMessage;
033: import javax.jms.Queue;
034: import javax.jms.StreamMessage;
035: import javax.jms.TextMessage;
036: import javax.transaction.xa.XAResource;
037:
038: /**
039: * The implementation of a session
040: *
041: * @author <a href="mailto:adrian@jboss.org>Adrian Brock</a>
042: * @version $Revision: 57195 $
043: */
044: public interface SessionDelegate extends Lifecycle {
045: // Constants -----------------------------------------------------
046:
047: // Public --------------------------------------------------------
048:
049: /**
050: *
051: * Acknowledge a message
052: *
053: * @param message the message to acknowledge
054: * @param acknowledge true for acknowledge, false for a Nack
055: */
056: void acknowledge(Message message, boolean acknowledge);
057:
058: /**
059: * Commit a session
060: *
061: * @throws JMSException for any error
062: */
063: void commit() throws JMSException;
064:
065: /**
066: * Create a queue browser
067: *
068: * @param queue the queue
069: * @param selector the message selector
070: * @return the browser
071: * @throws JMSException for any error
072: */
073: BrowserDelegate createBrowser(Queue queue, String selector)
074: throws JMSException;
075:
076: /**
077: * Create a bytes message
078: *
079: * @return the message
080: * @throws JMSException for any error
081: */
082: BytesMessage createBytesMessage() throws JMSException;
083:
084: /**
085: * Create a consumer
086: *
087: * @param destination the destination
088: * @param subscription the subscription name
089: * @param selector the message selector
090: * @param noLocal the no local flag
091: * @return the consumer
092: * @throws JMSException for any error
093: */
094: ConsumerDelegate createConsumer(Destination destination,
095: String subscription, String selector, boolean noLocal)
096: throws JMSException;
097:
098: /**
099: * Create a map message
100: *
101: * @return the message
102: * @throws JMSException for any error
103: */
104: MapMessage createMapMessage() throws JMSException;
105:
106: /**
107: * Create a message
108: *
109: * @return the message
110: * @throws JMSException for any error
111: */
112: Message createMessage() throws JMSException;
113:
114: /**
115: * Create an object message
116: *
117: * @param object the object
118: * @return the message
119: * @throws JMSException for any error
120: */
121: ObjectMessage createObjectMessage(Serializable object)
122: throws JMSException;
123:
124: /**
125: * Create a producer
126: *
127: * @param destination the destination
128: * @return the producer
129: * @throws JMSException for any error
130: */
131: ProducerDelegate createProducer(Destination destination)
132: throws JMSException;
133:
134: /**
135: * Create a stream message
136: *
137: * @return the message
138: * @throws JMSException for any error
139: */
140: StreamMessage createStreamMessage() throws JMSException;
141:
142: /**
143: * Create a temporary destination
144: *
145: * @param type the type of temporary destination
146: * @return the temporary destination
147: * @throws JMSException for any error
148: */
149: Destination createTempDestination(int type) throws JMSException;
150:
151: /**
152: * Create a text message
153: *
154: * @param text the text
155: * @return the message
156: * @throws JMSException for any error
157: */
158: TextMessage createTextMessage(String text) throws JMSException;
159:
160: /**
161: * Retrieve a destination
162: *
163: * @param name the implementation dependent name
164: * @return the destination
165: * @throws JMSException for any error
166: */
167: Destination getDestination(String name) throws JMSException;
168:
169: /**
170: * Retrieve the XAResource for this session
171: *
172: * @return the XAResource
173: */
174: XAResource getXAResource();
175:
176: /**
177: * Recover a session
178: *
179: * @throws JMSException for any error
180: */
181: void recover() throws JMSException;
182:
183: /**
184: * Rollback a session
185: *
186: * @throws JMSException for any error
187: */
188: void rollback() throws JMSException;
189:
190: /**
191: * Run the session listener
192: *
193: * @throws JMSException for any error
194: */
195: void run();
196:
197: /**
198: * Set the session's message listener
199: *
200: * @param listener the message listener
201: * @throws JMSException for any error
202: */
203: void setMessageListener(MessageListener listener)
204: throws JMSException;
205:
206: /**
207: * Unsubscribe the name
208: *
209: * @param name the name of the subscription
210: * @throws JMSException for any error
211: */
212: void unsubscribe(String name) throws JMSException;
213:
214: // Inner Classes --------------------------------------------------
215: }
|