Package org.apache.sling.jackrabbit.usermanager.impl.post

Class AbstractPostServlet

java.lang.Object
javax.servlet.GenericServlet
org.apache.sling.api.servlets.SlingSafeMethodsServlet
org.apache.sling.api.servlets.SlingAllMethodsServlet
org.apache.sling.jackrabbit.usermanager.impl.post.AbstractPostServlet
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
Direct Known Subclasses:
AbstractAuthorizablePostServlet, DeleteAuthorizableServlet
public abstract class AbstractPostServlet extends SlingAllMethodsServlet
Base class for all the POST servlets for the UserManager operations
See Also:

  • Constructor Details

    • AbstractPostServlet

      public AbstractPostServlet()

  • Method Details

    • doPost

      protected void doPost(SlingHttpServletRequest request, SlingHttpServletResponse httpResponse) throws javax.servlet.ServletException, 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.
      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, 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 - in case of exceptions during the operation

    • handleOperation

      protected abstract void handleOperation(SlingHttpServletRequest request, PostResponse response, 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 - in case of exceptions during the operation

    • getRedirectUrl

      @Deprecated protected String getRedirectUrl(javax.servlet.http.HttpServletRequest request, AbstractPostResponse ctx) throws IOException
      Deprecated.
      use getRedirectUrl(HttpServletRequest, PostResponse) instead
      compute redirect URL (SLING-126)
      Parameters:
      request - the request
      ctx - the post processor
      Returns:
      the redirect location or null
      Throws:
      IOException

    • getRedirectUrl

      protected String getRedirectUrl(javax.servlet.http.HttpServletRequest request, PostResponse ctx) throws IOException
      compute redirect URL (SLING-126)
      Parameters:
      request - the request
      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(SlingHttpServletRequest request)

    • 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.

      Parameters:
      request - the current request
      Returns:
      the path of the resource

    • 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:
      request - the request
      path - the path to externalize
      Returns:
      the url

    • bindPostResponseCreator

      protected void bindPostResponseCreator(PostResponseCreator creator, Map<String,Object> properties)
      Bind a new post response creator

    • unbindPostResponseCreator

      protected void unbindPostResponseCreator(PostResponseCreator creator, Map<String,Object> properties)
      Unbind a post response creator

    • getRanking

      protected int getRanking(Map<String,Object> properties)