com.arangodb.async.internal

Class ArangoDBAsyncImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable<E>

com.arangodb.internal.InternalArangoDB<ArangoExecutorAsync>

com.arangodb.async.internal.ArangoDBAsyncImpl

All Implemented Interfaces:

ArangoSerializationAccessor, ArangoDBAsync

public class ArangoDBAsyncImpl
extends com.arangodb.internal.InternalArangoDB<ArangoExecutorAsync>
implements ArangoDBAsync

Author:

Mark Vollmary

Nested Class Summary

Nested classes/interfaces inherited from interface com.arangodb.async.ArangoDBAsync

ArangoDBAsync.Builder

Field Summary

Fields inherited from class com.arangodb.internal.ArangoExecuteable

context, executor, util

Constructor Summary

Constructors

Constructor and Description
ArangoDBAsyncImpl(VstCommunicationAsync.Builder asyncCommBuilder, ArangoSerializationFactory util, VstCommunicationSync.Builder syncCommBuilder, HostResolver asyncHostResolver, HostResolver syncHostResolver, HostHandler asyncHostHandler, HostHandler syncHostHandler, com.arangodb.internal.ArangoContext context, int responseQueueTimeSamples, int timeoutMs)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	createDatabase(DBCreateOptions options) Creates a new database
CompletableFuture<Boolean>	createDatabase(DbName name) Creates a new database
CompletableFuture<UserEntity>	createUser(String user, String passwd) Create a new user.
CompletableFuture<UserEntity>	createUser(String user, String passwd, UserCreateOptions options) Create a new user.
ArangoDatabaseAsync	db() Returns a handler of the system database
ArangoDatabaseAsync	db(DbName name) Returns a handler of the database by the given name
CompletableFuture<Void>	deleteUser(String user) Removes an existing user, identified by user.
CompletableFuture<Response>	execute(Request request) Generic Execute.
protected ArangoExecutorAsync	executor()
CompletableFuture<Collection<String>>	getAccessibleDatabases() Retrieves a list of all databases the current user can access
CompletableFuture<Collection<String>>	getAccessibleDatabasesFor(String user) List available database to the specified user
CompletableFuture<Collection<String>>	getDatabases() Retrieves a list of all existing databases
CompletableFuture<LogEntriesEntity>	getLogEntries(LogOptions options) Returns the server logs
CompletableFuture<LogLevelEntity>	getLogLevel() Returns the server's current loglevel settings.
CompletableFuture<LogLevelEntity>	getLogLevel(LogLevelOptions options) Returns the server's current loglevel settings.
CompletableFuture<LogEntity>	getLogs(LogOptions options) Returns fatal, error, warning or info log messages from the server's global log.
CompletableFuture<Collection<QueryOptimizerRule>>	getQueryOptimizerRules()
CompletableFuture<ServerRole>	getRole() Returns the server role.
CompletableFuture<String>	getServerId() Returns the id of a server in a cluster.
CompletableFuture<UserEntity>	getUser(String user) Fetches data about the specified user.
CompletableFuture<Collection<UserEntity>>	getUsers() Fetches data about all users.
CompletableFuture<ArangoDBVersion>	getVersion() Returns the server name and version number.
CompletableFuture<Void>	grantDefaultCollectionAccess(String user, Permissions permissions) Sets the default access level for collections for the user user.
CompletableFuture<Void>	grantDefaultDatabaseAccess(String user, Permissions permissions) Sets the default access level for databases for the user user.
ArangoMetrics	metrics()
CompletableFuture<UserEntity>	replaceUser(String user, UserUpdateOptions options) Replaces the data of an existing user.
CompletableFuture<LogLevelEntity>	setLogLevel(LogLevelEntity entity) Modifies and returns the server's current loglevel settings.
CompletableFuture<LogLevelEntity>	setLogLevel(LogLevelEntity entity, LogLevelOptions options) Modifies and returns the server's current loglevel settings.
void	shutdown()
void	updateJwt(String jwt) Updates the JWT used for requests authorization.
CompletableFuture<UserEntity>	updateUser(String user, UserUpdateOptions options) Partially updates the data of an existing user.

Methods inherited from class com.arangodb.internal.InternalArangoDB

createDatabaseRequest, createDatabaseResponseDeserializer, createUserRequest, deleteUserRequest, getAccessibleDatabasesForRequest, getAccessibleDatabasesForResponseDeserializer, getDatabaseResponseDeserializer, getDatabasesRequest, getLogEntriesRequest, getLogLevelRequest, getLogsRequest, getQueryOptimizerRulesRequest, getRoleRequest, getRoleResponseDeserializer, getServerIdRequest, getServerIdResponseDeserializer, getUserRequest, getUsersRequest, getUsersResponseDeserializer, replaceUserRequest, setLogLevelRequest, updateUserDefaultCollectionAccessRequest, updateUserDefaultDatabaseAccessRequest, updateUserRequest

Methods inherited from class com.arangodb.internal.ArangoExecuteable

createPath, request, util, util

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.arangodb.async.ArangoDBAsync

createDatabase, db

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Constructor Detail

ArangoDBAsyncImpl

public ArangoDBAsyncImpl(VstCommunicationAsync.Builder asyncCommBuilder,
                         ArangoSerializationFactory util,
                         VstCommunicationSync.Builder syncCommBuilder,
                         HostResolver asyncHostResolver,
                         HostResolver syncHostResolver,
                         HostHandler asyncHostHandler,
                         HostHandler syncHostHandler,
                         com.arangodb.internal.ArangoContext context,
                         int responseQueueTimeSamples,
                         int timeoutMs)

Method Detail

executor

protected ArangoExecutorAsync executor()

Overrides:

executor in class com.arangodb.internal.ArangoExecuteable<ArangoExecutorAsync>

shutdown

public void shutdown()
              throws ArangoDBException

Specified by:

shutdown in interface ArangoDBAsync

Throws:

ArangoDBException

updateJwt

public void updateJwt(String jwt)

Description copied from interface: ArangoDBAsync

Updates the JWT used for requests authorization. It does not change already existing VST connections, since VST connections are authenticated during the initialization phase.

Specified by:

updateJwt in interface ArangoDBAsync

Parameters:

jwt - token to use

db

public ArangoDatabaseAsync db()

Description copied from interface: ArangoDBAsync

Returns a handler of the system database

Specified by:

db in interface ArangoDBAsync

Returns:

database handler

db

public ArangoDatabaseAsync db(DbName name)

Description copied from interface: ArangoDBAsync

Returns a handler of the database by the given name

Specified by:

db in interface ArangoDBAsync

Parameters:

name - Name of the database

Returns:

database handler

metrics

public ArangoMetrics metrics()

Specified by:

metrics in interface ArangoDBAsync

Returns:

entry point for accessing client metrics

createDatabase

public CompletableFuture<Boolean> createDatabase(DbName name)

Description copied from interface: ArangoDBAsync

Creates a new database

Specified by:

createDatabase in interface ArangoDBAsync

Parameters:

name - database name

Returns:

true if the database was created successfully.

See Also:

API Documentation

createDatabase

public CompletableFuture<Boolean> createDatabase(DBCreateOptions options)

Description copied from interface: ArangoDBAsync

Creates a new database

Specified by:

createDatabase in interface ArangoDBAsync

Parameters:

options - Creation options

Returns:

true if the database was created successfully.

See Also:

API Documentation

getDatabases

public CompletableFuture<Collection<String>> getDatabases()

Description copied from interface: ArangoDBAsync

Retrieves a list of all existing databases

Specified by:

getDatabases in interface ArangoDBAsync

Returns:

a list of all existing databases

See Also:

API Documentation

getAccessibleDatabases

public CompletableFuture<Collection<String>> getAccessibleDatabases()

Description copied from interface: ArangoDBAsync

Retrieves a list of all databases the current user can access

Specified by:

getAccessibleDatabases in interface ArangoDBAsync

Returns:

a list of all databases the current user can access

See Also:

API Documentation

getAccessibleDatabasesFor

public CompletableFuture<Collection<String>> getAccessibleDatabasesFor(String user)

Description copied from interface: ArangoDBAsync

List available database to the specified user

Specified by:

getAccessibleDatabasesFor in interface ArangoDBAsync

Parameters:

user - The name of the user for which you want to query the databases

Returns:

See Also:

API Documentation

getVersion

public CompletableFuture<ArangoDBVersion> getVersion()

Description copied from interface: ArangoDBAsync

Returns the server name and version number.

Specified by:

getVersion in interface ArangoDBAsync

Returns:

the server version, number

See Also:

API Documentation

getRole

public CompletableFuture<ServerRole> getRole()

Description copied from interface: ArangoDBAsync

Returns the server role.

Specified by:

getRole in interface ArangoDBAsync

Returns:

the server role

getServerId

public CompletableFuture<String> getServerId()

Description copied from interface: ArangoDBAsync

Returns the id of a server in a cluster.

Specified by:

getServerId in interface ArangoDBAsync

Returns:

the server id

See Also:

API Documentation

createUser

public CompletableFuture<UserEntity> createUser(String user,
                                                String passwd)

Description copied from interface: ArangoDBAsync

Create a new user. This user will not have access to any database. You need permission to the _system database in order to execute this call.

Specified by:

createUser in interface ArangoDBAsync

Parameters:

user - The name of the user

passwd - The user password

Returns:

information about the user

See Also:

API Documentation

createUser

public CompletableFuture<UserEntity> createUser(String user,
                                                String passwd,
                                                UserCreateOptions options)

Description copied from interface: ArangoDBAsync

Create a new user. This user will not have access to any database. You need permission to the _system database in order to execute this call.

Specified by:

createUser in interface ArangoDBAsync

Parameters:

user - The name of the user

passwd - The user password

options - Additional properties of the user, can be null

Returns:

information about the user

See Also:

API Documentation

deleteUser

public CompletableFuture<Void> deleteUser(String user)

Description copied from interface: ArangoDBAsync

Removes an existing user, identified by user. You need access to the _system database.

Specified by:

deleteUser in interface ArangoDBAsync

Parameters:

user - The name of the user

Returns:

void

See Also:

API Documentation

getUser

public CompletableFuture<UserEntity> getUser(String user)

Description copied from interface: ArangoDBAsync

Fetches data about the specified user. You can fetch information about yourself or you need permission to the _system database in order to execute this call.

Specified by:

getUser in interface ArangoDBAsync

Parameters:

user - The name of the user

Returns:

information about the user

See Also:

API Documentation

getUsers

public CompletableFuture<Collection<UserEntity>> getUsers()

Description copied from interface: ArangoDBAsync

Fetches data about all users. You can only execute this call if you have access to the _system database.

Specified by:

getUsers in interface ArangoDBAsync

Returns:

informations about all users

See Also:

API Documentation

updateUser

public CompletableFuture<UserEntity> updateUser(String user,
                                                UserUpdateOptions options)

Description copied from interface: ArangoDBAsync

Partially updates the data of an existing user. The name of an existing user must be specified in user. You can only change the password of your self. You need access to the _system database to change the active flag.

Specified by:

updateUser in interface ArangoDBAsync

Parameters:

user - The name of the user

options - Properties of the user to be changed

Returns:

information about the user

See Also:

API Documentation

replaceUser

public CompletableFuture<UserEntity> replaceUser(String user,
                                                 UserUpdateOptions options)

Description copied from interface: ArangoDBAsync

Replaces the data of an existing user. The name of an existing user must be specified in user. You can only change the password of your self. You need access to the _system database to change the active flag.

Specified by:

replaceUser in interface ArangoDBAsync

Parameters:

user - The name of the user

options - Additional properties of the user, can be null

Returns:

information about the user

See Also:

API Documentation

grantDefaultDatabaseAccess

public CompletableFuture<Void> grantDefaultDatabaseAccess(String user,
                                                          Permissions permissions)

Description copied from interface: ArangoDBAsync

Sets the default access level for databases for the user user. You need permission to the _system database in order to execute this call.

Specified by:

grantDefaultDatabaseAccess in interface ArangoDBAsync

Parameters:

user - The name of the user

permissions - The permissions the user grant

Returns:

void

grantDefaultCollectionAccess

public CompletableFuture<Void> grantDefaultCollectionAccess(String user,
                                                            Permissions permissions)

Description copied from interface: ArangoDBAsync

Sets the default access level for collections for the user user. You need permission to the _system database in order to execute this call.

Specified by:

grantDefaultCollectionAccess in interface ArangoDBAsync

Parameters:

user - The name of the user

permissions - The permissions the user grant

Returns:

void

execute

public CompletableFuture<Response> execute(Request request)

Description copied from interface: ArangoDBAsync

Generic Execute. Use this method to execute custom FOXX services.

Specified by:

execute in interface ArangoDBAsync

Parameters:

request - VelocyStream request

Returns:

VelocyStream response

getLogs

public CompletableFuture<LogEntity> getLogs(LogOptions options)

Description copied from interface: ArangoDBAsync

Returns fatal, error, warning or info log messages from the server's global log.

Specified by:

getLogs in interface ArangoDBAsync

Parameters:

options - Additional options, can be null

Returns:

the log messages

See Also:

API Documentation

getLogEntries

public CompletableFuture<LogEntriesEntity> getLogEntries(LogOptions options)

Description copied from interface: ArangoDBAsync

Returns the server logs

Specified by:

getLogEntries in interface ArangoDBAsync

Parameters:

options - Additional options, can be null

Returns:

the log messages

See Also:

API Documentation

getLogLevel

public CompletableFuture<LogLevelEntity> getLogLevel()

Description copied from interface: ArangoDBAsync

Returns the server's current loglevel settings.

Specified by:

getLogLevel in interface ArangoDBAsync

Returns:

the server's current loglevel settings

getLogLevel

public CompletableFuture<LogLevelEntity> getLogLevel(LogLevelOptions options)

Description copied from interface: ArangoDBAsync

Returns the server's current loglevel settings.

Specified by:

getLogLevel in interface ArangoDBAsync

Returns:

the server's current loglevel settings

setLogLevel

public CompletableFuture<LogLevelEntity> setLogLevel(LogLevelEntity entity)

Description copied from interface: ArangoDBAsync

Modifies and returns the server's current loglevel settings.

Specified by:

setLogLevel in interface ArangoDBAsync

Parameters:

entity - loglevel settings

Returns:

the server's current loglevel settings

setLogLevel

public CompletableFuture<LogLevelEntity> setLogLevel(LogLevelEntity entity,
                                                     LogLevelOptions options)

Description copied from interface: ArangoDBAsync

Modifies and returns the server's current loglevel settings.

Specified by:

setLogLevel in interface ArangoDBAsync

Parameters:

entity - loglevel settings

Returns:

the server's current loglevel settings

getQueryOptimizerRules

public CompletableFuture<Collection<QueryOptimizerRule>> getQueryOptimizerRules()
                                                                         throws ArangoDBException

Specified by:

getQueryOptimizerRules in interface ArangoDBAsync

Returns:

the list of available rules and their respective flags

Throws:

ArangoDBException