Package org.apache.sling.servlets.post

Klasse AbstractJakartaPostResponse

java.lang.Object
org.apache.sling.servlets.post.AbstractJakartaPostResponse
Alle implementierten Schnittstellen:
JakartaPostResponse
Bekannte direkte Unterklassen:
JakartaHtmlResponse, JakartaJSONResponse
public abstract class AbstractJakartaPostResponse extends Object implements JakartaPostResponse
The AbstractPostResponse class provides a basic implementation of the PostResponse interface maintaining properties to be prepared for sending the response in an internal map.
Seit:
2.5.0

  • Felddetails

  • Konstruktordetails

    • AbstractJakartaPostResponse

      public AbstractJakartaPostResponse()

  • Methodendetails

    • getReferer

      public String getReferer()
      Returns the referer previously set by JakartaPostResponse.setReferer(String)
      Angegeben von:
      getReferer in Schnittstelle JakartaPostResponse
      Gibt zurück:
      the referer

    • setReferer

      public void setReferer(String referer)
      Sets the referer property
      Angegeben von:
      setReferer in Schnittstelle JakartaPostResponse
      Parameter:
      referer - the referer

    • getPath

      public String getPath()
      Returns the absolute path of the item upon which the request operated.

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

      Angegeben von:
      getPath in Schnittstelle JakartaPostResponse
      Gibt zurück:
      the path (might be null)

    • setPath

      public void setPath(String path)
      Sets the absolute path of the item upon which the request operated.
      Angegeben von:
      setPath in Schnittstelle JakartaPostResponse
      Parameter:
      path - the path

    • isCreateRequest

      public boolean isCreateRequest()
      Returns true if this was a create request.

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

      Angegeben von:
      isCreateRequest in Schnittstelle JakartaPostResponse
      Gibt zurück:
      if this was a create request

    • setCreateRequest

      public void setCreateRequest(boolean isCreateRequest)
      Sets whether the request was a create request or not.
      Angegeben von:
      setCreateRequest in Schnittstelle JakartaPostResponse
      Parameter:
      isCreateRequest - true if the request was a create request

    • getLocation

      public String getLocation()
      Returns the location of the modification.

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

      Angegeben von:
      getLocation in Schnittstelle JakartaPostResponse
      Gibt zurück:
      the location

    • setLocation

      public void setLocation(String location)
      Beschreibung aus Schnittstelle kopiert: JakartaPostResponse
      Sets the location of this modification. This is the externalized form of the current path.
      Angegeben von:
      setLocation in Schnittstelle JakartaPostResponse
      Parameter:
      location - the location

    • getParentLocation

      public String getParentLocation()
      Returns the parent location of the modification. this is the externalized form of the parent node of the current path.
      Angegeben von:
      getParentLocation in Schnittstelle JakartaPostResponse
      Gibt zurück:
      the location of the modification.

    • setParentLocation

      public void setParentLocation(String parentLocation)
      Beschreibung aus Schnittstelle kopiert: JakartaPostResponse
      Sets the parent location of the modification. This is the externalized form of the parent node of the current path.
      Angegeben von:
      setParentLocation in Schnittstelle JakartaPostResponse
      Parameter:
      parentLocation - the parent location of the modification

    • setTitle

      public void setTitle(String title)
      Sets the title of the response message
      Angegeben von:
      setTitle in Schnittstelle JakartaPostResponse
      Parameter:
      title - the title

    • setStatus

      public void setStatus(int code, String message)
      sets the response status code properties
      Angegeben von:
      setStatus in Schnittstelle JakartaPostResponse
      Parameter:
      code - the code
      message - the message

    • getStatusCode

      public int getStatusCode()
      Returns the status code of this instance. If the status code has never been set by calling the 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.
      Angegeben von:
      getStatusCode in Schnittstelle JakartaPostResponse
      Gibt zurück:
      the status code

    • getStatusMessage

      public String getStatusMessage()
      Beschreibung aus Schnittstelle kopiert: JakartaPostResponse
      Returns the status message or null if no has been set with the JakartaPostResponse.setStatus(int, String) method.
      Angegeben von:
      getStatusMessage in Schnittstelle JakartaPostResponse
      Gibt zurück:
      the status message (might be null)

    • getError

      public Throwable getError()
      Returns any recorded error or null
      Angegeben von:
      getError in Schnittstelle JakartaPostResponse
      Gibt zurück:
      an error or null

    • setError

      public void setError(Throwable error)
      Beschreibung aus Schnittstelle kopiert: JakartaPostResponse
      Sets the recorded error causing the operation to fail.
      Angegeben von:
      setError in Schnittstelle JakartaPostResponse
      Parameter:
      error - the throwable

    • isSuccessful

      public boolean isSuccessful()
      Returns true if no error is set and if the status code is one of the 2xx codes.
      Angegeben von:
      isSuccessful in Schnittstelle JakartaPostResponse
      Gibt zurück:
      true if the status code is 2xx

    • onModified

      public void onModified(String path)
      Records a 'modified' change
      Angegeben von:
      onModified in Schnittstelle JakartaPostResponse
      Parameter:
      path - path of the item that was modified

    • onCreated

      public void onCreated(String path)
      Records a 'created' change
      Angegeben von:
      onCreated in Schnittstelle JakartaPostResponse
      Parameter:
      path - path of the item that was created

    • onDeleted

      public void onDeleted(String path)
      Records a 'deleted' change
      Angegeben von:
      onDeleted in Schnittstelle JakartaPostResponse
      Parameter:
      path - path of the item that was deleted

    • onMoved

      public void onMoved(String srcPath, String dstPath)
      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.

      Angegeben von:
      onMoved in Schnittstelle JakartaPostResponse
      Parameter:
      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)
      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.

      Angegeben von:
      onCopied in Schnittstelle JakartaPostResponse
      Parameter:
      srcPath - source path of the node that was copied
      dstPath - destination path of the node that was copied.

    • setProperty

      protected void setProperty(String name, Object value)
      Sets a generic response property with the given
      Parameter:
      name - name of the property
      value - value of the property

    • getProperty

      protected <Type> Type getProperty(String name, Class<Type> type)
      Returns the generic response property with the given name and type or null if no such property exists or the property is not of the requested type.
      Typparameter:
      Type - the return type
      Parameter:
      name - the name of the requetested property
      type - the type of the parameter which should be returned
      Gibt zurück:
      the property as the requested type or null if not available at all or not in the requested type

    • getProperty

      protected Object getProperty(String name)
      Returns the generic response property with the given name and type or null if no such property exists.
      Parameter:
      name - the name of the response property
      Gibt zurück:
      the requested property (might be null)

    • isSafeReferer

      protected boolean isSafeReferer()
      determines if the referer has a proper referer including protocol
      Gibt zurück:
      true if HTTP or HTTPS protocol information is available in the referer

    • doSend

      protected abstract void doSend(jakarta.servlet.http.HttpServletResponse response) throws IOException
      Löst aus:
      IOException

    • send

      public final void send(jakarta.servlet.http.HttpServletResponse response, boolean setStatus) throws IOException
      Writes the response to the given writer and replaces all ${var} patterns by the value of the respective property. if the property is not defined the pattern is not modified.
      Angegeben von:
      send in Schnittstelle JakartaPostResponse
      Parameter:
      response - to send to
      setStatus - whether to set the status code on the response
      Löst aus:
      IOException - if an i/o exception occurs