public 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.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
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.
|
static java.lang.String |
CHUNK_NODE_NAME
Constant for prefix for sling:chunk node name.
|
static java.lang.String |
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 "/").
|
static java.lang.String |
DEFAULT_VALUE_SUFFIX
Suffix indicating a default value for a property (value is
"@DefaultValue").
|
static java.lang.String |
ITEM_PREFIX_ABSOLUTE
Prefix for properties addressing repository items with an absolute path
(value is "/").
|
static java.lang.String |
ITEM_PREFIX_RELATIVE_CURRENT
Prefix for properties addressing repository items with a path relative to
the current request item (value is "./").
|
static java.lang.String |
ITEM_PREFIX_RELATIVE_PARENT
Prefix for properties addressing repository items with a path relative to
the parent of the request item (value is "../").
|
static int |
NOPSTATUS_VALUE_DEFAULT
The default response status sent back by a
OPERATION_NOP if the
RP_NOP_STATUS parameter is not provided or the parameter value
cannot be converted into a valid response status code (value is 200). |
static java.lang.String |
NT_SLING_CHUNK_MIXIN
Constant for the sling:chunks mixin.
|
static java.lang.String |
NT_SLING_CHUNK_NODETYPE
Constant for the sling:chunk node type.
|
static java.lang.String |
NT_SLING_CHUNK_OFFSET
Constant for the sling:offset property.
|
static java.lang.String |
NT_SLING_CHUNKS_LENGTH
Constant for the sling:length property.
|
static java.lang.String |
NT_SLING_FILE_LENGTH
Constant for the sling:fileLength property.
|
static java.lang.String |
OPERATION_CHECKIN
Name of the predefined checkin operation (value is "checkin").
|
static java.lang.String |
OPERATION_CHECKOUT
Name of the predefined checkout operation (value is "checkout").
|
static java.lang.String |
OPERATION_COPY
Name of the predefined copy operation (value is "copy").
|
static java.lang.String |
OPERATION_DELETE
Name of the predefined delete operation (value is "delete").
|
static java.lang.String |
OPERATION_IMPORT
Name of the predefined import operation (value is "import").
|
static java.lang.String |
OPERATION_MODIFY
Name of the predefined modify operation (value is "modify").
|
static java.lang.String |
OPERATION_MOVE
Name of the predefined move operation (value is "move")
|
static java.lang.String |
OPERATION_NOP
Name of the predefined null operation (value is "nop").
|
static java.lang.String |
OPERATION_RESTORE
Name of the predefined restore operation (value is "restore").
|
static java.lang.String |
ORDER_AFTER
|
static java.lang.String |
ORDER_BEFORE
|
static java.lang.String |
ORDER_FIRST
Possible value of the
RP_ORDER parameter indicating that the
node by moved to the first position amongst its sibblings (value is
"first"). |
static java.lang.String |
ORDER_LAST
Possible value of the
RP_ORDER parameter indicating that the
node by moved to the last position amongst its sibblings (value is
"last"). |
static char |
PATCH_ADD
Indicates a value to be added to the named multi-value property if the
property is being #
patched . |
static char |
PATCH_REMOVE
Indicates a value to be removed from the named multi-value property if
the property is being #
patched . |
static java.lang.String |
RP_APPLY_TO
Name of the request parameter used to indicate the resource to apply the
operation to (value is ":applyTo").
|
static java.lang.String |
RP_APPLY_TO_CHUNKS
Name of the request parameter indicating request operation is applicable
to chunks.
|
static java.lang.String |
RP_AUTO_CHECKOUT
Name of the request parameter indicating whether versionable nodes should
be checked in during an
OPERATION_IMPORT operation. |
static java.lang.String |
RP_CHECKIN
Name of the request parameter indicating whether versionable nodes should
be checked in during an
OPERATION_IMPORT operation. |
static java.lang.String |
RP_CONTENT
Name of the request parameter containing the content to be imported
by the 'import' operation.
|
static java.lang.String |
RP_CONTENT_FILE
Name of the request parameter containing the file to be imported
by the 'import' operation.
|
static java.lang.String |
RP_CONTENT_TYPE
Name of the request parameter containing the content type of the content
to be imported by the 'import' operation.
|
static java.lang.String |
RP_DEST
Name of the request parameter used to indicate the destination for the
copy and move operations (value is ":dest").
|
static java.lang.String |
RP_DISPLAY_EXTENSION
Optional request parameter: if provided, added at the end of the computed
(or supplied) redirect URL
|
static java.lang.String |
RP_NODE_NAME
Optional request paramter specifying a node name for a newly created node
(value is ":name").
|
static java.lang.String |
RP_NODE_NAME_HINT
Optional request paramter specifying a node name hint for a newly created
node (value is ":nameHint").
|
static java.lang.String |
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").
|
static java.lang.String |
RP_OPERATION
The name of the parameter containing the operation to execute (value is
":operation").
|
static java.lang.String |
RP_ORDER
Optional request parameter indicating the order of newly created nodes in
creation, copy and move operation requests (value is ":order").
|
static java.lang.String |
RP_PREFIX
Prefix for parameter names which control this POST (RP_ stands for
"request param") (value is ":").
|
static java.lang.String |
RP_REDIRECT_TO
Optional request parameter: redirect to the specified URL after POST
|
static java.lang.String |
RP_REMOVE_EXISTING
Name of the request parameter indicating whether the nodes existing
outside the versioning graph should be removed.
|
static java.lang.String |
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").
|
static java.lang.String |
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.
|
static java.lang.String |
RP_SEND_ERROR
Optional request parameter: defines if to enable the error handling
also for POST request.
|
static java.lang.String |
RP_STATUS
Optional request parameter: define how the response is sent back to the
client.
|
static java.lang.String |
RP_VERSION
Name of the request parameter indicating the name or the label of the
resource version.
|
static java.lang.String |
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 "/*").
|
static java.lang.String |
STATUS_VALUE_BROWSER
The supported value for the
RP_STATUS request 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 java.lang.String |
STATUS_VALUE_STANDARD
The supported value for the
RP_STATUS request parameter
requesting to report success or failure of request processing using
standard HTTP status codes. |
static java.lang.String |
SUFFIX_COMPLETED
Name of the request parameter indicating request contains last chunk
and as a result upload should be finished.
|
static java.lang.String |
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").
|
static java.lang.String |
SUFFIX_DELETE
Suffix indicating that the named property is to be removed before
applying any new content (value is "@Delete").
|
static java.lang.String |
SUFFIX_IGNORE_BLANKS
Suffix indicating that blank value or values for this property will be
ignored.
|
static java.lang.String |
SUFFIX_LENGTH
Name of the request parameter indicating length of complete file.
|
static java.lang.String |
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").
|
static java.lang.String |
SUFFIX_OFFSET
Name of the request parameter indicating offset of the chunk in request.
|
static java.lang.String |
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.
|
static java.lang.String |
SUFFIX_USE_DEFAULT_WHEN_MISSING
Suffix indicating that the default value should be used when the property
is not defined.
|
static java.lang.String |
TYPE_HINT_SUFFIX
Suffix indicating a type hint for the property (value is "@TypeHint").
|
static java.lang.String |
VALUE_FROM_SUFFIX
SLING-130, suffix that maps form field names to different JCR property
names
|
static final java.lang.String RP_PREFIX
static final java.lang.String RP_OPERATION
static final java.lang.String DEFAULT_CREATE_SUFFIX
static final java.lang.String STAR_CREATE_SUFFIX
static final java.lang.String OPERATION_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_OPERATION
request parameter.
static final java.lang.String OPERATION_DELETE
The delete operation requires no further request parameters and just deletes the content addressed by the request.
If the RP_APPLY_TO
parameter is set the resources listed in that
parameter are deleted instead of the request resource.
static final java.lang.String OPERATION_COPY
The copy operation requires the RP_DEST
request parameter
denoting the path to copy the content to. In addition the
RP_ORDER
parameter may be defined to specificy to relative node
order of the destination node. Finally the RP_REPLACE
parameter
may be set to indicate whether an existing item at the destination should
be replaced or not.
If the RP_APPLY_TO
parameter is set the resources listed in that
parameter are copied instead of the request resource.
static final java.lang.String OPERATION_MOVE
The move operation requires the RP_DEST
request parameter
denoting the path to move the content to. In addition the
RP_ORDER
parameter may be defined to specificy to relative node
order of the destination node. Finally the RP_REPLACE
parameter
may be set to indicate whether an existing item at the destination should
be replaced or not.
If the RP_APPLY_TO
parameter is set the resources listed in that
parameter are moved instead of the request resource.
static final java.lang.String OPERATION_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_STATUS
parameter to indicate
the actual response status to set and the RP_STATUS
parameter
to indicate how to send the actual response status.
static final java.lang.String OPERATION_CHECKIN
The checkin operation requires no further request parameters and just checks in the content addressed by the request.
If the RP_APPLY_TO
parameter is set the resources listed in that
parameter are checked in instead of the request resource.
static final java.lang.String OPERATION_CHECKOUT
The checkout operation requires no further request parameters and just checks out the content addressed by the request.
If the RP_APPLY_TO
parameter is set the resources listed in that
parameter are checked out instead of the request resource.
static final java.lang.String OPERATION_RESTORE
The restore operation requires the RP_VERSION
request parameter
denoting the name or the label of the version to be restored.
If the RP_APPLY_TO
parameter is set the resources listed in that
parameter are restored instead of the request resource. The
RP_REMOVE_EXISTING
parameter may be set to true to force
the operation even if there is a collision.
static final java.lang.String OPERATION_IMPORT
The import operation requires either the RP_CONTENT
and RP_CONTENT_TYPE
request parameters or the RP_CONTENT_FILE
request parameter.
Finally the RP_REPLACE
parameter may be set to indicate whether
an existing item at the destination should be overwritten or not.
static final java.lang.String RP_APPLY_TO
This property is used by certain opertaions - namely
OPERATION_COPY
, OPERATION_DELETE
and
OPERATION_MOVE
- to apply the operation to multiple resources
instead of the request resource.
static final java.lang.String RP_DEST
static final java.lang.String RP_REPLACE
static final java.lang.String RP_REPLACE_PROPERTIES
static final java.lang.String RP_ORDER
The value of this parameter may be ORDER_FIRST
,
ORDER_BEFORE
, ORDER_AFTER
, ORDER_LAST
or a
numberic value indicating the absolute position in the child list of the
parent node.
static final java.lang.String RP_REMOVE_EXISTING
VersionManager#restore()
for more info.
This request parameter is optional and can be used by the OPERATION_RESTORE
.
static final java.lang.String RP_VERSION
OPERATION_RESTORE
.static final java.lang.String ORDER_FIRST
RP_ORDER
parameter indicating that the
node by moved to the first position amongst its sibblings (value is
"first").static final java.lang.String ORDER_BEFORE
RP_ORDER
parameter indicating that the
node by moved immediately before the sibbling whose name is contained in
the RP_ORDER
parameter (value is "before ").static final java.lang.String ORDER_AFTER
RP_ORDER
parameter indicating that the
node by moved immediately after the sibbling whose name is contained in
the RP_ORDER
parameter (value is "after ").static final java.lang.String ORDER_LAST
RP_ORDER
parameter indicating that the
node by moved to the last position amongst its sibblings (value is
"last").static final java.lang.String RP_NODE_NAME
static final java.lang.String RP_NODE_NAME_HINT
static final java.lang.String ITEM_PREFIX_ABSOLUTE
static final java.lang.String ITEM_PREFIX_RELATIVE_CURRENT
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_ABSOLUTE
or the
ITEM_PREFIX_RELATIVE_PARENT
to be parameters addressing
properties to modify. Otherwise, that is if no parameter starts with this
prefix, all parameters not starting with the
command prefix
are considered addressing properties to
modify.
static final java.lang.String ITEM_PREFIX_RELATIVE_PARENT
static final java.lang.String RP_REDIRECT_TO
static final java.lang.String RP_STATUS
STATUS_VALUE_BROWSER
and STATUS_VALUE_STANDARD
. The
default is to assume STATUS_VALUE_STANDARD
if the parameter is
not set or set to any other value.static final java.lang.String RP_SEND_ERROR
static final java.lang.String STATUS_VALUE_STANDARD
RP_STATUS
request parameter
requesting to report success or failure of request processing using
standard HTTP status codes. This value is assumed as the default value
for the RP_STATUS
parameter if the parameter is missing or not
any of the two supported values.RP_STATUS
,
STATUS_VALUE_BROWSER
,
Constant Field Valuesstatic final java.lang.String STATUS_VALUE_BROWSER
RP_STATUS
request 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_STATUS
,
STATUS_VALUE_STANDARD
,
Constant Field Valuesstatic final java.lang.String RP_NOP_STATUS
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.
OPERATION_NOP
,
RP_STATUS
,
Constant Field Valuesstatic final int NOPSTATUS_VALUE_DEFAULT
OPERATION_NOP
if the
RP_NOP_STATUS
parameter is not provided or the parameter value
cannot be converted into a valid response status code (value is 200).RP_NOP_STATUS
,
Constant Field Valuesstatic final java.lang.String RP_DISPLAY_EXTENSION
static final java.lang.String VALUE_FROM_SUFFIX
static final java.lang.String TYPE_HINT_SUFFIX
static final java.lang.String DEFAULT_VALUE_SUFFIX
static final java.lang.String SUFFIX_DELETE
static final java.lang.String SUFFIX_MOVE_FROM
This suffix is similar to the VALUE_FROM_SUFFIX
in 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.
static final java.lang.String SUFFIX_COPY_FROM
This suffix is similar to the VALUE_FROM_SUFFIX
in 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.
static final java.lang.String SUFFIX_IGNORE_BLANKS
static final java.lang.String SUFFIX_USE_DEFAULT_WHEN_MISSING
static final java.lang.String SUFFIX_PATCH
If a property is marked to be patched with this suffix only properties
whose value start with +
or -
are considered. Other values are ignored.
PATCH_ADD
,
PATCH_REMOVE
,
Constant Field Valuesstatic final char PATCH_ADD
patched
.
If the given value already exists amongst the values of the multi-value properties it is not added.
static final char PATCH_REMOVE
patched
.
If the given value exists multiple times amongst the values of the multi-value properties all occurrences are removed.
static final java.lang.String RP_CONTENT
static final java.lang.String RP_CONTENT_TYPE
static final java.lang.String RP_CONTENT_FILE
static final java.lang.String RP_CHECKIN
OPERATION_IMPORT
operation.static final java.lang.String RP_AUTO_CHECKOUT
OPERATION_IMPORT
operation.static final java.lang.String ATTR_SKIP_SESSION_HANDLING
static final java.lang.String SUFFIX_OFFSET
static final java.lang.String SUFFIX_LENGTH
static final java.lang.String SUFFIX_COMPLETED
static final java.lang.String RP_APPLY_TO_CHUNKS
static final java.lang.String NT_SLING_CHUNK_MIXIN
static final java.lang.String NT_SLING_FILE_LENGTH
static final java.lang.String NT_SLING_CHUNKS_LENGTH
static final java.lang.String NT_SLING_CHUNK_NODETYPE
static final java.lang.String NT_SLING_CHUNK_OFFSET
static final java.lang.String CHUNK_NODE_NAME
Copyright © 2010 - 2020 Adobe. All Rights Reserved