org.apache.brooklyn.util.http

Class HttpAsserts

java.lang.Object

org.apache.brooklyn.util.http.HttpAsserts

public class HttpAsserts
extends java.lang.Object

Utility assertions on HTTP.

Constructor Summary

Constructors

Constructor and Description
HttpAsserts()

Method Summary

Modifier and Type	Method and Description
static <any>	assertAsyncHttpStatusCodeContinuallyEquals(ListeningExecutorService executor, java.lang.String url, int expectedStatusCode) Schedules (with the given executor) a poller that repeatedly accesses the given url, to confirm it always gives back the expected status code.
static void	assertClientErrorStatusCode(int code) Asserts that the given HTTP status code indicates "client error", i.e.
static void	assertContentContainsText(java.lang.String url, java.lang.String phrase, java.lang.String... additionalPhrases)
static void	assertContentEventuallyContainsText(java.util.Map<java.lang.String,?> flags, java.lang.String url, java.lang.String phrase, java.lang.String... additionalPhrases)
static void	assertContentEventuallyContainsText(java.lang.String url, java.lang.String phrase, java.lang.String... additionalPhrases)
static void	assertContentEventuallyMatches(java.util.Map<java.lang.String,?> flags, java.lang.String url, java.lang.String regex)
static void	assertContentEventuallyMatches(java.lang.String url, java.lang.String regex)
static void	assertContentMatches(java.lang.String url, java.lang.String regex)
static void	assertContentNotContainsText(java.lang.String url, java.lang.String phrase, java.lang.String... additionalPhrases)
static void	assertErrorContentContainsText(java.lang.String url, java.lang.String phrase, java.lang.String... additionalPhrases)
static void	assertErrorContentNotContainsText(java.lang.String url, java.lang.String phrase, java.lang.String... additionalPhrases)
static void	assertHealthyStatusCode(int code) Asserts that the given HTTP status code indicates "success", i.e.
static void	assertHttpStatusCodeEquals(java.lang.String url, int... acceptableReturnCodes) Assert that the status code returned from the URL is in the given codes.
static void	assertHttpStatusCodeEventuallyEquals(java.util.Map<java.lang.String,?> flags, java.lang.String url, int expectedCode)
static void	assertHttpStatusCodeEventuallyEquals(java.lang.String url, int expectedCode)
static void	assertNotHealthyStatusCode(int code) Asserts that the given HTTP status code does not indicate "success", i.e.
static void	assertServerErrorStatusCode(int code) Asserts that the given HTTP status code indicates "server error", i.e.
static void	assertUrlReachable(java.lang.String url) Asserts that gets back any "valid" response - i.e.
static void	assertUrlUnreachable(java.lang.String url) Asserts that the URL could not be reached, detected as an IOException.
static void	assertUrlUnreachableEventually(java.util.Map<java.lang.String,?> flags, java.lang.String url) Asserts that the URL becomes unreachable within a configurable time period.
static void	assertUrlUnreachableEventually(java.lang.String url) Asserts that the URL becomes unreachable within a default time period.
static boolean	isClientErrorStatusCode(int code)
static boolean	isHealthyStatusCode(int code)
static boolean	isServerErrorStatusCode(int code)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpAsserts

public HttpAsserts()

Method Detail

isHealthyStatusCode

public static boolean isHealthyStatusCode(int code)

Returns:

whether the given HTTP status code is a "success" class code (2xx)

assertHealthyStatusCode

public static void assertHealthyStatusCode(int code)

Asserts that the given HTTP status code indicates "success", i.e. isHealthyStatusCode(int) is true

assertNotHealthyStatusCode

public static void assertNotHealthyStatusCode(int code)

Asserts that the given HTTP status code does not indicate "success", i.e. isHealthyStatusCode(int) returns false

isClientErrorStatusCode

public static boolean isClientErrorStatusCode(int code)

Returns:

whether the given HTTP status code is a "client error" class code (4xx)

assertClientErrorStatusCode

public static void assertClientErrorStatusCode(int code)

Asserts that the given HTTP status code indicates "client error", i.e. isClientErrorStatusCode(int) is true

isServerErrorStatusCode

public static boolean isServerErrorStatusCode(int code)

Returns:

whether the given HTTP status code is a "server error" class code (5xx)

assertServerErrorStatusCode

public static void assertServerErrorStatusCode(int code)

Asserts that the given HTTP status code indicates "server error", i.e. isServerErrorStatusCode(int) is true

assertUrlReachable

public static void assertUrlReachable(java.lang.String url)

Asserts that gets back any "valid" response - i.e. not an exception. This could be an unauthorized, a redirect, a 404, or anything else that implies there is web-server listening on that port.

Parameters:

url - The URL to connect to.

assertUrlUnreachable

public static void assertUrlUnreachable(java.lang.String url)

Asserts that the URL could not be reached, detected as an IOException.

Parameters:

url - The URL to connect to.

assertUrlUnreachableEventually

public static void assertUrlUnreachableEventually(java.lang.String url)

Asserts that the URL becomes unreachable within a default time period.

Parameters:

url - The URL

assertUrlUnreachableEventually

public static void assertUrlUnreachableEventually(java.util.Map<java.lang.String,?> flags,
                                                  java.lang.String url)

Asserts that the URL becomes unreachable within a configurable time period.

Parameters:

flags - The flags controlling the timeout. For details see Asserts.succeedsEventually(java.util.Map, java.util.concurrent.Callable)

url - The URL

assertHttpStatusCodeEquals

public static void assertHttpStatusCodeEquals(java.lang.String url,
                                              int... acceptableReturnCodes)

Assert that the status code returned from the URL is in the given codes.

Parameters:

url - The URL to get.

acceptableReturnCodes - The return codes that are expected.

assertHttpStatusCodeEventuallyEquals

public static void assertHttpStatusCodeEventuallyEquals(java.lang.String url,
                                                        int expectedCode)

assertHttpStatusCodeEventuallyEquals

public static void assertHttpStatusCodeEventuallyEquals(java.util.Map<java.lang.String,?> flags,
                                                        java.lang.String url,
                                                        int expectedCode)

assertContentContainsText

public static void assertContentContainsText(java.lang.String url,
                                             java.lang.String phrase,
                                             java.lang.String... additionalPhrases)

assertContentNotContainsText

public static void assertContentNotContainsText(java.lang.String url,
                                                java.lang.String phrase,
                                                java.lang.String... additionalPhrases)

assertErrorContentContainsText

public static void assertErrorContentContainsText(java.lang.String url,
                                                  java.lang.String phrase,
                                                  java.lang.String... additionalPhrases)

assertErrorContentNotContainsText

public static void assertErrorContentNotContainsText(java.lang.String url,
                                                     java.lang.String phrase,
                                                     java.lang.String... additionalPhrases)

assertContentEventuallyContainsText

public static void assertContentEventuallyContainsText(java.lang.String url,
                                                       java.lang.String phrase,
                                                       java.lang.String... additionalPhrases)

assertContentEventuallyContainsText

public static void assertContentEventuallyContainsText(java.util.Map<java.lang.String,?> flags,
                                                       java.lang.String url,
                                                       java.lang.String phrase,
                                                       java.lang.String... additionalPhrases)

assertContentMatches

public static void assertContentMatches(java.lang.String url,
                                        java.lang.String regex)

assertContentEventuallyMatches

public static void assertContentEventuallyMatches(java.lang.String url,
                                                  java.lang.String regex)

assertContentEventuallyMatches

public static void assertContentEventuallyMatches(java.util.Map<java.lang.String,?> flags,
                                                  java.lang.String url,
                                                  java.lang.String regex)

assertAsyncHttpStatusCodeContinuallyEquals

public static <any> assertAsyncHttpStatusCodeContinuallyEquals(ListeningExecutorService executor,
                                                               java.lang.String url,
                                                               int expectedStatusCode)

Schedules (with the given executor) a poller that repeatedly accesses the given url, to confirm it always gives back the expected status code. Expected usage is to query the future, such as:

 
 Future<?> future = assertAsyncHttpStatusCodeContinuallyEquals(executor, url, 200);
 // do other stuff...
 if (future.isDone()) future.get(); // get exception if its Asserts.failed
 
 

NOTE that the exception thrown by future.get() is a java.util.concurrent.ExecutionException, not an AssertionError. For stopping it, you can either do future.cancel(true), or you can just do executor.shutdownNow(). TODO Look at difference between this and WebAppMonitor, to decide if this should be kept.