jakarta.jms.TopicConnectionFactory Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.jms;
/**
* A client uses a {@code TopicConnectionFactory} object to create {@code TopicConnection} objects with a
* publish/subscribe Jakarta Messaging provider.
*
*
* A{@code TopicConnectionFactory} can be used to create a {@code TopicConnection}, from which specialized
* topic-related objects can be created. A more general, and recommended approach is to use the
* {@code ConnectionFactory} object.
*
*
* The {@code TopicConnectionFactory} object should be used to support existing code.
*
* @see jakarta.jms.ConnectionFactory
*
* @version Jakarta Messaging 2.0
* @since JMS 1.0
*/
public interface TopicConnectionFactory extends ConnectionFactory {
/**
* Creates a topic connection with the default user identity. The connection is created in stopped mode. No messages
* will be delivered until the {@code Connection.start} method is explicitly called.
*
* @return a newly created topic connection
*
* @exception JMSException if the Jakarta Messaging provider fails to create a topic connection due to some internal error.
* @exception JMSSecurityException if client authentication fails due to an invalid user name or password.
*/
TopicConnection createTopicConnection() throws JMSException;
/**
* Creates a topic connection with the specified user identity. The connection is created in stopped mode. No messages
* will be delivered until the {@code Connection.start} method is explicitly called.
*
* @param userName the caller's user name
* @param password the caller's password
*
* @return a newly created topic connection
*
* @exception JMSException if the Jakarta Messaging provider fails to create a topic connection due to some internal error.
* @exception JMSSecurityException if client authentication fails due to an invalid user name or password.
*/
TopicConnection createTopicConnection(String userName, String password) throws JMSException;
}