com.arangodb

Interface ArangoRoute

All Superinterfaces:

ArangoSerializationAccessor

public interface ArangoRoute
extends ArangoSerializationAccessor

Interface for a specific path to be used to perform arbitrary requests.

Author:

Mark Vollmary

Method Summary

Modifier and Type	Method and Description
Response	delete() Performs a DELETE request to the given URL and returns the server response.
Response	get() Performs a GET request to the given URL and returns the server response.
Response	head() Performs a HEAD request to the given URL and returns the server response.
Response	patch() Performs a PATCH request to the given URL and returns the server response.
Response	post() Performs a POST request to the given URL and returns the server response.
Response	put() Performs a PUT request to the given URL and returns the server response.
ArangoRoute	route(String... path) Returns a new ArangoRoute instance for the given path (relative to the current route) that can be used to perform arbitrary requests.
ArangoRoute	withBody(Object body) The response body.
ArangoRoute	withHeader(String key, Object value) Header that should be sent with each request to the route.
ArangoRoute	withQueryParam(String key, Object value) Query parameter that should be sent with each request to the route.

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

route

ArangoRoute route(String... path)

Returns a new ArangoRoute instance for the given path (relative to the current route) that can be used to perform arbitrary requests.

Parameters:

path - The relative URL of the route

Returns:

ArangoRoute

withHeader

ArangoRoute withHeader(String key,
                       Object value)

Header that should be sent with each request to the route.

Parameters:

key - Header key

value - Header value (the toString() method will be called for the value}

Returns:

ArangoRoute

withQueryParam

ArangoRoute withQueryParam(String key,
                           Object value)

Query parameter that should be sent with each request to the route.

Parameters:

key - Query parameter key

value - Query parameter value (the toString() method will be called for the value}

Returns:

ArangoRoute

withBody

ArangoRoute withBody(Object body)

The response body. The body will be serialized to VPackSlice.

Parameters:

body - The request body

Returns:

ArangoRoute

delete

Response delete()
         throws ArangoDBException

Performs a DELETE request to the given URL and returns the server response.

Returns:

server response

Throws:

ArangoDBException

get

Response get()
      throws ArangoDBException

Performs a GET request to the given URL and returns the server response.

Returns:

server response

Throws:

ArangoDBException

head

Response head()
       throws ArangoDBException

Performs a HEAD request to the given URL and returns the server response.

Returns:

server response

Throws:

ArangoDBException

patch

Response patch()
        throws ArangoDBException

Performs a PATCH request to the given URL and returns the server response.

Returns:

server response

Throws:

ArangoDBException

post

Response post()
       throws ArangoDBException

Performs a POST request to the given URL and returns the server response.

Returns:

server response

Throws:

ArangoDBException

put

Response put()
      throws ArangoDBException

Performs a PUT request to the given URL and returns the server response.

Returns:

server response

Throws:

ArangoDBException