org.apache.felix.webconsole.VariableResolver 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;

import org.apache.felix.webconsole.servlet.RequestVariableResolver;
import org.osgi.annotation.versioning.ConsumerType;

/**
 * The VariableResolver interface defines the API for an object
 * which may be provided by plugins to provide replacement values for
 * variables in the generated content.
 * 
 * Plugins should call the
 * {@link WebConsoleUtil#setVariableResolver(javax.servlet.ServletRequest, VariableResolver)}
 * method to provide their implementation for variable resolution.
 * 

 * The main use of such a variable resolver is when a plugin is using a static
 * template which provides slots to place dynamically generated content
 * parts.
 * 
 * Note: The variable resolver must be set in the request before
 * the response writer is retrieved calling the
 * ServletRequest.getWriter() method. Otherwise the variable
 * resolver will not be used for resolving variables.
 *
 * @see WebConsoleUtil#getVariableResolver(javax.servlet.ServletRequest)
 * @see WebConsoleUtil#setVariableResolver(javax.servlet.ServletRequest, VariableResolver)
 * @deprecated Use {@link RequestVariableResolver} instead.
 */
@ConsumerType
@Deprecated
public interface VariableResolver {

    /**
     * Returns a replacement value for the named variable or null
     * if no replacement is available.
     *
     * @param variable The name of the variable for which to return a
     *      replacement.
     * @return The replacement value or null if no replacement is
     *      available.
     */
    String resolve( String variable );
}