com.arangodb.internal

Class ArangoDBImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable<E>

com.arangodb.internal.InternalArangoDB<ArangoExecutorSync>

com.arangodb.internal.ArangoDBImpl

All Implemented Interfaces:

ArangoDB, ArangoSerdeAccessor

public class ArangoDBImpl
extends InternalArangoDB<ArangoExecutorSync>
implements ArangoDB

Author:

Mark Vollmary, Heiko Kernbach, Michele Rastelli

Nested Class Summary

Nested classes/interfaces inherited from interface com.arangodb.ArangoDB

ArangoDB.Builder

Field Summary

Fields inherited from class com.arangodb.internal.ArangoExecuteable

executor, serde

Constructor Summary

Constructors

Constructor and Description
ArangoDBImpl(com.arangodb.internal.velocystream.VstCommunicationSync.Builder vstBuilder, com.arangodb.internal.http.HttpCommunication.Builder httpBuilder, com.arangodb.internal.serde.InternalSerde util, Protocol protocol, com.arangodb.internal.net.HostResolver hostResolver, com.arangodb.internal.net.HostHandler hostHandler, int responseQueueTimeSamples, int timeoutMs)

Method Summary

Modifier and Type	Method and Description
Boolean	createDatabase(DBCreateOptions options) Creates a new database with the given name.
Boolean	createDatabase(DbName dbName) Creates a new database with the given name.
UserEntity	createUser(String user, String passwd) Create a new user.
UserEntity	createUser(String user, String passwd, UserCreateOptions options) Create a new user.
ArangoDatabase	db() Returns a ArangoDatabase instance for the _system database.
ArangoDatabase	db(DbName dbName) Returns a ArangoDatabase instance for the given database name.
void	deleteUser(String user) Removes an existing user, identified by user.
<T,U> Response<U>	execute(Request<T> request, Class<U> type) Execute custom requests.
protected ArangoExecutorSync	executor()
Collection<String>	getAccessibleDatabases() Retrieves a list of all databases the current user can access
Collection<String>	getAccessibleDatabasesFor(String user) List available database to the specified user
Collection<String>	getDatabases() Retrieves a list of all existing databases
ArangoDBEngine	getEngine() Returns the server storage engine.
LogEntriesEntity	getLogEntries(LogOptions options) Returns the server logs
LogLevelEntity	getLogLevel() Returns the server's current loglevel settings.
Collection<QueryOptimizerRule>	getQueryOptimizerRules()
ServerRole	getRole() Returns the server role.
String	getServerId() Returns the id of a server in a cluster.
UserEntity	getUser(String user) Fetches data about the specified user.
Collection<UserEntity>	getUsers() Fetches data about all users.
ArangoDBVersion	getVersion() Returns the server name and version number.
void	grantDefaultCollectionAccess(String user, Permissions permissions) Sets the default access level for collections for the user user.
void	grantDefaultDatabaseAccess(String user, Permissions permissions) Sets the default access level for databases for the user user.
ArangoMetrics	metrics()
UserEntity	replaceUser(String user, UserUpdateOptions options) Replaces the data of an existing user.
LogLevelEntity	setLogLevel(LogLevelEntity entity) Modifies and returns the server's current loglevel settings.
void	shutdown() Releases all connections to the server and clear the connection pool.
void	updateJwt(String jwt) Updates the JWT used for requests authorization.
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, executeRequest, getAccessibleDatabasesForRequest, getAccessibleDatabasesForResponseDeserializer, getDatabaseResponseDeserializer, getDatabasesRequest, getLogEntriesRequest, getLogLevelRequest, getQueryOptimizerRulesRequest, getRoleRequest, getRoleResponseDeserializer, getServerIdRequest, getServerIdResponseDeserializer, getUserRequest, getUsersRequest, getUsersResponseDeserializer, replaceUserRequest, responseDeserializer, setLogLevelRequest, updateUserDefaultCollectionAccessRequest, updateUserDefaultDatabaseAccessRequest, updateUserRequest

Methods inherited from class com.arangodb.internal.ArangoExecuteable

createPath, getSerde, request

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

getSerde

Constructor Detail

ArangoDBImpl

public ArangoDBImpl(com.arangodb.internal.velocystream.VstCommunicationSync.Builder vstBuilder,
                    com.arangodb.internal.http.HttpCommunication.Builder httpBuilder,
                    com.arangodb.internal.serde.InternalSerde util,
                    Protocol protocol,
                    com.arangodb.internal.net.HostResolver hostResolver,
                    com.arangodb.internal.net.HostHandler hostHandler,
                    int responseQueueTimeSamples,
                    int timeoutMs)

Method Detail

executor

protected ArangoExecutorSync executor()

Overrides:

executor in class ArangoExecuteable<ArangoExecutorSync>

shutdown

public void shutdown()

Description copied from interface: ArangoDB

Releases all connections to the server and clear the connection pool.

Specified by:

shutdown in interface ArangoDB

updateJwt

public void updateJwt(String jwt)

Description copied from interface: ArangoDB

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 ArangoDB

Parameters:

jwt - token to use

db

public ArangoDatabase db()

Description copied from interface: ArangoDB

Returns a ArangoDatabase instance for the _system database.

Specified by:

db in interface ArangoDB

Returns:

database handler

db

public ArangoDatabase db(DbName dbName)

Description copied from interface: ArangoDB

Returns a ArangoDatabase instance for the given database name.

Specified by:

db in interface ArangoDB

Parameters:

dbName - Name of the database

Returns:

database handler

metrics

public ArangoMetrics metrics()

Specified by:

metrics in interface ArangoDB

Returns:

entry point for accessing client metrics

createDatabase

public Boolean createDatabase(DbName dbName)

Description copied from interface: ArangoDB

Creates a new database with the given name.

Specified by:

createDatabase in interface ArangoDB

Parameters:

dbName - Name of the database to create

Returns:

true if the database was created successfully.

See Also:

API Documentation

createDatabase

public Boolean createDatabase(DBCreateOptions options)

Description copied from interface: ArangoDB

Creates a new database with the given name.

Specified by:

createDatabase in interface ArangoDB

Parameters:

options - Creation options

Returns:

true if the database was created successfully.

See Also:

API Documentation

getDatabases

public Collection<String> getDatabases()

Description copied from interface: ArangoDB

Retrieves a list of all existing databases

Specified by:

getDatabases in interface ArangoDB

Returns:

a list of all existing databases

See Also:

API Documentation

getAccessibleDatabases

public Collection<String> getAccessibleDatabases()

Description copied from interface: ArangoDB

Retrieves a list of all databases the current user can access

Specified by:

getAccessibleDatabases in interface ArangoDB

Returns:

a list of all databases the current user can access

See Also:

API Documentation

getAccessibleDatabasesFor

public Collection<String> getAccessibleDatabasesFor(String user)

Description copied from interface: ArangoDB

List available database to the specified user

Specified by:

getAccessibleDatabasesFor in interface ArangoDB

Parameters:

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

Returns:

list of database names which are available for the specified user

See Also:

API Documentation

getVersion

public ArangoDBVersion getVersion()

Description copied from interface: ArangoDB

Returns the server name and version number.

Specified by:

getVersion in interface ArangoDB

Returns:

the server version, number

See Also:

API Documentation

getEngine

public ArangoDBEngine getEngine()

Description copied from interface: ArangoDB

Returns the server storage engine.

Specified by:

getEngine in interface ArangoDB

Returns:

the storage engine name

See Also:

API Documentation

getRole

public ServerRole getRole()

Description copied from interface: ArangoDB

Returns the server role.

Specified by:

getRole in interface ArangoDB

Returns:

the server role

getServerId

public String getServerId()

Description copied from interface: ArangoDB

Returns the id of a server in a cluster.

Specified by:

getServerId in interface ArangoDB

Returns:

the server id

See Also:

API Documentation

createUser

public UserEntity createUser(String user,
                             String passwd)

Description copied from interface: ArangoDB

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 ArangoDB

Parameters:

user - The name of the user

passwd - The user password

Returns:

information about the user

See Also:

API Documentation

createUser

public UserEntity createUser(String user,
                             String passwd,
                             UserCreateOptions options)

Description copied from interface: ArangoDB

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 ArangoDB

Parameters:

user - The name of the user

passwd - The user password

options - Additional options, can be null

Returns:

information about the user

See Also:

API Documentation

deleteUser

public void deleteUser(String user)

Description copied from interface: ArangoDB

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

Specified by:

deleteUser in interface ArangoDB

Parameters:

user - The name of the user

See Also:

API Documentation

getUser

public UserEntity getUser(String user)

Description copied from interface: ArangoDB

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 ArangoDB

Parameters:

user - The name of the user

Returns:

information about the user

See Also:

API Documentation

getUsers

public Collection<UserEntity> getUsers()

Description copied from interface: ArangoDB

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

Specified by:

getUsers in interface ArangoDB

Returns:

informations about all users

See Also:

API Documentation

updateUser

public UserEntity updateUser(String user,
                             UserUpdateOptions options)

Description copied from interface: ArangoDB

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 ArangoDB

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 UserEntity replaceUser(String user,
                              UserUpdateOptions options)

Description copied from interface: ArangoDB

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 ArangoDB

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 void grantDefaultDatabaseAccess(String user,
                                       Permissions permissions)

Description copied from interface: ArangoDB

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 ArangoDB

Parameters:

user - The name of the user

permissions - The permissions the user grant

grantDefaultCollectionAccess

public void grantDefaultCollectionAccess(String user,
                                         Permissions permissions)

Description copied from interface: ArangoDB

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 ArangoDB

Parameters:

user - The name of the user

permissions - The permissions the user grant

execute

public <T,U> Response<U> execute(Request<T> request,
                                 Class<U> type)

Description copied from interface: ArangoDB

Execute custom requests. Requests can be programmatically built by setting low level detail such as method, path, query parameters, headers and body payload. This method can be used to call FOXX services, API endpoints not (yet) implemented in this driver or trigger async jobs, see Fire and Forget and Async Execution and later Result Retrieval

Specified by:

execute in interface ArangoDB

Parameters:

request - request

type - Deserialization target type for the response body (POJO or RawData)

Returns:

response

getLogEntries

public LogEntriesEntity getLogEntries(LogOptions options)

Description copied from interface: ArangoDB

Returns the server logs

Specified by:

getLogEntries in interface ArangoDB

Parameters:

options - Additional options, can be null

Returns:

the log messages

See Also:

API Documentation

getLogLevel

public LogLevelEntity getLogLevel()

Description copied from interface: ArangoDB

Returns the server's current loglevel settings.

Specified by:

getLogLevel in interface ArangoDB

Returns:

the server's current loglevel settings

setLogLevel

public LogLevelEntity setLogLevel(LogLevelEntity entity)

Description copied from interface: ArangoDB

Modifies and returns the server's current loglevel settings.

Specified by:

setLogLevel in interface ArangoDB

Parameters:

entity - loglevel settings

Returns:

the server's current loglevel settings

getQueryOptimizerRules

public Collection<QueryOptimizerRule> getQueryOptimizerRules()

Specified by:

getQueryOptimizerRules in interface ArangoDB

Returns:

the list of available rules and their respective flags