/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2010 Oracle and/or its affiliates. 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_1_1.html
 * or packager/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 packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [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 org.glassfish.api.admingui;

import org.jvnet.hk2.annotations.Contract;

import java.net.URL;


/**
 *  <p>	This interface exists to provide a marker for locating modules which
 *	provide GUI features to be displayed in the GlassFish admin console.
 *	The {@link #getConfiguration()} method should either return (null), or
 *	a <code>URL</code> to the console-config.xml file.</p>
 *
 *  @author Ken Paulsen	(ken.paulsen@sun.com)
 */
@Contract
public interface ConsoleProvider {

    /**
     *	<p> Returns a <code>URL</code> to the <code>console-config.xml</code>
     *	    file, or <code>null</code>.  If <code>null</code> is returned, the
     *	    default ({@link #DEFAULT_CONFIG_FILENAME}) will be used.</p>
     */
    public URL getConfiguration();

    /**
     *	<p> The default location of the <code>console-config.xml</code>.</p>
     */
    public String DEFAULT_CONFIG_FILENAME   =
	"META-INF/admingui/console-config.xml";
}