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

Class AbstractAccessPostServlet

  • All Implemented Interfaces:
    Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
    Direct Known Subclasses:
    DeleteAcesServlet, ModifyAceServlet
    public abstract class AbstractAccessPostServlet
extends org.apache.sling.api.servlets.SlingAllMethodsServlet
    Base class for all the POST servlets for the AccessManager operations
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected void bindPostResponseCreator​(org.apache.sling.servlets.post.PostResponseCreator creator, Map<String,​Object> properties)
      Bind a new post response creator
      protected org.apache.sling.servlets.post.AbstractPostResponse createHtmlResponse​(org.apache.sling.api.SlingHttpServletRequest req)
      Deprecated.
      use createPostResponse(SlingHttpServletRequest) instead
      protected void doPost​(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.SlingHttpServletResponse httpResponse)  
      protected String externalizePath​(org.apache.sling.api.SlingHttpServletRequest request, 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, 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, String resourcePath, boolean mayCreate)
      Returns an AccessControlList to edit for the node at the given resourcePath.
      protected String getItemPath​(org.apache.sling.api.SlingHttpServletRequest request)
      Returns the path of the resource of the request as the item path.
      protected String getRedirectUrl​(javax.servlet.http.HttpServletRequest request, org.apache.sling.servlets.post.AbstractPostResponse ctx)
      Deprecated.
      use getRedirectUrl(HttpServletRequest, PostResponse) instead
      protected String getRedirectUrl​(javax.servlet.http.HttpServletRequest request, org.apache.sling.servlets.post.PostResponse ctx)
      compute redirect URL (SLING-126)
      protected void handleOperation​(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.servlets.post.AbstractPostResponse response, List<org.apache.sling.servlets.post.Modification> changes)
      Deprecated.
      use handleOperation(SlingHttpServletRequest, PostResponse, List) instead
      protected abstract void handleOperation​(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.servlets.post.PostResponse response, List<org.apache.sling.servlets.post.Modification> changes)
      Extending Servlet should implement this operation to do the work
      protected boolean isSetStatus​(org.apache.sling.api.SlingHttpServletRequest request)  
      protected void unbindPostResponseCreator​(org.apache.sling.servlets.post.PostResponseCreator creator, Map<String,​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

    • Constructor Detail

      • AbstractAccessPostServlet

        public AbstractAccessPostServlet()

    • Method Detail

      • doPost

        protected void doPost​(org.apache.sling.api.SlingHttpServletRequest request,
                      org.apache.sling.api.SlingHttpServletResponse httpResponse)
               throws javax.servlet.ServletException,
                      IOException
        Overrides:
        doPost in class org.apache.sling.api.servlets.SlingAllMethodsServlet
        Throws:
        javax.servlet.ServletException
        IOException

      • createHtmlResponse

        @Deprecated
protected org.apache.sling.servlets.post.AbstractPostResponse createHtmlResponse​(org.apache.sling.api.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​(org.apache.sling.api.SlingHttpServletRequest request,
                               org.apache.sling.servlets.post.AbstractPostResponse response,
                               List<org.apache.sling.servlets.post.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​(org.apache.sling.api.SlingHttpServletRequest request,
                                        org.apache.sling.servlets.post.PostResponse response,
                                        List<org.apache.sling.servlets.post.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 String getRedirectUrl​(javax.servlet.http.HttpServletRequest request,
                                org.apache.sling.servlets.post.AbstractPostResponse ctx)
                         throws 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:
        IOException - if there is something invalid with the :redirect value

      • getRedirectUrl

        protected String getRedirectUrl​(javax.servlet.http.HttpServletRequest request,
                                org.apache.sling.servlets.post.PostResponse ctx)
                         throws 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:
        IOException - if there is something invalid with the :redirect value

      • isSetStatus

        protected boolean isSetStatus​(org.apache.sling.api.SlingHttpServletRequest request)

      • getItemPath

        protected String getItemPath​(org.apache.sling.api.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 String externalizePath​(org.apache.sling.api.SlingHttpServletRequest request,
                                       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,
                                                                    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,
                                                                          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​(org.apache.sling.servlets.post.PostResponseCreator creator,
                                       Map<String,​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​(org.apache.sling.servlets.post.PostResponseCreator creator,
                                         Map<String,​Object> properties)
        Unbind a post response creator
        Parameters:
        creator - the response creator service reference
        properties - the component properties for the service reference