org.apache.sling.jcr.jackrabbit.accessmanager.post

Class AbstractAccessPostServlet

java.lang.Object

javax.servlet.GenericServlet

org.apache.sling.api.servlets.SlingSafeMethodsServlet

org.apache.sling.api.servlets.SlingAllMethodsServlet

org.apache.sling.jcr.jackrabbit.accessmanager.post.AbstractAccessPostServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

DeleteAcesServlet, ModifyAceServlet

public abstract class AbstractAccessPostServlet
extends SlingAllMethodsServlet

Base class for all the POST servlets for the AccessManager operations

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAccessPostServlet()

Method Summary

Modifier and Type	Method and Description
protected void	bindPostResponseCreator(PostResponseCreator creator, java.util.Map<java.lang.String,java.lang.Object> properties) Bind a new post response creator
protected AbstractPostResponse	createHtmlResponse(SlingHttpServletRequest req) Deprecated. use createPostResponse(SlingHttpServletRequest) instead
protected void	doPost(SlingHttpServletRequest request, SlingHttpServletResponse httpResponse) Called by the SlingAllMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse) method to handle an HTTP POST request.
protected java.lang.String	externalizePath(SlingHttpServletRequest request, java.lang.String path) Returns an external form of the given path prepending the context path and appending a display extension.
protected javax.jcr.security.AccessControlList	getAccessControlList(javax.jcr.security.AccessControlManager accessControlManager, java.lang.String resourcePath, boolean mayCreate) Returns an AccessControlList to edit for the node at the given resourcePath.
protected javax.jcr.security.AccessControlList	getAccessControlListOrNull(javax.jcr.security.AccessControlManager accessControlManager, java.lang.String resourcePath, boolean mayCreate) Returns an AccessControlList to edit for the node at the given resourcePath.
protected java.lang.String	getItemPath(SlingHttpServletRequest request) Returns the path of the resource of the request as the item path.
protected java.lang.String	getRedirectUrl(javax.servlet.http.HttpServletRequest request, AbstractPostResponse ctx) Deprecated. use getRedirectUrl(HttpServletRequest, PostResponse) instead
protected java.lang.String	getRedirectUrl(javax.servlet.http.HttpServletRequest request, PostResponse ctx) compute redirect URL (SLING-126)
protected void	handleOperation(SlingHttpServletRequest request, AbstractPostResponse response, java.util.List<Modification> changes) Deprecated. use handleOperation(SlingHttpServletRequest, PostResponse, List) instead
protected abstract void	handleOperation(SlingHttpServletRequest request, PostResponse response, java.util.List<Modification> changes) Extending Servlet should implement this operation to do the work
protected boolean	isSetStatus(SlingHttpServletRequest request)
protected void	unbindPostResponseCreator(PostResponseCreator creator, java.util.Map<java.lang.String,java.lang.Object> properties) Unbind a post response creator

Methods inherited from class org.apache.sling.api.servlets.SlingAllMethodsServlet

doDelete, doPut, getAllowedRequestMethods, isMethodValid, mayService

Methods inherited from class org.apache.sling.api.servlets.SlingSafeMethodsServlet

doGeneric, doGet, doHead, doOptions, doTrace, getServletInfo, handleMethodNotImplemented, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAccessPostServlet

public AbstractAccessPostServlet()

Method Detail

doPost

protected void doPost(SlingHttpServletRequest request,
                      SlingHttpServletResponse httpResponse)
               throws javax.servlet.ServletException,
                      java.io.IOException

Description copied from class: SlingAllMethodsServlet

Called by the SlingAllMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse) method to handle an HTTP POST request.

This default implementation reports back to the client that the method is not supported.

Implementations of this class should overwrite this method with their implementation for the HTTP POST method support.

Overrides:

doPost in class SlingAllMethodsServlet

Parameters:

request - The HTTP request

httpResponse - The HTTP response

Throws:

javax.servlet.ServletException - Not thrown by this implementation.

java.io.IOException - If the error status cannot be reported back to the client.

createHtmlResponse

@Deprecated
protected AbstractPostResponse createHtmlResponse(SlingHttpServletRequest req)

Deprecated. use createPostResponse(SlingHttpServletRequest) instead

Creates an instance of a HtmlResponse.

Parameters:

req - The request being serviced

Returns:

a JSONResponse if any of these conditions are true:

• the response content type is application/json

or a HtmlResponse otherwise

handleOperation

@Deprecated
protected void handleOperation(SlingHttpServletRequest request,
                                           AbstractPostResponse response,
                                           java.util.List<Modification> changes)
                                    throws javax.jcr.RepositoryException

Deprecated. use handleOperation(SlingHttpServletRequest, PostResponse, List) instead

Extending Servlet should implement this operation to do the work

Parameters:

request - the sling http request to process

response - the response

changes - the changes to report

Throws:

javax.jcr.RepositoryException - if any errors applying the changes

handleOperation

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

Extending Servlet should implement this operation to do the work

Parameters:

request - the sling http request to process

response - the response

changes - the changes to report

Throws:

javax.jcr.RepositoryException - if any errors applying the changes

getRedirectUrl

@Deprecated
protected java.lang.String getRedirectUrl(javax.servlet.http.HttpServletRequest request,
                                                      AbstractPostResponse ctx)
                                               throws java.io.IOException

Deprecated. use getRedirectUrl(HttpServletRequest, PostResponse) instead

compute redirect URL (SLING-126)

Parameters:

request - the sling http request to process

ctx - the post processor

Returns:

the redirect location or null

Throws:

java.io.IOException - if there is something invalid with the :redirect value

getRedirectUrl

protected java.lang.String getRedirectUrl(javax.servlet.http.HttpServletRequest request,
                                          PostResponse ctx)
                                   throws java.io.IOException

compute redirect URL (SLING-126)

Parameters:

request - the sling http request to process

ctx - the post processor

Returns:

the redirect location or null

Throws:

java.io.IOException - if there is something invalid with the :redirect value

isSetStatus

protected boolean isSetStatus(SlingHttpServletRequest request)

getItemPath

protected java.lang.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.

Parameters:

request - the sling http request to process

Returns:

the resolved path of the found item

externalizePath

protected final java.lang.String externalizePath(SlingHttpServletRequest request,
                                                 java.lang.String path)

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

Parameters:

request - the sling http request to process

path - the path to externalize

Returns:

the url

getAccessControlList

protected javax.jcr.security.AccessControlList getAccessControlList(javax.jcr.security.AccessControlManager accessControlManager,
                                                                    java.lang.String resourcePath,
                                                                    boolean mayCreate)
                                                             throws javax.jcr.RepositoryException

Returns an AccessControlList to edit for the node at the given resourcePath.

Parameters:

accessControlManager - The manager providing access control lists

resourcePath - The node path for which to return an access control list

mayCreate - true if an access control list should be created if the node does not have one yet.

Returns:

The AccessControlList to modify to control access to the node.

Throws:

javax.jcr.RepositoryException - If the access control manager does not provide a AccessControlPolicy which is an AccessControlList.

getAccessControlListOrNull

protected javax.jcr.security.AccessControlList getAccessControlListOrNull(javax.jcr.security.AccessControlManager accessControlManager,
                                                                          java.lang.String resourcePath,
                                                                          boolean mayCreate)
                                                                   throws javax.jcr.RepositoryException

Returns an AccessControlList to edit for the node at the given resourcePath.

Parameters:

accessControlManager - The manager providing access control lists

resourcePath - The node path for which to return an access control list

mayCreate - true if an access control list should be created if the node does not have one yet.

Returns:

The AccessControlList to modify to control access to the node or null if one could not be located or created

Throws:

javax.jcr.RepositoryException - if any errors reading the information

bindPostResponseCreator

protected void bindPostResponseCreator(PostResponseCreator creator,
                                       java.util.Map<java.lang.String,java.lang.Object> properties)

Bind a new post response creator

Parameters:

creator - the response creator service reference

properties - the component properties for the service reference

unbindPostResponseCreator

protected void unbindPostResponseCreator(PostResponseCreator creator,
                                         java.util.Map<java.lang.String,java.lang.Object> properties)

Unbind a post response creator

Parameters:

creator - the response creator service reference

properties - the component properties for the service reference