org.apache.jmeter.protocol.http.control

Class CookieManager

java.lang.Object

org.apache.jmeter.testelement.AbstractTestElement

org.apache.jmeter.config.ConfigTestElement

org.apache.jmeter.protocol.http.control.CookieManager

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.apache.jmeter.config.ConfigElement, org.apache.jmeter.gui.Searchable, org.apache.jmeter.testelement.TestElement, org.apache.jmeter.testelement.TestIterationListener, org.apache.jmeter.testelement.TestStateListener

public class CookieManager
extends org.apache.jmeter.config.ConfigTestElement
implements org.apache.jmeter.testelement.TestStateListener, org.apache.jmeter.testelement.TestIterationListener, java.io.Serializable

This class provides an interface to the netscape cookies file to pass cookies along with a request.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.jmeter.config.ConfigTestElement

PASSWORD, USERNAME

Fields inherited from interface org.apache.jmeter.testelement.TestElement

COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS

Constructor Summary

Constructors

Constructor and Description
CookieManager()

Method Summary

Modifier and Type	Method and Description
void	add(Cookie c) Add a cookie.
void	addCookieFromHeader(java.lang.String cookieHeader, java.net.URL url)
void	addFile(java.lang.String cookieFile) Add cookie data from a file.
void	clear()
java.lang.Object	clone()
Cookie	get(int i) Return the cookie at index i.
boolean	getClearEachIteration()
int	getCookieCount()
java.lang.String	getCookieHeaderForURL(java.net.URL url) Find cookies applicable to the given URL and build the Cookie header from them.
org.apache.jmeter.testelement.property.CollectionProperty	getCookies()
java.lang.String	getImplementation()
java.lang.String	getPolicy()
void	recoverRunningVersion()
void	remove(int index) Remove a cookie.
void	save(java.lang.String authFile) Save the static cookie data to a file.
void	setClearEachIteration(boolean clear)
void	setCookiePolicy(java.lang.String policy)
void	setImplementation(java.lang.String implementation)
void	setRunningVersion(boolean running)
void	testEnded()
void	testEnded(java.lang.String host)
void	testIterationStart(org.apache.jmeter.engine.event.LoopIterationEvent event)
void	testStarted()
void	testStarted(java.lang.String host)

Methods inherited from class org.apache.jmeter.config.ConfigTestElement

addConfigElement, addTestElement, expectsModification

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

addPropertiesValues, addProperty, addProperty, canRemove, clearTemporary, clearTestElementChildren, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jmeter.testelement.TestElement

removed

Constructor Detail

CookieManager

public CookieManager()

Method Detail

clone

public java.lang.Object clone()

Specified by:

clone in interface org.apache.jmeter.config.ConfigElement

Specified by:

clone in interface org.apache.jmeter.testelement.TestElement

Overrides:

clone in class org.apache.jmeter.testelement.AbstractTestElement

getPolicy

public java.lang.String getPolicy()

setCookiePolicy

public void setCookiePolicy(java.lang.String policy)

getCookies

public org.apache.jmeter.testelement.property.CollectionProperty getCookies()

getCookieCount

public int getCookieCount()

getClearEachIteration

public boolean getClearEachIteration()

setClearEachIteration

public void setClearEachIteration(boolean clear)

getImplementation

public java.lang.String getImplementation()

setImplementation

public void setImplementation(java.lang.String implementation)

save

public void save(java.lang.String authFile)
          throws java.io.IOException

Save the static cookie data to a file.

Cookies are only taken from the GUI - runtime cookies are not included.

Parameters:

authFile - name of the file to store the cookies into. If the name is relative, the system property user.dir will be prepended

Throws:

java.io.IOException - when writing to that file fails

addFile

public void addFile(java.lang.String cookieFile)
             throws java.io.IOException

Add cookie data from a file.

Parameters:

cookieFile - name of the file to read the cookies from. If the name is relative, the system property user.dir will be prepended

Throws:

java.io.IOException - if reading the file fails

recoverRunningVersion

public void recoverRunningVersion()

Specified by:

recoverRunningVersion in interface org.apache.jmeter.testelement.TestElement

Overrides:

recoverRunningVersion in class org.apache.jmeter.testelement.AbstractTestElement

setRunningVersion

public void setRunningVersion(boolean running)

Specified by:

setRunningVersion in interface org.apache.jmeter.testelement.TestElement

Overrides:

setRunningVersion in class org.apache.jmeter.testelement.AbstractTestElement

add

public void add(Cookie c)

Add a cookie.

Parameters:

c - cookie to be added

clear

public void clear()

Specified by:

clear in interface org.apache.jmeter.testelement.TestElement

Overrides:

clear in class org.apache.jmeter.testelement.AbstractTestElement

remove

public void remove(int index)

Remove a cookie.

Parameters:

index - index of the cookie to remove

get

public Cookie get(int i)

Return the cookie at index i.

Parameters:

i - index of the cookie to get

Returns:

cookie at index i

getCookieHeaderForURL

public java.lang.String getCookieHeaderForURL(java.net.URL url)

Find cookies applicable to the given URL and build the Cookie header from them.

Parameters:

url - URL of the request to which the returned header will be added.

Returns:

the value string for the cookie header (goes after "Cookie: ").

addCookieFromHeader

public void addCookieFromHeader(java.lang.String cookieHeader,
                                java.net.URL url)

testStarted

public void testStarted()

Specified by:

testStarted in interface org.apache.jmeter.testelement.TestStateListener

testEnded

public void testEnded()

Specified by:

testEnded in interface org.apache.jmeter.testelement.TestStateListener

testStarted

public void testStarted(java.lang.String host)

Specified by:

testStarted in interface org.apache.jmeter.testelement.TestStateListener

testEnded

public void testEnded(java.lang.String host)

Specified by:

testEnded in interface org.apache.jmeter.testelement.TestStateListener

testIterationStart

public void testIterationStart(org.apache.jmeter.engine.event.LoopIterationEvent event)

Specified by:

testIterationStart in interface org.apache.jmeter.testelement.TestIterationListener