Apache JMeter
2.1.1

org.apache.jmeter.protocol.ldap.sampler
Class LDAPExtSampler

java.lang.Object
  extended byorg.apache.jmeter.testelement.AbstractTestElement
      extended byorg.apache.jmeter.samplers.AbstractSampler
          extended byorg.apache.jmeter.protocol.ldap.sampler.LDAPExtSampler
All Implemented Interfaces:
Cloneable, Sampler, Serializable, TestElement, TestListener

public class LDAPExtSampler
extends AbstractSampler
implements TestListener

Ldap Sampler class is main class for the LDAP test. This will control all the test available in the LDAP Test.

See Also:
Serialized Form

Field Summary
static String ADD
           
static String ARGUMENTS
           
static String ATTRIBS
           
static String BASE_ENTRY_DN
           
static String BIND
           
static String COMPARE
           
static String COMPAREDN
           
static String COMPAREFILT
           
static String COUNTLIM
           
static String DELETE
           
static String DEREF
           
static String LDAPARGUMENTS
           
static String MODDDN
           
static String MODIFY
           
static String NEWDN
           
static String PORT
           
static String RENAME
           
static String RETOBJ
           
static String ROOTDN
           
static String SBIND
           
static String SCOPE
           
static String SEARCHBASE
           
static String SEARCHFILTER
           
static String SERVERNAME
           
static String SUSERDN
           
static String SUSERPW
           
static String TEST
           
static String TIMELIM
           
static String UNBIND
           
static String USERDN
           
static String USERPW
           
 
Fields inherited from interface org.apache.jmeter.testelement.TestElement
ENABLED, GUI_CLASS, NAME, TEST_CLASS
 
Constructor Summary
LDAPExtSampler()
          !
 
Method Summary
 Arguments getArguments()
          Gets the Arguments attribute of the LdapConfig object
 String getAttrs()
          Gets the test attribute of the LDAPSampler object
 String getBaseEntryDN()
          Gets the BaseEntryDN attribute of the LDAPSampler object
 BasicAttribute getBasicAttribute(String name, String value)
          This will create the Basic Attribute for the give name value pair
 String getCountlim()
          Gets the size limit attribute of the LDAPSampler object
 boolean getDeref()
          Gets the search scope attribute of the LDAPSampler object
 String getLabel()
          Returns a formatted string label describing this sampler Example output:
 LDAPArguments getLDAPArguments()
          Gets the LDAPArguments attribute of the LdapConfig object
 String getPort()
          Gets the Port attribute of the LDAPSampler object
 String[] getRequestAttributes(String reqAttr)
          Collect all the value from the table (Arguments), using this create the Attributes This will create the Basic Attributes for the User defined TestCase for search test
 boolean getRetobj()
          Gets the return objects attribute of the LDAPSampler object
 String getRootdn()
          Gets the Rootdn attribute of the LDAPSampler object
 String getScope()
          Gets the search scope attribute of the LDAPSampler object
 String getServername()
          Gets the servername attribute of the LDAPSampler object
 String getSuserDN()
          Gets the username attribute of the LDAP object
 String getSuserPw()
          Gets the password attribute of the LDAP object
 String getTest()
          Gets the test attribute of the LDAPSampler object
 String getTimelim()
          Gets the time limit attribute of the LDAPSampler object
 BasicAttributes getUserAttributes()
          Collect all the value from the table (Arguments), using this create the basicAttributes This will create the Basic Attributes for the User defined TestCase for Add Test
 String getUserDN()
          Gets the username attribute of the LDAP object
 ModificationItem[] getUserModAttributes()
          Collect all the value from the table (Arguments), using this create the basicAttributes This will create the Basic Attributes for the User defined TestCase for Modify test
 String getUserPw()
          Gets the password attribute of the LDAP object
 SampleResult sample(Entry e)
          !
 void setArguments(Arguments value)
          Sets the Arguments attribute of the LdapConfig object This will collect values from the table for user defined test case
 void setAttrs(String newAttrs)
          Sets the Test attribute of the LdapConfig object
 void setBaseEntryDN(String newbaseentry)
          Sets the Base Entry DN attribute of the LDAPSampler object
 void setCountlim(String newClim)
          Sets the size limit attribute of the LDAPSampler object
 void setDeref(String newDref)
          Sets the search scope attribute of the LDAPSampler object
 void setLDAPArguments(LDAPArguments value)
          Sets the Arguments attribute of the LdapConfig object This will collect values from the table for user defined test case
 void setPort(String port)
          Sets the Port attribute of the ServerConfig object
 void setRetobj(String newRobj)
          Sets the return objects attribute of the LDAPSampler object
 void setRootdn(String newRootdn)
          Sets the Rootdn attribute of the LDAPSampler object
 void setScope(String newScope)
          Sets the search scope attribute of the LDAPSampler object
 void setServername(String servername)
          Sets the Servername attribute of the ServerConfig object
 void SetSuserDN(String newUserDN)
          Sets the username attribute of the LDAP object
 void setSuserPw(String newUserPw)
          Gets the password attribute of the LDAP object
 void setTest(String newTest)
          Sets the Test attribute of the LdapConfig object
 void setTimelim(String newTlim)
          Sets the time limit attribute of the LDAPSampler object
 void SetUserDN(String newUserDN)
          Sets the username attribute of the LDAP object
 void setUserPw(String newUserPw)
          Gets the password attribute of the LDAP object
 void testEnded()
          Called once for all threads after the end of a test
 void testEnded(String host)
           
 void testIterationStart(LoopIterationEvent event)
          Each time through a Thread Group's test script, an iteration event is fired.
 void testStarted()
          Called just before the start of the test Note that not all the test variables will have been set up at this point.
 void testStarted(String host)
           
 
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addProperty, addTestElement, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, nextIsNull, propertyIterator, recoverRunningVersion, removeProperty, setName, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, threadFinished, threadStarted, traverse, traverseCollection, traverseMap, traverseProperty
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jmeter.testelement.TestElement
addTestElement, canRemove, clear, clone, getProperty, getPropertyAsBoolean, getPropertyAsFloat, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removeProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, threadFinished, threadStarted, traverse
 

Field Detail

SERVERNAME

public static final String SERVERNAME
See Also:
Constant Field Values

PORT

public static final String PORT
See Also:
Constant Field Values

ROOTDN

public static final String ROOTDN
See Also:
Constant Field Values

TEST

public static final String TEST
See Also:
Constant Field Values

ADD

public static final String ADD
See Also:
Constant Field Values

MODIFY

public static final String MODIFY
See Also:
Constant Field Values

BIND

public static final String BIND
See Also:
Constant Field Values

UNBIND

public static final String UNBIND
See Also:
Constant Field Values

DELETE

public static final String DELETE
See Also:
Constant Field Values

SEARCHBASE

public static final String SEARCHBASE
See Also:
Constant Field Values

SEARCHFILTER

public static final String SEARCHFILTER
See Also:
Constant Field Values

ARGUMENTS

public static final String ARGUMENTS
See Also:
Constant Field Values

LDAPARGUMENTS

public static final String LDAPARGUMENTS
See Also:
Constant Field Values

BASE_ENTRY_DN

public static final String BASE_ENTRY_DN
See Also:
Constant Field Values

SCOPE

public static final String SCOPE
See Also:
Constant Field Values

COUNTLIM

public static final String COUNTLIM
See Also:
Constant Field Values

TIMELIM

public static final String TIMELIM
See Also:
Constant Field Values

ATTRIBS

public static final String ATTRIBS
See Also:
Constant Field Values

RETOBJ

public static final String RETOBJ
See Also:
Constant Field Values

DEREF

public static final String DEREF
See Also:
Constant Field Values

USERDN

public static final String USERDN
See Also:
Constant Field Values

USERPW

public static final String USERPW
See Also:
Constant Field Values

SBIND

public static final String SBIND
See Also:
Constant Field Values

COMPARE

public static final String COMPARE
See Also:
Constant Field Values

SUSERDN

public static final String SUSERDN
See Also:
Constant Field Values

SUSERPW

public static final String SUSERPW
See Also:
Constant Field Values

COMPAREDN

public static final String COMPAREDN
See Also:
Constant Field Values

COMPAREFILT

public static final String COMPAREFILT
See Also:
Constant Field Values

RENAME

public static final String RENAME
See Also:
Constant Field Values

MODDDN

public static final String MODDDN
See Also:
Constant Field Values

NEWDN

public static final String NEWDN
See Also:
Constant Field Values
Constructor Detail

LDAPExtSampler

public LDAPExtSampler()
!ToDo (Constructor description)

Method Detail

getUserDN

public String getUserDN()
Gets the username attribute of the LDAP object

Returns:
The username

SetUserDN

public void SetUserDN(String newUserDN)
Sets the username attribute of the LDAP object

Returns:
The username

getUserPw

public String getUserPw()
Gets the password attribute of the LDAP object

Returns:
The password

setUserPw

public void setUserPw(String newUserPw)
Gets the password attribute of the LDAP object

Returns:
The password

getSuserDN

public String getSuserDN()
Gets the username attribute of the LDAP object

Returns:
The username

SetSuserDN

public void SetSuserDN(String newUserDN)
Sets the username attribute of the LDAP object

Returns:
The username

getSuserPw

public String getSuserPw()
Gets the password attribute of the LDAP object

Returns:
The password

setSuserPw

public void setSuserPw(String newUserPw)
Gets the password attribute of the LDAP object

Returns:
The password

setServername

public void setServername(String servername)
Sets the Servername attribute of the ServerConfig object

Parameters:
servername - The new servername value

setPort

public void setPort(String port)
Sets the Port attribute of the ServerConfig object

Parameters:
port - The new Port value

getServername

public String getServername()
Gets the servername attribute of the LDAPSampler object

Returns:
The Servername value

getPort

public String getPort()
Gets the Port attribute of the LDAPSampler object

Returns:
The Port value

setRootdn

public void setRootdn(String newRootdn)
Sets the Rootdn attribute of the LDAPSampler object


getRootdn

public String getRootdn()
Gets the Rootdn attribute of the LDAPSampler object

Returns:
The Rootdn value

getScope

public String getScope()
Gets the search scope attribute of the LDAPSampler object

Returns:
The scope value

setScope

public void setScope(String newScope)
Sets the search scope attribute of the LDAPSampler object


getCountlim

public String getCountlim()
Gets the size limit attribute of the LDAPSampler object

Returns:
The scope value

setCountlim

public void setCountlim(String newClim)
Sets the size limit attribute of the LDAPSampler object


getTimelim

public String getTimelim()
Gets the time limit attribute of the LDAPSampler object

Returns:
The scope value

setTimelim

public void setTimelim(String newTlim)
Sets the time limit attribute of the LDAPSampler object


getRetobj

public boolean getRetobj()
Gets the return objects attribute of the LDAPSampler object

Returns:
The scope value

setRetobj

public void setRetobj(String newRobj)
Sets the return objects attribute of the LDAPSampler object


getDeref

public boolean getDeref()
Gets the search scope attribute of the LDAPSampler object

Returns:
The scope value

setDeref

public void setDeref(String newDref)
Sets the search scope attribute of the LDAPSampler object


setTest

public void setTest(String newTest)
Sets the Test attribute of the LdapConfig object


getTest

public String getTest()
Gets the test attribute of the LDAPSampler object

Returns:
The test value (Add,Modify,Delete and search)

setAttrs

public void setAttrs(String newAttrs)
Sets the Test attribute of the LdapConfig object


getAttrs

public String getAttrs()
Gets the test attribute of the LDAPSampler object

Returns:
The test value (Add,Modify,Delete and search)

setBaseEntryDN

public void setBaseEntryDN(String newbaseentry)
Sets the Base Entry DN attribute of the LDAPSampler object


getBaseEntryDN

public String getBaseEntryDN()
Gets the BaseEntryDN attribute of the LDAPSampler object

Returns:
The Base entry DN value

setArguments

public void setArguments(Arguments value)
Sets the Arguments attribute of the LdapConfig object This will collect values from the table for user defined test case

Parameters:
value - The arguments

getArguments

public Arguments getArguments()
Gets the Arguments attribute of the LdapConfig object

Returns:
The arguments user defined test case

setLDAPArguments

public void setLDAPArguments(LDAPArguments value)
Sets the Arguments attribute of the LdapConfig object This will collect values from the table for user defined test case

Parameters:
value - The arguments

getLDAPArguments

public LDAPArguments getLDAPArguments()
Gets the LDAPArguments attribute of the LdapConfig object

Returns:
The LDAParguments user defined modify test case

getUserAttributes

public BasicAttributes getUserAttributes()
Collect all the value from the table (Arguments), using this create the basicAttributes This will create the Basic Attributes for the User defined TestCase for Add Test

Returns:
The BasicAttributes

getUserModAttributes

public ModificationItem[] getUserModAttributes()
Collect all the value from the table (Arguments), using this create the basicAttributes This will create the Basic Attributes for the User defined TestCase for Modify test

Returns:
The BasicAttributes

getRequestAttributes

public String[] getRequestAttributes(String reqAttr)
Collect all the value from the table (Arguments), using this create the Attributes This will create the Basic Attributes for the User defined TestCase for search test

Returns:
The BasicAttributes

getBasicAttribute

public BasicAttribute getBasicAttribute(String name,
                                        String value)
This will create the Basic Attribute for the give name value pair

Returns:
The BasicAttribute

getLabel

public String getLabel()
Returns a formatted string label describing this sampler Example output:

Returns:
a formatted string label describing this sampler

sample

public SampleResult sample(Entry e)
!ToDo (Method description)

Specified by:
sample in interface Sampler
Parameters:
e - !ToDo (Parameter description)
Returns:
!ToDo (Return description)

testStarted

public void testStarted()
Description copied from interface: TestListener
Called just before the start of the test Note that not all the test variables will have been set up at this point.

Specified by:
testStarted in interface TestListener
See Also:
StandardJMeterEngine.run()

testEnded

public void testEnded()
Description copied from interface: TestListener
Called once for all threads after the end of a test

Specified by:
testEnded in interface TestListener
See Also:
StandardJMeterEngine.stopTest()

testStarted

public void testStarted(String host)
Specified by:
testStarted in interface TestListener

testEnded

public void testEnded(String host)
Specified by:
testEnded in interface TestListener

testIterationStart

public void testIterationStart(LoopIterationEvent event)
Description copied from interface: TestListener
Each time through a Thread Group's test script, an iteration event is fired.

Specified by:
testIterationStart in interface TestListener
Parameters:
event -

Apache JMeter
2.1.1

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