
javax.jms.XAQueueConnectionFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ow2-jms-2.0-spec Show documentation
Show all versions of ow2-jms-2.0-spec Show documentation
The Java Message Service (JMS) API, version 2.0
The newest version!
/**
* Copyright 2013 ScalAgent Distributed Technologies
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ---------------------------------------------------------------------
* $Id: XAQueueConnectionFactory.java 6347 2013-03-13 08:52:02Z tachker $
* ---------------------------------------------------------------------
*/
package javax.jms;
/**
* An {@code XAQueueConnectionFactory} provides the same create options as a
* {@code QueueConnectionFactory} (optional).
*
* @see javax.jms.QueueConnectionFactory
* @see javax.jms.XAConnectionFactory
*
* @version JMS 2.0
* @since JMS 1.0
*
*/
public interface XAQueueConnectionFactory extends XAConnectionFactory,
QueueConnectionFactory {
/**
* Creates an XA queue 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 XA queue connection
*
* @exception JMSException
* if the JMS provider fails to create an XA queue connection due
* to some internal error.
* @exception JMSSecurityException
* if client authentication fails due to an invalid user name or
* password.
*/
XAQueueConnection createXAQueueConnection() throws JMSException;
/**
* Creates an XA queue 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 XA queue connection
*
* @exception JMSException
* if the JMS provider fails to create an XA queue connection due
* to some internal error.
* @exception JMSSecurityException
* if client authentication fails due to an invalid user name or
* password.
*/
XAQueueConnection createXAQueueConnection(String userName, String password)
throws JMSException;
}