Save This Page
Home » tapestry-src-5.0.19 » org.apache.tapestry5 » [javadoc | source]
org.apache.tapestry5
public class: TapestryFilter [javadoc | source]
java.lang.Object
   org.apache.tapestry5.TapestryFilter

All Implemented Interfaces:
    Filter

Direct Known Subclasses:
    TapestrySpringFilter

The TapestryFilter is responsible for intercepting all requests into the web application. It identifies the requests that are relevant to Tapestry, and lets the servlet container handle the rest. It is also responsible for initializing Tapestry.

The application is configured via context-level init parameters.

tapestry.app-package
The application package (used to search for pages, components, etc.)
Field Summary
public static final  String REGISTRY_CONTEXT_NAME    Key under which that Tapestry IoC org.apache.tapestry5.ioc.Registry is stored in the ServletContext. This allows other code, beyond Tapestry, to obtain the Registry and, from it, any Tapestry services. Such code should be careful about invoking org.apache.tapestry5.ioc.Registry#cleanupThread() appopriately. 
Method from org.apache.tapestry5.TapestryFilter Summary:
destroy,   destroy,   doFilter,   getFilterConfig,   init,   init,   provideExtraModuleDefs
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tapestry5.TapestryFilter Detail:
 public final  void destroy() 
 protected  void destroy(Registry registry) 
    Invoked from #destroy() to allow subclasses to add additional shutdown logic to the filter. The Registry will be shutdown after this call. This implementation does nothing, and may be overridden in subclasses.
 public final  void doFilter(ServletRequest request,
    ServletResponse response,
    FilterChain chain) throws IOException, ServletException 
 protected final FilterConfig getFilterConfig() 
 public final  void init(FilterConfig filterConfig) throws ServletException 
    Initializes the filter using the TapestryAppInitializer . The application name is the capitalization of the filter name (as specified in web.xml).
 protected  void init(Registry registry) throws ServletException 
    Invoked from #init(FilterConfig) after the Registry has been created, to allow any additional initialization to occur. This implementation does nothing, and my be overriden in subclasses.
 protected ModuleDef[] provideExtraModuleDefs(ServletContext context) 
    Overridden in subclasses to provide additional module definitions beyond those normally located. This implementation returns an empty array.