/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.enterprise.admin.common.constant;

/**
    Constants needed by the JMS administration handler.
 */
public final class JMSAdminConstants
{
    // JMS Object types
    public static final String JMS_OBJ_TYPE_TOPIC		= "topic";
    public static final String JMS_OBJ_TYPE_QUEUE		= "queue";
    public static final String JMS_OBJ_TYPE_QUEUE_CONN_FACTORY	= "qconfactory";
    public static final String JMS_OBJ_TYPE_TOPIC_CONN_FACTORY	= "tconfactory";

    // JMS destination types
    public static final String JMS_DEST_TYPE_TOPIC		= "topic";
    public static final String JMS_DEST_TYPE_QUEUE		= "queue";

    // JMS Ping status values
    public static final String JMS_HOST_RUNNING			= "RUNNING";

    /**
        Convenience method for checking if the JMS object type specified is valid.

	@param objType The JMS object type.
	@return true if the object type specified was valid. False if it
	is not valid.
    */
    public static boolean isValidJMSObjType(String objType)
    {
	if ( (objType.equals(JMS_OBJ_TYPE_TOPIC)) ||
	     (objType.equals(JMS_OBJ_TYPE_QUEUE)) ||
	     (objType.equals(JMS_OBJ_TYPE_QUEUE_CONN_FACTORY)) ||
	     (objType.equals(JMS_OBJ_TYPE_TOPIC_CONN_FACTORY)) )
	{
	    return (true);
	}

	return (false);
    }

    /**
        Convenience method for checking if the JMS destination type specified 
	is valid.

	@param destType The destination type.
	@return true if the destination type specified was valid. False if it
	is not valid.
    */
    public static boolean isValidJMSDestType(String destType)
    {
	if ( (destType.equals(JMS_DEST_TYPE_TOPIC)) ||
	     (destType.equals(JMS_DEST_TYPE_QUEUE)) )
	{
	    return (true);
	}

	return (false);
    }
}
