Class ContextPath
- java.lang.Object
-
- org.gcube.informationsystem.resourceregistry.api.rest.ContextPath
-
public class ContextPath extends Object
The Class ContextPath.- Author:
- Luca Frosini (ISTI - CNR)
-
-
Field Summary
Fields Modifier and Type Field Description static StringCONTEXTS_PATH_PARTThe Constant CONTEXTS_PATH_PART.static StringCURRENT_PATH_PARTThe literal path segment used to request the context associated with the caller's current authorization token.static StringDEPTH_QUERY_PARAMETERQuery parameter controlling the depth of the returned context hierarchy tree.static StringDEPTH_QUERY_PARAMETER_DEFAULT_READ_VALUEDefault value for theDEPTH_QUERY_PARAMETERquery parameter on Read-style endpoints ("0").static intDEPTH_ROOT_ONLYThe constant representing root/current level only depth expansion (0).static intDEPTH_UNLIMITEDThe constant representing unlimited depth hierarchy expansion (-1).static StringHISTORY_PATH_PARTThe literal path segment used to request the context's history/audit trail.static StringLIFECYCLE_QUERY_PARAMETERQuery parameter selecting which context lifecycle slice is returned by collection reads.static StringLIFECYCLE_QUERY_PARAMETER_DEFAULT_VALUEDefault value forLIFECYCLE_QUERY_PARAMETER.static StringLIMIT_QUERY_PARAMETERThe Constant LIMIT_QUERY_PARAMETER.static StringMETADATA_POLICY_QUERY_PARAMETERThe canonical metadata-policy query parameter.static StringMETADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUEDefault value forMETADATA_POLICY_QUERY_PARAMETER.static StringOFFSET_QUERY_PARAMETERThe Constant OFFSET_QUERY_PARAMETER.
-
Constructor Summary
Constructors Constructor Description ContextPath()
-
-
-
Field Detail
-
CONTEXTS_PATH_PART
public static final String CONTEXTS_PATH_PART
The Constant CONTEXTS_PATH_PART.- See Also:
- Constant Field Values
-
CURRENT_PATH_PART
public static final String 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:
- Constant Field Values
-
HISTORY_PATH_PART
public static final String HISTORY_PATH_PART
The literal path segment used to request the context's history/audit trail.- See Also:
- Constant Field Values
-
DEPTH_QUERY_PARAMETER
public static final String 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:
- Constant Field Values
-
DEPTH_QUERY_PARAMETER_DEFAULT_READ_VALUE
public static final String DEPTH_QUERY_PARAMETER_DEFAULT_READ_VALUE
Default value for theDEPTH_QUERY_PARAMETERquery parameter on Read-style endpoints ("0").- See Also:
- Constant Field Values
-
DEPTH_UNLIMITED
public static final int DEPTH_UNLIMITED
The constant representing unlimited depth hierarchy expansion (-1).- See Also:
- Constant Field Values
-
DEPTH_ROOT_ONLY
public static final int DEPTH_ROOT_ONLY
The constant representing root/current level only depth expansion (0).- 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
-
METADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
public static final String METADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
Default value forMETADATA_POLICY_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
-
LIFECYCLE_QUERY_PARAMETER
public static final String LIFECYCLE_QUERY_PARAMETER
Query parameter selecting which context lifecycle slice is returned by collection reads.- See Also:
- Constant Field Values
-
LIFECYCLE_QUERY_PARAMETER_DEFAULT_VALUE
public static final String LIFECYCLE_QUERY_PARAMETER_DEFAULT_VALUE
Default value forLIFECYCLE_QUERY_PARAMETER.- See Also:
- Constant Field Values
-
-