JMSConnectionInfo.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.client;

import java.util.Properties;

import org.apache.oozie.AppType;

/**
 * JMS connection related information
 *
 */
public interface JMSConnectionInfo {

    /**
     * Get the topic prefix for a JMS topic
     * @return JMS topic prefix
     */
    String getTopicPrefix();

    /**
     * Get the topic pattern given the app type of job
     * @param appType the appType for a job
     * @return JMS topic pattern
     */
    String getTopicPattern(AppType appType);

    /**
     * Retrieve the JNDI properties for establishing connection to JMS server
     * @return the JNDI properties
     */
    Properties getJNDIProperties();

}