io.innerloop.neo4j.client.spi.impl.rest.http

Class Response

java.lang.Object

io.innerloop.neo4j.client.spi.impl.rest.http.Response

public class Response
extends java.lang.Object

This class represents an HTTP Response message.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	body
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	headers

Constructor Summary

Constructors

Constructor and Description
Response() The default constructor is a no-op

Method Summary

Modifier and Type	Method and Description
T	addHeader(java.lang.String name, java.lang.String value) Adds a single header value to the Message.
java.lang.String	getBody() Returns the Message body (also known as the Entity body).
int	getResponseCode() Gets the HTTP Response Code from this Response instace.
java.lang.String	getResponseMessage() Returns a message pertaining to the Response Code.
T	removeHeader(java.lang.String name) Removes the specified header.
T	setBody(java.lang.String body) Sets the body of the Message.
T	setHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers) Sets all of the headers in one call.
Response	setResponseCode(int responseCode) Sets the HTTP Response Code on this object.
Response	setResponseMessage(java.lang.String responseMessage) Sets the Response Message, which should pertain to the Response Code
java.lang.String	toString() Returns a String representation of this Response.

Methods inherited from class java.lang.Object

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

Field Detail

headers

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers

body

protected java.lang.String body

Constructor Detail

Response

public Response()

The default constructor is a no-op

Method Detail

getResponseCode

public int getResponseCode()

Gets the HTTP Response Code from this Response instace.

Returns:

The HTTP Response Code that was sent from the server

setResponseCode

public Response setResponseCode(int responseCode)

Sets the HTTP Response Code on this object.

Parameters:

responseCode - Any of the standard HTTP Response Codes

Returns:

This object, to support chained method calls

getResponseMessage

public java.lang.String getResponseMessage()

Returns a message pertaining to the Response Code.

Returns:

Any response message that may have been returned by the server. This message should be related to the and should not be confused with the Response Body.

setResponseMessage

public Response setResponseMessage(java.lang.String responseMessage)

Sets the Response Message, which should pertain to the Response Code

Parameters:

responseMessage - Any message which was sent back from the server, pertaining to the Response Code

Returns:

this Response, to support chained method calls

toString

public java.lang.String toString()

Returns a String representation of this Response. Helpful for debugging.

Overrides:

toString in class java.lang.Object

Returns:

Returns a String representation of this Response. Helpful for debugging.

getBody

public java.lang.String getBody()

Returns the Message body (also known as the Entity body).

Returns:

The body of the HTTP Message. It will typically be HTML, JSON, or XML.

setBody

public T setBody(java.lang.String body)

Sets the body of the Message.

Parameters:

body - This is typically the JSON, XML, or Form Parameters being sent to the server.

Returns:

this Message, to support chained method calls

addHeader

public T addHeader(java.lang.String name,
                   java.lang.String value)

Adds a single header value to the Message.

Parameters:

name - The header name.

value - The header value

Returns:

this Message, to support chained method calls

removeHeader

public T removeHeader(java.lang.String name)

Removes the specified header.

Parameters:

name - The name of the header to remove.

Returns:

this Message, to support chained method calls

setHeaders

public T setHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Sets all of the headers in one call.

Parameters:

headers - A Map of headers, where the header name is a String, and the value is a List of one or more values.

Returns:

this Message, to support chained method calls