You can buy this project and download/modify it how often you want.
/* * 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.internal; import com.arangodb.entity.*; import com.arangodb.entity.arangosearch.AnalyzerEntity; import com.arangodb.internal.ArangoExecutor.ResponseDeserializer; import com.arangodb.internal.util.ArangoSerializationFactory; import com.arangodb.internal.util.ArangoSerializationFactory.Serializer; import com.arangodb.internal.util.RequestUtils; import com.arangodb.model.*; import com.arangodb.model.arangosearch.AnalyzerDeleteOptions; import com.arangodb.model.arangosearch.ArangoSearchCreateOptions; import com.arangodb.model.arangosearch.ArangoSearchOptionsBuilder; import com.arangodb.util.ArangoSerializer; import com.arangodb.velocypack.Type; import com.arangodb.velocypack.VPackSlice; import com.arangodb.velocypack.exception.VPackException; import com.arangodb.velocystream.Request; import com.arangodb.velocystream.RequestType; import java.util.ArrayList; import java.util.Collection; import java.util.Iterator; import java.util.Map; /** * @author Mark Vollmary * @author Michele Rastelli */ public abstract class InternalArangoDatabase, EXECUTOR extends ArangoExecutor> extends ArangoExecuteable { protected static final String PATH_API_DATABASE = "/_api/database"; private static final String PATH_API_VERSION = "/_api/version"; private static final String PATH_API_ENGINE = "/_api/engine"; private static final String PATH_API_CURSOR = "/_api/cursor"; private static final String PATH_API_TRANSACTION = "/_api/transaction"; private static final String PATH_API_BEGIN_STREAM_TRANSACTION = "/_api/transaction/begin"; private static final String PATH_API_AQLFUNCTION = "/_api/aqlfunction"; private static final String PATH_API_EXPLAIN = "/_api/explain"; private static final String PATH_API_QUERY = "/_api/query"; private static final String PATH_API_QUERY_CACHE = "/_api/query-cache"; private static final String PATH_API_QUERY_CACHE_PROPERTIES = "/_api/query-cache/properties"; private static final String PATH_API_QUERY_PROPERTIES = "/_api/query/properties"; private static final String PATH_API_QUERY_CURRENT = "/_api/query/current"; private static final String PATH_API_QUERY_SLOW = "/_api/query/slow"; private static final String PATH_API_TRAVERSAL = "/_api/traversal"; private static final String PATH_API_ADMIN_ROUTING_RELOAD = "/_admin/routing/reload"; private static final String PATH_API_USER = "/_api/user"; private static final String TRANSACTION_ID = "x-arango-trx-id"; private final String name; private final A arango; protected InternalArangoDatabase(final A arango, final String name) { super(arango.executor, arango.util, arango.context); this.arango = arango; this.name = name; } public A arango() { return arango; } public String name() { return name; } protected ResponseDeserializer> getDatabaseResponseDeserializer() { return arango.getDatabaseResponseDeserializer(); } protected Request getAccessibleDatabasesRequest() { return request(name, RequestType.GET, PATH_API_DATABASE, "user"); } protected Request getVersionRequest() { return request(name, RequestType.GET, PATH_API_VERSION); } protected Request getEngineRequest() { return request(name, RequestType.GET, PATH_API_ENGINE); } protected Request createCollectionRequest(final String name, final CollectionCreateOptions options) { VPackSlice body = util() .serialize(OptionsBuilder.build(options != null ? options : new CollectionCreateOptions(), name)); return request(name(), RequestType.POST, InternalArangoCollection.PATH_API_COLLECTION).setBody(body); } protected Request getCollectionsRequest(final CollectionsReadOptions options) { final Request request; request = request(name(), RequestType.GET, InternalArangoCollection.PATH_API_COLLECTION); final CollectionsReadOptions params = (options != null ? options : new CollectionsReadOptions()); request.putQueryParam("excludeSystem", params.getExcludeSystem()); return request; } protected ResponseDeserializer> getCollectionsResponseDeserializer() { return response -> { final VPackSlice result = response.getBody().get(ArangoResponseField.RESULT); return util().deserialize(result, new Type>() { }.getType()); }; } protected Request dropRequest() { return request(ArangoRequestParam.SYSTEM, RequestType.DELETE, PATH_API_DATABASE, name); } protected ResponseDeserializer createDropResponseDeserializer() { return response -> response.getBody().get(ArangoResponseField.RESULT).getAsBoolean(); } protected Request grantAccessRequest(final String user, final Permissions permissions) { return request(ArangoRequestParam.SYSTEM, RequestType.PUT, PATH_API_USER, user, ArangoRequestParam.DATABASE, name).setBody(util().serialize(OptionsBuilder.build(new UserAccessOptions(), permissions))); } protected Request resetAccessRequest(final String user) { return request(ArangoRequestParam.SYSTEM, RequestType.DELETE, PATH_API_USER, user, ArangoRequestParam.DATABASE, name); } protected Request updateUserDefaultCollectionAccessRequest(final String user, final Permissions permissions) { return request(ArangoRequestParam.SYSTEM, RequestType.PUT, PATH_API_USER, user, ArangoRequestParam.DATABASE, name, "*").setBody(util().serialize(OptionsBuilder.build(new UserAccessOptions(), permissions))); } protected Request getPermissionsRequest(final String user) { return request(ArangoRequestParam.SYSTEM, RequestType.GET, PATH_API_USER, user, ArangoRequestParam.DATABASE, name); } protected ResponseDeserializer getPermissionsResponseDeserialzer() { return response -> { final VPackSlice body = response.getBody(); if (body != null) { final VPackSlice result = body.get(ArangoResponseField.RESULT); if (!result.isNone()) { return util().deserialize(result, Permissions.class); } } return null; }; } protected Request queryRequest( final String query, final Map bindVars, final AqlQueryOptions options) { final AqlQueryOptions opt = options != null ? options : new AqlQueryOptions(); final Request request = request(name, RequestType.POST, PATH_API_CURSOR) .setBody(util().serialize(OptionsBuilder .build(opt, query, bindVars != null ? util(ArangoSerializationFactory.Serializer.CUSTOM).serialize(bindVars, new ArangoSerializer.Options().serializeNullValues(true)) : null))); if (opt.getAllowDirtyRead() == Boolean.TRUE) { RequestUtils.allowDirtyRead(request); } request.putHeaderParam(TRANSACTION_ID, opt.getStreamTransactionId()); return request; } protected Request queryNextRequest(final String id, final AqlQueryOptions options, Map meta) { final Request request = request(name, RequestType.PUT, PATH_API_CURSOR, id); if (meta != null) { request.getHeaderParam().putAll(meta); } final AqlQueryOptions opt = options != null ? options : new AqlQueryOptions(); if (opt.getAllowDirtyRead() == Boolean.TRUE) { RequestUtils.allowDirtyRead(request); } request.putHeaderParam(TRANSACTION_ID, opt.getStreamTransactionId()); return request; } protected Request queryCloseRequest(final String id, final AqlQueryOptions options, Map meta) { final Request request = request(name, RequestType.DELETE, PATH_API_CURSOR, id); if (meta != null) { request.getHeaderParam().putAll(meta); } final AqlQueryOptions opt = options != null ? options : new AqlQueryOptions(); if (opt.getAllowDirtyRead() == Boolean.TRUE) { RequestUtils.allowDirtyRead(request); } request.putHeaderParam(TRANSACTION_ID, opt.getStreamTransactionId()); return request; } protected Request explainQueryRequest( final String query, final Map bindVars, final AqlQueryExplainOptions options ) { final AqlQueryExplainOptions opt = options != null ? options : new AqlQueryExplainOptions(); return request(name, RequestType.POST, PATH_API_EXPLAIN) .setBody(util().serialize(OptionsBuilder.build( opt, query, bindVars != null ? util(ArangoSerializationFactory.Serializer.CUSTOM).serialize( bindVars, new ArangoSerializer.Options().serializeNullValues(true)) : null))); } protected Request parseQueryRequest(final String query) { return request(name, RequestType.POST, PATH_API_QUERY) .setBody(util().serialize(OptionsBuilder.build(new AqlQueryParseOptions(), query))); } protected Request clearQueryCacheRequest() { return request(name, RequestType.DELETE, PATH_API_QUERY_CACHE); } protected Request getQueryCachePropertiesRequest() { return request(name, RequestType.GET, PATH_API_QUERY_CACHE_PROPERTIES); } protected Request setQueryCachePropertiesRequest(final QueryCachePropertiesEntity properties) { return request(name, RequestType.PUT, PATH_API_QUERY_CACHE_PROPERTIES).setBody(util().serialize(properties)); } protected Request getQueryTrackingPropertiesRequest() { return request(name, RequestType.GET, PATH_API_QUERY_PROPERTIES); } protected Request setQueryTrackingPropertiesRequest(final QueryTrackingPropertiesEntity properties) { return request(name, RequestType.PUT, PATH_API_QUERY_PROPERTIES).setBody(util().serialize(properties)); } protected Request getCurrentlyRunningQueriesRequest() { return request(name, RequestType.GET, PATH_API_QUERY_CURRENT); } protected Request getSlowQueriesRequest() { return request(name, RequestType.GET, PATH_API_QUERY_SLOW); } protected Request clearSlowQueriesRequest() { return request(name, RequestType.DELETE, PATH_API_QUERY_SLOW); } protected Request killQueryRequest(final String id) { return request(name, RequestType.DELETE, PATH_API_QUERY, id); } protected Request createAqlFunctionRequest( final String name, final String code, final AqlFunctionCreateOptions options) { return request(name(), RequestType.POST, PATH_API_AQLFUNCTION).setBody(util().serialize( OptionsBuilder.build(options != null ? options : new AqlFunctionCreateOptions(), name, code))); } protected Request deleteAqlFunctionRequest(final String name, final AqlFunctionDeleteOptions options) { final Request request = request(name(), RequestType.DELETE, PATH_API_AQLFUNCTION, name); final AqlFunctionDeleteOptions params = options != null ? options : new AqlFunctionDeleteOptions(); request.putQueryParam("group", params.getGroup()); return request; } protected ResponseDeserializer deleteAqlFunctionResponseDeserializer() { return response -> { // compatibility with ArangoDB < 3.4 // https://www.arangodb.com/docs/stable/release-notes-upgrading-changes34.html Integer count = null; final VPackSlice body = response.getBody(); if (body.isObject()) { final VPackSlice deletedCount = body.get("deletedCount"); if (deletedCount.isInteger()) { count = deletedCount.getAsInt(); } } return count; }; } protected Request getAqlFunctionsRequest(final AqlFunctionGetOptions options) { final Request request = request(name(), RequestType.GET, PATH_API_AQLFUNCTION); final AqlFunctionGetOptions params = options != null ? options : new AqlFunctionGetOptions(); request.putQueryParam("namespace", params.getNamespace()); return request; } protected ResponseDeserializer> getAqlFunctionsResponseDeserializer() { return response -> { final VPackSlice body = response.getBody(); // compatibility with ArangoDB < 3.4 // https://www.arangodb.com/docs/stable/release-notes-upgrading-changes34.html final VPackSlice result = body.isArray() ? body : body.get(ArangoResponseField.RESULT); return util().deserialize(result, new Type>() { }.getType()); }; } protected Request createGraphRequest( final String name, final Collection edgeDefinitions, final GraphCreateOptions options) { return request(name(), RequestType.POST, InternalArangoGraph.PATH_API_GHARIAL).setBody(util().serialize( OptionsBuilder.build(options != null ? options : new GraphCreateOptions(), name, edgeDefinitions))); } protected ResponseDeserializer createGraphResponseDeserializer() { return response -> util().deserialize(response.getBody().get("graph"), GraphEntity.class); } protected Request getGraphsRequest() { return request(name, RequestType.GET, InternalArangoGraph.PATH_API_GHARIAL); } protected ResponseDeserializer> getGraphsResponseDeserializer() { return response -> util().deserialize(response.getBody().get("graphs"), new Type>() { }.getType()); } protected Request transactionRequest(final String action, final TransactionOptions options) { return request(name, RequestType.POST, PATH_API_TRANSACTION).setBody( util().serialize(OptionsBuilder.build(options != null ? options : new TransactionOptions(), action))); } protected ResponseDeserializer transactionResponseDeserializer(final Class type) { return response -> { final VPackSlice body = response.getBody(); if (body != null) { final VPackSlice result = body.get(ArangoResponseField.RESULT); if (!result.isNone() && !result.isNull()) { return util(Serializer.CUSTOM).deserialize(result, type); } } return null; }; } protected Request beginStreamTransactionRequest(final StreamTransactionOptions options) { return request(name, RequestType.POST, PATH_API_BEGIN_STREAM_TRANSACTION) .setBody(util().serialize(options != null ? options : new StreamTransactionOptions())); } protected Request abortStreamTransactionRequest(String id) { return request(name, RequestType.DELETE, PATH_API_TRANSACTION, id); } protected Request getStreamTransactionsRequest() { return request(name, RequestType.GET, PATH_API_TRANSACTION); } protected Request getStreamTransactionRequest(String id) { return request(name, RequestType.GET, PATH_API_TRANSACTION, id); } protected ResponseDeserializer> transactionsResponseDeserializer() { return response -> { final VPackSlice result = response.getBody().get("transactions"); return util().deserialize(result, new Type>() { }.getType()); }; } protected Request commitStreamTransactionRequest(String id) { return request(name, RequestType.PUT, PATH_API_TRANSACTION, id); } protected ResponseDeserializer streamTransactionResponseDeserializer() { return response -> util() .deserialize(response.getBody().get(ArangoResponseField.RESULT), StreamTransactionEntity.class); } protected Request getInfoRequest() { return request(name, RequestType.GET, PATH_API_DATABASE, "current"); } protected ResponseDeserializer getInfoResponseDeserializer() { return response -> util().deserialize(response.getBody().get(ArangoResponseField.RESULT), DatabaseEntity.class); } protected Request executeTraversalRequest(final TraversalOptions options) { return request(name, RequestType.POST, PATH_API_TRAVERSAL) .setBody(util().serialize(options != null ? options : new TransactionOptions())); } protected ResponseDeserializer> executeTraversalResponseDeserializer( final Class vertexClass, final Class edgeClass) { return response -> { final TraversalEntity result = new TraversalEntity<>(); final VPackSlice visited = response.getBody().get(ArangoResponseField.RESULT).get("visited"); result.setVertices(deserializeVertices(vertexClass, visited)); final Collection> paths = new ArrayList<>(); for (final Iterator iterator = visited.get("paths").arrayIterator(); iterator.hasNext(); ) { final PathEntity path = new PathEntity<>(); final VPackSlice next = iterator.next(); path.setEdges(deserializeEdges(edgeClass, next)); path.setVertices(deserializeVertices(vertexClass, next)); paths.add(path); } result.setPaths(paths); return result; }; } protected Collection deserializeVertices(final Class vertexClass, final VPackSlice vpack) throws VPackException { final Collection vertices = new ArrayList<>(); for (final Iterator iterator = vpack.get("vertices").arrayIterator(); iterator.hasNext(); ) { vertices.add(util(Serializer.CUSTOM).deserialize(iterator.next(), vertexClass)); } return vertices; } protected Collection deserializeEdges(final Class edgeClass, final VPackSlice next) throws VPackException { final Collection edges = new ArrayList<>(); for (final Iterator iteratorEdge = next.get("edges").arrayIterator(); iteratorEdge.hasNext(); ) { edges.add(util(Serializer.CUSTOM).deserialize(iteratorEdge.next(), edgeClass)); } return edges; } protected Request reloadRoutingRequest() { return request(name, RequestType.POST, PATH_API_ADMIN_ROUTING_RELOAD); } protected Request getViewsRequest() { return request(name, RequestType.GET, InternalArangoView.PATH_API_VIEW); } protected ResponseDeserializer> getViewsResponseDeserializer() { return response -> { final VPackSlice result = response.getBody().get(ArangoResponseField.RESULT); return util().deserialize(result, new Type>() { }.getType()); }; } protected Request createViewRequest(final String name, final ViewType type) { return request(name(), RequestType.POST, InternalArangoView.PATH_API_VIEW) .setBody(util().serialize(OptionsBuilder.build(new ViewCreateOptions(), name, type))); } protected Request createArangoSearchRequest(final String name, final ArangoSearchCreateOptions options) { return request(name(), RequestType.POST, InternalArangoView.PATH_API_VIEW).setBody(util().serialize( ArangoSearchOptionsBuilder.build(options != null ? options : new ArangoSearchCreateOptions(), name))); } protected Request getAnalyzerRequest(final String name) { return request(name(), RequestType.GET, InternalArangoView.PATH_API_ANALYZER, name); } protected Request getAnalyzersRequest() { return request(name(), RequestType.GET, InternalArangoView.PATH_API_ANALYZER); } protected ResponseDeserializer> getAnalyzersResponseDeserializer() { return response -> { final VPackSlice result = response.getBody().get(ArangoResponseField.RESULT); return util().deserialize(result, new Type>() { }.getType()); }; } protected Request createAnalyzerRequest(final AnalyzerEntity options) { return request(name(), RequestType.POST, InternalArangoView.PATH_API_ANALYZER) .setBody(util().serialize(options)); } protected Request deleteAnalyzerRequest(final String name, final AnalyzerDeleteOptions options) { Request request = request(name(), RequestType.DELETE, InternalArangoView.PATH_API_ANALYZER, name); request.putQueryParam("force", options != null ? options.getForce() : null); return request; } }
