| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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. |
| */ |
| package org.apache.tinkerpop.gremlin.driver; |
| |
| import org.apache.tinkerpop.gremlin.driver.message.ResponseMessage; |
| import org.apache.tinkerpop.gremlin.process.traversal.TraversalSource; |
| import org.apache.tinkerpop.gremlin.structure.Graph; |
| |
| /** |
| * String constants used in gremlin-driver and gremlin-server. |
| * |
| * @author Stephen Mallette (http://stephen.genoprime.com) |
| */ |
| public final class Tokens { |
| private Tokens() {} |
| |
| public static final String OPS_AUTHENTICATION = "authentication"; |
| public static final String OPS_BYTECODE = "bytecode"; |
| public static final String OPS_EVAL = "eval"; |
| public static final String OPS_INVALID = "invalid"; |
| public static final String OPS_CLOSE = "close"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String OPS_GATHER = "gather"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String OPS_KEYS = "keys"; |
| |
| /** |
| * The key for the unique identifier of the request. |
| */ |
| public static final String REQUEST_ID = "requestId"; |
| |
| /** |
| * Argument name that allows definition of the number of iterations each {@link ResponseMessage} should contain - |
| * overrides the @{code resultIterationBatchSize} server setting. |
| */ |
| public static final String ARGS_BATCH_SIZE = "batchSize"; |
| |
| /** |
| * Argument name that allows to provide a map of key/value pairs to apply as variables in the context of |
| * the Gremlin request sent to the server. |
| */ |
| public static final String ARGS_BINDINGS = "bindings"; |
| |
| /** |
| * Argument name that allows definition of alias names for {@link Graph} and {@link TraversalSource} objects on |
| * the remote system. |
| */ |
| public static final String ARGS_ALIASES = "aliases"; |
| public static final String ARGS_FORCE = "force"; |
| |
| /** |
| * Argument name that corresponds to the Gremlin to evaluate. |
| */ |
| public static final String ARGS_GREMLIN = "gremlin"; |
| |
| /** |
| * Argument name that allows definition of the flavor of Gremlin used (e.g. gremlin-groovy) to process the request. |
| */ |
| public static final String ARGS_LANGUAGE = "language"; |
| |
| /** |
| * @deprecated As of release 3.3.9, replaced by {@link #ARGS_EVAL_TIMEOUT}. |
| */ |
| @Deprecated |
| public static final String ARGS_SCRIPT_EVAL_TIMEOUT = "scriptEvaluationTimeout"; |
| |
| /** |
| * Argument name that allows the override of the server setting that determines the maximum time to wait for a |
| * request to execute on the server. |
| */ |
| public static final String ARGS_EVAL_TIMEOUT = "evaluationTimeout"; |
| public static final String ARGS_HOST = "host"; |
| public static final String ARGS_SESSION = "session"; |
| public static final String ARGS_MANAGE_TRANSACTION = "manageTransaction"; |
| public static final String ARGS_SASL = "sasl"; |
| public static final String ARGS_SASL_MECHANISM = "saslMechanism"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String ARGS_SIDE_EFFECT = "sideEffect"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String ARGS_AGGREGATE_TO = "aggregateTo"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String ARGS_SIDE_EFFECT_KEY = "sideEffectKey"; |
| |
| /** |
| * A value that is a custom string that the user can pass to a server that might accept it for purpose of |
| * identifying the kind of client it came from. |
| */ |
| public static final String ARGS_USER_AGENT = "userAgent"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String VAL_AGGREGATE_TO_BULKSET = "bulkset"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String VAL_AGGREGATE_TO_LIST = "list"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String VAL_AGGREGATE_TO_MAP = "map"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String VAL_AGGREGATE_TO_NONE = "none"; |
| |
| /** |
| * @deprecated As of release 3.3.8, not directly replaced in the protocol as side-effect retrieval after |
| * traversal iteration is not being promoted anymore as a feature. |
| */ |
| @Deprecated |
| public static final String VAL_AGGREGATE_TO_SET = "set"; |
| |
| public static final String VAL_TRAVERSAL_SOURCE_ALIAS = "g"; |
| |
| public static final String STATUS_ATTRIBUTE_EXCEPTIONS = "exceptions"; |
| public static final String STATUS_ATTRIBUTE_STACK_TRACE = "stackTrace"; |
| /** |
| * A {@link ResultSet#statusAttributes()} key for user-facing warnings. |
| * <p> |
| * Implementations that set this key should consider using one of |
| * these two recommended value types: |
| * <ul> |
| * <li>A {@link java.util.List} implementation containing |
| * references for which {@link String#valueOf(Object)} produces |
| * a meaningful return value. For example, a list of strings.</li> |
| * <li>Otherwise, any single non-list object for which |
| * {@link String#valueOf(Object)} produces a meaningful return value. |
| * For example, a string.</li> |
| * </ul> |
| */ |
| public static final String STATUS_ATTRIBUTE_WARNINGS = "warnings"; |
| } |