01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.jms;
23:
24: /** A client uses a <CODE>TopicConnectionFactory</CODE> object to create
25: * <CODE>TopicConnection</CODE> objects with a publish/subscribe JMS provider.
26: *
27: * <P>A<CODE> TopicConnectionFactory</CODE> can be used to create a
28: * <CODE>TopicConnection</CODE>, from which specialized topic-related objects
29: * can be created. A more general, and recommended approach
30: * is to use the <CODE>ConnectionFactory</CODE> object.
31: *
32: * <P> The <CODE>TopicConnectionFactory</CODE> object
33: * should be used to support existing code.
34: *
35: * @see javax.jms.ConnectionFactory
36: */
37:
38: public interface TopicConnectionFactory extends ConnectionFactory {
39:
40: /** Creates a topic connection with the default user identity.
41: * The connection is created in stopped mode. No messages
42: * will be delivered until the <code>Connection.start</code> method
43: * is explicitly called.
44: *
45: * @return a newly created topic connection
46: *
47: * @exception JMSException if the JMS provider fails to create a topic
48: * connection due to some internal error.
49: * @exception JMSSecurityException if client authentication fails due to
50: * an invalid user name or password.
51: */
52:
53: TopicConnection createTopicConnection() throws JMSException;
54:
55: /** Creates a topic connection with the specified user identity.
56: * The connection is created in stopped mode. No messages
57: * will be delivered until the <code>Connection.start</code> method
58: * is explicitly called.
59: *
60: * @param userName the caller's user name
61: * @param password the caller's password
62: *
63: * @return a newly created topic connection
64: *
65: * @exception JMSException if the JMS provider fails to create a topic
66: * connection due to some internal error.
67: * @exception JMSSecurityException if client authentication fails due to
68: * an invalid user name or password.
69: */
70:
71: TopicConnection createTopicConnection(String userName,
72: String password) throws JMSException;
73: }
|