org.eclipse.jetty.servlet.FilterHolder Maven / Gradle / Ivy
// ========================================================================
// Copyright (c) 1996-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.Collection;
import java.util.EnumSet;
import java.util.List;
import javax.servlet.DispatcherType;
import javax.servlet.Filter;
import javax.servlet.FilterConfig;
import javax.servlet.FilterRegistration;
import javax.servlet.ServletException;
import org.eclipse.jetty.servlet.Holder.Source;
import org.eclipse.jetty.util.TypeUtil;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
/* --------------------------------------------------------------------- */
/**
*
*/
public class FilterHolder extends Holder
{
private static final Logger LOG = Log.getLogger(FilterHolder.class);
/* ------------------------------------------------------------ */
private transient Filter _filter;
private transient Config _config;
private transient FilterRegistration.Dynamic _registration;
/* ---------------------------------------------------------------- */
/** Constructor
*/
public FilterHolder()
{
super (Source.EMBEDDED);
}
/* ---------------------------------------------------------------- */
/** Constructor
*/
public FilterHolder(Holder.Source source)
{
super (source);
}
/* ---------------------------------------------------------------- */
/** Constructor
*/
public FilterHolder(Class filter)
{
super (Source.EMBEDDED);
setHeldClass(filter);
}
/* ---------------------------------------------------------------- */
/** Constructor for existing filter.
*/
public FilterHolder(Filter filter)
{
super (Source.EMBEDDED);
setFilter(filter);
}
/* ------------------------------------------------------------ */
@Override
public void doStart()
throws Exception
{
super.doStart();
if (!javax.servlet.Filter.class
.isAssignableFrom(_class))
{
String msg = _class+" is not a javax.servlet.Filter";
super.stop();
throw new IllegalStateException(msg);
}
if (_filter==null)
{
try
{
_filter=((ServletContextHandler.Context)_servletHandler.getServletContext()).createFilter(getHeldClass());
}
catch (ServletException se)
{
Throwable cause = se.getRootCause();
if (cause instanceof InstantiationException)
throw (InstantiationException)cause;
if (cause instanceof IllegalAccessException)
throw (IllegalAccessException)cause;
throw se;
}
}
_config=new Config();
_filter.init(_config);
}
/* ------------------------------------------------------------ */
@Override
public void doStop()
throws Exception
{
if (_filter!=null)
{
try
{
destroyInstance(_filter);
}
catch (Exception e)
{
LOG.warn(e);
}
}
if (!_extInstance)
_filter=null;
_config=null;
super.doStop();
}
/* ------------------------------------------------------------ */
@Override
public void destroyInstance (Object o)
throws Exception
{
if (o==null)
return;
Filter f = (Filter)o;
f.destroy();
getServletHandler().destroyFilter(f);
}
/* ------------------------------------------------------------ */
public synchronized void setFilter(Filter filter)
{
_filter=filter;
_extInstance=true;
setHeldClass(filter.getClass());
if (getName()==null)
setName(filter.getClass().getName());
}
/* ------------------------------------------------------------ */
public Filter getFilter()
{
return _filter;
}
/* ------------------------------------------------------------ */
@Override
public String toString()
{
return getName();
}
/* ------------------------------------------------------------ */
public FilterRegistration.Dynamic getRegistration()
{
if (_registration == null)
_registration = new Registration();
return _registration;
}
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
protected class Registration extends HolderRegistration implements FilterRegistration.Dynamic
{
public void addMappingForServletNames(EnumSet dispatcherTypes, boolean isMatchAfter, String... servletNames)
{
illegalStateIfContextStarted();
FilterMapping mapping = new FilterMapping();
mapping.setFilterHolder(FilterHolder.this);
mapping.setServletNames(servletNames);
mapping.setDispatcherTypes(dispatcherTypes);
if (isMatchAfter)
_servletHandler.addFilterMapping(mapping);
else
_servletHandler.prependFilterMapping(mapping);
}
public void addMappingForUrlPatterns(EnumSet dispatcherTypes, boolean isMatchAfter, String... urlPatterns)
{
illegalStateIfContextStarted();
FilterMapping mapping = new FilterMapping();
mapping.setFilterHolder(FilterHolder.this);
mapping.setPathSpecs(urlPatterns);
mapping.setDispatcherTypes(dispatcherTypes);
if (isMatchAfter)
_servletHandler.addFilterMapping(mapping);
else
_servletHandler.prependFilterMapping(mapping);
}
public Collection getServletNameMappings()
{
FilterMapping[] mappings =_servletHandler.getFilterMappings();
List names=new ArrayList();
for (FilterMapping mapping : mappings)
{
if (mapping.getFilterHolder()!=FilterHolder.this)
continue;
String[] servlets=mapping.getServletNames();
if (servlets!=null && servlets.length>0)
names.addAll(Arrays.asList(servlets));
}
return names;
}
public Collection getUrlPatternMappings()
{
FilterMapping[] mappings =_servletHandler.getFilterMappings();
List patterns=new ArrayList();
for (FilterMapping mapping : mappings)
{
if (mapping.getFilterHolder()!=FilterHolder.this)
continue;
String[] specs=mapping.getPathSpecs();
patterns.addAll(TypeUtil.asList(specs));
}
return patterns;
}
}
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
class Config extends HolderConfig implements FilterConfig
{
/* ------------------------------------------------------------ */
public String getFilterName()
{
return _name;
}
}
}