org.apache.jmeter.protocol.http.control

Class Cookie

Implemented Interfaces:
Cloneable, Serializable, TestElement

public class Cookie
extends AbstractTestElement
implements Serializable

This class is a Cookie encapsulator.

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

COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS

Constructor Summary

Cookie()
create the coookie
Cookie(String name, String value, String domain, String path, boolean secure, long expires)
create the coookie
Cookie(String name, String value, String domain, String path, boolean secure, long expires, boolean hasPath, boolean hasDomain)
create the coookie
Cookie(String name, String value, String domain, String path, boolean secure, long expires, boolean hasPath, boolean hasDomain, int version)
Create a JMeter Cookie.

Method Summary

void
addConfigElement(ConfigElement config)
String
getDomain()
get the domain for this object.
long
getExpires()
get the expiry time for the cookie
long
getExpiresMillis()
get the expiry time for the cookie
String
getPath()
get the path for this object.
boolean
getSecure()
get the secure for this object.
String
getValue()
get the value for this object.
int
getVersion()
boolean
isDomainSpecified()
boolean
isPathSpecified()
void
setDomain(String domain)
set the domain for this object.
void
setDomainSpecified(boolean b)
void
setExpires(long expires)
set the expiry time for the cookie
void
setPath(String path)
set the path for this object.
void
setPathSpecified(boolean b)
void
setSecure(boolean secure)
set the secure for this object.
void
setValue(String value)
set the value for this object.
void
setVersion(int version)
String
toString()
creates a string representation of this cookie

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

addProperty, addTestElement, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty

Constructor Details

Cookie

public Cookie()
create the coookie

Cookie

public Cookie(String name,
              String value,
              String domain,
              String path,
              boolean secure,
              long expires)
create the coookie
Parameters:
expires - - this is in seconds

Cookie

public Cookie(String name,
              String value,
              String domain,
              String path,
              boolean secure,
              long expires,
              boolean hasPath,
              boolean hasDomain)
create the coookie
Parameters:
expires - - this is in seconds
hasPath - - was the path explicitly specified?
hasDomain - - was the domain explicitly specified?

Cookie

public Cookie(String name,
              String value,
              String domain,
              String path,
              boolean secure,
              long expires,
              boolean hasPath,
              boolean hasDomain,
              int version)
Create a JMeter Cookie.
Parameters:
name -
value -
domain -
path -
secure -
expires - - this is in seconds
hasPath - - was the path explicitly specified?
hasDomain - - was the domain explicitly specified?
version - - cookie spec. version

Method Details

addConfigElement

public void addConfigElement(ConfigElement config)

getDomain

public String getDomain()
get the domain for this object.

getExpires

public long getExpires()
get the expiry time for the cookie
Returns:
Expiry time in seconds since the Java epoch

getExpiresMillis

public long getExpiresMillis()
get the expiry time for the cookie
Returns:
Expiry time in milli-seconds since the Java epoch, i.e. same as System.currentTimeMillis()

getPath

public String getPath()
get the path for this object.

getSecure

public boolean getSecure()
get the secure for this object.

getValue

public String getValue()
get the value for this object.

getVersion

public int getVersion()
Returns:
the version

isDomainSpecified

public boolean isDomainSpecified()

isPathSpecified

public boolean isPathSpecified()

setDomain

public void setDomain(String domain)
set the domain for this object.

setDomainSpecified

public void setDomainSpecified(boolean b)

setExpires

public void setExpires(long expires)
set the expiry time for the cookie
Parameters:
expires - - expiry time in seconds since the Java epoch

setPath

public void setPath(String path)
set the path for this object.

setPathSpecified

public void setPathSpecified(boolean b)

setSecure

public void setSecure(boolean secure)
set the secure for this object.

setValue

public void setValue(String value)
set the value for this object.

setVersion

public void setVersion(int version)
Parameters:
version - the version to set

toString

public String toString()
creates a string representation of this cookie

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