com.arangodb

Class BaseArangoDriver

java.lang.Object

com.arangodb.BaseArangoDriver

Direct Known Subclasses:

ArangoDriver, InternalAdminDriverImpl, InternalAqlFunctionsDriverImpl, InternalBatchDriverImpl, InternalCollectionDriverImpl, InternalCursorDriverImpl, InternalDatabaseDriverImpl, InternalDocumentDriverImpl, InternalEdgeDriverImpl, InternalEndpointDriverImpl, InternalGraphDriverImpl, InternalImportDriverImpl, InternalIndexDriverImpl, InternalJobsDriverImpl, InternalQueryCacheDriverImpl, InternalReplicationDriverImpl, InternalSimpleDriverImpl, InternalTransactionDriverImpl, InternalTraversalDriverImpl, InternalUsersDriverImpl

public abstract class BaseArangoDriver
extends Object

Author:

tamtam180 - kirscheless at gmail.com

Constructor Summary

Constructors

Constructor and Description
BaseArangoDriver()

Method Summary

Modifier and Type	Method and Description
protected String	createDocumentEndpointUrl(String database, Object... paths)
protected String	createDocumentHandle(long collectionId, String documentKey)
protected String	createDocumentHandle(String collectionName, String documentKey)
protected String	createEndpointUrl(String database, Object... paths)
protected String	createEndpointUrl(String database, String str, Object... paths)
protected <T extends BaseEntity> T	createEntity(HttpResponseEntity res, Class<T> clazz)
protected <T extends BaseEntity> T	createEntity(HttpResponseEntity res, Class<T> clazz, Class<?>... pclazz)
protected <T extends BaseEntity> T	createEntity(HttpResponseEntity res, Class<T> clazz, Class<?>[] pclazz, boolean validate) Creates an entity object
protected <T> T	createEntity(String str, Class<T> clazz, Class<?>... pclazz)
protected <T> T	createEntityImpl(HttpResponseEntity res, Class<T> type)
protected String	createGharialEndpointUrl(String database, Object... paths)
protected String	createIndexEndpointUrl(String database, Object... paths)
protected String	createJobEndpointUrl(String database, Object... paths)
protected String	createUserEndpointUrl(String database, Object... paths)
protected String	getJSONResponseText(HttpResponseEntity res) Gets the raw JSON string with results, from the Http response
protected void	setKeyValueHeader(HttpResponseEntity res, KeyValueEntity entity)
protected void	setStatusCode(HttpResponseEntity res, BaseEntity entity)
protected ReplicationDumpHeader	toReplicationDumpHeader(HttpResponseEntity res)
protected void	validate(HttpResponseEntity res, BaseEntity entity)
protected void	validateCollectionName(String name)
protected void	validateDatabaseName(String database, boolean allowNull)
protected void	validateDocumentHandle(String documentHandle)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseArangoDriver

public BaseArangoDriver()

Method Detail

createDocumentHandle

protected String createDocumentHandle(long collectionId,
                                      String documentKey)

createDocumentHandle

protected String createDocumentHandle(String collectionName,
                                      String documentKey)
                               throws ArangoException

Throws:

ArangoException

validateCollectionName

protected void validateCollectionName(String name)
                               throws ArangoException

Throws:

ArangoException

validateDocumentHandle

protected void validateDocumentHandle(String documentHandle)
                               throws ArangoException

Throws:

ArangoException

validateDatabaseName

protected void validateDatabaseName(String database,
                                    boolean allowNull)
                             throws ArangoException

Parameters:

database -

allowNull -

Throws:

ArangoException

See Also:

DatabaseNames documentation

setKeyValueHeader

protected void setKeyValueHeader(HttpResponseEntity res,
                                 KeyValueEntity entity)
                          throws ArangoException

Throws:

ArangoException

toReplicationDumpHeader

protected ReplicationDumpHeader toReplicationDumpHeader(HttpResponseEntity res)

createEntity

protected <T extends BaseEntity> T createEntity(HttpResponseEntity res,
                                                Class<T> clazz,
                                                Class<?>[] pclazz,
                                                boolean validate)
                                         throws ArangoException

Creates an entity object

Parameters:

res - the response of the database

clazz - the class of the entity object

pclazz - the class of the object wrapped in the entity object

validate - true for validation

Returns:

the result entity object of class T (T extends BaseEntity)

Throws:

ArangoException

getJSONResponseText

protected String getJSONResponseText(HttpResponseEntity res)
                              throws ArangoException

Gets the raw JSON string with results, from the Http response

Parameters:

res - the response of the database

Returns:

A valid JSON string with the results

Throws:

ArangoException

createEntity

protected <T> T createEntity(String str,
                             Class<T> clazz,
                             Class<?>... pclazz)
                      throws ArangoException

Throws:

ArangoException

createEntity

protected <T extends BaseEntity> T createEntity(HttpResponseEntity res,
                                                Class<T> clazz)
                                         throws ArangoException

Throws:

ArangoException

createEntity

protected <T extends BaseEntity> T createEntity(HttpResponseEntity res,
                                                Class<T> clazz,
                                                Class<?>... pclazz)
                                         throws ArangoException

Throws:

ArangoException

setStatusCode

protected void setStatusCode(HttpResponseEntity res,
                             BaseEntity entity)
                      throws ArangoException

Throws:

ArangoException

validate

protected void validate(HttpResponseEntity res,
                        BaseEntity entity)
                 throws ArangoException

Throws:

ArangoException

createEntityImpl

protected <T> T createEntityImpl(HttpResponseEntity res,
                                 Class<T> type)
                          throws ArangoException

Throws:

ArangoException

createEndpointUrl

protected String createEndpointUrl(String database,
                                   Object... paths)
                            throws ArangoException

Throws:

ArangoException

createEndpointUrl

protected String createEndpointUrl(String database,
                                   String str,
                                   Object... paths)
                            throws ArangoException

Throws:

ArangoException

createUserEndpointUrl

protected String createUserEndpointUrl(String database,
                                       Object... paths)
                                throws ArangoException

Throws:

ArangoException

createJobEndpointUrl

protected String createJobEndpointUrl(String database,
                                      Object... paths)
                               throws ArangoException

Throws:

ArangoException

createIndexEndpointUrl

protected String createIndexEndpointUrl(String database,
                                        Object... paths)
                                 throws ArangoException

Throws:

ArangoException

createGharialEndpointUrl

protected String createGharialEndpointUrl(String database,
                                          Object... paths)
                                   throws ArangoException

Throws:

ArangoException

createDocumentEndpointUrl

protected String createDocumentEndpointUrl(String database,
                                           Object... paths)
                                    throws ArangoException

Throws:

ArangoException