org.pageseeder.bridge.net

Class PSHTTPResponseInfo

java.lang.Object

org.pageseeder.bridge.net.PSHTTPResponseInfo

public final class PSHTTPResponseInfo
extends Object

Provides metadata about a response to an HTTP request made to PageSeeder.

When possible, instances contain details such as the error ID and message when errors occur.

Since:

0.2.0

Version:

0.3.0

Author:

Christophe Lauret

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PSHTTPResponseInfo.Status Status of an HTTP response.

Constructor Summary

Constructors

Constructor and Description
PSHTTPResponseInfo()

Method Summary

Methods

Modifier and Type	Method and Description
int	getCode()
String	getErrorID()
String	getMediaType()
String	getMessage()
PSHTTPResponseInfo.Status	getStatus()
boolean	isSuccessful() Shorthand method to check whether the response was successful.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PSHTTPResponseInfo

public PSHTTPResponseInfo()

Method Detail

getCode

public int getCode()

Returns:

the HTTP code

getMessage

public String getMessage()

Returns:

the error message

getMediaType

public String getMediaType()

Returns:

the media type of the response

getStatus

public PSHTTPResponseInfo.Status getStatus()

Returns:

the status of the response.

isSuccessful

public boolean isSuccessful()

Shorthand method to check whether the response was successful.

Returns:

true is the status is SUCCESSFUL; false for any other status.

getErrorID

public String getErrorID()

Returns:

the error (services only)

toString

public String toString()

Overrides:

toString in class Object