Package com.microstrategy.web.filter

Class ClientIDFilter

java.lang.Object

com.microstrategy.web.filter.ClientIDFilter

All Implemented Interfaces:

javax.servlet.Filter

public class ClientIDFilter
extends java.lang.Object
implements javax.servlet.Filter

Configures client IP tracking. To enable this filter, you must add a new <filter> configuration in web.xml:

 <web-app ...>
  ...
  <filter>
    <filter-name>clientIDFilter</filter-name>
    <filter-class>com.microstrategy.web.filter.ClientIDFilter</filter-class>
    <init-param>
      <param-name>mode</param-name>
      <!-- PROXY, DEFAULT, DISABLED -->
      <param-value>DEFAULT</param-value>
    </init-param>
  </filter>
  <filter-mapping>
  <filter-name>clientIDFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientIDFilter.TrackMode

Constructor Summary

Constructors

Constructor	Description
ClientIDFilter()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
static void	enableHashed(boolean hash)
static boolean	getHashedSetting()
static ClientIDFilter.TrackMode	getMode()
void	init(javax.servlet.FilterConfig filterConfig)
static void	setMode(ClientIDFilter.TrackMode modeValue)	Configures mode attribute for client IP tracking.
static javax.servlet.ServletRequest	ut_getServletRequest()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientIDFilter

public ClientIDFilter()

Method Detail

init

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

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

enableHashed

public static void enableHashed(boolean hash)

getHashedSetting

public static boolean getHashedSetting()

setMode

public static void setMode(ClientIDFilter.TrackMode modeValue)

Configures mode attribute for client IP tracking.

Parameters:

modeValue - options: DEFAULT, PROXY, DISABLED

getMode

public static ClientIDFilter.TrackMode getMode()

ut_getServletRequest

public static javax.servlet.ServletRequest ut_getServletRequest()

doFilter

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

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException