com.arangodb.ArangoDB Maven / Gradle / Ivy
Show all versions of core Show documentation
/*
* DISCLAIMER
*
* Copyright 2016 ArangoDB GmbH, Cologne, Germany
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright holder is ArangoDB GmbH, Cologne, Germany
*/
package com.arangodb;
import com.arangodb.arch.UnstableApi;
import com.arangodb.config.ArangoConfigProperties;
import com.arangodb.config.HostDescription;
import com.arangodb.config.ProtocolConfig;
import com.arangodb.entity.*;
import com.arangodb.internal.ArangoDBImpl;
import com.arangodb.internal.ArangoExecutorSync;
import com.arangodb.internal.config.ArangoConfig;
import com.arangodb.internal.net.*;
import com.arangodb.internal.util.HostUtils;
import com.arangodb.model.*;
import com.arangodb.serde.ArangoSerde;
import com.arangodb.serde.ArangoSerdeProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.concurrent.ThreadSafe;
import javax.net.ssl.SSLContext;
import java.util.*;
import java.util.concurrent.Executor;
/**
* Central access point for applications to communicate with an ArangoDB server.
*
*
* Will be instantiated through {@link ArangoDB.Builder}
*
*
*
* ArangoDB arango = new ArangoDB.Builder().build();
* ArangoDB arango = new ArangoDB.Builder().host("127.0.0.1", 8529).build();
*
*
* @author Mark Vollmary
* @author Michele Rastelli
*/
@ThreadSafe
public interface ArangoDB extends ArangoSerdeAccessor {
/**
* @return the asynchronous version of this class
*/
ArangoDBAsync async();
/**
* Releases all connections to the server and clear the connection pool.
*/
void shutdown();
/**
* Updates the JWT used for requests authorization. It does not change already existing VST connections, since VST
* connections are authenticated during the initialization phase.
*
* @param jwt token to use
*/
void updateJwt(String jwt);
/**
* Returns a {@code ArangoDatabase} instance for the {@code _system} database.
*
* @return database handler
*/
ArangoDatabase db();
/**
* Returns a {@code ArangoDatabase} instance for the given database name.
*
* @param name Name of the database
* @return database handler
*/
ArangoDatabase db(String name);
/**
* @return entry point for accessing client metrics
*/
ArangoMetrics metrics();
/**
* Creates a new database with the given name.
*
* @param name Name of the database to create
* @return true if the database was created successfully.
* @see API
* Documentation
*/
Boolean createDatabase(String name);
/**
* Creates a new database with the given name.
*
* @param options Creation options
* @return true if the database was created successfully.
* @see API
* Documentation
* @since ArangoDB 3.6.0
*/
Boolean createDatabase(DBCreateOptions options);
/**
* Retrieves a list of all existing databases
*
* @return a list of all existing databases
* @see API
* Documentation
*/
Collection getDatabases();
/**
* Retrieves a list of all databases the current user can access
*
* @return a list of all databases the current user can access
* @see API
* Documentation
*/
Collection getAccessibleDatabases();
/**
* List available database to the specified user
*
* @param user The name of the user for which you want to query the databases
* @return list of database names which are available for the specified user
* @see API
* Documentation
*/
Collection getAccessibleDatabasesFor(String user);
/**
* Returns the server name and version number.
*
* @return the server version, number
* @see API
* Documentation
*/
ArangoDBVersion getVersion();
/**
* Returns the server storage engine.
*
* @return the storage engine name
* @see API
* Documentation
*/
ArangoDBEngine getEngine();
/**
* Returns the server role.
*
* @return the server role
* @see API
* Documentation
*/
ServerRole getRole();
/**
* Returns the id of a server in a cluster.
*
* @return the server id
* @see API
* Documentation
*/
String getServerId();
/**
* 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.
*
* @param user The name of the user
* @param passwd The user password
* @return information about the user
* @see API Documentation
*/
UserEntity createUser(String user, String passwd);
/**
* 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.
*
* @param user The name of the user
* @param passwd The user password
* @param options Additional options, can be null
* @return information about the user
* @see API Documentation
*/
UserEntity createUser(String user, String passwd, UserCreateOptions options);
/**
* Removes an existing user, identified by user. You need access to the _system database.
*
* @param user The name of the user
* @see API Documentation
*/
void deleteUser(String user);
/**
* 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.
*
* @param user The name of the user
* @return information about the user
* @see API Documentation
*/
UserEntity getUser(String user);
/**
* Fetches data about all users. You can only execute this call if you have access to the _system database.
*
* @return informations about all users
* @see API
* Documentation
*/
Collection getUsers();
/**
* 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.
*
* @param user The name of the user
* @param options Properties of the user to be changed
* @return information about the user
* @see API Documentation
*/
UserEntity updateUser(String user, UserUpdateOptions options);
/**
* 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.
*
* @param user The name of the user
* @param options Additional properties of the user, can be null
* @return information about the user
* @see API
* Documentation
*/
UserEntity replaceUser(String user, UserUpdateOptions options);
/**
* Sets the default access level for databases for the user {@code user}. You need permission to the _system
* database in order to execute this call.
*
* @param user The name of the user
* @param permissions The permissions the user grant
* @see API
* Documentation
* @since ArangoDB 3.2.0
*/
void grantDefaultDatabaseAccess(String user, Permissions permissions);
/**
* Sets the default access level for collections for the user {@code user}. You need permission to the _system
* database in order to execute this call.
*
* @param user The name of the user
* @param permissions The permissions the user grant
* @see API
* Documentation
* @since ArangoDB 3.2.0
*/
void grantDefaultCollectionAccess(String user, Permissions permissions);
/**
* 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
*
* @param request request
* @param type Deserialization target type for the response body (POJO or {@link com.arangodb.util.RawData})
* @return response
*/
Response execute(Request request, Class type);
/**
* Returns the server logs
*
* @param options Additional options, can be null
* @return the log messages
* @see API
* Documentation
* @since ArangoDB 3.8
*/
LogEntriesEntity getLogEntries(LogOptions options);
/**
* Returns the server's current loglevel settings.
*
* @return the server's current loglevel settings
* @see API
* Documentation
* @since ArangoDB 3.1.0
*/
LogLevelEntity getLogLevel();
/**
* Returns the server's current loglevel settings.
*
* @return the server's current loglevel settings
* @see API
* Documentation
* @since ArangoDB 3.10
*/
LogLevelEntity getLogLevel(LogLevelOptions options);
/**
* Modifies and returns the server's current loglevel settings.
*
* @param entity loglevel settings
* @return the server's current loglevel settings
* @see API
* Documentation
* @since ArangoDB 3.1.0
*/
LogLevelEntity setLogLevel(LogLevelEntity entity);
/**
* Modifies and returns the server's current loglevel settings.
*
* @param entity loglevel settings
* @return the server's current loglevel settings
* @see API
* Documentation
* @since ArangoDB 3.10
*/
LogLevelEntity setLogLevel(LogLevelEntity entity, LogLevelOptions options);
/**
* Reset the server log levels
* Revert the server's log level settings to the values they had at startup, as determined by the startup options specified on the command-line, a configuration file, and the factory defaults.
* @since ArangoDB 3.12
*/
LogLevelEntity resetLogLevels(LogLevelOptions options);
/**
* @return the list of available rules and their respective flags
* @see API
* Documentation
* @since ArangoDB 3.10
*/
Collection getQueryOptimizerRules();
/**
* Builder class to build an instance of {@link ArangoDB}.
*
* @author Mark Vollmary
*/
class Builder {
private static final Logger LOG = LoggerFactory.getLogger(Builder.class);
private final ArangoConfig config = new ArangoConfig();
/**
* Returns an instance of {@link ArangoDB}.
*
* @return {@link ArangoDB}
*/
public ArangoDB build() {
if (config.getHosts().isEmpty()) {
throw new ArangoDBException("No host has been set!");
}
ProtocolProvider protocolProvider = protocolProvider(config.getProtocol());
config.setProtocolModule(protocolProvider.protocolModule());
ConnectionFactory connectionFactory = protocolProvider.createConnectionFactory(config.getProtocolConfig());
Collection hostList = createHostList(connectionFactory);
HostResolver hostResolver = createHostResolver(hostList, connectionFactory);
HostHandler hostHandler = createHostHandler(hostResolver);
hostHandler.setJwt(config.getJwt());
CommunicationProtocol protocol = protocolProvider.createProtocol(config, hostHandler);
ArangoExecutorSync executor = new ArangoExecutorSync(protocol, config);
hostResolver.init(executor, config.getInternalSerde());
return new ArangoDBImpl(
config,
protocol,
hostHandler
);
}
public Builder loadProperties(final ArangoConfigProperties properties) {
config.loadProperties(properties);
return this;
}
public Builder protocol(final Protocol protocol) {
config.setProtocol(protocol);
return this;
}
/**
* Adds a host to connect to. Multiple hosts can be added to provide fallbacks.
*
* @param host address of the host
* @param port port of the host
* @return {@link ArangoDB.Builder}
*/
public Builder host(final String host, final int port) {
config.addHost(new HostDescription(host, port));
return this;
}
/**
* Sets the connection and request timeout in milliseconds.
*
* @param timeout timeout in milliseconds
* @return {@link ArangoDB.Builder}
*/
public Builder timeout(final Integer timeout) {
config.setTimeout(timeout);
return this;
}
/**
* Sets the username to use for authentication.
*
* @param user the user in the database (default: {@code root})
* @return {@link ArangoDB.Builder}
*/
public Builder user(final String user) {
config.setUser(user);
return this;
}
/**
* Sets the password for the user for authentication.
*
* @param password the password of the user in the database (default: {@code null})
* @return {@link ArangoDB.Builder}
*/
public Builder password(final String password) {
config.setPassword(password);
return this;
}
/**
* Sets the JWT for the user authentication.
*
* @param jwt token to use (default: {@code null})
* @return {@link ArangoDB.Builder}
*/
public Builder jwt(final String jwt) {
config.setJwt(jwt);
return this;
}
/**
* If set to {@code true} SSL will be used when connecting to an ArangoDB server.
*
* @param useSsl whether or not use SSL (default: {@code false})
* @return {@link ArangoDB.Builder}
*/
public Builder useSsl(final Boolean useSsl) {
config.setUseSsl(useSsl);
return this;
}
/**
* Sets the SSL context to be used when {@code true} is passed through {@link #useSsl(Boolean)}.
*
* @param sslContext SSL context to be used
* @return {@link ArangoDB.Builder}
*/
public Builder sslContext(final SSLContext sslContext) {
config.setSslContext(sslContext);
return this;
}
/**
* Set whether hostname verification is enabled
*
* @param verifyHost {@code true} if enabled
* @return {@link ArangoDB.Builder}
*/
public Builder verifyHost(final Boolean verifyHost) {
config.setVerifyHost(verifyHost);
return this;
}
/**
* Sets the chunk size when {@link Protocol#VST} is used.
*
* @param chunkSize size of a chunk in bytes
* @return {@link ArangoDB.Builder}
*/
public Builder chunkSize(final Integer chunkSize) {
config.setChunkSize(chunkSize);
return this;
}
/**
* Sets the maximum number of connections the built in connection pool will open per host.
*
*
* Defaults:
*
*
*
* {@link Protocol#VST} == 1
* {@link Protocol#HTTP_JSON} == 20
* {@link Protocol#HTTP_VPACK} == 20
*
*
* @param maxConnections max number of connections
* @return {@link ArangoDB.Builder}
*/
public Builder maxConnections(final Integer maxConnections) {
config.setMaxConnections(maxConnections);
return this;
}
/**
* Set the time to live of an inactive connection. After this time of inactivity the connection will be
* closed automatically.
*
* @param connectionTtl the time to live of a connection in milliseconds
* @return {@link ArangoDB.Builder}
*/
public Builder connectionTtl(final Long connectionTtl) {
config.setConnectionTtl(connectionTtl);
return this;
}
/**
* Set the keep-alive interval for VST connections. If set, every VST connection will perform a no-op request
* every {@code keepAliveInterval} seconds, to avoid to be closed due to inactivity by the server (or by the
* external environment, eg. firewall, intermediate routers, operating system).
*
* @param keepAliveInterval interval in seconds
* @return {@link ArangoDB.Builder}
*/
public Builder keepAliveInterval(final Integer keepAliveInterval) {
config.setKeepAliveInterval(keepAliveInterval);
return this;
}
/**
* Whether the driver should acquire a list of available coordinators in an ArangoDB cluster or a single
* server with active failover. In case of Active-Failover deployment set to {@code true} to enable automatic
* master discovery.
*
*
* The host list will be used for failover and load balancing.
*
*
* @param acquireHostList whether automatically acquire a list of available hosts (default: false)
* @return {@link ArangoDB.Builder}
*/
public Builder acquireHostList(final Boolean acquireHostList) {
config.setAcquireHostList(acquireHostList);
return this;
}
/**
* Setting the Interval for acquireHostList
*
* @param acquireHostListInterval Interval in milliseconds
* @return {@link ArangoDB.Builder}
*/
public Builder acquireHostListInterval(final Integer acquireHostListInterval) {
config.setAcquireHostListInterval(acquireHostListInterval);
return this;
}
/**
* Sets the load balancing strategy to be used in an ArangoDB cluster setup. In case of Active-Failover
* deployment set to {@link LoadBalancingStrategy#NONE} or not set at all, since that would be the default.
*
* @param loadBalancingStrategy the load balancing strategy to be used (default:
* {@link LoadBalancingStrategy#NONE}
* @return {@link ArangoDB.Builder}
*/
public Builder loadBalancingStrategy(final LoadBalancingStrategy loadBalancingStrategy) {
config.setLoadBalancingStrategy(loadBalancingStrategy);
return this;
}
/**
* Setting the amount of samples kept for queue time metrics
*
* @param responseQueueTimeSamples amount of samples to keep
* @return {@link ArangoDB.Builder}
*/
public Builder responseQueueTimeSamples(final Integer responseQueueTimeSamples) {
config.setResponseQueueTimeSamples(responseQueueTimeSamples);
return this;
}
/**
* Sets the serde for the user data.
* This is used to serialize and deserialize all the data payload such as:
* - documents, vertexes, edges
* - AQL bind vars
* - body payload of requests and responses in {@link ArangoDB#execute(Request, Class)}
*
* However, note that the following types will always be serialized and deserialized using the internal serde:
* - {@link com.fasterxml.jackson.databind.JsonNode}
* - {@link com.arangodb.util.RawJson}
* - {@link com.arangodb.util.RawBytes}
* - {@link com.arangodb.entity.BaseDocument}
* - {@link com.arangodb.entity.BaseEdgeDocument}
*
* @param serde custom serde for the user data
* @return {@link ArangoDB.Builder}
*/
public Builder serde(final ArangoSerde serde) {
config.setUserDataSerde(serde);
return this;
}
/**
* Sets the serde provider to be used to instantiate the user data serde.
* Ignored if {@link Builder#serde(ArangoSerde)} is used.
*
* @param serdeProviderClass class of the serde provider, it must have a public no-args constructor
* @return {@link ArangoDB.Builder}
*/
public Builder serdeProviderClass(final Class serdeProviderClass) {
config.setUserDataSerdeProvider(serdeProviderClass);
return this;
}
/**
* Sets the downstream async executor that will be used to consume the responses of the async API, that are returned
* as {@link java.util.concurrent.CompletableFuture}
*
* @param executor async downstream executor
* @return {@link ArangoDB.Builder}
* @deprecated for removal. To consume the responses in a custom executor use async CompletableFuture methods.
*/
@Deprecated
public Builder asyncExecutor(final Executor executor) {
config.setAsyncExecutor(executor);
return this;
}
/**
* Sets the {@code content-encoding} and {@code accept-encoding} to use for HTTP requests and the related
* algorithm to encode and decode the transferred data. (default: {@link Compression#NONE})
*
* @param compression format
* @return {@link ArangoDB.Builder}
* @since ArangoDB 3.12
*/
public Builder compression(final Compression compression) {
config.setCompression(compression);
return this;
}
/**
* Sets the minimum HTTP request body size (in bytes) to trigger compression.
* (default: {@code 1024})
*
* @param threshold body size (in bytes)
* @return {@link ArangoDB.Builder}
* @since ArangoDB 3.12
*/
public Builder compressionThreshold(Integer threshold) {
config.setCompressionThreshold(threshold);
return this;
}
/**
* Sets the compression level. (default: {@code 6})
*
* @param level compression level between 0 and 9
* @return {@link ArangoDB.Builder}
* @since ArangoDB 3.12
*/
public Builder compressionLevel(Integer level) {
config.setCompressionLevel(level);
return this;
}
/**
* Configuration specific for {@link com.arangodb.internal.net.ProtocolProvider}.
* @return {@link ArangoDB.Builder}
*/
public Builder protocolConfig(ProtocolConfig protocolConfig) {
config.setProtocolConfig(protocolConfig);
return this;
}
@UnstableApi
protected ProtocolProvider protocolProvider(Protocol protocol) {
ServiceLoader loader = ServiceLoader.load(ProtocolProvider.class);
Iterator iterator = loader.iterator();
while (iterator.hasNext()) {
ProtocolProvider p;
try {
p = iterator.next();
} catch (ServiceConfigurationError e) {
LOG.warn("ServiceLoader failed to load ProtocolProvider", e);
continue;
}
if (p.supportsProtocol(protocol)) {
return p;
}
LOG.debug("Required protocol ({}) not supported by ProtocolProvider: {}", protocol, p.getClass().getName());
}
throw new ArangoDBException("No ProtocolProvider found for protocol: " + protocol);
}
@UnstableApi
protected HostHandler createHostHandler(@UnstableApi final HostResolver hostResolver) {
final HostHandler hostHandler;
LoadBalancingStrategy loadBalancingStrategy = config.getLoadBalancingStrategy();
if (loadBalancingStrategy != null) {
switch (loadBalancingStrategy) {
case ONE_RANDOM:
hostHandler = new RandomHostHandler(hostResolver, new FallbackHostHandler(hostResolver));
break;
case ROUND_ROBIN:
hostHandler = new RoundRobinHostHandler(hostResolver);
break;
case NONE:
default:
hostHandler = new FallbackHostHandler(hostResolver);
break;
}
} else {
hostHandler = new FallbackHostHandler(hostResolver);
}
LOG.debug("HostHandler is {}", hostHandler.getClass().getSimpleName());
return new DirtyReadHostHandler(hostHandler, new RoundRobinHostHandler(hostResolver));
}
@UnstableApi
protected HostResolver createHostResolver(@UnstableApi final Collection hosts, @UnstableApi final ConnectionFactory connectionFactory) {
Boolean acquireHostList = config.getAcquireHostList();
if (acquireHostList != null && acquireHostList) {
LOG.debug("acquireHostList -> Use ExtendedHostResolver");
return new ExtendedHostResolver(new ArrayList<>(hosts), config, connectionFactory,
config.getAcquireHostListInterval());
} else {
LOG.debug("Use SimpleHostResolver");
return new SimpleHostResolver(new ArrayList<>(hosts));
}
}
@UnstableApi
protected Collection createHostList(@UnstableApi final ConnectionFactory connectionFactory) {
final Collection hostList = new ArrayList<>();
for (final HostDescription host : config.getHosts()) {
hostList.add(HostUtils.createHost(host, config, connectionFactory));
}
return hostList;
}
}
}