Class AttributeKey<T>


public abstract class AttributeKey<T> extends Object
Type-safe attribute accessor.

Servlet API has a bag of stuff in several scopes (such as request, session, ...) but the API is not type-safe. This object provides a convenient type-safe access to to such bags, as well as providing uniform API regardless of the actual scope.

Each instance of AttributeKey gets an unique attribute name, which means in the most typical case, these instances should be used as a singleton.

Kohsuke Kawaguchi
  • Field Details

    • name

      protected final String name
  • Constructor Details

    • AttributeKey

      public AttributeKey()
    • AttributeKey

      public AttributeKey(String name)
  • Method Details

    • get

      public abstract T get(javax.servlet.http.HttpServletRequest req)
    • set

      public abstract void set(javax.servlet.http.HttpServletRequest req, T value)
    • remove

      public abstract void remove(javax.servlet.http.HttpServletRequest req)
    • get

      public final T get()
    • set

      public final void set(T value)
    • remove

      public final void remove()
    • requestScoped

      public static <T> AttributeKey<T> requestScoped()
      Creates a new request-scoped AttributeKey.
    • sessionScoped

      public static <T> AttributeKey<T> sessionScoped()
      Creates a new session-scoped AttributeKey.
    • appScoped

      public static <T> AttributeKey<T> appScoped()
      Creates a new ServletContext-scoped AttributeKey.