public interface PostResponse
PostResponse
interface defines the API of a response
container which can (and should) be used by PostOperation
services to
prepare responses to be sent back to the client.
This bundle provides a preconfigured HtmlResponse
and a
JSONResponse
implementation of this interface. Clients may extend the
AbstractPostResponse
class to provide their own response
implementations.
Modifier and Type | Method and Description |
---|---|
java.lang.Throwable |
getError()
Returns any recorded error or
null |
java.lang.String |
getLocation()
Returns the location of the modification.
|
java.lang.String |
getParentLocation()
Returns the parent location of the modification.
|
java.lang.String |
getPath()
Returns the absolute path of the item upon which the request operated.
|
java.lang.String |
getReferer()
Returns the referer previously set by
setReferer(String) |
int |
getStatusCode()
Returns the status code of this instance.
|
java.lang.String |
getStatusMessage()
Returns the status message or
null if no has been set with
the setStatus(int, String) method. |
boolean |
isCreateRequest()
Returns
true if this was a create request. |
boolean |
isSuccessful()
|
void |
onChange(java.lang.String type,
java.lang.String... arguments)
Records a generic change of the given
type with arguments. |
void |
onCopied(java.lang.String srcPath,
java.lang.String dstPath)
Records a 'copied' change.
|
void |
onCreated(java.lang.String path)
Records a 'created' change
|
void |
onDeleted(java.lang.String path)
Records a 'deleted' change
|
void |
onModified(java.lang.String path)
Records a 'modified' change
|
void |
onMoved(java.lang.String srcPath,
java.lang.String dstPath)
Records a 'moved' change.
|
void |
send(HttpServletResponse response,
boolean setStatus)
Writes the response back over the provided HTTP channel.
|
void |
setCreateRequest(boolean isCreateRequest)
Sets whether the request was a create request or not.
|
void |
setError(java.lang.Throwable error)
Sets the recorded error causing the operation to fail.
|
void |
setLocation(java.lang.String location)
Sets the location of this modification.
|
void |
setParentLocation(java.lang.String parentLocation)
Sets the parent location of the modification.
|
void |
setPath(java.lang.String path)
Sets the absolute path of the item upon which the request operated.
|
void |
setReferer(java.lang.String referer)
Sets the referer property
|
void |
setStatus(int code,
java.lang.String message)
Sets the response status code properties
|
void |
setTitle(java.lang.String title)
Sets the title of the response message
|
void setReferer(java.lang.String referer)
java.lang.String getReferer()
setReferer(String)
void setPath(java.lang.String path)
java.lang.String getPath()
If the setPath(String)
method has not been called yet, this
method returns null
.
void setCreateRequest(boolean isCreateRequest)
boolean isCreateRequest()
true
if this was a create request.
Before calling the setCreateRequest(boolean)
method, this method
always returns false
.
void setLocation(java.lang.String location)
current path
.location
- java.lang.String getLocation()
If the setLocation(String)
method has not been called yet, this
method returns null
.
void setParentLocation(java.lang.String parentLocation)
current path
.java.lang.String getParentLocation()
If the setParentLocation(String)
method has not been called yet,
this method returns null
.
void setTitle(java.lang.String title)
title
- the titlevoid setStatus(int code, java.lang.String message)
code
- the codemessage
- the messageint getStatusCode()
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.java.lang.String getStatusMessage()
null
if no has been set with
the setStatus(int, String)
method.void setError(java.lang.Throwable error)
java.lang.Throwable getError()
null
null
boolean isSuccessful()
void onCreated(java.lang.String path)
path
- path of the item that was createdvoid onModified(java.lang.String path)
path
- path of the item that was modifiedvoid onDeleted(java.lang.String path)
path
- path of the item that was deletedvoid onMoved(java.lang.String srcPath, java.lang.String dstPath)
Note: the moved change only records the basic move command. the implied changes on the moved properties and sub nodes are not recorded.
srcPath
- source path of the node that was moveddstPath
- destination path of the node that was moved.void onCopied(java.lang.String srcPath, java.lang.String dstPath)
Note: the copy change only records the basic copy command. the implied changes on the copied properties and sub nodes are not recorded.
srcPath
- source path of the node that was copieddstPath
- destination path of the node that was copied.void onChange(java.lang.String type, java.lang.String... arguments)
type
with arguments.type
- The type of the modificationarguments
- The arguments to the modificationsvoid send(HttpServletResponse response, boolean setStatus) throws java.io.IOException
response
- to send tosetStatus
- whether to set the status code on the responsejava.io.IOException
- if an i/o exception occursCopyright © 2010 - 2020 Adobe. All Rights Reserved