All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.jetty.servlet.ServletContextHandler Maven / Gradle / Ivy

There is a newer version: 11.0.0.beta1
Show newest version
// ========================================================================
// Copyright (c) 2004-2009 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
// The Eclipse Public License is available at 
// http://www.eclipse.org/legal/epl-v10.html
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
// You may elect to redistribute this code under either of these licenses. 
// ========================================================================

package org.eclipse.jetty.servlet;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumSet;
import java.util.EventListener;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.servlet.Filter;
import javax.servlet.RequestDispatcher;
import javax.servlet.Servlet;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.ServletException;

import org.eclipse.jetty.security.ConstraintAware;
import org.eclipse.jetty.security.ConstraintSecurityHandler;
import org.eclipse.jetty.security.SecurityHandler;
import org.eclipse.jetty.server.Dispatcher;
import org.eclipse.jetty.server.DispatcherType;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.HandlerContainer;
import org.eclipse.jetty.server.handler.ContextHandler;
import org.eclipse.jetty.server.handler.ErrorHandler;
import org.eclipse.jetty.server.handler.HandlerCollection;
import org.eclipse.jetty.server.handler.HandlerWrapper;
import org.eclipse.jetty.server.session.SessionHandler;
import org.eclipse.jetty.servlet.api.FilterRegistration;
import org.eclipse.jetty.servlet.api.ServletRegistration;
import org.eclipse.jetty.util.Loader;


/* ------------------------------------------------------------ */
/** Servlet Context.
 * This extension to the ContextHandler allows for
 * simple construction of a context with ServletHandler and optionally
 * session and security handlers, et.
 *   new ServletContext("/context",Context.SESSIONS|Context.NO_SECURITY);
 * 
*

* This class should have been called ServletContext, but this would have * cause confusion with {@link ServletContext}. */ public class ServletContextHandler extends ContextHandler { public final static int SESSIONS=1; public final static int SECURITY=2; public final static int NO_SESSIONS=0; public final static int NO_SECURITY=0; protected final List _decorators= new ArrayList(); protected Class _defaultSecurityHandlerClass=org.eclipse.jetty.security.ConstraintSecurityHandler.class; protected SessionHandler _sessionHandler; protected SecurityHandler _securityHandler; protected ServletHandler _servletHandler; protected HandlerWrapper _wrapper; protected int _options; protected Object _restrictedContextListeners; /* ------------------------------------------------------------ */ public ServletContextHandler() { this(null,null,null,null,null); } /* ------------------------------------------------------------ */ public ServletContextHandler(int options) { this(null,null,options); } /* ------------------------------------------------------------ */ public ServletContextHandler(HandlerContainer parent, String contextPath) { this(parent,contextPath,null,null,null,null); } /* ------------------------------------------------------------ */ public ServletContextHandler(HandlerContainer parent, String contextPath, int options) { this(parent,contextPath,null,null,null,null); _options=options; } /* ------------------------------------------------------------ */ public ServletContextHandler(HandlerContainer parent, String contextPath, boolean sessions, boolean security) { this(parent,contextPath,(sessions?SESSIONS:0)|(security?SECURITY:0)); } /* ------------------------------------------------------------ */ public ServletContextHandler(HandlerContainer parent, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler) { this(parent,null,sessionHandler,securityHandler,servletHandler,errorHandler); } /* ------------------------------------------------------------ */ public ServletContextHandler(HandlerContainer parent, String contextPath, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler) { super((ContextHandler.Context)null); _scontext = new Context(); _sessionHandler = sessionHandler; _securityHandler = securityHandler; _servletHandler = servletHandler; if (errorHandler!=null) setErrorHandler(errorHandler); if (contextPath!=null) setContextPath(contextPath); if (parent instanceof HandlerWrapper) ((HandlerWrapper)parent).setHandler(this); else if (parent instanceof HandlerCollection) ((HandlerCollection)parent).addHandler(this); } /* ------------------------------------------------------------ */ /** * @see org.eclipse.jetty.server.handler.ContextHandler#doStop() */ @Override protected void doStop() throws Exception { super.doStop(); _decorators.clear(); _wrapper.setHandler(null); } /* ------------------------------------------------------------ */ /** Get the defaultSecurityHandlerClass. * @return the defaultSecurityHandlerClass */ public Class getDefaultSecurityHandlerClass() { return _defaultSecurityHandlerClass; } /* ------------------------------------------------------------ */ /** Set the defaultSecurityHandlerClass. * @param defaultSecurityHandlerClass the defaultSecurityHandlerClass to set */ public void setDefaultSecurityHandlerClass(Class defaultSecurityHandlerClass) { _defaultSecurityHandlerClass = defaultSecurityHandlerClass; } /* ------------------------------------------------------------ */ protected SessionHandler newSessionHandler() { return new SessionHandler(); } /* ------------------------------------------------------------ */ protected SecurityHandler newSecurityHandler() { try { return (SecurityHandler)_defaultSecurityHandlerClass.newInstance(); } catch(Exception e) { throw new IllegalStateException(e); } } /* ------------------------------------------------------------ */ protected ServletHandler newServletHandler() { return new ServletHandler(); } /* ------------------------------------------------------------ */ /** * Finish constructing handlers and link them together. * * @see org.eclipse.jetty.server.handler.ContextHandler#startContext() */ protected void startContext() throws Exception { // force creation of missing handlers. getSessionHandler(); getSecurityHandler(); getServletHandler(); Handler handler = _servletHandler; if (_securityHandler!=null) { _securityHandler.setHandler(handler); handler=_securityHandler; } if (_sessionHandler!=null) { _sessionHandler.setHandler(handler); handler=_sessionHandler; } // skip any wrapped handlers _wrapper=this; while (_wrapper!=handler && _wrapper.getHandler() instanceof HandlerWrapper) _wrapper=(HandlerWrapper)_wrapper.getHandler(); // if we are not already linked if (_wrapper!=handler) { if (_wrapper.getHandler()!=null ) throw new IllegalStateException("!ScopedHandler"); _wrapper.setHandler(handler); } super.startContext(); // OK to Initialize servlet handler now if (_servletHandler != null && _servletHandler.isStarted()) { for (int i=_decorators.size()-1;i>=0; i--) { Decorator decorator = _decorators.get(i); if (_servletHandler.getFilters()!=null) for (FilterHolder holder:_servletHandler.getFilters()) decorator.decorateFilterHolder(holder); if(_servletHandler.getServlets()!=null) for (ServletHolder holder:_servletHandler.getServlets()) decorator.decorateServletHolder(holder); } _servletHandler.initialize(); } } /* ------------------------------------------------------------ */ /** * @return Returns the securityHandler. */ public SecurityHandler getSecurityHandler() { if (_securityHandler==null && (_options&SECURITY)!=0 && !isStarted()) _securityHandler=newSecurityHandler(); return _securityHandler; } /* ------------------------------------------------------------ */ /** * @return Returns the servletHandler. */ public ServletHandler getServletHandler() { if (_servletHandler==null && !isStarted()) _servletHandler=newServletHandler(); return _servletHandler; } /* ------------------------------------------------------------ */ /** * @return Returns the sessionHandler. */ public SessionHandler getSessionHandler() { if (_sessionHandler==null && (_options&SESSIONS)!=0 && !isStarted()) _sessionHandler=newSessionHandler(); return _sessionHandler; } /* ------------------------------------------------------------ */ /** conveniance method to add a servlet. */ public ServletHolder addServlet(String className,String pathSpec) { return getServletHandler().addServletWithMapping(className, pathSpec); } /* ------------------------------------------------------------ */ /** conveniance method to add a servlet. */ public ServletHolder addServlet(Class servlet,String pathSpec) { return getServletHandler().addServletWithMapping(servlet.getName(), pathSpec); } /* ------------------------------------------------------------ */ /** conveniance method to add a servlet. */ public void addServlet(ServletHolder servlet,String pathSpec) { getServletHandler().addServletWithMapping(servlet, pathSpec); } /* ------------------------------------------------------------ */ /** conveniance method to add a filter */ public void addFilter(FilterHolder holder,String pathSpec,EnumSet dispatches) { getServletHandler().addFilterWithMapping(holder,pathSpec,dispatches); } /* ------------------------------------------------------------ */ /** convenience method to add a filter */ public FilterHolder addFilter(Class filterClass,String pathSpec,EnumSet dispatches) { return getServletHandler().addFilterWithMapping(filterClass,pathSpec,dispatches); } /* ------------------------------------------------------------ */ /** convenience method to add a filter */ public FilterHolder addFilter(String filterClass,String pathSpec,EnumSet dispatches) { return getServletHandler().addFilterWithMapping(filterClass,pathSpec,dispatches); } /* ------------------------------------------------------------ */ /** conveniance method to add a filter */ public void addFilter(FilterHolder holder,String pathSpec,int dispatches) { getServletHandler().addFilterWithMapping(holder,pathSpec,dispatches); } /* ------------------------------------------------------------ */ /** convenience method to add a filter */ public FilterHolder addFilter(Class filterClass,String pathSpec,int dispatches) { return getServletHandler().addFilterWithMapping(filterClass,pathSpec,dispatches); } /* ------------------------------------------------------------ */ /** convenience method to add a filter */ public FilterHolder addFilter(String filterClass,String pathSpec,int dispatches) { return getServletHandler().addFilterWithMapping(filterClass,pathSpec,dispatches); } public void callContextInitialized(ServletContextListener l, ServletContextEvent e) { l.contextInitialized(e); } public void callContextDestroyed(ServletContextListener l, ServletContextEvent e) { l.contextDestroyed(e); } /* ------------------------------------------------------------ */ /** * @param sessionHandler The sessionHandler to set. */ public void setSessionHandler(SessionHandler sessionHandler) { if (isStarted()) throw new IllegalStateException("STARTED"); _sessionHandler = sessionHandler; } /* ------------------------------------------------------------ */ /** * @param securityHandler The {@link SecurityHandler} to set on this context. */ public void setSecurityHandler(SecurityHandler securityHandler) { if (isStarted()) throw new IllegalStateException("STARTED"); _securityHandler = securityHandler; } /* ------------------------------------------------------------ */ /** * @param servletHandler The servletHandler to set. */ public void setServletHandler(ServletHandler servletHandler) { if (isStarted()) throw new IllegalStateException("STARTED"); _servletHandler = servletHandler; } /* ------------------------------------------------------------ */ /** * @return The decorator list used to resource inject new Filters, Servlets and EventListeners */ public List getDecorators() { return Collections.unmodifiableList(_decorators); } /* ------------------------------------------------------------ */ /** * @param decorators The lis of {@link Decorator}s */ public void setDecorators(List decorators) { _decorators.clear(); _decorators.addAll(decorators); } /* ------------------------------------------------------------ */ /** * @param decorator The decorator to add */ public void addDecorator(Decorator decorator) { _decorators.add(decorator); } /* ------------------------------------------------------------ */ void destroyServlet(Servlet servlet) { for (Decorator decorator : _decorators) decorator.destroyServletInstance(servlet); } /* ------------------------------------------------------------ */ void destroyFilter(Filter filter) { for (Decorator decorator : _decorators) decorator.destroyFilterInstance(filter); } /* ------------------------------------------------------------ */ public class Context extends ContextHandler.Context { /* ------------------------------------------------------------ */ /* * @see javax.servlet.ServletContext#getNamedDispatcher(java.lang.String) */ @Override public RequestDispatcher getNamedDispatcher(String name) { ContextHandler context=org.eclipse.jetty.servlet.ServletContextHandler.this; if (_servletHandler==null || _servletHandler.getServlet(name)==null) return null; return new Dispatcher(context, name); } /* ------------------------------------------------------------ */ /** * @since servlet-api-3.0 */ public FilterRegistration.Dynamic addFilter(String filterName, Class filterClass) { if (isStarted()) throw new IllegalStateException(); final ServletHandler handler = ServletContextHandler.this.getServletHandler(); final FilterHolder holder= handler.newFilterHolder(); holder.setName(filterName); holder.setHeldClass(filterClass); handler.addFilter(holder); return holder.getRegistration(); } /* ------------------------------------------------------------ */ /** * @since servlet-api-3.0 */ public FilterRegistration.Dynamic addFilter(String filterName, String className) { if (isStarted()) throw new IllegalStateException(); final ServletHandler handler = ServletContextHandler.this.getServletHandler(); final FilterHolder holder= handler.newFilterHolder(); holder.setName(filterName); holder.setClassName(className); handler.addFilter(holder); return holder.getRegistration(); } /* ------------------------------------------------------------ */ /** * @since servlet-api-3.0 */ public FilterRegistration.Dynamic addFilter(String filterName, Filter filter) { if (isStarted()) throw new IllegalStateException(); final ServletHandler handler = ServletContextHandler.this.getServletHandler(); final FilterHolder holder= handler.newFilterHolder(); holder.setName(filterName); holder.setFilter(filter); handler.addFilter(holder); return holder.getRegistration(); } /* ------------------------------------------------------------ */ /** * @since servlet-api-3.0 */ public ServletRegistration.Dynamic addServlet(String servletName, Class servletClass) { if (!isStarting()) throw new IllegalStateException(); final ServletHandler handler = ServletContextHandler.this.getServletHandler(); final ServletHolder holder= handler.newServletHolder(); holder.setName(servletName); holder.setHeldClass(servletClass); handler.addServlet(holder); return holder.getRegistration(); } /* ------------------------------------------------------------ */ /** * @since servlet-api-3.0 */ public ServletRegistration.Dynamic addServlet(String servletName, String className) { if (!isStarting()) throw new IllegalStateException(); final ServletHandler handler = ServletContextHandler.this.getServletHandler(); final ServletHolder holder= handler.newServletHolder(); holder.setName(servletName); holder.setClassName(className); handler.addServlet(holder); return holder.getRegistration(); } /* ------------------------------------------------------------ */ /** * @since servlet-api-3.0 */ public ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet) { if (!isStarting()) throw new IllegalStateException(); final ServletHandler handler = ServletContextHandler.this.getServletHandler(); final ServletHolder holder= handler.newServletHolder(); holder.setName(servletName); holder.setServlet(servlet); handler.addServlet(holder); return holder.getRegistration(); } /* ------------------------------------------------------------ */ public boolean setInitParameter(String name, String value) { // TODO other started conditions if (!isStarting()) throw new IllegalStateException(); return super.setInitParameter(name,value); } /* ------------------------------------------------------------ */ public T createFilter(Class c) throws ServletException { try { T f = c.newInstance(); for (int i=_decorators.size()-1; i>=0; i--) { Decorator decorator = _decorators.get(i); f=decorator.decorateFilterInstance(f); } return f; } catch (InstantiationException e) { throw new ServletException(e); } catch (IllegalAccessException e) { throw new ServletException(e); } } /* ------------------------------------------------------------ */ public T createServlet(Class c) throws ServletException { try { T s = c.newInstance(); for (int i=_decorators.size()-1; i>=0; i--) { Decorator decorator = _decorators.get(i); s=decorator.decorateServletInstance(s); } return s; } catch (InstantiationException e) { throw new ServletException(e); } catch (IllegalAccessException e) { throw new ServletException(e); } } public FilterRegistration getFilterRegistration(String filterName) { final FilterHolder holder=ServletContextHandler.this.getServletHandler().getFilter(filterName); return (holder==null)?null:holder.getRegistration(); } public Map getFilterRegistrations() { HashMap registrations = new HashMap(); ServletHandler handler=ServletContextHandler.this.getServletHandler(); FilterHolder[] holders=handler.getFilters(); if (holders!=null) { for (FilterHolder holder : holders) registrations.put(holder.getName(),holder.getRegistration()); } return registrations; } public ServletRegistration getServletRegistration(String servletName) { final ServletHolder holder=ServletContextHandler.this.getServletHandler().getServlet(servletName); return (holder==null)?null:holder.getRegistration(); } public Map getServletRegistrations() { HashMap registrations = new HashMap(); ServletHandler handler=ServletContextHandler.this.getServletHandler(); ServletHolder[] holders=handler.getServlets(); if (holders!=null) { for (ServletHolder holder : holders) registrations.put(holder.getName(),holder.getRegistration()); } return registrations; } public void addListener(String className) { // TODO other started conditions if (!isStarting()) throw new IllegalStateException(); try { Class clazz = getClassLoader()==null?Loader.loadClass(ContextHandler.class,className):getClassLoader().loadClass(className); addListener(clazz); } catch (ClassNotFoundException e) { throw new IllegalArgumentException(e); } } public void addListener(T t) { if (!isStarting()) throw new IllegalStateException(); ServletContextHandler.this.addEventListener(t); } public void addListener(Class listenerClass) { if (!isStarting()) throw new IllegalStateException(); try { EventListener l = createListener(listenerClass); ServletContextHandler.this.addEventListener(l); } catch (ServletException e) { throw new IllegalStateException(e); } } public T createListener(Class clazz) throws ServletException { try { T l = null; try { l = clazz.newInstance(); } catch (InstantiationException e) { throw new ServletException(e); } catch (IllegalAccessException e) { throw new ServletException(e); } for (int i=_decorators.size()-1; i>=0; i--) { Decorator decorator = _decorators.get(i); l=decorator.decorateListenerInstance(l); } return l; } catch(ServletException e) { throw e; } catch(Exception e) { throw new ServletException(e); } } public void declareRoles(String... roleNames) { if (!isStarting()) throw new IllegalStateException(); //Get a reference to the SecurityHandler, which must be ConstraintAware if (_securityHandler != null && _securityHandler instanceof ConstraintAware) { HashSet union = new HashSet(); Set existing = ((ConstraintAware)_securityHandler).getRoles(); if (existing != null) union.addAll(existing); union.addAll(Arrays.asList(roleNames)); ((ConstraintSecurityHandler)_securityHandler).setRoles(union); } } } /* ------------------------------------------------------------ */ /** Interface to decorate loaded classes. */ public interface Decorator { T decorateFilterInstance(T filter) throws ServletException; T decorateServletInstance(T servlet) throws ServletException; T decorateListenerInstance(T listener) throws ServletException; void decorateFilterHolder(FilterHolder filter) throws ServletException; void decorateServletHolder(ServletHolder servlet) throws ServletException; void destroyServletInstance(Servlet s); void destroyFilterInstance(Filter f); void destroyListenerInstance(EventListener f); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy