com.arangodb.ArangoDB Maven / Gradle / Ivy
/*
* 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 java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Properties;
import javax.net.ssl.SSLContext;
import com.arangodb.entity.ArangoDBVersion;
import com.arangodb.entity.LogEntity;
import com.arangodb.entity.LogLevelEntity;
import com.arangodb.entity.Permissions;
import com.arangodb.entity.ServerRole;
import com.arangodb.entity.UserEntity;
import com.arangodb.internal.ArangoDBConstants;
import com.arangodb.internal.ArangoExecutor.ResponseDeserializer;
import com.arangodb.internal.ArangoExecutorSync;
import com.arangodb.internal.CollectionCache;
import com.arangodb.internal.CollectionCache.DBAccess;
import com.arangodb.internal.CommunicationProtocol;
import com.arangodb.internal.DefaultHostHandler;
import com.arangodb.internal.DocumentCache;
import com.arangodb.internal.Host;
import com.arangodb.internal.InternalArangoDB;
import com.arangodb.internal.http.HttpCommunication;
import com.arangodb.internal.http.HttpProtocol;
import com.arangodb.internal.util.ArangoDeserializerImpl;
import com.arangodb.internal.util.ArangoSerializerImpl;
import com.arangodb.internal.util.ArangoUtilImpl;
import com.arangodb.internal.velocypack.VPackDocumentModule;
import com.arangodb.internal.velocypack.VPackDriverModule;
import com.arangodb.internal.velocystream.VstCommunicationSync;
import com.arangodb.internal.velocystream.VstProtocol;
import com.arangodb.internal.velocystream.internal.ConnectionSync;
import com.arangodb.model.LogOptions;
import com.arangodb.model.UserCreateOptions;
import com.arangodb.model.UserUpdateOptions;
import com.arangodb.util.ArangoCursorInitializer;
import com.arangodb.util.ArangoDeserializer;
import com.arangodb.util.ArangoSerialization;
import com.arangodb.util.ArangoSerializer;
import com.arangodb.velocypack.VPack;
import com.arangodb.velocypack.VPackAnnotationFieldFilter;
import com.arangodb.velocypack.VPackAnnotationFieldNaming;
import com.arangodb.velocypack.VPackDeserializer;
import com.arangodb.velocypack.VPackInstanceCreator;
import com.arangodb.velocypack.VPackJsonDeserializer;
import com.arangodb.velocypack.VPackJsonSerializer;
import com.arangodb.velocypack.VPackModule;
import com.arangodb.velocypack.VPackParser;
import com.arangodb.velocypack.VPackParserModule;
import com.arangodb.velocypack.VPackSerializer;
import com.arangodb.velocypack.ValueType;
import com.arangodb.velocypack.exception.VPackException;
import com.arangodb.velocystream.Request;
import com.arangodb.velocystream.Response;
/**
* @author Mark Vollmary
*
*/
public class ArangoDB extends InternalArangoDB {
public static class Builder {
private final List hosts;
private Host host;
private Integer timeout;
private String user;
private String password;
private Boolean useSsl;
private SSLContext sslContext;
private Integer chunksize;
private Integer maxConnections;
private final VPack.Builder vpackBuilder;
private final VPackParser.Builder vpackParserBuilder;
private ArangoSerializer serializer;
private ArangoDeserializer deserializer;
private Protocol protocol;
public Builder() {
super();
vpackBuilder = new VPack.Builder();
vpackParserBuilder = new VPackParser.Builder();
vpackBuilder.registerModule(new VPackDriverModule());
vpackParserBuilder.registerModule(new VPackDriverModule());
host = new Host(ArangoDBConstants.DEFAULT_HOST, ArangoDBConstants.DEFAULT_PORT);
hosts = new ArrayList();
user = ArangoDBConstants.DEFAULT_USER;
loadProperties(ArangoDB.class.getResourceAsStream(DEFAULT_PROPERTY_FILE));
}
public Builder loadProperties(final InputStream in) throws ArangoDBException {
if (in != null) {
final Properties properties = new Properties();
try {
properties.load(in);
loadHosts(properties, this.hosts);
final String host = loadHost(properties, this.host.getHost());
final int port = loadPort(properties, this.host.getPort());
this.host = new Host(host, port);
timeout = loadTimeout(properties, timeout);
user = loadUser(properties, user);
password = loadPassword(properties, password);
useSsl = loadUseSsl(properties, useSsl);
chunksize = loadChunkSize(properties, chunksize);
maxConnections = loadMaxConnections(properties, maxConnections);
protocol = loadProtocol(properties, protocol);
} catch (final IOException e) {
throw new ArangoDBException(e);
}
}
return this;
}
/**
* @deprecated will be removed in version 4.2.0 use {@link #host(String, int)} instead
*
* @param host
* @return
*/
@Deprecated
public Builder host(final String host) {
this.host = new Host(host, this.host.getPort());
return this;
}
/**
* @deprecated will be removed in version 4.2.0 use {@link #host(String, int)} instead
*
* @param port
* @return
*/
@Deprecated
public Builder port(final Integer port) {
host = new Host(host.getHost(), port);
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) {
hosts.add(new Host(host, port));
return this;
}
public Builder timeout(final Integer timeout) {
this.timeout = timeout;
return this;
}
public Builder user(final String user) {
this.user = user;
return this;
}
public Builder password(final String password) {
this.password = password;
return this;
}
public Builder useSsl(final Boolean useSsl) {
this.useSsl = useSsl;
return this;
}
public Builder sslContext(final SSLContext sslContext) {
this.sslContext = sslContext;
return this;
}
public Builder chunksize(final Integer chunksize) {
this.chunksize = chunksize;
return this;
}
public Builder maxConnections(final Integer maxConnections) {
this.maxConnections = maxConnections;
return this;
}
public Builder useProtocol(final Protocol protocol) {
this.protocol = protocol;
return this;
}
public Builder registerSerializer(final Class clazz, final VPackSerializer serializer) {
vpackBuilder.registerSerializer(clazz, serializer);
return this;
}
/**
* Register a special serializer for a member class which can only be identified by its enclosing class.
*
* @param clazz
* type of the enclosing class
* @param serializer
* serializer to register
* @return builder
*/
public Builder registerEnclosingSerializer(final Class clazz, final VPackSerializer serializer) {
vpackBuilder.registerEnclosingSerializer(clazz, serializer);
return this;
}
public Builder registerDeserializer(final Class clazz, final VPackDeserializer deserializer) {
vpackBuilder.registerDeserializer(clazz, deserializer);
return this;
}
public Builder registerInstanceCreator(final Class clazz, final VPackInstanceCreator creator) {
vpackBuilder.registerInstanceCreator(clazz, creator);
return this;
}
public Builder registerJsonDeserializer(final ValueType type, final VPackJsonDeserializer deserializer) {
vpackParserBuilder.registerDeserializer(type, deserializer);
return this;
}
public Builder registerJsonDeserializer(
final String attribute,
final ValueType type,
final VPackJsonDeserializer deserializer) {
vpackParserBuilder.registerDeserializer(attribute, type, deserializer);
return this;
}
public Builder registerJsonSerializer(final Class clazz, final VPackJsonSerializer serializer) {
vpackParserBuilder.registerSerializer(clazz, serializer);
return this;
}
public Builder registerJsonSerializer(
final String attribute,
final Class clazz,
final VPackJsonSerializer serializer) {
vpackParserBuilder.registerSerializer(attribute, clazz, serializer);
return this;
}
public Builder annotationFieldFilter(
final Class type,
final VPackAnnotationFieldFilter fieldFilter) {
vpackBuilder.annotationFieldFilter(type, fieldFilter);
return this;
}
public Builder annotationFieldNaming(
final Class type,
final VPackAnnotationFieldNaming fieldNaming) {
vpackBuilder.annotationFieldNaming(type, fieldNaming);
return this;
}
public Builder registerModule(final VPackModule module) {
vpackBuilder.registerModule(module);
return this;
}
public Builder registerModules(final VPackModule... modules) {
vpackBuilder.registerModules(modules);
return this;
}
public Builder registerJsonModule(final VPackParserModule module) {
vpackParserBuilder.registerModule(module);
return this;
}
public Builder registerJsonModules(final VPackParserModule... module) {
vpackParserBuilder.registerModules(module);
return this;
}
/**
* Replace the built-in serializer with the given serializer.
*
*
* ATTENTION!: Use at your own risk
*
* @param serializer
* custom serializer
* @return builder
*/
public Builder setSerializer(final ArangoSerializer serializer) {
this.serializer = serializer;
return this;
}
/**
* Replace the built-in deserializer with the given deserializer.
*
*
* ATTENTION!: Use at your own risk
*
* @param deserializer
* custom deserializer
* @return builder
*/
public Builder setDeserializer(final ArangoDeserializer deserializer) {
this.deserializer = deserializer;
return this;
}
public synchronized ArangoDB build() {
if (hosts.isEmpty()) {
hosts.add(host);
}
final CollectionCache collectionCache = new CollectionCache();
vpackBuilder.registerModule(new VPackDocumentModule(collectionCache));
vpackParserBuilder.registerModule(new VPackDocumentModule(collectionCache));
final VPack vpacker = vpackBuilder.serializeNullValues(false).build();
final VPack vpackerNull = vpackBuilder.serializeNullValues(true).build();
final VPackParser vpackParser = vpackParserBuilder.build();
final ArangoSerializer serializerTemp = serializer != null ? serializer
: new ArangoSerializerImpl(vpacker, vpackerNull, vpackParser);
final ArangoDeserializer deserializerTemp = deserializer != null ? deserializer
: new ArangoDeserializerImpl(vpackerNull, vpackParser);
return new ArangoDB(
new VstCommunicationSync.Builder(new DefaultHostHandler(new ArrayList(hosts)))
.timeout(timeout).user(user).password(password).useSsl(useSsl).sslContext(sslContext)
.chunksize(chunksize).maxConnections(maxConnections),
new HttpCommunication.Builder(new DefaultHostHandler(new ArrayList(hosts)), protocol)
.timeout(timeout).user(user).password(password).useSsl(useSsl).sslContext(sslContext)
.maxConnections(maxConnections),
new ArangoUtilImpl(serializerTemp, deserializerTemp), collectionCache, protocol);
}
}
private ArangoCursorInitializer cursorInitializer;
public ArangoDB(final VstCommunicationSync.Builder vstBuilder, final HttpCommunication.Builder httpBuilder,
final ArangoSerialization util, final CollectionCache collectionCache, final Protocol protocol) {
super(new ArangoExecutorSync(createProtocol(vstBuilder, httpBuilder, util, collectionCache, protocol), util,
new DocumentCache()), util);
final CommunicationProtocol cp = createProtocol(vstBuilder, httpBuilder, util, collectionCache, protocol);
collectionCache.init(new DBAccess() {
@Override
public ArangoDatabase db(final String name) {
return new ArangoDatabase(cp, util, executor.documentCache(), name)
.setCursorInitializer(cursorInitializer);
}
});
}
private static CommunicationProtocol createProtocol(
final VstCommunicationSync.Builder vstBuilder,
final HttpCommunication.Builder httpBuilder,
final ArangoSerialization util,
final CollectionCache collectionCache,
final Protocol protocol) {
return (protocol == null || Protocol.VST == protocol) ? createVST(vstBuilder, util, collectionCache)
: createHTTP(httpBuilder, util);
}
private static CommunicationProtocol createVST(
final VstCommunicationSync.Builder builder,
final ArangoSerialization util,
final CollectionCache collectionCache) {
return new VstProtocol(builder.build(util, collectionCache));
}
private static CommunicationProtocol createHTTP(
final HttpCommunication.Builder builder,
final ArangoSerialization util) {
return new HttpProtocol(builder.build(util));
}
@Override
protected ArangoExecutorSync executor() {
return executor;
}
public void shutdown() {
executor.disconnect();
}
/**
* Returns a handler of the system database
*
* @return database handler
*/
public ArangoDatabase db() {
return db(ArangoDBConstants.SYSTEM);
}
/**
* Returns a handler of the database by the given name
*
* @param name
* Name of the database
* @return database handler
*/
public ArangoDatabase db(final String name) {
return new ArangoDatabase(this, name).setCursorInitializer(cursorInitializer);
}
/**
* Creates a new database
*
* @see API
* Documentation
* @param name
* Has to contain a valid database name
* @return true if the database was created successfully.
* @throws ArangoDBException
*/
public Boolean createDatabase(final String name) throws ArangoDBException {
return executor.execute(createDatabaseRequest(name), createDatabaseResponseDeserializer());
}
/**
* Retrieves a list of all existing databases
*
* @see API
* Documentation
* @return a list of all existing databases
* @throws ArangoDBException
*/
public Collection getDatabases() throws ArangoDBException {
return executor.execute(getDatabasesRequest(db().name()), getDatabaseResponseDeserializer());
}
/**
* Retrieves a list of all databases the current user can access
*
* @see API
* Documentation
* @return a list of all databases the current user can access
* @throws ArangoDBException
*/
public Collection getAccessibleDatabases() throws ArangoDBException {
return db().getAccessibleDatabases();
}
/**
* List available database to the specified user
*
* @see API
* Documentation
* @param user
* The name of the user for which you want to query the databases
* @return
* @throws ArangoDBException
*/
public Collection getAccessibleDatabasesFor(final String user) throws ArangoDBException {
return executor.execute(getAccessibleDatabasesForRequest(db().name(), user),
getAccessibleDatabasesForResponseDeserializer());
}
/**
* Returns the server name and version number.
*
* @see API
* Documentation
* @return the server version, number
* @throws ArangoDBException
*/
public ArangoDBVersion getVersion() throws ArangoDBException {
return db().getVersion();
}
/**
* Returns the server role.
*
* @return the server role
* @throws ArangoDBException
*/
public ServerRole getRole() throws ArangoDBException {
return executor.execute(getRoleRequest(), getRoleResponseDeserializer());
}
/**
* 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.
*
* @see API Documentation
* @param user
* The name of the user
* @param passwd
* The user password
* @return information about the user
* @throws ArangoDBException
*/
public UserEntity createUser(final String user, final String passwd) throws ArangoDBException {
return executor.execute(createUserRequest(db().name(), user, passwd, new UserCreateOptions()),
UserEntity.class);
}
/**
* 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.
*
* @see API Documentation
* @param user
* The name of the user
* @param passwd
* The user password
* @param options
* Additional options, can be null
* @return information about the user
* @throws ArangoDBException
*/
public UserEntity createUser(final String user, final String passwd, final UserCreateOptions options)
throws ArangoDBException {
return executor.execute(createUserRequest(db().name(), user, passwd, options), UserEntity.class);
}
/**
* Removes an existing user, identified by user. You need access to the _system database.
*
* @see API Documentation
* @param user
* The name of the user
* @throws ArangoDBException
*/
public void deleteUser(final String user) throws ArangoDBException {
executor.execute(deleteUserRequest(db().name(), user), Void.class);
}
/**
* 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.
*
* @see API Documentation
* @param user
* The name of the user
* @return information about the user
* @throws ArangoDBException
*/
public UserEntity getUser(final String user) throws ArangoDBException {
return executor.execute(getUserRequest(db().name(), user), UserEntity.class);
}
/**
* Fetches data about all users. You can only execute this call if you have access to the _system database.
*
* @see API
* Documentation
* @return informations about all users
* @throws ArangoDBException
*/
public Collection getUsers() throws ArangoDBException {
return executor.execute(getUsersRequest(db().name()), getUsersResponseDeserializer());
}
/**
* 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.
*
* @see API Documentation
* @param user
* The name of the user
* @param options
* Properties of the user to be changed
* @return information about the user
* @throws ArangoDBException
*/
public UserEntity updateUser(final String user, final UserUpdateOptions options) throws ArangoDBException {
return executor.execute(updateUserRequest(db().name(), user, options), UserEntity.class);
}
/**
* 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.
*
* @see API
* Documentation
* @param user
* The name of the user
* @param options
* Additional properties of the user, can be null
* @return information about the user
* @throws ArangoDBException
*/
public UserEntity replaceUser(final String user, final UserUpdateOptions options) throws ArangoDBException {
return executor.execute(replaceUserRequest(db().name(), user, options), UserEntity.class);
}
/**
* @deprecated use {@link #grantDefaultDatabaseAccess(String, Permissions)} instead
*
* @param user
* The name of the user
* @param permissions
* The permissions the user grant
* @since ArangoDB 3.2.0
* @throws ArangoDBException
*/
@Deprecated
public void updateUserDefaultDatabaseAccess(final String user, final Permissions permissions)
throws ArangoDBException {
executor.execute(updateUserDefaultDatabaseAccessRequest(user, permissions), Void.class);
}
/**
* Sets the default access level for databases for the user 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
* @since ArangoDB 3.2.0
* @throws ArangoDBException
*/
public void grantDefaultDatabaseAccess(final String user, final Permissions permissions) throws ArangoDBException {
executor.execute(updateUserDefaultDatabaseAccessRequest(user, permissions), Void.class);
}
/**
* @deprecated user {@link #grantDefaultCollectionAccess(String, Permissions)} instead
*
* @param user
* The name of the user
* @param permissions
* The permissions the user grant
* @since ArangoDB 3.2.0
* @throws ArangoDBException
*/
@Deprecated
public void updateUserDefaultCollectionAccess(final String user, final Permissions permissions)
throws ArangoDBException {
executor.execute(updateUserDefaultCollectionAccessRequest(user, permissions), Void.class);
}
/**
* Sets the default access level for collections for the user 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
* @since ArangoDB 3.2.0
* @throws ArangoDBException
*/
public void grantDefaultCollectionAccess(final String user, final Permissions permissions)
throws ArangoDBException {
executor.execute(updateUserDefaultCollectionAccessRequest(user, permissions), Void.class);
}
/**
* Generic Execute. Use this method to execute custom FOXX services.
*
* @param request
* VelocyStream request
* @return VelocyStream response
* @throws ArangoDBException
*/
public Response execute(final Request request) throws ArangoDBException {
return executor.execute(request, new ResponseDeserializer() {
@Override
public Response deserialize(final Response response) throws VPackException {
return response;
}
});
}
/**
* Returns fatal, error, warning or info log messages from the server's global log.
*
* @see API
* Documentation
* @param options
* Additional options, can be null
* @return the log messages
* @throws ArangoDBException
*/
public LogEntity getLogs(final LogOptions options) throws ArangoDBException {
return executor.execute(getLogsRequest(options), LogEntity.class);
}
/**
* Returns the server's current loglevel settings.
*
* @return the server's current loglevel settings
* @throws ArangoDBException
*/
public LogLevelEntity getLogLevel() throws ArangoDBException {
return executor.execute(getLogLevelRequest(), LogLevelEntity.class);
}
/**
* Modifies and returns the server's current loglevel settings.
*
* @param entity
* loglevel settings
* @return the server's current loglevel settings
* @throws ArangoDBException
*/
public LogLevelEntity setLogLevel(final LogLevelEntity entity) throws ArangoDBException {
return executor.execute(setLogLevelRequest(entity), LogLevelEntity.class);
}
public ArangoDB _setCursorInitializer(final ArangoCursorInitializer cursorInitializer) {
this.cursorInitializer = cursorInitializer;
return this;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy