org.apache.felix.webconsole.servlet.ServletConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.felix.webconsole Show documentation
Web Based Management Console for OSGi Frameworks. See http://felix.apache.org/site/apache-felix-web-console.html for more information on this bundle.
There is a newer version: 5.0.8
Show newest version
/*
 * 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.felix.webconsole.servlet;

/**
 * Constants for servlets registered with the web console.
 */
public abstract class ServletConstants {

    /**
     * The URI address label under which the servlet is called by
     * the web console (value is "felix.webconsole.label").
     * 
     * This service registration property must be set to a single non-empty
     * String value. Otherwise the Servlet services will
     * be ignored by the web console and not be used as a plugin.
     */
    public static final String PLUGIN_LABEL = "felix.webconsole.label";

    /**
     * The title under which the servlet is called by
     * the web console (value is "felix.webconsole.title").
     * 

     * This property is required for the service to be used as a plugin. 
     * Otherwise the service is just ignored by the web console.
     */
    public static final String PLUGIN_TITLE = "felix.webconsole.title";

    /**
     * The category under which the servlet is listed in the top
     * navigation by the web console (value is "felix.webconsole.category").
     * 

     * If not specified, the servlet is put into the default category.
     */
    public static final String PLUGIN_CATEGORY = "felix.webconsole.category";

    /**
     * The name of the service registration properties providing references
     * to addition CSS files that should be loaded when rendering the header
     * for a registered plugin.
     * 

     * This property is expected to be a single string value, array of string
     * values or a Collection (or Vector) of string values.
     */
    public static final String PLUGIN_CSS_REFERENCES = "felix.webconsole.css";

    /**
     * The name of the request attribute providing the absolute path of the
     * Web Console root (value is "felix.webconsole.appRoot"). This consists of
     * the servlet context path (from HttpServletRequest.getContextPath())
     * and the Web Console servlet path (from
     * HttpServletRequest.getServletPath(),
     * /system/console by default).
     * 

     * The type of this request attribute is String.
     */
    public static final String ATTR_APP_ROOT = "felix.webconsole.appRoot";

    /**
     * The name of the request attribute providing the absolute path of the
     * current plugin (value is "felix.webconsole.pluginRoot"). This consists of
     * the servlet context path (from ServletRequest.getContextPath()),
     * the configured path of the web console root (/system/console
     * by default) and the plugin label {@link #PLUGIN_LABEL}.
     * 

     * The type of this request attribute is String.
     */
    public static final String ATTR_PLUGIN_ROOT = "felix.webconsole.pluginRoot";

    /**
     * The name of the request attribute holding the configuration params {@link java.util.Map}
     * for the request (value is "felix.webconsole.configuration").
     * 

     * The type of this request attribute is Map<String, Object>.
     * 
     * This map contains the web console configuration params managed by the web console.
     * It can be used to access to the configuration values while processing requests.
     */
    public static final String ATTR_CONFIGURATION = "felix.webconsole.configuration";
}