org.wikimedia.eventutilities.core.http

Class BasicHttpResult

java.lang.Object

org.wikimedia.eventutilities.core.http.BasicHttpResult

@ParametersAreNonnullByDefault
 @ThreadSafe
public class BasicHttpResult
extends Object

Class representing an HTTP request result from HttpRequest This is not called 'response' as it also can represent a failed result caused by a local Exception rather than an HTTP response error status code.

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	body THe HTTP response body, if there was one.
protected IOException	exception If a local IOException was encountered, this will be set to it.
protected String	message The HTTP response message, or the Exception message if a local exception was encountered.
protected int	status The HTTP response status code, or -1 if a local exception was encountered.
protected boolean	success If the HTTP request that caused this result was successful.

Method Summary

Modifier and Type	Method and Description
boolean	causedByException() Returns true if this result represents a failure due to a local IOException.
static BasicHttpResult	create(org.apache.http.HttpResponse response, IntPredicate isSuccess) Creates an BasicHttpResult from an httpcomponents HttpResponse and a lambda isSuccess that determines what http response status codes constitute a successful response.
byte[]	getBody() Returns a copy of the byte[] response body.
String	getBodyAsString()
IOException	getException()
String	getMessage()
int	getStatus()
boolean	getSuccess()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

success

protected final boolean success

If the HTTP request that caused this result was successful. If a local exception is encountered or a provided the isSuccess function is false, this will be false.

status

protected final int status

The HTTP response status code, or -1 if a local exception was encountered.

message

@Nullable
protected final String message

The HTTP response message, or the Exception message if a local exception was encountered.

body

@Nullable
protected final byte[] body

THe HTTP response body, if there was one.

exception

@Nullable
protected final IOException exception

If a local IOException was encountered, this will be set to it.

Method Detail

create

@Nullable
public static BasicHttpResult create(org.apache.http.HttpResponse response,
                                               IntPredicate isSuccess)
                                        throws IOException

Creates an BasicHttpResult from an httpcomponents HttpResponse and a lambda isSuccess that determines what http response status codes constitute a successful response.

Throws:

IOException

getSuccess

public boolean getSuccess()

getStatus

public int getStatus()

getMessage

@Nullable
public String getMessage()

getBody

@Nullable
public byte[] getBody()

Returns a copy of the byte[] response body.

getBodyAsString

@Nonnull
public String getBodyAsString()

getException

@Nullable
public IOException getException()

causedByException

public boolean causedByException()

Returns true if this result represents a failure due to a local IOException.

toString

@Nonnull
public String toString()

Overrides:

toString in class Object