org.kohsuke.stapler.AttributeKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stapler Show documentation
Stapler HTTP request handling engine
There is a newer version: 1.263
package org.kohsuke.stapler;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.util.UUID;

/**
 * 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 {@link AttributeKey} gets an unique attribute name, which means
 * in the most typical case, these instances should be used as a singleton.
 *
 * @author Kohsuke Kawaguchi
 */
public abstract class AttributeKey {
    protected final String name;

    public AttributeKey() {
        name = UUID.randomUUID().toString();
    }

    public AttributeKey(String name) {
        this.name = name;
    }

    public abstract T get(HttpServletRequest req);

    public abstract void set(HttpServletRequest req, T value);

    public abstract void remove(HttpServletRequest req);

    public final T get() {
        return get(Stapler.getCurrentRequest());
    }

    public final void set(T value) {
        set(Stapler.getCurrentRequest(),value);
    }

    public final void remove() {
        remove(Stapler.getCurrentRequest());
    }

    /**
     * Creates a new request-scoped {@link AttributeKey}.
     */
    public static  AttributeKey requestScoped() {
        return new AttributeKey() {
            public T get(HttpServletRequest req) {
                return (T)req.getAttribute(name);
            }

            public void set(HttpServletRequest req, T value) {
                req.setAttribute(name, value);
            }

            public void remove(HttpServletRequest req) {
                req.removeAttribute(name);
            }
        };
    }

    /**
     * Creates a new session-scoped {@link AttributeKey}.
     */
    public static  AttributeKey sessionScoped() {
        return new AttributeKey() {
            public T get(HttpServletRequest req) {
                HttpSession s = req.getSession(false);
                if (s==null)    return null;
                return (T)s.getAttribute(name);
            }

            public void set(HttpServletRequest req, T value) {
                req.getSession().setAttribute(name, value);
            }

            public void remove(HttpServletRequest req) {
                HttpSession s = req.getSession(false);
                if (s!=null)
                    s.removeAttribute(name);
            }
        };
    }

    /**
     * Creates a new {@link ServletContext}-scoped {@link AttributeKey}.
     */
    public static  AttributeKey appScoped() {
        return new AttributeKey() {
            public T get(HttpServletRequest req) {
                return (T) getContext(req).getAttribute(name);
            }

            public void set(HttpServletRequest req, T value) {
                getContext(req).setAttribute(name, value);
            }

            public void remove(HttpServletRequest req) {
                getContext(req).removeAttribute(name);
            }

            private ServletContext getContext(HttpServletRequest req) {
                return ((StaplerRequest)req).getServletContext();
            }
        };
    }
}