Package org.gcube.informationsystem.resourceregistry.api.rest

Class AccessPath

  • public class AccessPath
extends Object
    The Class AccessPath.
    Author:
    Luca Frosini (ISTI - CNR)

    • Field Detail

      • INSTANCES_PATH_PART

        public static final String INSTANCES_PATH_PART
        The Constant INSTANCES_PATH_PART.
        See Also:
        Constant Field Values

      • QUERY_TEMPLATES_PATH_PART

        public static final String QUERY_TEMPLATES_PATH_PART
        The Constant QUERY_TEMPLATES_PATH_PART.
        See Also:
        Constant Field Values

      • QUERY_PATH_PART

        public static final String QUERY_PATH_PART
        The Constant QUERY_PATH_PART. Used for the JSON query endpoint (POST /access/query) and the prepared query endpoint (GET /access/query/{resource-type}/{relation-type}/{entity-type}).
        See Also:
        Constant Field Values

      • RAW_QUERY_PATH_PART

        public static final String RAW_QUERY_PATH_PART
        The Constant RAW_QUERY_PATH_PART. The literal path segment for the raw backend query diagnostic endpoint. Despite living in this class, it is mounted only under /admin (as QUERY /admin/raw-query, with a POST + X-HTTP-Method-Override: QUERY fallback) by AdminQueryManager; the endpoint is restricted to GLOBAL_PRIVILEGED_ROLES and never exposed through any client library. The former public GET /access/raw-query endpoint that once used this constant has been removed.
        See Also:
        Constant Field Values

      • Q_QUERY_PARAMETER

        public static final String Q_QUERY_PARAMETER
        The Constant Q_QUERY_PARAMETER. Formerly the query-text parameter of the removed GET /access/raw-query endpoint. Its replacement, QUERY /admin/raw-query, carries the query text in a JSON request body (field "query") instead of a query parameter, so this constant is not currently wired to any endpoint.
        See Also:
        Constant Field Values

      • RAW_RESULT_QUERY_PARAMETER

        public static final String RAW_RESULT_QUERY_PARAMETER
        The Constant RAW_RESULT_QUERY_PARAMETER. Controls how the query result is formatted: false (default) — result is converted to the Information System model format; true — result is returned exactly as provided by the OrientDB backend.
        See Also:
        Constant Field Values

      • RAW_RESULT_QUERY_PARAMETER_DEFAULT_VALUE

        public static final String RAW_RESULT_QUERY_PARAMETER_DEFAULT_VALUE
        The Constant RAW_RESULT_QUERY_PARAMETER_DEFAULT_VALUE.
        See Also:
        Constant Field Values

      • POLYMORPHIC_QUERY_PARAMETER

        public static final String POLYMORPHIC_QUERY_PARAMETER
        The Constant POLYMORPHIC_QUERY_PARAMETER.
        See Also:
        Constant Field Values

      • HIERARCHICAL_MODE_QUERY_PARAMETER

        public static final String HIERARCHICAL_MODE_QUERY_PARAMETER
        The Constant HIERARCHICAL_MODE_QUERY_PARAMETER.
        See Also:
        Constant Field Values

      • METADATA_POLICY_QUERY_PARAMETER

        public static final String METADATA_POLICY_QUERY_PARAMETER
        The canonical metadata-policy query parameter.
        See Also:
        Constant Field Values

      • CONTEXTS_POLICY_QUERY_PARAMETER

        public static final String CONTEXTS_POLICY_QUERY_PARAMETER
        The canonical contexts-policy query parameter.
        See Also:
        Constant Field Values

      • MEMBERSHIP_SCOPE_QUERY_PARAMETER

        public static final String MEMBERSHIP_SCOPE_QUERY_PARAMETER
        The canonical membership-scope query parameter.
        See Also:
        Constant Field Values

      • OFFSET_QUERY_PARAMETER

        public static final String OFFSET_QUERY_PARAMETER
        The Constant OFFSET_QUERY_PARAMETER.
        See Also:
        Constant Field Values

      • LIMIT_QUERY_PARAMETER

        public static final String LIMIT_QUERY_PARAMETER
        The Constant LIMIT_QUERY_PARAMETER.
        See Also:
        Constant Field Values

      • _REFERENCE_QUERY_PARAMETER

        public static final String _REFERENCE_QUERY_PARAMETER
        Was intended for a getRelated() navigation endpoint (a query parameter naming the reference/relation type to traverse); the _ prefix avoids a clash with the JSON reference/type field names. No such endpoint or method currently exists in either the server or the client libraries.
        See Also:
        Constant Field Values

      • _POLYMORPHIC_QUERY_PARAMETER

        public static final String _POLYMORPHIC_QUERY_PARAMETER
        Was intended for a getRelated() navigation endpoint (a query parameter selecting polymorphic traversal); the _ prefix avoids a clash with the JSON polymorphic field name. No such endpoint or method currently exists in either the server or the client libraries.
        See Also:
        Constant Field Values

      • _DIRECTION_QUERY_PARAMETER

        public static final String _DIRECTION_QUERY_PARAMETER
        Was intended for a getRelated() navigation endpoint (a query parameter selecting the traversal direction); the _ prefix avoids a clash with the JSON direction field name. No such endpoint or method currently exists in either the server or the client libraries.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AccessPath

        public AccessPath()