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

Class Request

java.lang.Object

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

public class Request
extends java.lang.Object

This class represents an HTTP Request 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
Request(java.lang.String url) The Constructor takes the url as a String.

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.
Request	addQueryParameter(java.lang.String name, java.lang.String value) Adds a Query Parameter to a list.
Response	deleteResource() Issues a DELETE to the server.
java.lang.String	getBody() Returns the Message body (also known as the Entity body).
Response	getResource() Issues a GET to the server.
Response	postResource() Issues a POST to the server.
Response	putResource() Issues a PUT to the server.
T	removeHeader(java.lang.String name) Removes the specified header.
Request	removeQueryParameter(java.lang.String name) Removes the specified Query Parameter.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Request

public Request(java.lang.String url)
        throws java.io.IOException

The Constructor takes the url as a String.

Parameters:

url - The url parameter does not need the query string parameters if they are going to be supplied via calls to addQueryParameter(String, String). You can, however, supply the query parameters in the URL if you wish.

Throws:

java.io.IOException

Method Detail

addQueryParameter

public Request addQueryParameter(java.lang.String name,
                                 java.lang.String value)

Adds a Query Parameter to a list. The list is converted to a String and appended to the URL when the Request is submitted.

Parameters:

name - The Query Parameter's name

value - The Query Parameter's value

Returns:

this Request, to support chained method calls

removeQueryParameter

public Request removeQueryParameter(java.lang.String name)

Removes the specified Query Parameter.

Parameters:

name - The name of the Query Parameter to remove

Returns:

this Request, to support chained method calls

getResource

public Response getResource()
                     throws java.io.IOException

Issues a GET to the server.

Returns:

The Response from the server

Throws:

java.io.IOException

putResource

public Response putResource()
                     throws java.io.IOException

Issues a PUT to the server.

Returns:

The Response from the server

Throws:

java.io.IOException

postResource

public Response postResource()
                      throws java.io.IOException

Issues a POST to the server.

Returns:

The Response from the server

Throws:

java.io.IOException

deleteResource

public Response deleteResource()
                        throws java.io.IOException

Issues a DELETE to the server.

Returns:

The Response from the server

Throws:

java.io.IOException

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