001/*
002 * Copyright 2012-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.jms;
018
019import javax.jms.ConnectionFactory;
020import javax.jms.XAConnectionFactory;
021import javax.transaction.TransactionManager;
022
023/**
024 * Strategy interface used to wrap a JMS {@link XAConnectionFactory} enrolling it with a
025 * JTA {@link TransactionManager}.
026 *
027 * @author Phillip Webb
028 * @since 2.0.0
029 */
030@FunctionalInterface
031public interface XAConnectionFactoryWrapper {
032
033        /**
034         * Wrap the specific {@link XAConnectionFactory} and enroll it with a JTA
035         * {@link TransactionManager}.
036         * @param connectionFactory the connection factory to wrap
037         * @return the wrapped connection factory
038         * @throws Exception if the connection factory cannot be wrapped
039         */
040        ConnectionFactory wrapConnectionFactory(XAConnectionFactory connectionFactory)
041                        throws Exception;
042
043}