com.meterware.httpunit

Class HttpUnitOptions

public abstract class HttpUnitOptions extends Object

A collection of global options to control HttpUnit's behavior.

Author: Russell Gold Dave Glowacki Benoit Xhenseval

Field Summary
static StringDEFAULT_SCRIPT_ENGINE_FACTORY
Method Summary
static voidaddHtmlErrorListener(HTMLParserListener el)
Add an Html error listener.
static voidclearScriptErrorMessages()
Clears the accumulated script error messages.
static booleangetAutoRedirect()
Returns true if HttpUnit should automatically follow page redirect requests (status 3xx).
static booleangetAutoRefresh()
Returns true if HttpUnit should automatically follow page refresh requests.
static StringgetDefaultCharacterSet()
Returns the character set to be used for pages which do not specify one.
static StringgetDefaultContentType()
Returns the content type to be used for pages which do not specify one.
static booleangetExceptionsThrownOnErrorStatus()
Returns true if WebClient.getResponse throws exceptions when detected an error status.
static booleangetExceptionsThrownOnScriptError()
Returns true if script errors cause exceptions to be thrown.
static VectorgetHtmlErrorListeners()
Get the list of Html Error Listeners
static booleangetImagesTreatedAsAltText()
Returns true if images are treated as text, using their alt attributes.
static booleangetMatchesIgnoreCase()
If true, text matches in methods such as HTMLSegment are case insensitive.
static booleangetParameterValuesValidated()
Returns true if form parameter settings are checked.
static booleangetParserWarningsEnabled()
Returns true if parser warnings are enabled.
static intgetRedirectDelay()
Returns the delay, in milliseconds, before a redirect request is issues.
static StringgetScriptEngineClassName()
static String[]getScriptErrorMessages()
Returns the accumulated script error messages encountered.
static ScriptingEngineFactorygetScriptingEngine()
static booleanisAcceptCookies()
Returns true if HttpUnit is accepting and saving cookies.
static booleanisAcceptGzip()
Returns true if any WebClient created will accept GZIP encoding of responses.
static booleanisCheckContentLength()
Returns true if HttpUnit will throw an exception when a message is only partially received.
static booleanisLoggingHttpHeaders()
Returns true if HTTP headers are to be dumped to system output.
static booleanisPostIncludesCharset()
Returns true if POST requests should include the character set in the content-type header.
static booleanisScriptingEnabled()
static voidremoveHtmlErrorListener(HTMLParserListener el)
Remove an Html error listener.
static voidreset()
Resets all options to their default values.
static voidresetDefaultCharacterSet()
Resets the default character set to the HTTP default encoding.
static voidresetDefaultContentType()
Resets the default content type to plain text.
static voidsetAcceptCookies(boolean acceptCookies)
Specifies whether HttpUnit should accept and send cookies.
static voidsetAcceptGzip(boolean acceptGzip)
Specifies whether a WebClient will be initialized to accept GZIP encoded responses.
static voidsetAutoRedirect(boolean autoRedirect)
Determines whether HttpUnit should automatically follow page redirect requests (status 3xx).
static voidsetAutoRefresh(boolean autoRefresh)
Specifies whether HttpUnit should automatically follow page refresh requests.
static voidsetCheckContentLength(boolean checkContentLength)
Specifies whether HttpUnit should throw an exception when the content length of a message does not match its actual received length.
static voidsetDefaultCharacterSet(String characterSet)
Sets the default character set for pages which do not specify one and for requests created without HTML sources.
static voidsetDefaultContentType(String contentType)
Sets the default content type for pages which do not specify one.
static voidsetExceptionsThrownOnErrorStatus(boolean enabled)
If true, WebClient.getResponse throws an exception when it receives an error status.
static voidsetExceptionsThrownOnScriptError(boolean throwExceptions)
Determines whether script errors result in exceptions or warning messages.
static voidsetImagesTreatedAsAltText(boolean asText)
If true, tells HttpUnit to treat images with alt attributes as though they were the text value of that attribute in all searches and displays.
static voidsetLoggingHttpHeaders(boolean enabled)
If true, tells HttpUnit to log HTTP headers to system output.
static voidsetMatchesIgnoreCase(boolean ignoreCase)
If true, text matches in methods such as HTMLSegment are case insensitive.
static voidsetParameterValuesValidated(boolean validated)
If true, tells HttpUnit to throw an exception on any attempt to set a form parameter to a value which could not be set via the browser.
static voidsetParserWarningsEnabled(boolean enabled)
If true, tells the parser to display warning messages.
static voidsetPostIncludesCharset(boolean postIncludesCharset)
Determines whether a normal POST request will include the character set in the content-type header.
static voidsetRedirectDelay(int delayInMilliseconds)
Sets the delay, in milliseconds, before a redirect request is issued.
static voidsetScriptEngineClassName(String scriptEngineClassName)
static voidsetScriptingEnabled(boolean scriptingEnabled)

Field Detail

DEFAULT_SCRIPT_ENGINE_FACTORY

public static final String DEFAULT_SCRIPT_ENGINE_FACTORY

Method Detail

addHtmlErrorListener

public static void addHtmlErrorListener(HTMLParserListener el)

Deprecated: as of 1.5.2, use HTMLParserfactory#addHTMLParserListener

Add an Html error listener.

clearScriptErrorMessages

public static void clearScriptErrorMessages()
Clears the accumulated script error messages.

getAutoRedirect

public static boolean getAutoRedirect()

Deprecated: as of 1.5.3, use ClientProperties#isAutoRedirect();

Returns true if HttpUnit should automatically follow page redirect requests (status 3xx). By default, this is true.

getAutoRefresh

public static boolean getAutoRefresh()

Deprecated: as of 1.5.3, use ClientProperties#isAutoRefresh();

Returns true if HttpUnit should automatically follow page refresh requests. By default, this is false, so that programs can verify the redirect page presented to users before the browser switches to the new page.

getDefaultCharacterSet

public static String getDefaultCharacterSet()
Returns the character set to be used for pages which do not specify one.

getDefaultContentType

public static String getDefaultContentType()
Returns the content type to be used for pages which do not specify one.

getExceptionsThrownOnErrorStatus

public static boolean getExceptionsThrownOnErrorStatus()
Returns true if WebClient.getResponse throws exceptions when detected an error status.

getExceptionsThrownOnScriptError

public static boolean getExceptionsThrownOnScriptError()
Returns true if script errors cause exceptions to be thrown.

getHtmlErrorListeners

public static Vector getHtmlErrorListeners()

Deprecated: as of 1.5.2, removed with no replacement

Get the list of Html Error Listeners

getImagesTreatedAsAltText

public static boolean getImagesTreatedAsAltText()
Returns true if images are treated as text, using their alt attributes.

getMatchesIgnoreCase

public static boolean getMatchesIgnoreCase()
If true, text matches in methods such as HTMLSegment are case insensitive. The default is true (matches ignore case).

getParameterValuesValidated

public static boolean getParameterValuesValidated()

Deprecated: as of 1.6, use WebForm#newUnvalidatedRequest() to obtain a request without parameter validation.

Returns true if form parameter settings are checked.

getParserWarningsEnabled

public static boolean getParserWarningsEnabled()

Deprecated: as of 1.5.2, use HTMLParserFactory#isParserWarningsEnabled

Returns true if parser warnings are enabled.

getRedirectDelay

public static int getRedirectDelay()
Returns the delay, in milliseconds, before a redirect request is issues.

getScriptEngineClassName

public static String getScriptEngineClassName()

getScriptErrorMessages

public static String[] getScriptErrorMessages()
Returns the accumulated script error messages encountered. Error messages are accumulated only if 'throwExceptionsOnError' is disabled.

getScriptingEngine

public static ScriptingEngineFactory getScriptingEngine()

isAcceptCookies

public static boolean isAcceptCookies()

Deprecated: as of 1.5.3, use ClientProperties#isAcceptCookies();

Returns true if HttpUnit is accepting and saving cookies. The default is to accept them.

isAcceptGzip

public static boolean isAcceptGzip()

Deprecated: as of 1.5.3, use ClientProperties#isAcceptGzip();

Returns true if any WebClient created will accept GZIP encoding of responses. The default is to accept GZIP encoding.

isCheckContentLength

public static boolean isCheckContentLength()
Returns true if HttpUnit will throw an exception when a message is only partially received. The default is to avoid such checks.

isLoggingHttpHeaders

public static boolean isLoggingHttpHeaders()
Returns true if HTTP headers are to be dumped to system output.

isPostIncludesCharset

public static boolean isPostIncludesCharset()
Returns true if POST requests should include the character set in the content-type header.

isScriptingEnabled

public static boolean isScriptingEnabled()

removeHtmlErrorListener

public static void removeHtmlErrorListener(HTMLParserListener el)

Deprecated: as of 1.5.2, use HTMLParserfactory#removeHTMLParserListener

Remove an Html error listener.

reset

public static void reset()
Resets all options to their default values.

resetDefaultCharacterSet

public static void resetDefaultCharacterSet()
Resets the default character set to the HTTP default encoding.

resetDefaultContentType

public static void resetDefaultContentType()
Resets the default content type to plain text.

setAcceptCookies

public static void setAcceptCookies(boolean acceptCookies)

Deprecated: as of 1.5.3, use ClientProperties#setAcceptCookies();

Specifies whether HttpUnit should accept and send cookies.

setAcceptGzip

public static void setAcceptGzip(boolean acceptGzip)

Deprecated: as of 1.5.3, use ClientProperties#setAcceptGzip();

Specifies whether a WebClient will be initialized to accept GZIP encoded responses. The default is true.

setAutoRedirect

public static void setAutoRedirect(boolean autoRedirect)

Deprecated: as of 1.5.3, use ClientProperties#setAutoRedirect();

Determines whether HttpUnit should automatically follow page redirect requests (status 3xx). By default, this is true in order to simulate normal browser operation.

setAutoRefresh

public static void setAutoRefresh(boolean autoRefresh)

Deprecated: as of 1.5.3, use ClientProperties#setAutoRefresh();

Specifies whether HttpUnit should automatically follow page refresh requests. By default, this is false, so that programs can verify the redirect page presented to users before the browser switches to the new page. Setting this to true can cause an infinite loop on pages that refresh themselves.

setCheckContentLength

public static void setCheckContentLength(boolean checkContentLength)
Specifies whether HttpUnit should throw an exception when the content length of a message does not match its actual received length. Defaults to false.

setDefaultCharacterSet

public static void setDefaultCharacterSet(String characterSet)
Sets the default character set for pages which do not specify one and for requests created without HTML sources. By default, HttpUnit uses the HTTP default encoding, iso-8859-1.

setDefaultContentType

public static void setDefaultContentType(String contentType)
Sets the default content type for pages which do not specify one.

setExceptionsThrownOnErrorStatus

public static void setExceptionsThrownOnErrorStatus(boolean enabled)
If true, WebClient.getResponse throws an exception when it receives an error status. Defaults to true.

setExceptionsThrownOnScriptError

public static void setExceptionsThrownOnScriptError(boolean throwExceptions)
Determines whether script errors result in exceptions or warning messages.

setImagesTreatedAsAltText

public static void setImagesTreatedAsAltText(boolean asText)
If true, tells HttpUnit to treat images with alt attributes as though they were the text value of that attribute in all searches and displays. The default is false (image text is generally ignored).

setLoggingHttpHeaders

public static void setLoggingHttpHeaders(boolean enabled)
If true, tells HttpUnit to log HTTP headers to system output. The default is false.

setMatchesIgnoreCase

public static void setMatchesIgnoreCase(boolean ignoreCase)
If true, text matches in methods such as HTMLSegment are case insensitive. The default is true (matches ignore case).

setParameterValuesValidated

public static void setParameterValuesValidated(boolean validated)

Deprecated: as of 1.6, use WebForm#newUnvalidatedRequest() to obtain a request without parameter validation.

If true, tells HttpUnit to throw an exception on any attempt to set a form parameter to a value which could not be set via the browser. The default is true (parameters are validated).
Note: this only applies to a WebRequest created after this setting is changed. A request created with this option disabled will not only not be checked for correctness, its parameter submission order will not be guaranteed, and changing parameters will not trigger Javascript onChange / onClick events.

setParserWarningsEnabled

public static void setParserWarningsEnabled(boolean enabled)

Deprecated: as of 1.5.2, use HTMLParserFactory#setParserWarningsEnabled

If true, tells the parser to display warning messages. The default is false (warnings are not shown).

setPostIncludesCharset

public static void setPostIncludesCharset(boolean postIncludesCharset)
Determines whether a normal POST request will include the character set in the content-type header. The default is to include it; however, some older servlet engines (most notably Tomcat 3.1) get confused when they see it.

setRedirectDelay

public static void setRedirectDelay(int delayInMilliseconds)
Sets the delay, in milliseconds, before a redirect request is issued. This may be necessary if the server under some cases where the server performs asynchronous processing which must be completed before the new request can be handled properly, and is taking advantage of slower processing by most user agents. It almost always indicates an error in the server design, and therefore the default delay is zero.

setScriptEngineClassName

public static void setScriptEngineClassName(String scriptEngineClassName)

setScriptingEnabled

public static void setScriptingEnabled(boolean scriptingEnabled)