Package org.apache.log

Class ContextMap

  • All Implemented Interfaces:
    java.io.Serializable 
    @Deprecated() 
public final class ContextMap
 implements Serializable

    The ContextMap contains non-hierarchical context information relevant to a particular LogEvent. It may include information such as;

    • user ->fred
    • hostname ->helm.realityforge.org
    • ipaddress ->1.2.3.4
    • interface ->127.0.0.1
    • caller ->com.biz.MyCaller.method(MyCaller.java:18)
    • source ->1.6.3.2:33
    The context is bound to a thread (and inherited by sub-threads) but it can also be added to by LogTargets.
    Author:

    Avalon Development Team

    Peter Donald

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description
      ContextMap() Default constructor.
      ContextMap(ContextMap parent) Constructor that sets parent contextMap.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final static ContextMap getCurrentContext() Get the Current ContextMap.
      final static ContextMap getCurrentContext(boolean autocreate) Get the Current ContextMap.
      final static void bind(ContextMap context) Bind a particular ContextMap to current thread.
      void makeReadOnly() Make the context read-only.
      boolean isReadOnly() Determine if context is read-only.
      void clear() Empty the context map.
      Object get(String key, Object defaultObject) Get an entry from the context.
      Object get(String key) Get an entry from the context.
      void set(String key, Object value) Set a value in context
      int getSize() Get the number of contexts in map.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ContextMap

        ContextMap()
        Default constructor.

      • ContextMap

        ContextMap(ContextMap parent)
        Constructor that sets parent contextMap.
        Parameters:
        parent - the parent ContextMap

    • Method Detail

      • getCurrentContext

         final static ContextMap getCurrentContext()

        Get the Current ContextMap. This method returns a ContextMap associated with current thread. If the thread doesn't have a ContextMap associated with it then a new ContextMap is created.

        Returns:

        the current ContextMap

      • getCurrentContext

         final static ContextMap getCurrentContext(boolean autocreate)

        Get the Current ContextMap. This method returns a ContextMap associated with current thread. If the thread doesn't have a ContextMap associated with it and autocreate is true then a new ContextMap is created.

        Parameters:
        autocreate - true if a ContextMap is to be created if it doesn't exist
        Returns:

        the current ContextMap

      • bind

         final static void bind(ContextMap context)

        Bind a particular ContextMap to current thread.

        Parameters:
        context - the context map (may be null)

      • makeReadOnly

         void makeReadOnly()

        Make the context read-only. This makes it safe to allow untrusted code reference to ContextMap.

      • isReadOnly

         boolean isReadOnly()

        Determine if context is read-only.

        Returns:

        true if Context is read only, false otherwise

      • clear

         void clear()

        Empty the context map.

      • get

         Object get(String key, Object defaultObject)

        Get an entry from the context.

        Parameters:
        key - the key to map
        defaultObject - a default object to return if key does not exist
        Returns:

        the object in context

      • get

         Object get(String key)

        Get an entry from the context.

        Parameters:
        key - the key to map
        Returns:

        the object in context or null if none with specified key

      • set

         void set(String key, Object value)

        Set a value in context

        Parameters:
        key - the key
        value - the value (may be null)

      • getSize

         int getSize()

        Get the number of contexts in map.

        Returns:

        the number of contexts in map