Overview  Package   Class  Use  Deprecated  Index
Home >> All >> info >> crossbar >> [ filtersAndListeners overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

info.crossbar.filtersAndListeners
Class UserFilter  

java.lang.Object
  info.crossbar.filtersAndListeners.UserFilter

All Implemented Interfaces:

javax.servlet.Filter

---

public class UserFilter

extends java.lang.Object

implements javax.servlet.Filter

UserFilter class for use by Crossbar

Version:

View source, revision history $Revision: 1.3 $ $Date: 2003/06/04 04:55:33 $

DESCRIPTION: A filter that detects if a user has logged in and initializes a User object when necessary.

---

Field Summary
protected  javax.servlet.FilterConfig	filterConfig
private static java.util.logging.Logger	log           Set up logging.

 

Constructor Summary

UserFilter()

 

Method Summary
void	destroy()           When the session is destroyed (maybe when logging out a user), remove the user from the list of active users.
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)           The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.
void	init(javax.servlet.FilterConfig filterConfig)           Called by the web container to indicate to a filter that it is being placed into service.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

log

private static java.util.logging.Logger log

Set up logging.

---

filterConfig

protected javax.servlet.FilterConfig filterConfig

Constructor Detail

UserFilter

public UserFilter()

Method Detail

doFilter

public void doFilter(javax.servlet.ServletRequest req,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException

Description copied from interface: javax.servlet.Filter

The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:-
1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.

Specified by:

doFilter in interface javax.servlet.Filter

---

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Description copied from interface: javax.servlet.Filter

Called by the web container to indicate to a filter that it is being placed into service. The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.

The web container cannot place the filter into service if the init method either
1.Throws a ServletException
2.Does not return within a time period defined by the web container

Specified by:

init in interface javax.servlet.Filter

---

destroy

public void destroy()

When the session is destroyed (maybe when logging out a user), remove the user from the list of active users.

Specified by:

destroy in interface javax.servlet.Filter

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> info >> crossbar >> [ filtersAndListeners overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---