Apache JMeter

## org.apache.jmeter.protocol.http.util.accesslog
Class SessionFilter

    java.lang.Object
      org.apache.jmeter.protocol.http.util.accesslog.SessionFilter

All Implemented Interfaces:
  Serializable, Cloneable, Filter, TestCloneable, ThreadListener

    public class SessionFilter

extends Object
implements Filter, Serializable, TestCloneable, ThreadListener

Provides Session Filtering for the AccessLog Sampler.

See Also:
  Serialized Form

Field Summary
`protected Map<String,CookieManager>` `cookieManagers` These objects are static across multiple threads in a test, via clone() method.
`protected CookieManager` `lastUsed`
`protected Set<CookieManager>` `managersInUse`

Constructor Summary
`SessionFilter()`

Method Summary
`Object` `clone()`
`void` `excludeFiles(String[] filenames)` Exclude all files in the array
`void` `excludePattern(String[] regexp)` Exclude any log entry that contains the following regular expression pattern.
`String` `filter(String text)` In case the user wants to replace the file extension, log parsers should call this method.
`protected CookieManager` `getCookieManager(String ipAddr)`
`protected String` `getIpAddress(String logLine)`
`protected boolean` `hasExcPattern(String text)`
`void` `includeFiles(String[] filenames)` Include all files in the array.
`void` `includePattern(String[] regexp)` Include any log entry that contains the following regular expression pattern.
`boolean` `isFiltered(String path, TestElement sampler)` Log parser will call this method to see if a particular entry should be filtered or not.
`void` `reset()` Tell the filter when the parsing has reached the end of the log file and is about to begin again.
`void` `setReplaceExtension(String oldextension, String newextension)`
`void` `threadFinished()` Called for each thread after all samples have been processed.
`void` `threadStarted()` Called for each thread before starting sampling.

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### cookieManagers

    protected Map<String,CookieManager> cookieManagers

  These objects are static across multiple threads in a test, via clone() method.

### managersInUse

    protected Set<CookieManager> managersInUse

### lastUsed

    protected CookieManager lastUsed

Constructor Detail

### SessionFilter

    public SessionFilter()

Method Detail

### hasExcPattern

    protected boolean hasExcPattern(String text)

### getIpAddress

    protected String getIpAddress(String logLine)

### reset

    public void reset()

  Tell the filter when the parsing has reached the end of the log file and is about to begin again. Gives the filter a chance to adjust it's values, if needed.

  Specified by:
    `reset` in interface `Filter`

### clone

    public Object clone()

  Specified by:
    `clone` in interface `TestCloneable`
  Overrides:
    `clone` in class `Object`

### excludeFiles

    public void excludeFiles(String[] filenames)

  Exclude all files in the array

  Specified by:
    `excludeFiles` in interface `Filter`

### excludePattern

    public void excludePattern(String[] regexp)

  Exclude any log entry that contains the following regular expression pattern.

  Specified by:
    `excludePattern` in interface `Filter`

### filter

    public String filter(String text)

  In case the user wants to replace the file extension, log parsers should call this method. This is useful for regression test plans. If a website is migrating from one platform to another and the file extension changes, the filter provides an easy way to do it without spending a lot of time.

  Specified by:
    `filter` in interface `Filter`
  Returns:
    String

### includeFiles

    public void includeFiles(String[] filenames)

  Include all files in the array.

  Specified by:
    `includeFiles` in interface `Filter`

### includePattern

    public void includePattern(String[] regexp)

  Include any log entry that contains the following regular expression pattern.

  Specified by:
    `includePattern` in interface `Filter`

### isFiltered

    public boolean isFiltered(String path,
                              TestElement sampler)

  Log parser will call this method to see if a particular entry should be filtered or not.

  Specified by:
    `isFiltered` in interface `Filter`
  Returns:
    boolean

### getCookieManager

    protected CookieManager getCookieManager(String ipAddr)

### setReplaceExtension

    public void setReplaceExtension(String oldextension,
                                    String newextension)

  Specified by:
    `setReplaceExtension` in interface `Filter`

### threadFinished

    public void threadFinished()

  Called for each thread after all samples have been processed.

  Specified by:
    `threadFinished` in interface `ThreadListener`
  See Also:
    `JMeterThread.threadFinished(LoopIterationListener)`

### threadStarted

    public void threadStarted()

  Called for each thread before starting sampling. WARNING: this is called before any Config test elements are processed, so any properties they define will not have been merged in yet.

  Specified by:
    `threadStarted` in interface `ThreadListener`
  See Also:
    `JMeterThread.threadStarted()`

Apache JMeter

Copyright © 1998-2011 Apache Software Foundation. All Rights Reserved.