Package org.apache.felix.webconsole.servlet

Class RequestVariableResolver

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
    Direct Known Subclasses:
    DefaultVariableResolver
    public class RequestVariableResolver
extends java.util.HashMap<java.lang.String,​java.lang.Object>
    The RequestVariableResolver is a HashMap that is used by the webconsole to process variables in the template. The resolver is stored as a request attribute with the name REQUEST_ATTRIBUTE.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String KEY_APP_ROOT
      The name of the key providing the absolute path of the Web Console root.
      static java.lang.String KEY_PLUGIN_ROOT
      The name of the key providing the absolute path of the current plugin.
      static java.lang.String REQUEST_ATTRIBUTE
      The name of the request attribute holding the RequestVariableResolver for the request (value is "felix.webconsole.variable.resolver").

    • Constructor Summary

      Constructors 
      Constructor Description
      RequestVariableResolver()
      Creates a new variable resolver with default capacity.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String resolve​(java.lang.String variable)
      Returns the string representation of the value stored under the variable name in this map.

      • Methods inherited from class java.util.HashMap

        clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

      • Methods inherited from class java.util.AbstractMap

        equals, hashCode, toString

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        equals, hashCode

    • Field Detail

      • REQUEST_ATTRIBUTE

        public static final java.lang.String REQUEST_ATTRIBUTE
        The name of the request attribute holding the RequestVariableResolver for the request (value is "felix.webconsole.variable.resolver"). This attribute is guaaranteed to be set for plugins.
        See Also:
        Constant Field Values

    • Constructor Detail

      • RequestVariableResolver

        public RequestVariableResolver()
        Creates a new variable resolver with default capacity.

    • Method Detail

      • resolve

        public java.lang.String resolve​(java.lang.String variable)
        Returns the string representation of the value stored under the variable name in this map. If no value is stored under the variable name, null is returned.
        Parameters:
        variable - The name of the variable whose value is to be returned.
        Returns:
        The variable value or null if there is no entry with the given name in this map.