com.aspc.remote.rest

Class Response

java.lang.Object

com.aspc.remote.rest.Response

public final class Response
extends java.lang.Object

ReST call response. THREAD MODE: readonly

Since:

Jan 9, 2014

Author:

Lei Gao

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Response.Builder

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	cacheControl
long	lastModified
java.lang.String	mimeType
java.lang.String	redirection
Status	status
Trace	trace

Method Summary

Modifier and Type	Method and Description
static Response.Builder	builder(Status status, ContentType contentType, java.lang.String data)
static Response.Builder	builder(Status status, java.lang.String mimeType, java.io.File file)
static Response.Builder	builder(Status status, java.lang.String mimeType, java.lang.String data)
java.lang.String	checkStatus() http://www.restapitutorial.com/httpstatuscodes.html
byte[]	getContentAsByteArray() Get a raw input stream of the content.
java.io.File	getContentAsFile() Get the content as a file.
JSONObject	getContentAsJSON() Get the content as a JSON.
JSONArray	getContentAsJSONArray() Get the content as a JSONArray.
java.lang.String	getContentAsString() Get the content as a String.
org.w3c.dom.Document	getContentAsXML() Get the content as a XML.
java.util.Date	getLastModified() When this response was modified.

Methods inherited from class java.lang.Object

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

Field Detail

redirection

@Nullable
public final java.lang.String redirection

trace

public final Trace trace

mimeType

public final java.lang.String mimeType

cacheControl

public final java.lang.String cacheControl

status

public final Status status

lastModified

public final long lastModified

Method Detail

builder

public static Response.Builder builder(@Nonnull
                                       Status status,
                                       @Nonnull
                                       java.lang.String mimeType,
                                       @Nonnull
                                       java.io.File file)

builder

public static Response.Builder builder(@Nonnull
                                       Status status,
                                       @Nonnull
                                       java.lang.String mimeType,
                                       @Nonnull
                                       java.lang.String data)

builder

public static Response.Builder builder(@Nonnull
                                       Status status,
                                       @Nonnull
                                       ContentType contentType,
                                       @Nonnull
                                       java.lang.String data)

getLastModified

@CheckReturnValue
 @Nonnull
public java.util.Date getLastModified()

When this response was modified.

Returns:

getContentAsString

@CheckReturnValue
 @Nonnull
public java.lang.String getContentAsString()
                                                                throws java.io.IOException

Get the content as a String.

Returns:

the content.

Throws:

java.io.IOException - problem reading.

getContentAsXML

@CheckReturnValue
 @Nonnull
public org.w3c.dom.Document getContentAsXML()
                                                                 throws java.io.IOException,
                                                                        DocumentException

Get the content as a XML.

Returns:

the content.

Throws:

java.io.IOException - problem reading.

DocumentException - invalid XML

getContentAsJSON

@CheckReturnValue
 @Nonnull
public JSONObject getContentAsJSON()
                                                        throws java.io.IOException

Get the content as a JSON.

Returns:

the content.

Throws:

java.io.IOException - problem reading.

getContentAsJSONArray

@CheckReturnValue
 @Nonnull
public JSONArray getContentAsJSONArray()
                                                            throws java.io.IOException

Get the content as a JSONArray.

Returns:

the content.

Throws:

java.io.IOException - problem reading.

getContentAsFile

@CheckReturnValue
 @Nonnull
public java.io.File getContentAsFile()
                                                          throws java.io.IOException

Get the content as a file.

Returns:

the content.

Throws:

java.io.IOException - problem reading.

getContentAsByteArray

@CheckReturnValue
 @Nonnull
public byte[] getContentAsByteArray()
                                                         throws java.io.IOException

Get a raw input stream of the content.

Returns:

the input stream.

Throws:

java.io.IOException - a problem reading.

checkStatus

@Nonnull
public java.lang.String checkStatus()
                                      throws java.io.FileNotFoundException,
                                             ReSTException

http://www.restapitutorial.com/httpstatuscodes.html

Returns:

the status name.

Throws:

java.io.FileNotFoundException - 404

ReSTException - unknown error.