A B C D E F G H I J L M O P R S T V X _

A

AbstractReporter - class org.apache.commons.latka.AbstractReporter.

The base class for several 'reporters'.

AbstractReporter() - Constructor for class org.apache.commons.latka.AbstractReporter

addCookie(String, String, String, String) - Method in interface org.apache.commons.latka.http.Session

Adds a cookie to all HTTP requests whose domain and path match (according to RFC2109).

addCookie(String, String, String, String) - Method in class org.apache.commons.latka.http.SessionImpl

Adds a cookie to all HTTP requests whose domain and path match (according to RFC2109).

addHeader(String, String) - Method in interface org.apache.commons.latka.http.Request

Sets a request header.

addHeader(String, String) - Method in interface org.apache.commons.latka.http.RequestHeaders

Add a header to the request

addHeader(String, String) - Method in class org.apache.commons.latka.http.RequestHeadersImpl

Defined in interface

addHeader(String, String) - Method in class org.apache.commons.latka.http.RequestImpl

Set a header in the request

addHttpClientParameter(String, String) - Method in class org.apache.commons.latka.http.RequestImpl

Associate a parameter with this request.

addListener(LatkaEventListener) - Method in class org.apache.commons.latka.event.LatkaEventPublisher

add a LatkaEventListener to the list of publishees.

addParameter(String, String) - Method in interface org.apache.commons.latka.http.Parameters

Add a parameter to the request

addParameter(String, String) - Method in class org.apache.commons.latka.http.ParametersImpl

Defined in interface

addParameter(String, String) - Method in interface org.apache.commons.latka.http.Request

Associate a parameter with this request.

addParameter(String, String) - Method in class org.apache.commons.latka.http.RequestImpl

Add a parameter (name and value) to the request

assertTrue(Response) - Method in class org.apache.commons.latka.validators.BaseConditionalValidator

Return true or false, depending on whether or not the test conditions were met.

assertTrue(Response) - Method in class org.apache.commons.latka.validators.CookieValidator

assertTrue(Response) - Method in class org.apache.commons.latka.validators.RegexpValidator

assertTrue(Response) - Method in class org.apache.commons.latka.validators.ResponseHeaderValidator

Checks to see that the header exists, and also checks its value if setHeaderValue(String) has been called

assertTrue(Response) - Method in class org.apache.commons.latka.validators.XPathValidator

B

BARE_EXCEPTION_MESSAGE - Static variable in class org.apache.commons.latka.validators.RegexpValidator

BARE_MESSAGE_EQUAL_VALUES - Static variable in class org.apache.commons.latka.validators.CookieValidator

BARE_MESSAGE_EQUAL_VALUES - Static variable in class org.apache.commons.latka.validators.ResponseHeaderValidator

BARE_MESSAGE_EXISTENT_COOKIE - Static variable in class org.apache.commons.latka.validators.CookieValidator

BARE_MESSAGE_EXISTENT_HEADER - Static variable in class org.apache.commons.latka.validators.ResponseHeaderValidator

BaseConditionalValidator - class org.apache.commons.latka.validators.BaseConditionalValidator.

This subclass of BaseValidator largely removes the need of a validator to know whether a particular test is supposed to succeed or fail.

BaseConditionalValidator(boolean) - Constructor for class org.apache.commons.latka.validators.BaseConditionalValidator

A test without a label

BaseConditionalValidator(String, boolean) - Constructor for class org.apache.commons.latka.validators.BaseConditionalValidator

A test with a label

BaseRequestEvent - class org.apache.commons.latka.event.BaseRequestEvent.

The base class for request events fired by latka.

BaseRequestEvent(Request, Response) - Constructor for class org.apache.commons.latka.event.BaseRequestEvent

Store the request, response and session for later retrieval

BaseValidator - class org.apache.commons.latka.validators.BaseValidator.

BaseValidator() - Constructor for class org.apache.commons.latka.validators.BaseValidator

BaseValidator(String) - Constructor for class org.apache.commons.latka.validators.BaseValidator

ByteLengthTag - class org.apache.commons.latka.jelly.validators.ByteLengthTag.

A class to check the size of an HTTP response

ByteLengthTag() - Constructor for class org.apache.commons.latka.jelly.validators.ByteLengthTag

ByteLengthValidator - class org.apache.commons.latka.validators.ByteLengthValidator.

FIXME: Docs

ByteLengthValidator() - Constructor for class org.apache.commons.latka.validators.ByteLengthValidator

ByteLengthValidator(String) - Constructor for class org.apache.commons.latka.validators.ByteLengthValidator

ByteLengthValidator(int, int) - Constructor for class org.apache.commons.latka.validators.ByteLengthValidator

ByteLengthValidator(String, int, int) - Constructor for class org.apache.commons.latka.validators.ByteLengthValidator

broadcastEvent(LatkaEvent) - Method in class org.apache.commons.latka.event.LatkaEventPublisher

Send the provided event object to all registered listeners

broadcastEvent(LatkaEvent, LatkaEventListener) - Method in class org.apache.commons.latka.event.LatkaEventPublisher

Send the provided event to the provided listener

buildJellyContext() - Method in class org.apache.commons.latka.Latka

C

CookieTag - class org.apache.commons.latka.jelly.validators.CookieTag.

A class to check for the existence and value of cookies

CookieTag() - Constructor for class org.apache.commons.latka.jelly.validators.CookieTag

CookieValidator - class org.apache.commons.latka.validators.CookieValidator.

CookieValidator validates cookie existence and/or value in an HTTP session.

CookieValidator() - Constructor for class org.apache.commons.latka.validators.CookieValidator

CookieValidator(String) - Constructor for class org.apache.commons.latka.validators.CookieValidator

CookieValidator(String, String) - Constructor for class org.apache.commons.latka.validators.CookieValidator

CookieValidator(String, String, String, boolean) - Constructor for class org.apache.commons.latka.validators.CookieValidator

Credentials - interface org.apache.commons.latka.http.Credentials.

Used for authentication

CredentialsImpl - class org.apache.commons.latka.http.CredentialsImpl.

Concrete Implementation of Credentials

CredentialsImpl(String, String) - Constructor for class org.apache.commons.latka.http.CredentialsImpl

Create credentials given user name and password

CredentialsTag - class org.apache.commons.latka.jelly.CredentialsTag.

Basic authentication support for requests

CredentialsTag() - Constructor for class org.apache.commons.latka.jelly.CredentialsTag

closeConnection() - Method in class org.apache.commons.latka.http.RequestImpl

Closes the http connection associated with the request

compare(byte[], byte[]) - Method in class org.apache.commons.latka.validators.GoldenFileValidator

compareWeak(String, String) - Method in class org.apache.commons.latka.validators.GoldenFileValidator

countTestCases() - Method in class org.apache.commons.latka.junit.JUnitTestAdapter

Provides access, post-parsing, of the number of request elements in the Latka Suite

createRequest(URL, int, String) - Method in interface org.apache.commons.latka.http.Session

Creates a request object with the specified URL, HTTP Method, and version.

createRequest(String, URL, int, String, boolean) - Method in interface org.apache.commons.latka.http.Session

Creates a labeled request object, with the specified URL, HTTP Method, version, and redirect handling behavior.

createRequest(URL, int, Proxy, String) - Method in interface org.apache.commons.latka.http.Session

Creates a request object with the specified URL, HTTP Method, and version to be accessed via the provided proxy.

createRequest(String, URL, int, String, boolean, Proxy) - Method in interface org.apache.commons.latka.http.Session

Create a labeled request with the specified URL, HTTP method, version, and redirect handling behavior, using the given proxy for communication.

createRequest(URL, int, String) - Method in class org.apache.commons.latka.http.SessionImpl

Creates a request object with the specified URL, HTTP Method, and version.

createRequest(String, URL, int, String, boolean) - Method in class org.apache.commons.latka.http.SessionImpl

Creates a labeled request object with the specified URL, HTTP Method, version, and redirect handling behavior.

createRequest(URL, int, Proxy, String) - Method in class org.apache.commons.latka.http.SessionImpl

Creates a request object with the specified URL, HTTP Method, and version to be accessed via the provided proxy.

createRequest(String, URL, int, String, boolean, Proxy) - Method in class org.apache.commons.latka.http.SessionImpl

Create a labeled request , with the specified URL, HTTP method, version, and redirect handling behavior, using the given proxy for communications.

createRequestElement(RequestEvent) - Method in class org.apache.commons.latka.XMLReporter

Utility method that converts a RequestEvent object to its corresponding element in the dom4j object.

createTestFromFile(String) - Static method in class org.apache.commons.latka.junit.JUnitTestAdapter

Create a Test from a Latka file

createTestFromFile(File) - Static method in class org.apache.commons.latka.junit.JUnitTestAdapter

Create a Test from a Java file

createTestFromResource(String) - Static method in class org.apache.commons.latka.junit.JUnitTestAdapter

Create a Test from a resource accessible via the class loader

createTestFromURL(String) - Static method in class org.apache.commons.latka.junit.JUnitTestAdapter

Create a Test from a String containing a URL whose contents are in Latka's XML format

createTestFromURL(URL) - Static method in class org.apache.commons.latka.junit.JUnitTestAdapter

Create a Test from a URL whose contents are in Latka's XML format

D

DefaultLatkaEventInfo - class org.apache.commons.latka.DefaultLatkaEventInfo.

The base class for several 'reporters'.

DefaultLatkaEventInfo(LatkaEventListener) - Constructor for class org.apache.commons.latka.DefaultLatkaEventInfo

didRequestSucceed(Request) - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

Check to see if a particular Request succeeded or failed.

didRequestSucceed(Request) - Method in interface org.apache.commons.latka.event.LatkaEventInfo

Check to see if a particular Request succeeded or failed.

didSessionSucceed(Session) - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

Check to see if a particular Session succeeded or failed.

didSessionSucceed(Session) - Method in interface org.apache.commons.latka.event.LatkaEventInfo

Check to see if a particular Session succeeded or failed.

didSuiteSucceed() - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

Returns true if all Requests in the suite succeed.

didSuiteSucceed() - Method in interface org.apache.commons.latka.event.LatkaEventInfo

Returns true if all Requests in the suite succeed.

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.latka.servlet.ViewResponseServlet

Perform a get request

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.latka.servlet.ViewSuiteServlet

Perform a get request

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.latka.servlet.ViewResponseServlet

Perform a post request

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.latka.servlet.ViewSuiteServlet

perform a get request

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.CredentialsTag

Set user credentials

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.ParameterNameTag

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.ParameterTag

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.ParameterValueTag

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.ReportMessageTag

Send a report message to the listener

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.RequestBodyTag

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.RequestHeaderTag

Set user credentials

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.RequestTag

Wraps Latka tests, provides some defaults for host, port etc.

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.SessionTag

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.SuiteTag

Wraps Latka tests, provides some defaults for host, port etc.

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.ValidateTag

make sure the request executes, then call validators.

doTag(XMLOutput) - Method in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

Provides a default implementation for simple validation tags.

E

EVENT_INFO_VAR - Static variable in class org.apache.commons.latka.jelly.JellyUtils

EVENT_LISTENER_VAR - Static variable in class org.apache.commons.latka.jelly.JellyUtils

execute() - Method in interface org.apache.commons.latka.http.Request

Execute this HTTP request.

execute() - Method in class org.apache.commons.latka.http.RequestImpl

Executes the request.

executeRequestPerHost() - Method in class org.apache.commons.latka.http.RequestImpl

Execute the request - perform the http interaction.

F

fail(String) - Method in class org.apache.commons.latka.validators.BaseValidator

findParentRequest(Tag) - Method in class org.apache.commons.latka.jelly.JellyUtils

Given a tag, find a parent RequestTag and return its Request object.

findSession() - Method in class org.apache.commons.latka.jelly.RequestTag

findSession(String) - Method in class org.apache.commons.latka.jelly.SessionTag

followRedirects() - Method in interface org.apache.commons.latka.http.Request

Whether or not this request will instruct HttpClient to follow local redirects automatically.

followRedirects() - Method in class org.apache.commons.latka.http.RequestImpl

Defined in the interface

G

GoldenFileTag - class org.apache.commons.latka.jelly.validators.GoldenFileTag.

A class to compare an HTTP response to a golden file

GoldenFileTag() - Constructor for class org.apache.commons.latka.jelly.validators.GoldenFileTag

GoldenFileValidator - class org.apache.commons.latka.validators.GoldenFileValidator.

Compare the response with a golden file.

GoldenFileValidator(File) - Constructor for class org.apache.commons.latka.validators.GoldenFileValidator

GoldenFileValidator(String, File) - Constructor for class org.apache.commons.latka.validators.GoldenFileValidator

generateBareExceptionMessage() - Method in class org.apache.commons.latka.validators.BaseConditionalValidator

The BASE exception message for a subclass of BaseConditionalValidator.

generateBareExceptionMessage() - Method in class org.apache.commons.latka.validators.CookieValidator

generateBareExceptionMessage() - Method in class org.apache.commons.latka.validators.RegexpValidator

generateBareExceptionMessage() - Method in class org.apache.commons.latka.validators.ResponseHeaderValidator

generateBareExceptionMessage() - Method in class org.apache.commons.latka.validators.XPathValidator

getByteLength() - Method in interface org.apache.commons.latka.http.Response

Returns the length of the Response stream (as bytes), or -1 if no stream is available

getByteLength() - Method in class org.apache.commons.latka.http.ResponseImpl

Returns the length of the Response stream (as bytes), or -1 if no stream is available

getCondition() - Method in class org.apache.commons.latka.validators.BaseConditionalValidator

Returns whether or not this test is supposed to succeed

getCookieValue(String) - Method in interface org.apache.commons.latka.http.Session

Returns the value of cookie name.

getCookieValue(String) - Method in class org.apache.commons.latka.http.SessionImpl

Returns the value of cookie name.

getCredentials() - Method in interface org.apache.commons.latka.http.Request

Return the credentials for this request

getCredentials() - Method in class org.apache.commons.latka.http.RequestImpl

getDefaultHost() - Method in class org.apache.commons.latka.jelly.SuiteSettings

defaultHost

getDefaultPort() - Method in class org.apache.commons.latka.jelly.SuiteSettings

defaultPort

getDefaultProxyHost() - Method in class org.apache.commons.latka.jelly.SuiteSettings

defaultProxyHost

getDefaultProxyPort() - Method in class org.apache.commons.latka.jelly.SuiteSettings

defaultProxyPort

getDocument() - Method in class org.apache.commons.latka.XMLReporter

Returns the XML Document produced by this listener

getDocumentAsString() - Method in class org.apache.commons.latka.XMLReporter

Returns the test report converted from dom4j to a text string.

getError() - Method in class org.apache.commons.latka.event.RequestErrorEvent

provides access to the Throwable representing the request error

getException() - Method in class org.apache.commons.latka.LatkaException

Get a wrapped exception

getFailedResponses() - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

List failed responses

getFailedResponses() - Method in interface org.apache.commons.latka.event.LatkaEventInfo

Returns a List of all responses that failed validation.

getHeader(String) - Method in interface org.apache.commons.latka.http.Response

Check a response header.

getHeader(String) - Method in class org.apache.commons.latka.http.ResponseImpl

Check a response header.

getHeaders() - Method in interface org.apache.commons.latka.http.Request

Get the headers for the request, so that they can be copied to another request if necessary.

getHeaders() - Method in interface org.apache.commons.latka.http.RequestHeaders

Return a list of all the headers for the request.

getHeaders() - Method in class org.apache.commons.latka.http.RequestHeadersImpl

Defined in interface

getHeaders() - Method in class org.apache.commons.latka.http.RequestImpl

Defined in the implemented interface

getHost() - Method in class org.apache.commons.latka.http.Proxy

Getter for property host.

getHttpMethod() - Method in class org.apache.commons.latka.http.RequestImpl

Returns the object implementing the HttpMethod (get, post, etc.) for this request.

getInstance(int, URL) - Static method in class org.apache.commons.latka.http.MethodFactory

Creates and returns an object implementing the HttpMethod interface.

getInstance() - Static method in class org.apache.commons.latka.jelly.JellyUtils

getLabel() - Method in class org.apache.commons.latka.ValidationException

User's description of the test/assertion

getLabel() - Method in interface org.apache.commons.latka.http.Request

Assigns a text label to this request.

getLabel() - Method in class org.apache.commons.latka.http.RequestImpl

Get the label used for the request

getLabel() - Method in class org.apache.commons.latka.validators.BaseValidator

getLatkaEventInfo(JellyContext) - Method in class org.apache.commons.latka.jelly.JellyUtils

Return the LatkaEventInfo for the context, or null if none has been set

getLatkaEventListener(JellyContext) - Method in class org.apache.commons.latka.jelly.JellyUtils

Return the LatkaEventListener for the context, or null if none has been set

getMessage() - Method in class org.apache.commons.latka.ValidationException

the message of the exception

getMessage() - Method in class org.apache.commons.latka.event.ReportMessageEvent

The message text of the event

getMethod() - Method in interface org.apache.commons.latka.http.Request

Return the constant representing the HTTP method to use in this request

getMethod() - Method in class org.apache.commons.latka.http.RequestImpl

Defined in the interface

getParameters() - Method in interface org.apache.commons.latka.http.Parameters

Returns a list of all the parameters for the request.

getParameters() - Method in class org.apache.commons.latka.http.ParametersImpl

Defined in interface

getParameters() - Method in interface org.apache.commons.latka.http.Request

Get the parameters for the request, so that they can be copied to another request if necessary.

getParameters() - Method in class org.apache.commons.latka.http.RequestImpl

Defined in the implemented interface

getPassword() - Method in interface org.apache.commons.latka.http.Credentials

return the user's password

getPassword() - Method in class org.apache.commons.latka.http.CredentialsImpl

return the user's password

getPort() - Method in class org.apache.commons.latka.http.Proxy

Getter for property port.

getProperties() - Static method in class org.apache.commons.latka.LatkaProperties

Returns the unique Properties object for the current Thread.

getProxy() - Method in class org.apache.commons.latka.http.RequestImpl

Getter for property proxy.

getReason() - Method in class org.apache.commons.latka.ValidationException

Why the test/assertion failed

getReferer() - Method in class org.apache.commons.latka.http.SessionImpl

The URL of the last request that was executed.

getRequest() - Method in class org.apache.commons.latka.event.BaseRequestEvent

getRequest() - Method in interface org.apache.commons.latka.event.RequestEvent

the request the event is about

getRequest() - Method in interface org.apache.commons.latka.http.Response

Getter for request property

getRequest() - Method in class org.apache.commons.latka.http.ResponseImpl

Defined in interface

getRequest() - Method in class org.apache.commons.latka.jelly.RequestTag

getRequestExecuted() - Method in class org.apache.commons.latka.jelly.RequestTag

getRequestTiming() - Method in interface org.apache.commons.latka.http.Request

The amount of time it took to execute the request in milliseconds, or -1 if the request has not been executed successfully

getRequestTiming() - Method in class org.apache.commons.latka.http.RequestImpl

getResource() - Method in interface org.apache.commons.latka.http.Response

Returns the resource, in string form, provided by the HTTP server

getResource() - Method in class org.apache.commons.latka.http.ResponseImpl

Returns the resource, in string form, provided by the HTTP server

getResponse() - Method in class org.apache.commons.latka.event.BaseRequestEvent

getResponse() - Method in interface org.apache.commons.latka.event.RequestEvent

the response associated with the event's request

getResponse() - Method in class org.apache.commons.latka.jelly.RequestTag

The first time this method is called, a live HTTP call will be made to the server, returning null if the response cannot be obtained.

getResponse() - Method in class org.apache.commons.latka.jelly.ValidateTag

getResponse() - Method in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

the response being validated

getSession() - Method in class org.apache.commons.latka.event.BaseRequestEvent

getSession() - Method in interface org.apache.commons.latka.event.RequestEvent

the session the event took place within

getSession() - Method in interface org.apache.commons.latka.http.Request

Retrieve the session associated with this request.

getSession() - Method in class org.apache.commons.latka.http.RequestImpl

Retrieve the session associated with this request.

getSession() - Method in class org.apache.commons.latka.jelly.SessionTag

getSessionCache() - Method in class org.apache.commons.latka.jelly.SuiteTag

getStatusCode() - Method in interface org.apache.commons.latka.http.Response

getStatusCode() - Method in class org.apache.commons.latka.http.ResponseImpl

getStatusText() - Method in interface org.apache.commons.latka.http.Response

getStatusText() - Method in class org.apache.commons.latka.http.ResponseImpl

getStream() - Method in interface org.apache.commons.latka.http.Response

Get the actual bytes returned by the web server

getStream() - Method in class org.apache.commons.latka.http.ResponseImpl

Get the actual bytes returned by the web server

getSuiteSettings() - Method in class org.apache.commons.latka.jelly.RequestTag

get the suite settings from SuiteTag

getSuiteSettings() - Method in class org.apache.commons.latka.jelly.SuiteTag

getURL() - Method in class org.apache.commons.latka.Suite

URL containing the test suite.

getURL() - Method in interface org.apache.commons.latka.http.Request

Gets the URL that Latka will attempt to contact.

getURL() - Method in class org.apache.commons.latka.http.RequestImpl

Get the URL used for the request

getUserName() - Method in interface org.apache.commons.latka.http.Credentials

return the user's name

getUserName() - Method in class org.apache.commons.latka.http.CredentialsImpl

return the user's name

getValidationException() - Method in class org.apache.commons.latka.event.RequestFailedEvent

get the validation exception provided on construction

getValidator() - Method in class org.apache.commons.latka.jelly.validators.ByteLengthTag

getValidator() - Method in class org.apache.commons.latka.jelly.validators.CookieTag

getValidator() - Method in class org.apache.commons.latka.jelly.validators.GoldenFileTag

return the golden file validator

getValidator() - Method in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

getValidator() - Method in class org.apache.commons.latka.jelly.validators.MaxRequestTimeTag

return the validator

getValidator() - Method in class org.apache.commons.latka.jelly.validators.RegexpTag

getValidator() - Method in class org.apache.commons.latka.jelly.validators.ResponseHeaderTag

return the validator

getValidator() - Method in class org.apache.commons.latka.jelly.validators.StatusCodeTag

return the validator

getValidator() - Method in class org.apache.commons.latka.jelly.validators.StatusTextTag

return the validator

getValidator() - Method in class org.apache.commons.latka.jelly.validators.XPathTag

return the validator

getVersion() - Method in interface org.apache.commons.latka.http.Request

Get the HTTP version to use in this request

getVersion() - Method in class org.apache.commons.latka.http.RequestImpl

Get the HTTP version to use in this request.

H

HTTPS_PORT - Static variable in class org.apache.commons.latka.http.RequestImpl

Standard HTTPS Port

HTTP_METHOD_GET - Static variable in interface org.apache.commons.latka.http.Request

An integer representing the HTTP GET method

HTTP_METHOD_HEAD - Static variable in interface org.apache.commons.latka.http.Request

An integer representing the HTTP POST method

HTTP_METHOD_POST - Static variable in interface org.apache.commons.latka.http.Request

An integer representing the HTTP POST method

HTTP_PORT - Static variable in class org.apache.commons.latka.http.RequestImpl

Standard HTTP Port

HtmlPrettyPrintWriter - class org.apache.commons.latka.HtmlPrettyPrintWriter.

Provides more attractive HTML formatting for the runtime output of Latka.

HtmlPrettyPrintWriter(Writer) - Constructor for class org.apache.commons.latka.HtmlPrettyPrintWriter

Create a HtmlPrettyPrintWriter wrapping an existing writer sends output to the wrapped writer

HttpValidatorTagSupport - class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport.

A base class for validation tags

HttpValidatorTagSupport() - Constructor for class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

I

init() - Method in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

Called by the ValidationFactory.

J

JUnitEventReporter - class org.apache.commons.latka.junit.JUnitEventReporter.

A Latka reporter that takes the various latka events and adapts them into JUnit Tests.

JUnitEventReporter(TestResult) - Constructor for class org.apache.commons.latka.junit.JUnitEventReporter

Create a JUnitEventReporter, storing the JUnit Test results in the provided object

JUnitTestAdapter - class org.apache.commons.latka.junit.JUnitTestAdapter.

A JUnit Test which is created by wrapping a Latka Suite

JUnitTestAdapter(Suite, int) - Constructor for class org.apache.commons.latka.junit.JUnitTestAdapter

Create a Test from a Latka suite and a number of tests

JellyUtils - class org.apache.commons.latka.jelly.JellyUtils.

JellyUtils() - Constructor for class org.apache.commons.latka.jelly.JellyUtils

Creates a new instance of SuiteTag

L

Latka - class org.apache.commons.latka.Latka.

This is the primary class for executing Latka functional tests.

Latka() - Constructor for class org.apache.commons.latka.Latka

LatkaEvent - interface org.apache.commons.latka.event.LatkaEvent.

A 'marker' interface that all classes which are able to function as Latka events must implement

LatkaEventInfo - interface org.apache.commons.latka.event.LatkaEventInfo.

An extension to LatkaEventListener that stores the success or failure of all requests.

LatkaEventListener - interface org.apache.commons.latka.event.LatkaEventListener.

Event listener used during the execution of Latka tests.

LatkaEventPublisher - class org.apache.commons.latka.event.LatkaEventPublisher.

A LatkaEventListener that publishes the incoming events to other listeners

LatkaEventPublisher() - Constructor for class org.apache.commons.latka.event.LatkaEventPublisher

LatkaException - exception org.apache.commons.latka.LatkaException.

Latka throws this exception to the client whenever a problem occurs that is not covered by one of the standard JDK exceptions (validation errors, SAX problems, etc.)

LatkaException(String) - Constructor for class org.apache.commons.latka.LatkaException

Standard exception constructor

LatkaException(Exception) - Constructor for class org.apache.commons.latka.LatkaException

Wrapped exception.

LatkaProperties - class org.apache.commons.latka.LatkaProperties.

Stores properties for Latka.

LatkaProperties() - Constructor for class org.apache.commons.latka.LatkaProperties

LatkaTagLibrary - class org.apache.commons.latka.jelly.LatkaTagLibrary.

A Jelly version of Latka

LatkaTagLibrary() - Constructor for class org.apache.commons.latka.jelly.LatkaTagLibrary

Creates a new instance of LatkaTagLibrary

loadDefaultProps() - Static method in class org.apache.commons.latka.LatkaProperties

Loads the default Properties from the first "latka.properties" file located encountered in the classpath.

loadPropsFromClasspath(String) - Static method in class org.apache.commons.latka.LatkaProperties

Load properties specified from context class path

loadUserProps() - Static method in class org.apache.commons.latka.LatkaProperties

Load latka.properties from classpath

log(String) - Method in class org.apache.commons.latka.validators.GoldenFileValidator

logXML(String) - Method in class org.apache.commons.latka.Latka

Use this method to log XML generated by the XMLReporter class.

M

MAX_MESSAGE - Static variable in class org.apache.commons.latka.validators.ByteLengthValidator

MESSAGE - Static variable in class org.apache.commons.latka.validators.MaxRequestTimeValidator

MESSAGE - Static variable in class org.apache.commons.latka.validators.StatusCodeValidator

MESSAGE_INVALID_TEST - Static variable in class org.apache.commons.latka.validators.CookieValidator

MIN_MESSAGE - Static variable in class org.apache.commons.latka.validators.ByteLengthValidator

MaxRequestTimeTag - class org.apache.commons.latka.jelly.validators.MaxRequestTimeTag.

Class to validate the request time

MaxRequestTimeTag() - Constructor for class org.apache.commons.latka.jelly.validators.MaxRequestTimeTag

MaxRequestTimeValidator - class org.apache.commons.latka.validators.MaxRequestTimeValidator.

MaxRequestTimeValidator() - Constructor for class org.apache.commons.latka.validators.MaxRequestTimeValidator

MaxRequestTimeValidator(String) - Constructor for class org.apache.commons.latka.validators.MaxRequestTimeValidator

MaxRequestTimeValidator(String, int) - Constructor for class org.apache.commons.latka.validators.MaxRequestTimeValidator

MethodFactory - class org.apache.commons.latka.http.MethodFactory.

This factory provides a single point to obtain implementations of HttpMethod base.

main(String[]) - Static method in class org.apache.commons.latka.Latka

Execute a single test suite via the command line interface.

O

openConnection() - Method in class org.apache.commons.latka.http.RequestImpl

opens an HTTP connection.

org.apache.commons.latka - package org.apache.commons.latka

org.apache.commons.latka.event - package org.apache.commons.latka.event

org.apache.commons.latka.http - package org.apache.commons.latka.http

org.apache.commons.latka.jelly - package org.apache.commons.latka.jelly

org.apache.commons.latka.jelly.validators - package org.apache.commons.latka.jelly.validators

org.apache.commons.latka.junit - package org.apache.commons.latka.junit

org.apache.commons.latka.servlet - package org.apache.commons.latka.servlet

org.apache.commons.latka.validators - package org.apache.commons.latka.validators

P

PORT_UNSPECIFIED - Static variable in class org.apache.commons.latka.http.Proxy

the port number that represents port is unassigned

ParameterNameTag - class org.apache.commons.latka.jelly.ParameterNameTag.

ParameterNameTag() - Constructor for class org.apache.commons.latka.jelly.ParameterNameTag

ParameterTag - class org.apache.commons.latka.jelly.ParameterTag.

ParameterTag() - Constructor for class org.apache.commons.latka.jelly.ParameterTag

ParameterValueTag - class org.apache.commons.latka.jelly.ParameterValueTag.

ParameterValueTag() - Constructor for class org.apache.commons.latka.jelly.ParameterValueTag

Parameters - interface org.apache.commons.latka.http.Parameters.

Create a new set of parameters

ParametersImpl - class org.apache.commons.latka.http.ParametersImpl.

An implementation of the Parameters interface that stores the name value pairs as a list of two element string arrays

ParametersImpl() - Constructor for class org.apache.commons.latka.http.ParametersImpl

Protected access, parameters can only be copied from request to request.

Proxy - class org.apache.commons.latka.http.Proxy.

A class that holds proxy details for a session.

Proxy() - Constructor for class org.apache.commons.latka.http.Proxy

Creates a new instance of Proxy

Proxy(String, int) - Constructor for class org.apache.commons.latka.http.Proxy

Create a proxy given a host name and port number .

parse(InputSource) - Static method in class org.apache.commons.latka.junit.JUnitTestAdapter

Parse the Latka XML document to count the requests

print(String) - Method in class org.apache.commons.latka.HtmlPrettyPrintWriter

Write a string to the wrapped writer format it specially as per the class definition

printStackTrace() - Method in class org.apache.commons.latka.LatkaException

provide wrapped exception details

printStackTrace(PrintStream) - Method in class org.apache.commons.latka.LatkaException

provide wrapped exception details

printStackTrace(PrintWriter) - Method in class org.apache.commons.latka.LatkaException

Print wrapped exception details, if any

printWrappedExceptions(LatkaException) - Static method in class org.apache.commons.latka.LatkaException

Print a wrapped exception to stdout and, in the case of SAXExceptions, an additional wrapped exception.

R

RegexpTag - class org.apache.commons.latka.jelly.validators.RegexpTag.

A class to match some part of the response body to a regular expression

RegexpTag() - Constructor for class org.apache.commons.latka.jelly.validators.RegexpTag

RegexpValidator - class org.apache.commons.latka.validators.RegexpValidator.

Perform regular expression matches on the body of the HTTP response.

RegexpValidator() - Constructor for class org.apache.commons.latka.validators.RegexpValidator

RegexpValidator(String) - Constructor for class org.apache.commons.latka.validators.RegexpValidator

RegexpValidator(String, String, boolean, boolean) - Constructor for class org.apache.commons.latka.validators.RegexpValidator

ReportMessageEvent - class org.apache.commons.latka.event.ReportMessageEvent.

An event detailing a report message

ReportMessageEvent(String) - Constructor for class org.apache.commons.latka.event.ReportMessageEvent

Create a new instance of the class with the supplied message

ReportMessageTag - class org.apache.commons.latka.jelly.ReportMessageTag.

Report message tag

ReportMessageTag() - Constructor for class org.apache.commons.latka.jelly.ReportMessageTag

Request - interface org.apache.commons.latka.http.Request.

A Latka Request represents a request from an HTTP server.

RequestBodyTag - class org.apache.commons.latka.jelly.RequestBodyTag.

RequestBodyTag() - Constructor for class org.apache.commons.latka.jelly.RequestBodyTag

RequestErrorEvent - class org.apache.commons.latka.event.RequestErrorEvent.

An event that represents an error that occurred processing a request

RequestErrorEvent(Request, Response, Throwable) - Constructor for class org.apache.commons.latka.event.RequestErrorEvent

Create an event from the request, response and some Throwable

RequestEvent - interface org.apache.commons.latka.event.RequestEvent.

The basic set of methods available on all Latka events

RequestFailedEvent - class org.apache.commons.latka.event.RequestFailedEvent.

An event for when a request fails

RequestFailedEvent(Request, Response, ValidationException) - Constructor for class org.apache.commons.latka.event.RequestFailedEvent

Create a new request failed event

RequestHeaderTag - class org.apache.commons.latka.jelly.RequestHeaderTag.

Add a header to the request

RequestHeaderTag() - Constructor for class org.apache.commons.latka.jelly.RequestHeaderTag

RequestHeaders - interface org.apache.commons.latka.http.RequestHeaders.

Manage a set of http request headers

RequestHeadersImpl - class org.apache.commons.latka.http.RequestHeadersImpl.

Implementation of RequestHeaders that stores its name-value pairs in a list

RequestHeadersImpl() - Constructor for class org.apache.commons.latka.http.RequestHeadersImpl

Protected access, headers can only be copied from request to request.

RequestImpl - class org.apache.commons.latka.http.RequestImpl.

An implementation of a Latka Request interface based on the Jakarta Commons HttpClient package.

RequestImpl(URL, int, HttpState, SessionImpl) - Constructor for class org.apache.commons.latka.http.RequestImpl

Create a request for the specified URL, process using the supplied method and use the supplied state and session for persistent data

RequestImpl(String, URL, int, HttpState, SessionImpl, boolean) - Constructor for class org.apache.commons.latka.http.RequestImpl

Create a RequestImpl

RequestSkippedEvent - class org.apache.commons.latka.event.RequestSkippedEvent.

An event used when Latka skips a request

RequestSkippedEvent(Request, Response) - Constructor for class org.apache.commons.latka.event.RequestSkippedEvent

Create a RequestSkippedEvent with the provided request and response

RequestSucceededEvent - class org.apache.commons.latka.event.RequestSucceededEvent.

An event generated by Latka when a request completes successfully

RequestSucceededEvent(Request, Response) - Constructor for class org.apache.commons.latka.event.RequestSucceededEvent

Create the event for the given request and response

RequestTag - class org.apache.commons.latka.jelly.RequestTag.

RequestTag() - Constructor for class org.apache.commons.latka.jelly.RequestTag

Response - interface org.apache.commons.latka.http.Response.

A Latka Response represents a response from an HTTP server.

ResponseHeaderTag - class org.apache.commons.latka.jelly.validators.ResponseHeaderTag.

Validator tag class

ResponseHeaderTag() - Constructor for class org.apache.commons.latka.jelly.validators.ResponseHeaderTag

ResponseHeaderValidator - class org.apache.commons.latka.validators.ResponseHeaderValidator.

ResponseHeaderValidator validates response headers in an HTTP session.

ResponseHeaderValidator(String) - Constructor for class org.apache.commons.latka.validators.ResponseHeaderValidator

Constructs a validator for the given header with no label.

ResponseHeaderValidator(String, String) - Constructor for class org.apache.commons.latka.validators.ResponseHeaderValidator

Constructs a labeled validator for the given header

ResponseHeaderValidator(String, String, boolean) - Constructor for class org.apache.commons.latka.validators.ResponseHeaderValidator

Constructs a labeled validator for the given header

ResponseImpl - class org.apache.commons.latka.http.ResponseImpl.

An implementation of a Latka Response interface based on the Jakarta Commons HttpClient package.

recordSuccess(RequestEvent, boolean) - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

Record the "success status" of a request event.

removeLatkaEventInfo(JellyContext) - Method in class org.apache.commons.latka.jelly.JellyUtils

Remove a LatkaEventInfo object.

reportMessage(ReportMessageEvent) - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

Invoked if a Latka suite wants to send a message to the report generated for the test.

reportMessage(ReportMessageEvent) - Method in class org.apache.commons.latka.XMLReporter

Add the message of the provided event to the XML document as a <reportMessage> element with text

reportMessage(ReportMessageEvent) - Method in interface org.apache.commons.latka.event.LatkaEventListener

Invoked if a Latka suite wants to send a message to the report generated for the test.

reportMessage(ReportMessageEvent) - Method in class org.apache.commons.latka.event.LatkaEventPublisher

send the supplied event to all listeners

reportMessage(ReportMessageEvent) - Method in class org.apache.commons.latka.junit.JUnitEventReporter

This method is currently ignored by the JUnitEventReporter.

requestError(RequestEvent) - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

Invoked if a request error occurs.

requestError(RequestEvent) - Method in class org.apache.commons.latka.XMLReporter

requestError(RequestEvent) - Method in interface org.apache.commons.latka.event.LatkaEventListener

Invoked if a request error occurs.

requestError(RequestEvent) - Method in class org.apache.commons.latka.event.LatkaEventPublisher

send the supplied event to all listeners

requestError(RequestEvent) - Method in class org.apache.commons.latka.junit.JUnitEventReporter

Process a Latka request error

requestFailed(RequestEvent) - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

Invoked if the request failed.

requestFailed(RequestEvent) - Method in class org.apache.commons.latka.XMLReporter

requestFailed(RequestEvent) - Method in interface org.apache.commons.latka.event.LatkaEventListener

Invoked if the request failed.

requestFailed(RequestEvent) - Method in class org.apache.commons.latka.event.LatkaEventPublisher

send the supplied event to all listeners

requestFailed(RequestEvent) - Method in class org.apache.commons.latka.junit.JUnitEventReporter

Process a Latka request failure

requestSkipped(RequestEvent) - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

A skipped request.

requestSkipped(RequestEvent) - Method in class org.apache.commons.latka.XMLReporter

requestSkipped(RequestEvent) - Method in interface org.apache.commons.latka.event.LatkaEventListener

A skipped request.

requestSkipped(RequestEvent) - Method in class org.apache.commons.latka.event.LatkaEventPublisher

send the supplied event to all listeners

requestSkipped(RequestEvent) - Method in class org.apache.commons.latka.junit.JUnitEventReporter

Process a Latka event being skipped

requestSucceeded(RequestEvent) - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

Invoked if the request succeeds.

requestSucceeded(RequestEvent) - Method in class org.apache.commons.latka.XMLReporter

requestSucceeded(RequestEvent) - Method in interface org.apache.commons.latka.event.LatkaEventListener

Invoked if the request succeeds

requestSucceeded(RequestEvent) - Method in class org.apache.commons.latka.event.LatkaEventPublisher

send the supplied event to all listeners

requestSucceeded(RequestEvent) - Method in class org.apache.commons.latka.junit.JUnitEventReporter

Process a Latka request success event

resetProperties() - Static method in class org.apache.commons.latka.LatkaProperties

Resets the Latka properties to their initial value (getProperties() will still return the same Object).

run(TestResult) - Method in class org.apache.commons.latka.junit.JUnitTestAdapter

Run the test, adding results to the provided TestResult

runCommandLine(String[]) - Method in class org.apache.commons.latka.Latka

Processes the command line arguments, executes a single test.

runTests(Suite, LatkaEventListener) - Method in class org.apache.commons.latka.Latka

Execute a single Latka test suite.

S

Session - interface org.apache.commons.latka.http.Session.

A Latka Session is a container that manages state information over 1+ HTTP request/response pairs over 1+ HTTP servers.

SessionImpl - class org.apache.commons.latka.http.SessionImpl.

An implementation of a Latka Session interface based on the Jakarta Commons HttpClient package.

SessionImpl() - Constructor for class org.apache.commons.latka.http.SessionImpl

SessionTag - class org.apache.commons.latka.jelly.SessionTag.

SessionTag() - Constructor for class org.apache.commons.latka.jelly.SessionTag

StatusCodeTag - class org.apache.commons.latka.jelly.validators.StatusCodeTag.

Validator tag class

StatusCodeTag() - Constructor for class org.apache.commons.latka.jelly.validators.StatusCodeTag

StatusCodeValidator - class org.apache.commons.latka.validators.StatusCodeValidator.

Validates a Response according to its HTTP status code (200, 301, 302, 404, etc).

StatusCodeValidator() - Constructor for class org.apache.commons.latka.validators.StatusCodeValidator

StatusCodeValidator(int) - Constructor for class org.apache.commons.latka.validators.StatusCodeValidator

StatusCodeValidator(String) - Constructor for class org.apache.commons.latka.validators.StatusCodeValidator

StatusCodeValidator(String, int) - Constructor for class org.apache.commons.latka.validators.StatusCodeValidator

StatusTextTag - class org.apache.commons.latka.jelly.validators.StatusTextTag.

Validator tag class

StatusTextTag() - Constructor for class org.apache.commons.latka.jelly.validators.StatusTextTag

StatusTextValidator - class org.apache.commons.latka.validators.StatusTextValidator.

Validates a Response according to its HTTP status text (the text portion of the status line, eg typically 'OK' for 200 responses).

StatusTextValidator() - Constructor for class org.apache.commons.latka.validators.StatusTextValidator

StatusTextValidator(String, String) - Constructor for class org.apache.commons.latka.validators.StatusTextValidator

Suite - class org.apache.commons.latka.Suite.

References a Latka XML suite, stored either inside a Reader or at a file URI.

Suite(URL) - Constructor for class org.apache.commons.latka.Suite

Create a test suite from an XML document located at the designated URL.

SuiteCompletedEvent - class org.apache.commons.latka.event.SuiteCompletedEvent.

An event Latka fires when a suite has completed

SuiteCompletedEvent() - Constructor for class org.apache.commons.latka.event.SuiteCompletedEvent

Create the event

SuiteEvent - interface org.apache.commons.latka.event.SuiteEvent.

An interface to mark classes as being SuiteEvents

SuiteSettings - class org.apache.commons.latka.jelly.SuiteSettings.

SuiteSettings(String, int, String, int) - Constructor for class org.apache.commons.latka.jelly.SuiteSettings

Creates a new instance of SuiteSettings

SuiteTag - class org.apache.commons.latka.jelly.SuiteTag.

SuiteTag() - Constructor for class org.apache.commons.latka.jelly.SuiteTag

setCode(int) - Method in class org.apache.commons.latka.jelly.validators.StatusCodeTag

setCond(boolean) - Method in class org.apache.commons.latka.jelly.validators.CookieTag

sets whether or not this cookie is expected

setCond(boolean) - Method in class org.apache.commons.latka.jelly.validators.RegexpTag

setCond(boolean) - Method in class org.apache.commons.latka.jelly.validators.ResponseHeaderTag

setCond(boolean) - Method in class org.apache.commons.latka.jelly.validators.XPathTag

setCondition(boolean) - Method in class org.apache.commons.latka.validators.BaseConditionalValidator

Set whether or not this test is supposed to succeed

setCookieName(String) - Method in class org.apache.commons.latka.validators.CookieValidator

The cookie name must be set for this Validator to function properly.

setCookieValue(String) - Method in class org.apache.commons.latka.validators.CookieValidator

If cookie value is set, this Validator tests for cookie value equivalency, in addition to cookie existence

setCredentials(Credentials) - Method in interface org.apache.commons.latka.http.Request

Sets the basic authentication credentials for this request, if any.

setCredentials(Credentials) - Method in class org.apache.commons.latka.http.RequestImpl

Defined in the implemented interface

setDefaultHost(String) - Method in class org.apache.commons.latka.jelly.SuiteTag

Setter for defaultHost

setDefaultPort(int) - Method in class org.apache.commons.latka.jelly.SuiteTag

Setter for defaultPort

setDefaultProxyHost(String) - Method in class org.apache.commons.latka.jelly.SuiteTag

Setter for defaultProxyHost

setDefaultProxyPort(int) - Method in class org.apache.commons.latka.jelly.SuiteTag

Setter for defaultProxyPort

setFileName(String) - Method in class org.apache.commons.latka.jelly.validators.GoldenFileTag

set the file name for the golden file

setFollowRedirects(String) - Method in class org.apache.commons.latka.jelly.RequestTag

Sets whether or not to transmit the request over SSL.

setHeaderName(String) - Method in class org.apache.commons.latka.jelly.RequestHeaderTag

sets header name

setHeaderName(String) - Method in class org.apache.commons.latka.jelly.validators.ResponseHeaderTag

Sets the header name

setHeaderValue(String) - Method in class org.apache.commons.latka.jelly.RequestHeaderTag

set header value

setHeaderValue(String) - Method in class org.apache.commons.latka.jelly.validators.ResponseHeaderTag

The value to check for

setHeaderValue(String) - Method in class org.apache.commons.latka.validators.ResponseHeaderValidator

Sets the desired value of the header to be validated.

setHeaders(RequestHeaders) - Method in interface org.apache.commons.latka.http.Request

Set all the headers for the request.

setHeaders(RequestHeaders) - Method in class org.apache.commons.latka.http.RequestImpl

Defined in the implemented interface

setHost(String) - Method in class org.apache.commons.latka.http.Proxy

Setter for property host.

setHost(String) - Method in class org.apache.commons.latka.jelly.RequestTag

Setter for host

setIgnoreCase(boolean) - Method in class org.apache.commons.latka.jelly.validators.RegexpTag

Setter for property ignoreCase.

setIgnoreCase(boolean) - Method in class org.apache.commons.latka.validators.RegexpValidator

setIgnoreWhitespace(boolean) - Method in class org.apache.commons.latka.jelly.validators.GoldenFileTag

whether or not to ignore whitespace

setIgnoreWhitespace(boolean) - Method in class org.apache.commons.latka.validators.GoldenFileValidator

setLabel(String) - Method in class org.apache.commons.latka.jelly.RequestTag

Set the label for this suite

setLabel(String) - Method in class org.apache.commons.latka.jelly.SessionTag

Set the label for this session

setLabel(String) - Method in class org.apache.commons.latka.jelly.SuiteTag

Set the label for this suite

setLabel(String) - Method in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

setLabel(String) - Method in class org.apache.commons.latka.validators.BaseValidator

setLatkaEventInfo(JellyContext, LatkaEventInfo) - Method in class org.apache.commons.latka.jelly.JellyUtils

Provide a LatkaEventInfo object.

setLatkaEventListener(JellyContext, LatkaEventListener) - Method in class org.apache.commons.latka.jelly.JellyUtils

Provide a LatkaEventListener object.

setMax(int) - Method in class org.apache.commons.latka.jelly.validators.ByteLengthTag

Setter for maximum byte length.

setMaxLength(int) - Method in class org.apache.commons.latka.validators.ByteLengthValidator

setMaxMillis(int) - Method in class org.apache.commons.latka.validators.MaxRequestTimeValidator

setMessage(String) - Method in class org.apache.commons.latka.jelly.ReportMessageTag

Message to write to the log

setMethod(String) - Method in class org.apache.commons.latka.jelly.RequestTag

Sets the HTTP method to use.

setMillis(int) - Method in class org.apache.commons.latka.jelly.validators.MaxRequestTimeTag

setMin(int) - Method in class org.apache.commons.latka.jelly.validators.ByteLengthTag

Setter for minimum byte length.

setMinLength(int) - Method in class org.apache.commons.latka.validators.ByteLengthValidator

setName(String) - Method in class org.apache.commons.latka.jelly.validators.CookieTag

Setter the cookie name.

setParamName(String) - Method in class org.apache.commons.latka.jelly.ParameterTag

setParamValue(String) - Method in class org.apache.commons.latka.jelly.ParameterTag

setParameters(Parameters) - Method in interface org.apache.commons.latka.http.Request

Set all the parameters for the request.

setParameters(Parameters) - Method in class org.apache.commons.latka.http.RequestImpl

Defined in the implemented interface

setPassword(String) - Method in class org.apache.commons.latka.jelly.CredentialsTag

Sets the password for basic authentication

setPath(String) - Method in class org.apache.commons.latka.jelly.RequestTag

Sets the path of the document on the server, combined with the host and port

setPattern(String) - Method in class org.apache.commons.latka.jelly.validators.RegexpTag

Setter for property pattern.

setPattern(String) - Method in class org.apache.commons.latka.validators.RegexpValidator

setPort(int) - Method in class org.apache.commons.latka.http.Proxy

Setter for property port.

setPort(int) - Method in class org.apache.commons.latka.jelly.RequestTag

Setter for port

setPrintWriter(PrintWriter) - Method in class org.apache.commons.latka.XMLReporter

During the execution, any diagnostic ouput will be sent to the stream designated here.

setProxy(Proxy) - Method in class org.apache.commons.latka.http.RequestImpl

Setter for property proxy.

setProxyHost(String) - Method in class org.apache.commons.latka.jelly.RequestTag

Setter for defaultProxyHost

setProxyPort(int) - Method in class org.apache.commons.latka.jelly.RequestTag

Setter for defaultProxyPort

setReferer(URL) - Method in class org.apache.commons.latka.http.SessionImpl

Called inside the request.execute() method, setting the referer for the next request.

setReportStylesheet(URL) - Method in class org.apache.commons.latka.Latka

Set the URL to be used when transforming XML generated by the XMLReporter

setRequestBody(String) - Method in interface org.apache.commons.latka.http.Request

Set the request body for a manual POST.

setRequestBody(String) - Method in class org.apache.commons.latka.http.RequestImpl

Defined in the implemented interface

setSecure(String) - Method in class org.apache.commons.latka.jelly.RequestTag

Sets whether or not to transmit the request over SSL.

setSelect(String) - Method in class org.apache.commons.latka.jelly.validators.XPathTag

setSelect(String) - Method in class org.apache.commons.latka.validators.XPathValidator

setSessionId(String) - Method in class org.apache.commons.latka.jelly.SessionTag

Optionally sets the session id.

setStatusCode(int) - Method in class org.apache.commons.latka.validators.StatusCodeValidator

setStatusText(String) - Method in class org.apache.commons.latka.validators.StatusTextValidator

setText(String) - Method in class org.apache.commons.latka.jelly.validators.StatusTextTag

setURL(URL) - Method in class org.apache.commons.latka.Suite

Set the URL of the test suite.

setUserName(String) - Method in class org.apache.commons.latka.jelly.CredentialsTag

Sets the user name for basic authentication

setValidating(boolean) - Method in class org.apache.commons.latka.Latka

Set whether or not Latka will validate the XML in each test.

setValue(String) - Method in class org.apache.commons.latka.jelly.validators.CookieTag

Set the cookie value

setValue(String) - Method in class org.apache.commons.latka.jelly.validators.XPathTag

setValue(String) - Method in class org.apache.commons.latka.validators.XPathValidator

setVersion(String) - Method in interface org.apache.commons.latka.http.Request

Sets the version of HTTP that is used in the request.

setVersion(String) - Method in class org.apache.commons.latka.http.RequestImpl

Sets the HTTP version for this request.

setVersion(String) - Method in class org.apache.commons.latka.jelly.RequestTag

HTTP version to use.

suiteCompleted(SuiteEvent) - Method in class org.apache.commons.latka.DefaultLatkaEventInfo

Invoke when all requests completed.

suiteCompleted(SuiteEvent) - Method in class org.apache.commons.latka.XMLReporter

suiteCompleted(SuiteEvent) - Method in interface org.apache.commons.latka.event.LatkaEventListener

Invoke when all requests completed.

suiteCompleted(SuiteEvent) - Method in class org.apache.commons.latka.event.LatkaEventPublisher

send the supplied event to all listeners

suiteCompleted(SuiteEvent) - Method in class org.apache.commons.latka.junit.JUnitEventReporter

Process a Latka suite completion event

T

TRUE_MESSAGE - Static variable in class org.apache.commons.latka.validators.GoldenFileValidator

throwValidationException() - Method in class org.apache.commons.latka.validators.BaseConditionalValidator

Automatically generated exception messages, based on the value of getCondition() and generateBareExceptionMessage().

transformXML(String) - Method in class org.apache.commons.latka.Latka

Transform the XML generated by the XMLReporter using the default stylesheet.

V

ValidateTag - class org.apache.commons.latka.jelly.ValidateTag.

ValidateTag() - Constructor for class org.apache.commons.latka.jelly.ValidateTag

ValidationException - exception org.apache.commons.latka.ValidationException.

This exception is thrown by validators when a validation has failed

ValidationException() - Constructor for class org.apache.commons.latka.ValidationException

Create a validation exception with a null label and reason

ValidationException(String, String) - Constructor for class org.apache.commons.latka.ValidationException

Create a validation exception with the given label and reason

Validator - interface org.apache.commons.latka.Validator.

This is the standard interface for custom validation of an HTTP Response in Latka.

ViewResponseServlet - class org.apache.commons.latka.servlet.ViewResponseServlet.

A servlet to view the result of running a Latka suite

ViewResponseServlet() - Constructor for class org.apache.commons.latka.servlet.ViewResponseServlet

ViewSuiteServlet - class org.apache.commons.latka.servlet.ViewSuiteServlet.

A servlet to view the Latka Suite

ViewSuiteServlet() - Constructor for class org.apache.commons.latka.servlet.ViewSuiteServlet

validate(Response) - Method in interface org.apache.commons.latka.Validator

Run custom validation.

validate(Validator) - Method in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

validate the response using the validator provided.

validate(Response) - Method in class org.apache.commons.latka.validators.BaseConditionalValidator

Final method.

validate(Response) - Method in class org.apache.commons.latka.validators.BaseValidator

Validate a response

validate(Response) - Method in class org.apache.commons.latka.validators.ByteLengthValidator

validate(Response) - Method in class org.apache.commons.latka.validators.GoldenFileValidator

validate(Response) - Method in class org.apache.commons.latka.validators.MaxRequestTimeValidator

validate(Response) - Method in class org.apache.commons.latka.validators.StatusCodeValidator

validate(Response) - Method in class org.apache.commons.latka.validators.StatusTextValidator

X

XMLReporter - class org.apache.commons.latka.XMLReporter.

This LatkaEventListener will generate an XML report of all tests run during an Latka XML suite.

XMLReporter() - Constructor for class org.apache.commons.latka.XMLReporter

Create an XML Reporter, initialising document property, as a new empty report with an unsuccessful suite

XPathTag - class org.apache.commons.latka.jelly.validators.XPathTag.

Validator tag class

XPathTag() - Constructor for class org.apache.commons.latka.jelly.validators.XPathTag

XPathValidator - class org.apache.commons.latka.validators.XPathValidator.

An XPath validator.

XPathValidator() - Constructor for class org.apache.commons.latka.validators.XPathValidator

XPathValidator(String) - Constructor for class org.apache.commons.latka.validators.XPathValidator

XPathValidator(String, String, boolean, String) - Constructor for class org.apache.commons.latka.validators.XPathValidator

_

_actualValue - Variable in class org.apache.commons.latka.validators.ResponseHeaderValidator

_charsWritten - Variable in class org.apache.commons.latka.HtmlPrettyPrintWriter

number of characters written by the writer

_checkValue - Variable in class org.apache.commons.latka.validators.ResponseHeaderValidator

_cond - Variable in class org.apache.commons.latka.jelly.validators.CookieTag

_condition - Variable in class org.apache.commons.latka.jelly.validators.ResponseHeaderTag

_condition - Variable in class org.apache.commons.latka.jelly.validators.XPathTag

_condition - Variable in class org.apache.commons.latka.validators.BaseConditionalValidator

condition to test against

_cookieName - Variable in class org.apache.commons.latka.validators.CookieValidator

_cookieValue - Variable in class org.apache.commons.latka.validators.CookieValidator

_credentials - Variable in class org.apache.commons.latka.http.RequestImpl

credentials for the request

_defaultHost - Variable in class org.apache.commons.latka.jelly.SuiteSettings

_defaultHost - Variable in class org.apache.commons.latka.jelly.SuiteTag

_defaultPort - Variable in class org.apache.commons.latka.jelly.SuiteSettings

_defaultPort - Variable in class org.apache.commons.latka.jelly.SuiteTag

_defaultProxyHost - Variable in class org.apache.commons.latka.jelly.SuiteSettings

_defaultProxyHost - Variable in class org.apache.commons.latka.jelly.SuiteTag

_defaultProxyPort - Variable in class org.apache.commons.latka.jelly.SuiteSettings

_defaultProxyPort - Variable in class org.apache.commons.latka.jelly.SuiteTag

_didSuiteSucceed - Variable in class org.apache.commons.latka.XMLReporter

_doc - Variable in class org.apache.commons.latka.XMLReporter

dom4j document produced as output

_factory - Variable in class org.apache.commons.latka.XMLReporter

_failedResponses - Variable in class org.apache.commons.latka.DefaultLatkaEventInfo

Holds the failed responses received by this object.

_fileName - Variable in class org.apache.commons.latka.jelly.validators.GoldenFileTag

_followRedirects - Variable in class org.apache.commons.latka.http.RequestImpl

whether or not redirect responses should be followed as part of the request processing

_followRedirects - Variable in class org.apache.commons.latka.jelly.RequestTag

_goldFile - Variable in class org.apache.commons.latka.validators.GoldenFileValidator

_headerName - Variable in class org.apache.commons.latka.jelly.RequestHeaderTag

_headerName - Variable in class org.apache.commons.latka.jelly.validators.ResponseHeaderTag

_headerName - Variable in class org.apache.commons.latka.validators.ResponseHeaderValidator

_headerValue - Variable in class org.apache.commons.latka.jelly.RequestHeaderTag

_headerValue - Variable in class org.apache.commons.latka.jelly.validators.ResponseHeaderTag

_headerValue - Variable in class org.apache.commons.latka.validators.ResponseHeaderValidator

_host - Variable in class org.apache.commons.latka.http.RequestImpl

host the request is being made on

_host - Variable in class org.apache.commons.latka.jelly.RequestTag

_httpClient - Variable in class org.apache.commons.latka.http.RequestImpl

object used to perform the http requests

_httpMethod - Variable in class org.apache.commons.latka.http.RequestImpl

http method implementation

_httpMethod - Variable in class org.apache.commons.latka.http.ResponseImpl

the implementation of the http method used to create the response

_httpVersion - Variable in class org.apache.commons.latka.http.RequestImpl

_httpVersion - Variable in class org.apache.commons.latka.jelly.RequestTag

_ignoreCase - Variable in class org.apache.commons.latka.validators.RegexpValidator

_ignoreWhitespace - Variable in class org.apache.commons.latka.jelly.validators.GoldenFileTag

_ignoreWhitespace - Variable in class org.apache.commons.latka.validators.GoldenFileValidator

_initProps - Static variable in class org.apache.commons.latka.LatkaProperties

default Properties file for Latka

_isValidating - Variable in class org.apache.commons.latka.Latka

whether xml parsing is validating or not

_label - Variable in class org.apache.commons.latka.http.RequestImpl

name given to the request

_label - Variable in class org.apache.commons.latka.jelly.RequestTag

_label - Variable in class org.apache.commons.latka.jelly.SessionTag

_label - Variable in class org.apache.commons.latka.jelly.SuiteTag

_label - Variable in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

label for the test

_label - Variable in class org.apache.commons.latka.validators.BaseValidator

_lastSelected - Variable in class org.apache.commons.latka.validators.XPathValidator

_lastTestedCookieValue - Variable in class org.apache.commons.latka.validators.CookieValidator

_list - Variable in class org.apache.commons.latka.event.LatkaEventPublisher

the listeners to publish events to

_list - Variable in class org.apache.commons.latka.http.ParametersImpl

List of parameters.

_list - Variable in class org.apache.commons.latka.http.RequestHeadersImpl

The list of headers.

_listener - Variable in class org.apache.commons.latka.DefaultLatkaEventInfo

_listener - Variable in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

the listener handling request success/failure etc

_log - Static variable in class org.apache.commons.latka.AbstractReporter

The log4J category used for processing log requests.

_log - Static variable in class org.apache.commons.latka.DefaultLatkaEventInfo

The log4J category used for processing log requests.

_log - Static variable in class org.apache.commons.latka.Latka

log4j category for logged output

_log - Static variable in class org.apache.commons.latka.LatkaProperties

log4j category to append output to

_log - Static variable in class org.apache.commons.latka.http.RequestImpl

log4j category used when logging messages

_log - Static variable in class org.apache.commons.latka.jelly.RequestTag

_log - Static variable in class org.apache.commons.latka.jelly.validators.ByteLengthTag

_log - Static variable in class org.apache.commons.latka.jelly.validators.CookieTag

_log - Static variable in class org.apache.commons.latka.jelly.validators.GoldenFileTag

_log - Static variable in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

_log - Static variable in class org.apache.commons.latka.jelly.validators.MaxRequestTimeTag

_log - Static variable in class org.apache.commons.latka.jelly.validators.RegexpTag

_log - Static variable in class org.apache.commons.latka.jelly.validators.ResponseHeaderTag

_log - Static variable in class org.apache.commons.latka.jelly.validators.StatusCodeTag

_log - Static variable in class org.apache.commons.latka.jelly.validators.StatusTextTag

_log - Static variable in class org.apache.commons.latka.jelly.validators.XPathTag

_log - Static variable in class org.apache.commons.latka.servlet.ViewResponseServlet

log4 category for output

_log - Variable in class org.apache.commons.latka.validators.BaseConditionalValidator

log4j category for output

_log - Variable in class org.apache.commons.latka.validators.BaseValidator

log4j category for debug output

_matchLog - Variable in class org.apache.commons.latka.validators.GoldenFileValidator

_maxLength - Variable in class org.apache.commons.latka.jelly.validators.ByteLengthTag

_maxLength - Variable in class org.apache.commons.latka.validators.ByteLengthValidator

_message - Variable in class org.apache.commons.latka.jelly.ReportMessageTag

_method - Variable in class org.apache.commons.latka.http.RequestImpl

http method being used to make the request

_method - Variable in class org.apache.commons.latka.jelly.RequestTag

_millis - Variable in class org.apache.commons.latka.jelly.validators.MaxRequestTimeTag

_millis - Variable in class org.apache.commons.latka.validators.MaxRequestTimeValidator

_minLength - Variable in class org.apache.commons.latka.jelly.validators.ByteLengthTag

_minLength - Variable in class org.apache.commons.latka.validators.ByteLengthValidator

_name - Variable in class org.apache.commons.latka.jelly.validators.CookieTag

_paramName - Variable in class org.apache.commons.latka.jelly.ParameterTag

_paramValue - Variable in class org.apache.commons.latka.jelly.ParameterTag

_parameters - Variable in class org.apache.commons.latka.http.RequestImpl

parameters sent with this request

_password - Variable in class org.apache.commons.latka.http.CredentialsImpl

holds password

_password - Variable in class org.apache.commons.latka.jelly.CredentialsTag

_path - Variable in class org.apache.commons.latka.jelly.RequestTag

_pattern - Variable in class org.apache.commons.latka.validators.RegexpValidator

_port - Variable in class org.apache.commons.latka.http.RequestImpl

port the request is being made on

_port - Variable in class org.apache.commons.latka.jelly.RequestTag

_printWriter - Variable in class org.apache.commons.latka.XMLReporter

used for output as tests run

_props - Variable in class org.apache.commons.latka.Latka

Latka configuration variables

_propsThreadLocal - Static variable in class org.apache.commons.latka.LatkaProperties

This ThreadLocal is automatically instantiated per thread with a Properties object containing the default properties.

_proxyHost - Variable in class org.apache.commons.latka.jelly.RequestTag

_proxyPort - Variable in class org.apache.commons.latka.jelly.RequestTag

_query - Variable in class org.apache.commons.latka.http.RequestImpl

query string portion of the URL

_reportStylesheetUrl - Variable in class org.apache.commons.latka.Latka

XSL stylesheet url to use when generating XML

_request - Variable in class org.apache.commons.latka.http.ResponseImpl

the request used to get the response

_request - Variable in class org.apache.commons.latka.jelly.RequestTag

_requestBody - Variable in class org.apache.commons.latka.http.RequestImpl

manually constructed post body

_requestExecuted - Variable in class org.apache.commons.latka.jelly.RequestTag

_requestHeaders - Variable in class org.apache.commons.latka.http.RequestImpl

headers sent with this request

_requestSucceeded - Variable in class org.apache.commons.latka.DefaultLatkaEventInfo

maps the request to it's success or failure as a Boolean

_requestTiming - Variable in class org.apache.commons.latka.http.RequestImpl

time taken for the request in milliseconds

_response - Variable in class org.apache.commons.latka.jelly.RequestTag

_response - Variable in class org.apache.commons.latka.jelly.validators.HttpValidatorTagSupport

the response being validated

_rootElement - Variable in class org.apache.commons.latka.XMLReporter

top level element of dom4j document, a <report> element

_secure - Variable in class org.apache.commons.latka.jelly.RequestTag

_select - Variable in class org.apache.commons.latka.jelly.validators.XPathTag

_select - Variable in class org.apache.commons.latka.validators.XPathValidator

_session - Variable in class org.apache.commons.latka.http.RequestImpl

http session the request is part of

_session - Variable in class org.apache.commons.latka.jelly.RequestTag

_session - Variable in class org.apache.commons.latka.jelly.SessionTag

_sessionCache - Variable in class org.apache.commons.latka.jelly.SuiteTag

_sessionId - Variable in class org.apache.commons.latka.jelly.SessionTag

_sessionSucceeded - Variable in class org.apache.commons.latka.DefaultLatkaEventInfo

maps the session to it's success or failure as a Boolean

_settings - Variable in class org.apache.commons.latka.jelly.SuiteTag

_state - Variable in class org.apache.commons.latka.http.SessionImpl

this state object 'belongs' to HttpClient we maintain a reference in SessionImpl for simplicity

_statusCode - Variable in class org.apache.commons.latka.jelly.validators.StatusCodeTag

_statusCode - Variable in class org.apache.commons.latka.validators.StatusCodeValidator

_statusText - Variable in class org.apache.commons.latka.jelly.validators.StatusTextTag

_statusText - Variable in class org.apache.commons.latka.validators.StatusTextValidator

_suiteSucceeded - Variable in class org.apache.commons.latka.DefaultLatkaEventInfo

Holds whether or not the entire suite has succeeded This is set to false when any request fails.

_targetURL - Variable in class org.apache.commons.latka.http.RequestImpl

URL being requested

_url - Variable in class org.apache.commons.latka.Suite

test suite URL

_urls - Variable in class org.apache.commons.latka.http.SessionImpl

tracks URLs treated by this session Session will automatically set the referer header for a request to the URL of the previous request

_userName - Variable in class org.apache.commons.latka.http.CredentialsImpl

holds user name

_userName - Variable in class org.apache.commons.latka.jelly.CredentialsTag

_utils - Static variable in class org.apache.commons.latka.jelly.JellyUtils

_value - Variable in class org.apache.commons.latka.jelly.validators.CookieTag

_value - Variable in class org.apache.commons.latka.jelly.validators.XPathTag

_value - Variable in class org.apache.commons.latka.validators.XPathValidator

_visitedURLs - Variable in class org.apache.commons.latka.http.RequestImpl

_wrappedException - Variable in class org.apache.commons.latka.LatkaException

The original exception

A B C D E F G H I J L M O P R S T V X _