Class ContextPath
java.lang.Object
org.gcube.informationsystem.resourceregistry.api.rest.ContextPath
The Class ContextPath.
- Author:
- Luca Frosini (ISTI - CNR)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe Constant CONTEXTS_PATH_PART.static final StringThe literal path segment used to request the context associated with the caller's current authorization token.static final StringQuery parameter controlling the depth of the returned context hierarchy tree.static final StringDefault value for theDEPTH_QUERY_PARAMETERquery parameter on Read-style endpoints ("0").static final intThe constant representing root/current level only depth expansion (0).static final intThe constant representing unlimited depth hierarchy expansion (-1).static final StringThe literal path segment used to request the context's history/audit trail.static final StringQuery parameter selecting which context lifecycle slice is returned by collection reads.static final StringDefault value forLIFECYCLE_QUERY_PARAMETER.static final StringThe Constant LIMIT_QUERY_PARAMETER.static final StringThe canonical metadata-policy query parameter.static final StringDefault value forMETADATA_POLICY_QUERY_PARAMETER.static final StringThe Constant OFFSET_QUERY_PARAMETER. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
CONTEXTS_PATH_PART
The Constant CONTEXTS_PATH_PART.- See Also:
-
CURRENT_PATH_PART
The literal path segment used to request the context associated with the caller's current authorization token.Accepted in both raw (
@current) and percent-encoded (%40current) forms; the JAX-RS container decodes the percent encoding before path matching, so no special handling is required.- See Also:
-
HISTORY_PATH_PART
The literal path segment used to request the context's history/audit trail.- See Also:
-
DEPTH_QUERY_PARAMETER
Query parameter controlling the depth of the returned context hierarchy tree.0(default) — returns only the requested context- positive integer
N— returns the context andNlevels of its descendants (ifNexceeds the available descendant depth, the response is naturally bounded by existing data and no warning is emitted) -1— returns the context and all descendants recursively
- See Also:
-
DEPTH_QUERY_PARAMETER_DEFAULT_READ_VALUE
Default value for theDEPTH_QUERY_PARAMETERquery parameter on Read-style endpoints ("0").- See Also:
-
DEPTH_UNLIMITED
public static final int DEPTH_UNLIMITEDThe constant representing unlimited depth hierarchy expansion (-1).- See Also:
-
DEPTH_ROOT_ONLY
public static final int DEPTH_ROOT_ONLYThe constant representing root/current level only depth expansion (0).- See Also:
-
METADATA_POLICY_QUERY_PARAMETER
The canonical metadata-policy query parameter.- See Also:
-
METADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
Default value forMETADATA_POLICY_QUERY_PARAMETER.- See Also:
-
OFFSET_QUERY_PARAMETER
The Constant OFFSET_QUERY_PARAMETER.- See Also:
-
LIMIT_QUERY_PARAMETER
The Constant LIMIT_QUERY_PARAMETER.- See Also:
-
LIFECYCLE_QUERY_PARAMETER
Query parameter selecting which context lifecycle slice is returned by collection reads.- See Also:
-
LIFECYCLE_QUERY_PARAMETER_DEFAULT_VALUE
Default value forLIFECYCLE_QUERY_PARAMETER.- See Also:
-
-
Constructor Details
-
ContextPath
public ContextPath()
-