core/src/main/java/org/apache/oozie/jms/ConnectionContext.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

package org.apache.oozie.jms;

import java.util.Properties;

import javax.jms.ExceptionListener;
import javax.jms.JMSException;
import javax.jms.MessageConsumer;
import javax.jms.MessageProducer;
import javax.jms.Session;
import javax.naming.NamingException;

/**
 * Maintains a JMS connection for creating session, consumer and producer
 */
public interface ConnectionContext {

    /**
     * Create connection using properties
     *
     * @param props the properties used for creating jndi context
     * @throws NamingException if there is naming issue
     * @throws JMSException if JMS issue occurs
     */
    void createConnection(Properties props) throws NamingException, JMSException;

    /**
     * Set the exception Listener
     *
     * @param exceptionListener exception listener
     * @throws JMSException if JMS issue occurs
     */
    void setExceptionListener(ExceptionListener exceptionListener) throws JMSException;

    /**
     * Checks whether connection is initialized or not
     *
     * @return true if connection is initialized
     */
    boolean isConnectionInitialized();

    /**
     * Creates session using the specified session opts
     *
     * @param sessionOpts session options
     * @return Session returns session using the specified session opts
     * @throws JMSException if JMS issue occurs
     */
    Session createSession(int sessionOpts) throws JMSException;

    /**
     * Creates consumer using session and topic name
     *
     * @param session session
     * @param topicName topic name
     * @return MessageConsumer returns consumer using session and topic name
     * @throws JMSException if JMS issue occurs
     */
    MessageConsumer createConsumer(Session session, String topicName) throws JMSException;

    /**
     * Creates consumer using session, topic name and selector
     *
     * @param session session
     * @param topicName topic name
     * @param selector selector
     * @return MessageConsumer returns consumer using session, topic name and selector
     * @throws JMSException if JMS issue occurs
     */
    MessageConsumer createConsumer(Session session, String topicName, String selector) throws JMSException;

    /**
     * Creates producer using session and topic
     *
     * @param session session
     * @param topicName topic name
     * @return MessageProducer returns producer using session and topic name
     * @throws JMSException if JMS issue occurs
     */
    MessageProducer createProducer(Session session, String topicName) throws JMSException;

    /**
     * Creates a threadlocal session using session opts
     *
     * @param sessionOpts session options
     * @return Session returns a threadlocal session using session opts
     * @throws JMSException if JMS issue occurs
     */
    Session createThreadLocalSession(final int sessionOpts) throws JMSException;

    /**
     * Closes the connection
     */
    void close();

}