Class InstancePath
- java.lang.Object
-
- org.gcube.informationsystem.resourceregistry.api.rest.InstancePath
-
public class InstancePath extends Object
The Class InstancePath.- Author:
- Luca Frosini (ISTI - CNR)
-
-
Field Summary
Fields Modifier and Type Field Description static StringBYPASS_HIERARCHY_CHECK_QUERY_PARAMETERWhentrueon Add to Context, waives destination containment so that IS-Manager, Infrastructure-Manager and IS-Admin can target any live Context instead of only the token Context subtree and its siblings.static StringBYPASS_HIERARCHY_CHECK_QUERY_PARAMETER_DEFAULT_VALUEDefault value for theBYPASS_HIERARCHY_CHECK_QUERY_PARAMETERquery parameter ("false").static StringCONTEXTS_PATH_PARTThe path part used for instance Context membership sub-resources.static StringCONTEXTS_POLICY_QUERY_PARAMETERCanonical query parameter controlling wherecontextsmembership maps appear.static StringCONTEXTS_POLICY_QUERY_PARAMETER_DEFAULT_VALUEDefault value for theCONTEXTS_POLICY_QUERY_PARAMETERquery parameter.static StringDRY_RUN_QUERY_PARAMETERWhentrue, the operation is simulated and not persisted to the database.static StringDRY_RUN_QUERY_PARAMETER_DEFAULT_VALUEDefault value for theDRY_RUN_QUERY_PARAMETERquery parameter ("false").static StringHIERARCHICAL_MODE_QUERY_PARAMETERThe Constant HIERARCHICAL_MODE_QUERY_PARAMETER.static StringHIERARCHICAL_MODE_QUERY_PARAMETER_DEFAULT_VALUEDefault value for theHIERARCHICAL_MODE_QUERY_PARAMETERquery parameter ("false").static StringINSTANCES_PATH_PARTThe Constant INSTANCES_PATH_PART.static StringLIMIT_QUERY_PARAMETERThe Constant LIMIT_QUERY_PARAMETER.static intLIMIT_QUERY_PARAMETER_DEFAULT_VALUEDefault value for theLIMIT_QUERY_PARAMETERquery parameter (10).static StringMEMBERSHIP_SCOPE_QUERY_PARAMETERCanonical query parameter selecting the Context boundary ofcontextsmembership maps.static StringMEMBERSHIP_SCOPE_QUERY_PARAMETER_DEFAULT_VALUEDefault value for theMEMBERSHIP_SCOPE_QUERY_PARAMETERquery parameter.static StringMETADATA_POLICY_QUERY_PARAMETERCanonical query parameter controlling metadata inclusion strategy.static StringMETADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUEDefault value for theMETADATA_POLICY_QUERY_PARAMETERquery parameter.static StringOFFSET_QUERY_PARAMETERThe Constant OFFSET_QUERY_PARAMETER.static intOFFSET_QUERY_PARAMETER_DEFAULT_VALUEDefault value for theOFFSET_QUERY_PARAMETERquery parameter (0).static StringPOLYMORPHIC_QUERY_PARAMETERThe Constant POLYMORPHIC_QUERY_PARAMETER.static StringPOLYMORPHIC_QUERY_PARAMETER_DEFAULT_VALUEDefault value for thePOLYMORPHIC_QUERY_PARAMETERquery parameter ("true").static StringPROPAGATION_MODE_QUERY_PARAMETERControls how the avalanche effect propagates when adding an instance to a Context.static StringPROPAGATION_MODE_QUERY_PARAMETER_DEFAULT_VALUEDefault value for thePROPAGATION_MODE_QUERY_PARAMETERquery parameter (derived fromPropagationMode.DEFAULT).static StringSYNC_EXISTING_HIERARCHY_QUERY_PARAMETERWhentrueon aPUT /instances/{type}/{uuid}call, the service synchronises the instance's context membership across the existing hierarchy rather than treating the call as a simple create-or-replace.static StringSYNC_EXISTING_HIERARCHY_QUERY_PARAMETER_DEFAULT_VALUEDefault value for theSYNC_EXISTING_HIERARCHY_QUERY_PARAMETERquery parameter ("false").
-
Constructor Summary
Constructors Constructor Description InstancePath()
-
-
-
Field Detail
-
INSTANCES_PATH_PART
public static final String INSTANCES_PATH_PART
The Constant INSTANCES_PATH_PART.- See Also:
- Constant Field Values
-
CONTEXTS_PATH_PART
public static final String CONTEXTS_PATH_PART
The path part used for instance Context membership sub-resources.- 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
-
LIMIT_QUERY_PARAMETER_DEFAULT_VALUE
public static final int LIMIT_QUERY_PARAMETER_DEFAULT_VALUE
Default value for theLIMIT_QUERY_PARAMETERquery parameter (10).- 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
-
OFFSET_QUERY_PARAMETER_DEFAULT_VALUE
public static final int OFFSET_QUERY_PARAMETER_DEFAULT_VALUE
Default value for theOFFSET_QUERY_PARAMETERquery parameter (0).- 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
-
POLYMORPHIC_QUERY_PARAMETER_DEFAULT_VALUE
public static final String POLYMORPHIC_QUERY_PARAMETER_DEFAULT_VALUE
Default value for thePOLYMORPHIC_QUERY_PARAMETERquery parameter ("true").- 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
-
HIERARCHICAL_MODE_QUERY_PARAMETER_DEFAULT_VALUE
public static final String HIERARCHICAL_MODE_QUERY_PARAMETER_DEFAULT_VALUE
Default value for theHIERARCHICAL_MODE_QUERY_PARAMETERquery parameter ("false").- See Also:
- Constant Field Values
-
METADATA_POLICY_QUERY_PARAMETER
public static final String METADATA_POLICY_QUERY_PARAMETER
Canonical query parameter controlling metadata inclusion strategy. Accepted values are derived fromMetadataPolicy.- See Also:
- Constant Field Values
-
METADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
public static final String METADATA_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
Default value for theMETADATA_POLICY_QUERY_PARAMETERquery parameter.- See Also:
- Constant Field Values
-
CONTEXTS_POLICY_QUERY_PARAMETER
public static final String CONTEXTS_POLICY_QUERY_PARAMETER
Canonical query parameter controlling wherecontextsmembership maps appear. Accepted values are derived fromContextsPolicy.- See Also:
- Constant Field Values
-
CONTEXTS_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
public static final String CONTEXTS_POLICY_QUERY_PARAMETER_DEFAULT_VALUE
Default value for theCONTEXTS_POLICY_QUERY_PARAMETERquery parameter.- See Also:
- Constant Field Values
-
MEMBERSHIP_SCOPE_QUERY_PARAMETER
public static final String MEMBERSHIP_SCOPE_QUERY_PARAMETER
Canonical query parameter selecting the Context boundary ofcontextsmembership maps. Accepted values are derived fromMembershipScope.- See Also:
- Constant Field Values
-
MEMBERSHIP_SCOPE_QUERY_PARAMETER_DEFAULT_VALUE
public static final String MEMBERSHIP_SCOPE_QUERY_PARAMETER_DEFAULT_VALUE
Default value for theMEMBERSHIP_SCOPE_QUERY_PARAMETERquery parameter.- See Also:
- Constant Field Values
-
PROPAGATION_MODE_QUERY_PARAMETER
public static final String PROPAGATION_MODE_QUERY_PARAMETER
Controls how the avalanche effect propagates when adding an instance to a Context. Accepted values:surgical(restricted to IS-Manager, Infrastructure-Manager and IS-Admin),shallow(default),deep.- See Also:
- Constant Field Values
-
PROPAGATION_MODE_QUERY_PARAMETER_DEFAULT_VALUE
public static final String PROPAGATION_MODE_QUERY_PARAMETER_DEFAULT_VALUE
Default value for thePROPAGATION_MODE_QUERY_PARAMETERquery parameter (derived fromPropagationMode.DEFAULT).- See Also:
- Constant Field Values
-
BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER
public static final String BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER
Whentrueon Add to Context, waives destination containment so that IS-Manager, Infrastructure-Manager and IS-Admin can target any live Context instead of only the token Context subtree and its siblings. It never changes the source lookup.- See Also:
- Constant Field Values
-
BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER_DEFAULT_VALUE
public static final String BYPASS_HIERARCHY_CHECK_QUERY_PARAMETER_DEFAULT_VALUE
Default value for theBYPASS_HIERARCHY_CHECK_QUERY_PARAMETERquery parameter ("false").- See Also:
- Constant Field Values
-
SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER
public static final String SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER
Whentrueon aPUT /instances/{type}/{uuid}call, the service synchronises the instance's context membership across the existing hierarchy rather than treating the call as a simple create-or-replace. Mutually exclusive withHIERARCHICAL_MODE_QUERY_PARAMETER.- See Also:
- Constant Field Values
-
SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER_DEFAULT_VALUE
public static final String SYNC_EXISTING_HIERARCHY_QUERY_PARAMETER_DEFAULT_VALUE
Default value for theSYNC_EXISTING_HIERARCHY_QUERY_PARAMETERquery parameter ("false").- See Also:
- Constant Field Values
-
DRY_RUN_QUERY_PARAMETER
public static final String DRY_RUN_QUERY_PARAMETER
Whentrue, the operation is simulated and not persisted to the database.- See Also:
- Constant Field Values
-
DRY_RUN_QUERY_PARAMETER_DEFAULT_VALUE
public static final String DRY_RUN_QUERY_PARAMETER_DEFAULT_VALUE
Default value for theDRY_RUN_QUERY_PARAMETERquery parameter ("false").- See Also:
- Constant Field Values
-
-