org.gcube.common.gxrest.response.inbound

Class GXInboundResponse

java.lang.Object

org.gcube.common.gxrest.response.inbound.GXInboundResponse

public class GXInboundResponse
extends Object

The response returned from the web application.

Author:

Manuele Simi (ISTI CNR)

Constructor Summary

Constructors

Constructor and Description
GXInboundResponse(HttpURLConnection connection)
GXInboundResponse(javax.ws.rs.core.Response source) Builds a new inbound response.

Method Summary

Modifier and Type	Method and Description
ErrorCode	getErrorCode() Gets the ErrorCode inside the entity.
<E extends Exception> E	getException() Gets the Exception inside the entity.
Map<String,List<String>>	getHeaderFields() Returns an unmodifiable Map of the header fields.
int	getHTTPCode() Gets the status code from the HTTP response message.
String	getMessage() Gets the message in the response
byte[]	getStreamedContent() Returns the content of the response as byte array.
String	getStreamedContentAsString() Gets the streamed content as a string, if possible.
boolean	hasBAD_REQUESTCode() Checks if the response has a BAD_REQUEST (400) HTTP status.
boolean	hasCREATEDCode() Checks if the response has a CREATED (201) HTTP status.
boolean	hasErrorCode() Checks if there is an ErrorCode in the entity.
boolean	hasException() Checks if there is an Exception in the entity.
boolean	hasGXError() Checks if the response was generated as a GXOutboundErrorResponse .
boolean	hasNOT_ACCEPTABLECode() Checks if the response has a NOT_ACCEPTABLE (406) HTTP status.
boolean	hasOKCode() Checks if the response has a OK (200) HTTP status.
<T> T	tryConvertStreamedContentFromJson(Class<T> raw) Tries to convert the content from its Json serialization, if possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

GXInboundResponse

public GXInboundResponse(javax.ws.rs.core.Response source)

Builds a new inbound response.

Parameters:

source - the original response

GXInboundResponse

public GXInboundResponse(HttpURLConnection connection)
                  throws IOException

Parameters:

connection - the connection from which to parse the information

Throws:

IOException

Method Detail

hasException

public boolean hasException()

Checks if there is an Exception in the entity.

Returns:

true if the entity holds an exception, false otherwise

hasGXError

public boolean hasGXError()

Checks if the response was generated as a GXOutboundErrorResponse .

Returns:

true if it is an error response generated with GXRest.

getException

public <E extends Exception> E getException()
                                     throws ClassNotFoundException

Gets the Exception inside the entity.

Returns:

the exception or null

Throws:

ClassNotFoundException - if the exception's class is not available on the classpath

hasErrorCode

public boolean hasErrorCode()

Checks if there is an ErrorCode in the entity.

Returns:

true if the entity holds an errorcode, false otherwise

getErrorCode

public ErrorCode getErrorCode()

Gets the ErrorCode inside the entity.

Returns:

the error code or null

getMessage

public String getMessage()

Gets the message in the response

Returns:

the message

getStreamedContentAsString

public String getStreamedContentAsString()

Gets the streamed content as a string, if possible.

Returns:

the content

getStreamedContent

public byte[] getStreamedContent()

Returns the content of the response as byte array.

Returns:

the streamedContent

tryConvertStreamedContentFromJson

public <T> T tryConvertStreamedContentFromJson(Class<T> raw)
                                        throws Exception

Tries to convert the content from its Json serialization, if possible.

Type Parameters:

T - the type of the desired object

Returns:

an object of type T from the content

Throws:

Exception - if the deserialization fails

getHTTPCode

public int getHTTPCode()

Gets the status code from the HTTP response message.

Returns:

the HTTP code

hasCREATEDCode

public boolean hasCREATEDCode()

Checks if the response has a CREATED (201) HTTP status.

Returns:

true if CREATED, false otherwise

hasOKCode

public boolean hasOKCode()

Checks if the response has a OK (200) HTTP status.

Returns:

true if OK, false otherwise

hasNOT_ACCEPTABLECode

public boolean hasNOT_ACCEPTABLECode()

Checks if the response has a NOT_ACCEPTABLE (406) HTTP status.

Returns:

true if NOT_ACCEPTABLE, false otherwise

hasBAD_REQUESTCode

public boolean hasBAD_REQUESTCode()

Checks if the response has a BAD_REQUEST (400) HTTP status.

Returns:

true if BAD_REQUEST, false otherwise

getHeaderFields

public Map<String,List<String>> getHeaderFields()

Returns an unmodifiable Map of the header fields. The Map keys are Strings that represent the response-header field names. Each Map value is an unmodifiable List of Strings that represents the corresponding field values.

Returns:

a Map of header fields