org.glassfish.api.admingui.ConsoleProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of glassfish-api Show documentation

The newest version!

/*
 * Copyright (c) 2008, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.api.admingui;

import java.net.URL;

import org.jvnet.hk2.annotations.Contract;

/**
 * 
 * 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 URL to
 * the console-config.xml file.
 * 
 *
 * @author Ken Paulsen ([email protected])
 */
@Contract
public interface ConsoleProvider {

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

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