org.apache.sling.servlets.post

Class AbstractPostOperation

java.lang.Object

org.apache.sling.servlets.post.AbstractPostOperation

All Implemented Interfaces:

PostOperation

Direct Known Subclasses:

AbstractSlingPostOperation

public abstract class AbstractPostOperation
extends Object
implements PostOperation

The AbstractPostOperation class is a base implementation of the PostOperation service interface providing actual implementations with useful tooling and common functionality like preparing the change logs or saving or refreshing the JCR Session.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log default log

Fields inherited from interface org.apache.sling.servlets.post.PostOperation

PROP_OPERATION_NAME, SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractPostOperation()

Method Summary

Modifier and Type	Method and Description
protected void	checkoutIfNecessary(javax.jcr.Node node, List<Modification> changes, VersioningConfiguration versioningConfiguration)
protected abstract void	doRun(SlingHttpServletRequest request, PostResponse response, List<Modification> changes) Actually performs the desired operation filling progress into the changes list and preparing and further information in the response.
protected String	externalizePath(SlingHttpServletRequest request, String path) Returns an external form of the given path prepending the context path and appending a display extension.
protected javax.jcr.Node	findVersionableAncestor(javax.jcr.Node node)
protected Iterator<Resource>	getApplyToResources(SlingHttpServletRequest request) Returns an iterator on Resource instances addressed in the SlingPostConstants.RP_APPLY_TO request parameter.
protected String	getItemPath(SlingHttpServletRequest request) Returns the path of the resource of the request as the item path.
protected VersioningConfiguration	getVersioningConfiguration(SlingHttpServletRequest request) Get the versioning configuration.
protected boolean	hasItemPathPrefix(String name) Returns true if the name starts with either of the prefixes ./, ../ and /.
protected boolean	isSessionSaveRequired(javax.jcr.Session session, SlingHttpServletRequest request) Check whether commit to the resource resolver should be called.
protected boolean	isSkipCheckin(SlingHttpServletRequest request) Check if checkin should be skipped
protected boolean	isSkipSessionHandling(SlingHttpServletRequest request) Check whether changes should be written back
protected boolean	isVersionable(javax.jcr.Node node)
protected void	orderNode(SlingHttpServletRequest request, javax.jcr.Item item, List<Modification> changes) Orders the given node according to the specified command.
protected String	removeAndValidateWorkspace(String path, javax.jcr.Session session) Remove the workspace name, if any, from the start of the path and validate that the session's workspace name matches the path workspace name.
protected boolean	requireItemPathPrefix(SlingHttpServletRequest request) Returns true if any of the request parameters starts with ./.
protected String	resolvePath(String absPath, String relPath) Resolves the given path with respect to the current root path.
void	run(SlingHttpServletRequest request, PostResponse response, SlingPostProcessor[] processors) Prepares and finalizes the actual operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected final org.slf4j.Logger log

default log

Constructor Detail

AbstractPostOperation

public AbstractPostOperation()

Method Detail

run

public void run(SlingHttpServletRequest request,
                PostResponse response,
                SlingPostProcessor[] processors)

Prepares and finalizes the actual operation. Preparation encompasses getting the absolute path of the item to operate on by calling the getItemPath(SlingHttpServletRequest) method and setting the location and parent location on the response. After the operation has been done in the doRun(SlingHttpServletRequest, PostResponse, List) method the session is saved if there are unsaved modifications. In case of errorrs, the unsaved changes in the session are rolled back.

Specified by:

run in interface PostOperation

Parameters:

request - the request to operate on

response - The PostResponse to record execution progress.

processors - The SlingPostProcessor services to be called after applying the operation. This may be null if there are none.

doRun

protected abstract void doRun(SlingHttpServletRequest request,
                              PostResponse response,
                              List<Modification> changes)
                       throws javax.jcr.RepositoryException

Actually performs the desired operation filling progress into the changes list and preparing and further information in the response.

The response comes prepared with the path, location and parent location set. Other properties are expected to be set by this implementation.

Parameters:

request - The SlingHttpServletRequest providing the input, mostly in terms of request parameters, to the operation.

response - The PostResponse to fill with response information

changes - A container to add Modification instances representing the operations done.

Throws:

javax.jcr.RepositoryException - Maybe thrown if any error occurrs while accessing the repository.

getVersioningConfiguration

protected VersioningConfiguration getVersioningConfiguration(SlingHttpServletRequest request)

Get the versioning configuration.

isSkipCheckin

protected boolean isSkipCheckin(SlingHttpServletRequest request)

Check if checkin should be skipped

isSkipSessionHandling

protected boolean isSkipSessionHandling(SlingHttpServletRequest request)

Check whether changes should be written back

isSessionSaveRequired

protected boolean isSessionSaveRequired(javax.jcr.Session session,
                                        SlingHttpServletRequest request)
                                 throws javax.jcr.RepositoryException

Check whether commit to the resource resolver should be called.

Throws:

javax.jcr.RepositoryException

removeAndValidateWorkspace

protected String removeAndValidateWorkspace(String path,
                                            javax.jcr.Session session)
                                     throws javax.jcr.RepositoryException

Remove the workspace name, if any, from the start of the path and validate that the session's workspace name matches the path workspace name.

Throws:

javax.jcr.RepositoryException

getItemPath

protected String getItemPath(SlingHttpServletRequest request)

Returns the path of the resource of the request as the item path.

This method may be overwritten by extension if the operation has different requirements on path processing.

getApplyToResources

protected Iterator<Resource> getApplyToResources(SlingHttpServletRequest request)

Returns an iterator on Resource instances addressed in the SlingPostConstants.RP_APPLY_TO request parameter. If the request parameter is not set, null is returned. If the parameter is set with valid resources an empty iterator is returned. Any resources addressed in the SlingPostConstants.RP_APPLY_TO parameter is ignored.

Parameters:

request - The SlingHttpServletRequest object used to get the SlingPostConstants.RP_APPLY_TO parameter.

Returns:

The iterator of resources listed in the parameter or null if the parameter is not set in the request.

externalizePath

protected final String externalizePath(SlingHttpServletRequest request,
                                       String path)

Returns an external form of the given path prepending the context path and appending a display extension.

Parameters:

path - the path to externalize

Returns:

the url

resolvePath

protected final String resolvePath(String absPath,
                                   String relPath)

Resolves the given path with respect to the current root path.

Parameters:

relPath - the path to resolve

Returns:

the given path if it starts with a '/'; a resolved path otherwise.

requireItemPathPrefix

protected final boolean requireItemPathPrefix(SlingHttpServletRequest request)

Returns true if any of the request parameters starts with ./. In this case only parameters starting with either of the prefixes ./, ../ and / are considered as providing content to be stored. Otherwise all parameters not starting with the command prefix : are considered as parameters to be stored.

hasItemPathPrefix

protected boolean hasItemPathPrefix(String name)

Returns true if the name starts with either of the prefixes ./, ../ and /.

orderNode

protected void orderNode(SlingHttpServletRequest request,
                         javax.jcr.Item item,
                         List<Modification> changes)
                  throws javax.jcr.RepositoryException

Orders the given node according to the specified command. The following syntax is supported: | first | before all child nodes | before A | before child node A | after A | after child node A | last | after all nodes | N | at a specific position, N being an integer

Parameters:

item - node to order

Throws:

javax.jcr.RepositoryException - if an error occurs

findVersionableAncestor

protected javax.jcr.Node findVersionableAncestor(javax.jcr.Node node)
                                          throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isVersionable

protected boolean isVersionable(javax.jcr.Node node)
                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

checkoutIfNecessary

protected void checkoutIfNecessary(javax.jcr.Node node,
                                   List<Modification> changes,
                                   VersioningConfiguration versioningConfiguration)
                            throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException