001/*
002 * Copyright 2011 Atteo.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
005 * in compliance with the License. You may obtain a copy of the License at
006 *
007 * http://www.apache.org/licenses/LICENSE-2.0
008 *
009 * Unless required by applicable law or agreed to in writing, software distributed under the License
010 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
011 * or implied. See the License for the specific language governing permissions and limitations under
012 * the License.
013 */
014package org.atteo.moonshine.jta;
015
016import javax.annotation.Nullable;
017import javax.jms.ConnectionFactory;
018import javax.jms.XAConnectionFactory;
019
020
021/**
022 * Wraps {@link XAConnectionFactory} into {@link ConnectionFactory} adding transaction support.
023 */
024public interface JtaConnectionFactoryWrapper {
025    /**
026     * Wrap given {@link XAConnectionFactory} into {@link ConnectionFactory} adding transaction support.
027     * @param name unique name for the returned {@link ConnectionFactory}
028     * @param xaFactory {@link ConnectionFactory} to wrap
029     * @param poolOptions options for the connection pool
030     * @return wrapped {@link ConnectionFactory}
031     */
032    ConnectionFactory wrap(String name, XAConnectionFactory xaFactory,
033            @Nullable PoolOptions poolOptions);
034
035    /**
036     * Close previously wrapped connection factory.
037     * @param connectionFactory connection factory to close
038     */
039    void close(ConnectionFactory connectionFactory);
040}