Interface SlingPostConstants
SlingPostConstants interface provides constants for well
known parameters of the core SlingPostServlet. Extensions of the servlet
through implementations of the SlingPostOperation interface may
extend this constants.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringName of the request attribute (not parameter) indicating that a post operation should not invoke the commit method on the resource resolver upon completion.static final StringConstant for prefix for sling:chunk node name.static final StringThe suffix to the resource path used to indicate to automatically generate the name of the new item to create during a content creation request (value is "/").static final StringSuffix indicating a default value for a property (value is "@DefaultValue").static final StringPrefix for properties addressing repository items with an absolute path (value is "/").static final StringPrefix for properties addressing repository items with a path relative to the current request item (value is "./").static final StringPrefix for properties addressing repository items with a path relative to the parent of the request item (value is "../").static final intThe default response status sent back by aOPERATION_NOPif theRP_NOP_STATUSparameter is not provided or the parameter value cannot be converted into a valid response status code (value is 200).static final StringConstant for the sling:chunks mixin.static final StringConstant for the sling:chunk node type.static final StringConstant for the sling:offset property.static final StringConstant for the sling:length property.static final StringConstant for the sling:fileLength property.static final StringName of the predefined checkin operation (value is "checkin").static final StringName of the predefined checkout operation (value is "checkout").static final StringName of the predefined copy operation (value is "copy").static final StringName of the predefined delete operation (value is "delete").static final StringName of the predefined import operation (value is "import").static final StringName of the predefined modify operation (value is "modify").static final StringName of the predefined move operation (value is "move")static final StringName of the predefined null operation (value is "nop").static final StringName of the predefined restore operation (value is "restore").static final Stringstatic final Stringstatic final StringPossible value of theRP_ORDERparameter indicating that the node by moved to the first position amongst its siblings (value is "first").static final StringPossible value of theRP_ORDERparameter indicating that the node by moved to the last position amongst its siblings (value is "last").static final charIndicates a value to be added to the named multi-value property if the property is being #patched.static final charIndicates a value to be removed from the named multi-value property if the property is being #patched.static final StringName of the request parameter used to indicate the resource to apply the operation to (value is ":applyTo").static final StringName of the request parameter indicating request operation is applicable to chunks.static final StringName of the request parameter indicating whether versionable nodes should be checked in during anOPERATION_IMPORToperation.static final StringName of the request parameter indicating whether versionable nodes should be checked in during anOPERATION_IMPORToperation.static final StringName of the request parameter containing the content to be imported by the 'import' operation.static final StringName of the request parameter containing the file to be imported by the 'import' operation.static final StringName of the request parameter containing the content type of the content to be imported by the 'import' operation.static final StringName of the request parameter used to indicate the destination for the copy and move operations (value is ":dest").static final StringOptional request parameter: if provided, added at the end of the computed (or supplied) redirect URLstatic final StringOptional request paramter specifying a node name for a newly created node (value is ":name").static final StringOptional request paramter specifying a node name hint for a newly created node (value is ":nameHint").static final StringOptional request parameter to indicate the actual response status to send back as a result of calling the #OPERATION_NOP (value is ":nopstatus").static final StringThe name of the parameter containing the operation to execute (value is ":operation").static final StringOptional request parameter indicating the order of newly created nodes in creation, copy and move operation requests (value is ":order").static final StringPrefix for parameter names which control this POST (RP_ stands for "request param") (value is ":").static final StringOptional request parameter: redirect to the specified URL after POSTstatic final StringName of the request parameter indicating whether the nodes existing outside the versioning graph should be removed.static final StringName of the request parameter indicating whether the destination for a copy or move operation is to be replaced if existing (value is ":replace").static final StringName of the request parameter indicating whether the destination for a property change during an import operation is to be replaced if existing.static final StringOptional request parameter: defines if to enable the error handling also for POST request.static final StringOptional request parameter: define how the response is sent back to the client.static final StringName of the request parameter indicating the name or the label of the resource version.static final StringAn alternative suffix to the resource path used to indicate to automatically generate the name of the new item to create during a content creation request (value is "/*").static final StringThe supported value for theRP_STATUSrequest parameter requesting to not report success or failure of request processing using standard HTTP status codes but instead alwas set the status to 200/OK and only report the real success or failure status in the XHTML response.static final StringThe supported value for theRP_STATUSrequest parameter requesting to report success or failure of request processing using standard HTTP status codes.static final StringName of the request parameter indicating request contains last chunk and as a result upload should be finished.static final StringSuffix indicating that the named item is to be set from an item whose absolute or relative path is given in the parameter's value (value is "@CopyFrom").static final StringSuffix indicating that the named property is to be removed before applying any new content (value is "@Delete").static final StringSuffix indicating that blank value or values for this property will be ignored.static final StringName of the request parameter indicating length of complete file.static final StringSuffix indicating that the named item is to be set from an item whose absolute or relative path is given in the parameter's value (value is "@MoveFrom").static final StringName of the request parameter indicating offset of the chunk in request.static final StringSuffix indicating that a multi-value property is to be handled as an ordered set and the sent values start with either "+" or "-" to indicate wether a value should be added to or removed from the set.static final StringSuffix indicating that the default value should be used when the property is not defined.static final StringSuffix indicating a type hint for the property (value is "@TypeHint").static final StringSLING-130, suffix that maps form field names to different JCR property names
-
Field Details
-
RP_PREFIX
Prefix for parameter names which control this POST (RP_ stands for "request param") (value is ":"). This prefix must be used on all request parameters which have significance to POST request processing. Such parameters will not be used to denote properties to be written to the repository.- See Also:
-
RP_OPERATION
The name of the parameter containing the operation to execute (value is ":operation"). If this parameter is missing or empty, the request is assumed to be a request to create new content or to modify existing content.- See Also:
-
DEFAULT_CREATE_SUFFIX
The suffix to the resource path used to indicate to automatically generate the name of the new item to create during a content creation request (value is "/").- See Also:
-
STAR_CREATE_SUFFIX
An alternative suffix to the resource path used to indicate to automatically generate the name of the new item to create during a content creation request (value is "/*").- See Also:
-
OPERATION_MODIFY
Name of the predefined modify operation (value is "modify").The modify operation uses the remaining request parameters to indicate nodes and properties to create.
The modify operation is actually chosen by the Sling POST Servlet if the request has no
RP_OPERATIONrequest parameter.- Since:
- 2.0.6 (Bundle version 2.0.6)
- See Also:
-
OPERATION_DELETE
Name of the predefined delete operation (value is "delete").The delete operation requires no further request parameters and just deletes the content addressed by the request.
If the
RP_APPLY_TOparameter is set the resources listed in that parameter are deleted instead of the request resource.- See Also:
-
OPERATION_COPY
Name of the predefined copy operation (value is "copy").The copy operation requires the
RP_DESTrequest parameter denoting the path to copy the content to. In addition theRP_ORDERparameter may be defined to specificy to relative node order of the destination node. Finally theRP_REPLACEparameter may be set to indicate whether an existing item at the destination should be replaced or not.If the
RP_APPLY_TOparameter is set the resources listed in that parameter are copied instead of the request resource.- See Also:
-
OPERATION_MOVE
Name of the predefined move operation (value is "move")The move operation requires the
RP_DESTrequest parameter denoting the path to move the content to. In addition theRP_ORDERparameter may be defined to specificy to relative node order of the destination node. Finally theRP_REPLACEparameter may be set to indicate whether an existing item at the destination should be replaced or not.If the
RP_APPLY_TOparameter is set the resources listed in that parameter are moved instead of the request resource.- See Also:
-
OPERATION_NOP
Name of the predefined null operation (value is "nop").The null operation is a pseudo operation, which has no effects whatsoever except setting the response status. The null operation may be accompanied with the
RP_NOP_STATUSparameter to indicate the actual response status to set and theRP_STATUSparameter to indicate how to send the actual response status.- See Also:
-
OPERATION_CHECKIN
Name of the predefined checkin operation (value is "checkin").The checkin operation requires no further request parameters and just checks in the content addressed by the request.
If the
RP_APPLY_TOparameter is set the resources listed in that parameter are checked in instead of the request resource.- See Also:
-
OPERATION_CHECKOUT
Name of the predefined checkout operation (value is "checkout").The checkout operation requires no further request parameters and just checks out the content addressed by the request.
If the
RP_APPLY_TOparameter is set the resources listed in that parameter are checked out instead of the request resource.- See Also:
-
OPERATION_RESTORE
Name of the predefined restore operation (value is "restore").The restore operation requires the
RP_VERSIONrequest parameter denoting the name or the label of the version to be restored.If the
RP_APPLY_TOparameter is set the resources listed in that parameter are restored instead of the request resource. TheRP_REMOVE_EXISTINGparameter may be set to true to force the operation even if there is a collision.- See Also:
-
OPERATION_IMPORT
Name of the predefined import operation (value is "import").The import operation requires either the
RP_CONTENTandRP_CONTENT_TYPErequest parameters or theRP_CONTENT_FILErequest parameter. Finally theRP_REPLACEparameter may be set to indicate whether an existing item at the destination should be overwritten or not.- See Also:
-
RP_APPLY_TO
Name of the request parameter used to indicate the resource to apply the operation to (value is ":applyTo").This property is used by certain opertaions - namely
OPERATION_COPY,OPERATION_DELETEandOPERATION_MOVE- to apply the operation to multiple resources instead of the request resource.- See Also:
-
RP_DEST
Name of the request parameter used to indicate the destination for the copy and move operations (value is ":dest"). This request parameter is required by the copy and move operations.- See Also:
-
RP_REPLACE
Name of the request parameter indicating whether the destination for a copy or move operation is to be replaced if existing (value is ":replace"). Copy or move is only possible if the destination exists if the replace parameter is set to the case-insignificant value true. This request parameter is also used to indicate whether the destination node for an import operation is to be replaced if existing. The parameter value is checked to see if it matches the case-insignificant value true.- See Also:
-
RP_REPLACE_PROPERTIES
Name of the request parameter indicating whether the destination for a property change during an import operation is to be replaced if existing. The parameter value is checked to see if it matches the case-insignificant value true.- See Also:
-
RP_ORDER
Optional request parameter indicating the order of newly created nodes in creation, copy and move operation requests (value is ":order").The value of this parameter may be
ORDER_FIRST,ORDER_BEFORE,ORDER_AFTER,ORDER_LASTor a numberic value indicating the absolute position in the child list of the parent node.- See Also:
-
RP_REMOVE_EXISTING
Name of the request parameter indicating whether the nodes existing outside the versioning graph should be removed. SeeVersionManager#restore()for more info.This request parameter is optional and can be used by the
OPERATION_RESTORE.- See Also:
-
RP_VERSION
Name of the request parameter indicating the name or the label of the resource version. This request parameter is required by theOPERATION_RESTORE.- See Also:
-
ORDER_FIRST
Possible value of theRP_ORDERparameter indicating that the node by moved to the first position amongst its siblings (value is "first").- See Also:
-
ORDER_BEFORE
Possible value of theRP_ORDERparameter indicating that the node by moved immediately before the sibling whose name is contained in theRP_ORDERparameter (value is "before ").- See Also:
-
ORDER_AFTER
Possible value of theRP_ORDERparameter indicating that the node by moved immediately after the sibling whose name is contained in theRP_ORDERparameter (value is "after ").- See Also:
-
ORDER_LAST
Possible value of theRP_ORDERparameter indicating that the node by moved to the last position amongst its siblings (value is "last").- See Also:
-
RP_NODE_NAME
Optional request paramter specifying a node name for a newly created node (value is ":name").- See Also:
-
RP_NODE_NAME_HINT
Optional request paramter specifying a node name hint for a newly created node (value is ":nameHint").- See Also:
-
ITEM_PREFIX_ABSOLUTE
Prefix for properties addressing repository items with an absolute path (value is "/"). -
ITEM_PREFIX_RELATIVE_CURRENT
Prefix for properties addressing repository items with a path relative to the current request item (value is "./").When collecting parameters addressing repository items for modification, the parameters are first scanned to see whether there is a parameter with this relative path prefix. If such a parameter exists, the modification operations only assumes parameters whose name is prefixes with this prefix or the
ITEM_PREFIX_ABSOLUTEor theITEM_PREFIX_RELATIVE_PARENTto be parameters addressing properties to modify. Otherwise, that is if no parameter starts with this prefix, all parameters not starting with thecommand prefixare considered addressing properties to modify.- See Also:
-
ITEM_PREFIX_RELATIVE_PARENT
Prefix for properties addressing repository items with a path relative to the parent of the request item (value is "../"). -
RP_REDIRECT_TO
Optional request parameter: redirect to the specified URL after POST- See Also:
-
RP_STATUS
Optional request parameter: define how the response is sent back to the client. Supported values for this property areSTATUS_VALUE_BROWSERandSTATUS_VALUE_STANDARD. The default is to assumeSTATUS_VALUE_STANDARDif the parameter is not set or set to any other value.- See Also:
-
RP_SEND_ERROR
Optional request parameter: defines if to enable the error handling also for POST request. The parameter value is checked to see if it matches the case-insensitive value true.- Since:
- 2.2.0 (Bundle version 2.3.0)
- See Also:
-
STATUS_VALUE_STANDARD
-
STATUS_VALUE_BROWSER
The supported value for theRP_STATUSrequest parameter requesting to not report success or failure of request processing using standard HTTP status codes but instead alwas set the status to 200/OK and only report the real success or failure status in the XHTML response. -
RP_NOP_STATUS
Optional request parameter to indicate the actual response status to send back as a result of calling the #OPERATION_NOP (value is ":nopstatus").This parameter is expected to be single-valued and by an integer being a valid HTTP status code. If this parameter is missing or the parameter value cannot be converted to a HTTP status code (integer in the range [100..999]), the default status code 200/OK is returned.
- See Also:
-
NOPSTATUS_VALUE_DEFAULT
static final int NOPSTATUS_VALUE_DEFAULTThe default response status sent back by aOPERATION_NOPif theRP_NOP_STATUSparameter is not provided or the parameter value cannot be converted into a valid response status code (value is 200).- See Also:
-
RP_DISPLAY_EXTENSION
Optional request parameter: if provided, added at the end of the computed (or supplied) redirect URL- See Also:
-
VALUE_FROM_SUFFIX
SLING-130, suffix that maps form field names to different JCR property names- See Also:
-
TYPE_HINT_SUFFIX
Suffix indicating a type hint for the property (value is "@TypeHint").- See Also:
-
DEFAULT_VALUE_SUFFIX
Suffix indicating a default value for a property (value is "@DefaultValue").- See Also:
-
SUFFIX_DELETE
Suffix indicating that the named property is to be removed before applying any new content (value is "@Delete").- See Also:
-
SUFFIX_MOVE_FROM
Suffix indicating that the named item is to be set from an item whose absolute or relative path is given in the parameter's value (value is "@MoveFrom").This suffix is similar to the
VALUE_FROM_SUFFIXin that the value for the item is not taken from the request parameter itself but from somewhere else. In this case the value is set by moving another repository item (in the same workspace) to the location addressed by the parameter.- See Also:
-
SUFFIX_COPY_FROM
Suffix indicating that the named item is to be set from an item whose absolute or relative path is given in the parameter's value (value is "@CopyFrom").This suffix is similar to the
VALUE_FROM_SUFFIXin that the value for the item is not taken from the request parameter itself but from somewhere else. In this case the value is set by copying another repository item (in the same workspace) to the location addressed by the parameter.- See Also:
-
SUFFIX_IGNORE_BLANKS
Suffix indicating that blank value or values for this property will be ignored.- See Also:
-
SUFFIX_USE_DEFAULT_WHEN_MISSING
Suffix indicating that the default value should be used when the property is not defined. By default the default value is only used when the property is defined, but blank (i.e. an empty form field). With this suffix, the default value will also be used if the property isn't provided at all. This is useful for HTML checkboxes.- See Also:
-
SUFFIX_PATCH
Suffix indicating that a multi-value property is to be handled as an ordered set and the sent values start with either "+" or "-" to indicate wether a value should be added to or removed from the set.If a property is marked to be patched with this suffix only properties whose value start with
+or-are considered. Other values are ignored.- See Also:
-
PATCH_ADD
static final char PATCH_ADDIndicates a value to be added to the named multi-value property if the property is being #patched.If the given value already exists amongst the values of the multi-value properties it is not added.
- See Also:
-
PATCH_REMOVE
static final char PATCH_REMOVEIndicates a value to be removed from the named multi-value property if the property is being #patched.If the given value exists multiple times amongst the values of the multi-value properties all occurrences are removed.
- See Also:
-
RP_CONTENT
Name of the request parameter containing the content to be imported by the 'import' operation.- See Also:
-
RP_CONTENT_TYPE
Name of the request parameter containing the content type of the content to be imported by the 'import' operation.- See Also:
-
RP_CONTENT_FILE
Name of the request parameter containing the file to be imported by the 'import' operation.- See Also:
-
RP_CHECKIN
Name of the request parameter indicating whether versionable nodes should be checked in during anOPERATION_IMPORToperation.- See Also:
-
RP_AUTO_CHECKOUT
Name of the request parameter indicating whether versionable nodes should be checked in during anOPERATION_IMPORToperation.- Since:
- 2.1.2
- See Also:
-
ATTR_SKIP_SESSION_HANDLING
Name of the request attribute (not parameter) indicating that a post operation should not invoke the commit method on the resource resolver upon completion.- Since:
- 2.1.2
- See Also:
-
SUFFIX_OFFSET
Name of the request parameter indicating offset of the chunk in request.- Since:
- 2.3.4
- See Also:
-
SUFFIX_LENGTH
Name of the request parameter indicating length of complete file.- Since:
- 2.3.4
- See Also:
-
SUFFIX_COMPLETED
Name of the request parameter indicating request contains last chunk and as a result upload should be finished. It is useful in scenarios like file streaming where file size is not known in advance.- Since:
- 2.3.4
- See Also:
-
RP_APPLY_TO_CHUNKS
Name of the request parameter indicating request operation is applicable to chunks.- Since:
- 2.3.4
- See Also:
-
NT_SLING_CHUNK_MIXIN
Constant for the sling:chunks mixin. Used to identify that node contains chunks.- Since:
- 2.3.4
- See Also:
-
NT_SLING_FILE_LENGTH
Constant for the sling:fileLength property. The property stores file length.- Since:
- 2.3.4
- See Also:
-
NT_SLING_CHUNKS_LENGTH
Constant for the sling:length property. The property stores cumulative length of all uploaded chunks.- Since:
- 2.3.4
- See Also:
-
NT_SLING_CHUNK_NODETYPE
Constant for the sling:chunk node type. The node type is used to store chunk.- Since:
- 2.3.4
- See Also:
-
NT_SLING_CHUNK_OFFSET
Constant for the sling:offset property. The property stores start offset of chunk.- Since:
- 2.3.4
- See Also:
-
CHUNK_NODE_NAME
Constant for prefix for sling:chunk node name.- Since:
- 2.3.4
- See Also:
-