org.apache.jmeter.protocol.http.control

Class AuthManager

Implemented Interfaces:
Cloneable, ConfigElement, Serializable, TestElement

public class AuthManager
extends ConfigTestElement
implements ConfigElement, Serializable

This class provides a way to provide Authorization in jmeter requests. The format of the authorization file is: URL user pass where URL is an HTTP URL, user a username to use and pass the appropriate password.

Field Summary

static int
COL_DOMAIN
static int
COL_PASSWORD
static int
COL_REALM
static int
COL_URL
static int
COL_USERNAME

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

AuthManager()
Default Constructor.

Method Summary

void
addAuth()
void
addAuth(Authorization auth)
void
addConfigElement(ConfigElement config)
Add a configuration element to this one.
void
addFile(String authFile)
Add authentication data from a file.
void
clear()
Clear the TestElement of all data.
boolean
expectsModification()
If your config element expects to be modified in the process of a test run, and you want those modifications to carry over from sample to sample (as in a cookie manager - you want to save all cookies that get set throughout the test), then return true for this method.
Authorization
get(int i)
Return the record at index i
Collection
getAddList()
int
getAuthCount()
Return the number of records.
Authorization
getAuthForURL(URL url)
String
getAuthHeaderForURL(URL url)
Authorization
getAuthObjectAt(int row)
CollectionProperty
getAuthObjects()
Class
getColumnClass(int column)
int
getColumnCount()
String
getColumnName(int column)
Class
getGuiClass()
boolean
isEditable()
void
remove(int index)
Remove an authentication record.
void
save(String authFile)
Save the authentication data to a file.
void
set(int index, String url, String user, String pass, String domain, String realm)
Update an authentication record.
void
uncompile()

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

addConfigElement, addTestElement, expectsModification

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

Field Details

COL_DOMAIN

public static final int COL_DOMAIN
Field Value:
3

COL_PASSWORD

public static final int COL_PASSWORD
Field Value:
2

COL_REALM

public static final int COL_REALM
Field Value:
4

COL_URL

public static final int COL_URL
Field Value:
0

COL_USERNAME

public static final int COL_USERNAME
Field Value:
1

Constructor Details

AuthManager

public AuthManager()
Default Constructor.

Method Details

addAuth

public void addAuth()

addAuth

public void addAuth(Authorization auth)

addConfigElement

public void addConfigElement(ConfigElement config)
Add a configuration element to this one. This allows config elements to combine and give a "layered" effect. For example, HTTPConfigElements have properties for domain, path, method, and parameters. If element A has everything filled in, but null for domain, and element B is added, which has only domain filled in, then after adding B to A, A will have the domain from B. If A already had a domain, then the correct behavior is for A to ignore the addition of element B.
Specified by:
addConfigElement in interface ConfigElement
Overrides:
addConfigElement in interface ConfigTestElement
Parameters:
config - the element to be added to this ConfigElement

addFile

public void addFile(String authFile)
            throws IOException
Add authentication data from a file.

clear

public void clear()
Clear the TestElement of all data.
Specified by:
clear in interface TestElement
Overrides:
clear in interface AbstractTestElement

expectsModification

public boolean expectsModification()
If your config element expects to be modified in the process of a test run, and you want those modifications to carry over from sample to sample (as in a cookie manager - you want to save all cookies that get set throughout the test), then return true for this method. Your config element will not be cloned for each sample. If your config elements are more static in nature, return false. If in doubt, return false.
Specified by:
expectsModification in interface ConfigElement
Overrides:
expectsModification in interface ConfigTestElement
Returns:
true if the element expects to be modified over the course of a test run

get

public Authorization get(int i)
Return the record at index i

getAddList

public Collection getAddList()

getAuthCount

public int getAuthCount()
Return the number of records.

getAuthForURL

public Authorization getAuthForURL(URL url)

getAuthHeaderForURL

public String getAuthHeaderForURL(URL url)

getAuthObjectAt

public Authorization getAuthObjectAt(int row)

getAuthObjects

public CollectionProperty getAuthObjects()

getColumnClass

public Class getColumnClass(int column)

getColumnCount

public int getColumnCount()

getColumnName

public String getColumnName(int column)

getGuiClass

public Class getGuiClass()

isEditable

public boolean isEditable()

remove

public void remove(int index)
Remove an authentication record.

save

public void save(String authFile)
            throws IOException
Save the authentication data to a file.

set

public void set(int index,
                String url,
                String user,
                String pass,
                String domain,
                String realm)
Update an authentication record.

uncompile

public void uncompile()

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