Package org.apache.sling.servlets.post

Class AbstractPostResponseWrapper

java.lang.Object
org.apache.sling.servlets.post.AbstractPostResponseWrapper
All Implemented Interfaces:
PostResponse
public abstract class AbstractPostResponseWrapper extends Object implements PostResponse
Provides a simple implementation of PostResponse that can be subclassed by developers wishing to provide specialized behavior to an existing PostResponse instance. The default implementation of all methods is to call through to the wrapped PostResponse instance.

  • Constructor Details

    • AbstractPostResponseWrapper

      public AbstractPostResponseWrapper()

  • Method Details

    • getWrapped

      public abstract PostResponse getWrapped()
      Use this method to return an instance of the class being wrapped.
      Returns:
      the wrapped PostResponse instance

    • setReferer

      public void setReferer(String referer)
      Description copied from interface: PostResponse
      Sets the referer property
      Specified by:
      setReferer in interface PostResponse
      Parameters:
      referer - the referer

    • getReferer

      public String getReferer()
      Description copied from interface: PostResponse
      Returns the referer previously set by PostResponse.setReferer(String)
      Specified by:
      getReferer in interface PostResponse
      Returns:
      the referer

    • setPath

      public void setPath(String path)
      Description copied from interface: PostResponse
      Sets the absolute path of the item upon which the request operated.
      Specified by:
      setPath in interface PostResponse
      Parameters:
      path - the path

    • getPath

      public String getPath()
      Description copied from interface: PostResponse
      Returns the absolute path of the item upon which the request operated.

      If the PostResponse.setPath(String) method has not been called yet, this method returns null.

      Specified by:
      getPath in interface PostResponse
      Returns:
      the path (might be null)

    • setCreateRequest

      public void setCreateRequest(boolean isCreateRequest)
      Description copied from interface: PostResponse
      Sets whether the request was a create request or not.
      Specified by:
      setCreateRequest in interface PostResponse
      Parameters:
      isCreateRequest - true if the request was a create request

    • isCreateRequest

      public boolean isCreateRequest()
      Description copied from interface: PostResponse
      Returns true if this was a create request.

      Before calling the PostResponse.setCreateRequest(boolean) method, this method always returns false.

      Specified by:
      isCreateRequest in interface PostResponse
      Returns:
      if this was a create request

    • setLocation

      public void setLocation(String location)
      Description copied from interface: PostResponse
      Sets the location of this modification. This is the externalized form of the current path.
      Specified by:
      setLocation in interface PostResponse
      Parameters:
      location - the location

    • getLocation

      public String getLocation()
      Description copied from interface: PostResponse
      Returns the location of the modification.

      If the PostResponse.setLocation(String) method has not been called yet, this method returns null.

      Specified by:
      getLocation in interface PostResponse
      Returns:
      the location

    • setParentLocation

      public void setParentLocation(String parentLocation)
      Description copied from interface: PostResponse
      Sets the parent location of the modification. This is the externalized form of the parent node of the current path.
      Specified by:
      setParentLocation in interface PostResponse
      Parameters:
      parentLocation - the parent location of the modification

    • getParentLocation

      public String getParentLocation()
      Description copied from interface: PostResponse
      Returns the parent location of the modification.

      If the PostResponse.setParentLocation(String) method has not been called yet, this method returns null.

      Specified by:
      getParentLocation in interface PostResponse
      Returns:
      the parent location

    • setTitle

      public void setTitle(String title)
      Description copied from interface: PostResponse
      Sets the title of the response message
      Specified by:
      setTitle in interface PostResponse
      Parameters:
      title - the title

    • setStatus

      public void setStatus(int code, String message)
      Description copied from interface: PostResponse
      Sets the response status code properties
      Specified by:
      setStatus in interface PostResponse
      Parameters:
      code - the code
      message - the message

    • getStatusCode

      public int getStatusCode()
      Description copied from interface: PostResponse
      Returns the status code of this instance. If the status code has never been set by calling the PostResponse.setStatus(int, String) method, the status code is determined by checking if there was an error. If there was an error, the response is assumed to be unsuccessful and 500 is returned. If there is no error, the response is assumed to be successful and 200 is returned.
      Specified by:
      getStatusCode in interface PostResponse
      Returns:
      the status code

    • getStatusMessage

      public String getStatusMessage()
      Description copied from interface: PostResponse
      Returns the status message or null if no has been set with the PostResponse.setStatus(int, String) method.
      Specified by:
      getStatusMessage in interface PostResponse
      Returns:
      the status message (might be null)

    • setError

      public void setError(Throwable error)
      Description copied from interface: PostResponse
      Sets the recorded error causing the operation to fail.
      Specified by:
      setError in interface PostResponse
      Parameters:
      error - the throwable

    • getError

      public Throwable getError()
      Description copied from interface: PostResponse
      Returns any recorded error or null
      Specified by:
      getError in interface PostResponse
      Returns:
      an error or null

    • isSuccessful

      public boolean isSuccessful()
      Description copied from interface: PostResponse
      Returns true if no error is set and if the status code is one of the 2xx codes.
      Specified by:
      isSuccessful in interface PostResponse
      Returns:
      true if the status code is 2xx

    • onCreated

      public void onCreated(String path)
      Description copied from interface: PostResponse
      Records a 'created' change
      Specified by:
      onCreated in interface PostResponse
      Parameters:
      path - path of the item that was created

    • onModified

      public void onModified(String path)
      Description copied from interface: PostResponse
      Records a 'modified' change
      Specified by:
      onModified in interface PostResponse
      Parameters:
      path - path of the item that was modified

    • onDeleted

      public void onDeleted(String path)
      Description copied from interface: PostResponse
      Records a 'deleted' change
      Specified by:
      onDeleted in interface PostResponse
      Parameters:
      path - path of the item that was deleted

    • onMoved

      public void onMoved(String srcPath, String dstPath)
      Description copied from interface: PostResponse
      Records a 'moved' change.

      Note: the moved change only records the basic move command. the implied changes on the moved properties and sub nodes are not recorded.

      Specified by:
      onMoved in interface PostResponse
      Parameters:
      srcPath - source path of the node that was moved
      dstPath - destination path of the node that was moved.

    • onCopied

      public void onCopied(String srcPath, String dstPath)
      Description copied from interface: PostResponse
      Records a 'copied' change.

      Note: the copy change only records the basic copy command. the implied changes on the copied properties and sub nodes are not recorded.

      Specified by:
      onCopied in interface PostResponse
      Parameters:
      srcPath - source path of the node that was copied
      dstPath - destination path of the node that was copied.

    • onChange

      public void onChange(String type, String... arguments)
      Description copied from interface: PostResponse
      Records a generic change of the given type with arguments.
      Specified by:
      onChange in interface PostResponse
      Parameters:
      type - The type of the modification
      arguments - The arguments to the modifications

    • send

      public void send(javax.servlet.http.HttpServletResponse response, boolean setStatus) throws IOException
      Description copied from interface: PostResponse
      Writes the response back over the provided HTTP channel. The actual format of the response is implementation dependent.
      Specified by:
      send in interface PostResponse
      Parameters:
      response - to send to
      setStatus - whether to set the status code on the response
      Throws:
      IOException - if an i/o exception occurs