edu.uiuc.ncsa.security.servlet.Initialization Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ncsa-security-servlet Show documentation

There is a newer version: 4.3

Show newest version

package edu.uiuc.ncsa.security.servlet;

import edu.uiuc.ncsa.security.core.util.AbstractEnvironment;

import javax.servlet.ServletException;

/**
 * The reason this class exists is because of Java single-inheritence. A top-level servlet
 * class has an init() method that is called. However, if there are many subclasses of this
 * it can be very hard to change their initialization without over-riding several classes
 * or doing something very odd, such as extending a single subclass to do nothing but over-ride
 * its parent then putting in machinery to prevent the parent from running its init method. Hardly
 * ideal.This interface decouples initialization from the servlet. The {@link Bootstrapper}
 * is tasked with making the correct instance of this class which is then injected into the
 * servlet statically on boot. This in turn is called in the servlet init method.
 * 

This solve issue OAUTH-112.
 * Created by Jeff Gaynor

 * on 4/15/14 at  10:24 AM
 */
public interface Initialization {
    /**
     * This should handle all initialization tasks for a servlet. Set the environment before use.
     * @throws ServletException
     */
    public void init() throws ServletException;

    public void setEnvironment(AbstractEnvironment environment);

    public AbstractEnvironment getEnvironment();

    /**
     * Many initialization tasks can only be done dynamically, after the servlet has been created and
     * its {@link javax.servlet.ServletContext} set. There has to be a back reference to
     * or you cannot completely control servlet startup.
     * @return
     */
    public AbstractServlet getServlet();

    public void setServlet(AbstractServlet servlet);

    public ExceptionHandler getExceptionHandler();
}