Class HtmlPostResponseProxy
- java.lang.Object
-
- org.apache.sling.servlets.post.impl.helper.HtmlPostResponseProxy
-
- All Implemented Interfaces:
PostResponse
@Deprecated public class HtmlPostResponseProxy extends Object implements PostResponse
Deprecated.TheHtmlPostResponseProxy
class implements thePostResponse
interface using a Sling APIHtmlResponse
.This class is mainly used by the deprecated
AbstractSlingPostOperation
for bridging into the newAbstractPostOperation
.
-
-
Constructor Summary
Constructors Constructor Description HtmlPostResponseProxy(org.apache.sling.api.servlets.HtmlResponse apiHtmlResponse)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Throwable
getError()
Deprecated.Returns any recorded error ornull
org.apache.sling.api.servlets.HtmlResponse
getHtmlResponse()
Deprecated.String
getLocation()
Deprecated.Returns the location of the modification.String
getParentLocation()
Deprecated.Returns the parent location of the modification.String
getPath()
Deprecated.Returns the absolute path of the item upon which the request operated.Object
getProperty(String name)
Deprecated.<Type> Type
getProperty(String name, Class<Type> type)
Deprecated.String
getReferer()
Deprecated.Returns the referer previously set byPostResponse.setReferer(String)
int
getStatusCode()
Deprecated.Returns the status code of this instance.String
getStatusMessage()
Deprecated.Returns the status message ornull
if no has been set with thePostResponse.setStatus(int, String)
method.boolean
isCreateRequest()
Deprecated.Returnstrue
if this was a create request.boolean
isSuccessful()
Deprecated.void
onChange(String type, String... arguments)
Deprecated.Records a generic change of the giventype
with arguments.void
onCopied(String srcPath, String dstPath)
Deprecated.Records a 'copied' change.void
onCreated(String path)
Deprecated.Records a 'created' changevoid
onDeleted(String path)
Deprecated.Records a 'deleted' changevoid
onModified(String path)
Deprecated.Records a 'modified' changevoid
onMoved(String srcPath, String dstPath)
Deprecated.Records a 'moved' change.void
send(javax.servlet.http.HttpServletResponse response, boolean setStatus)
Deprecated.Writes the response back over the provided HTTP channel.void
setCreateRequest(boolean isCreateRequest)
Deprecated.Sets whether the request was a create request or not.void
setError(Throwable error)
Deprecated.Sets the recorded error causing the operation to fail.void
setLocation(String location)
Deprecated.Sets the location of this modification.void
setParentLocation(String parentLocation)
Deprecated.Sets the parent location of the modification.void
setPath(String path)
Deprecated.Sets the absolute path of the item upon which the request operated.void
setProperty(String name, Object value)
Deprecated.void
setReferer(String referer)
Deprecated.Sets the referer propertyvoid
setStatus(int code, String message)
Deprecated.Sets the response status code propertiesvoid
setTitle(String title)
Deprecated.Sets the title of the response message
-
-
-
Method Detail
-
getHtmlResponse
public org.apache.sling.api.servlets.HtmlResponse getHtmlResponse()
Deprecated.
-
getError
public Throwable getError()
Deprecated.Description copied from interface:PostResponse
Returns any recorded error ornull
- Specified by:
getError
in interfacePostResponse
- Returns:
- an error or
null
-
getLocation
public String getLocation()
Deprecated.Description copied from interface:PostResponse
Returns the location of the modification.If the
PostResponse.setLocation(String)
method has not been called yet, this method returnsnull
.- Specified by:
getLocation
in interfacePostResponse
- Returns:
- the location
-
getParentLocation
public String getParentLocation()
Deprecated.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 returnsnull
.- Specified by:
getParentLocation
in interfacePostResponse
- Returns:
- the parent location
-
getPath
public String getPath()
Deprecated.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 returnsnull
.- Specified by:
getPath
in interfacePostResponse
- Returns:
- the path (might be null)
-
getReferer
public String getReferer()
Deprecated.Description copied from interface:PostResponse
Returns the referer previously set byPostResponse.setReferer(String)
- Specified by:
getReferer
in interfacePostResponse
- Returns:
- the referer
-
getStatusCode
public int getStatusCode()
Deprecated.Description copied from interface:PostResponse
Returns the status code of this instance. If the status code has never been set by calling thePostResponse.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 interfacePostResponse
- Returns:
- the status code
-
getStatusMessage
public String getStatusMessage()
Deprecated.Description copied from interface:PostResponse
Returns the status message ornull
if no has been set with thePostResponse.setStatus(int, String)
method.- Specified by:
getStatusMessage
in interfacePostResponse
- Returns:
- the status message (might be null)
-
isCreateRequest
public boolean isCreateRequest()
Deprecated.Description copied from interface:PostResponse
Returnstrue
if this was a create request.Before calling the
PostResponse.setCreateRequest(boolean)
method, this method always returnsfalse
.- Specified by:
isCreateRequest
in interfacePostResponse
- Returns:
- if this was a create request
-
isSuccessful
public boolean isSuccessful()
Deprecated.Description copied from interface:PostResponse
- Specified by:
isSuccessful
in interfacePostResponse
- Returns:
- true if the status code is 2xx
-
onChange
public void onChange(String type, String... arguments)
Deprecated.Description copied from interface:PostResponse
Records a generic change of the giventype
with arguments.- Specified by:
onChange
in interfacePostResponse
- Parameters:
type
- The type of the modificationarguments
- The arguments to the modifications
-
onCopied
public void onCopied(String srcPath, String dstPath)
Deprecated.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 interfacePostResponse
- Parameters:
srcPath
- source path of the node that was copieddstPath
- destination path of the node that was copied.
-
onCreated
public void onCreated(String path)
Deprecated.Description copied from interface:PostResponse
Records a 'created' change- Specified by:
onCreated
in interfacePostResponse
- Parameters:
path
- path of the item that was created
-
onDeleted
public void onDeleted(String path)
Deprecated.Description copied from interface:PostResponse
Records a 'deleted' change- Specified by:
onDeleted
in interfacePostResponse
- Parameters:
path
- path of the item that was deleted
-
onModified
public void onModified(String path)
Deprecated.Description copied from interface:PostResponse
Records a 'modified' change- Specified by:
onModified
in interfacePostResponse
- Parameters:
path
- path of the item that was modified
-
onMoved
public void onMoved(String srcPath, String dstPath)
Deprecated.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 interfacePostResponse
- Parameters:
srcPath
- source path of the node that was moveddstPath
- destination path of the node that was moved.
-
send
public void send(javax.servlet.http.HttpServletResponse response, boolean setStatus) throws IOException
Deprecated.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 interfacePostResponse
- Parameters:
response
- to send tosetStatus
- whether to set the status code on the response- Throws:
IOException
- if an i/o exception occurs
-
setCreateRequest
public void setCreateRequest(boolean isCreateRequest)
Deprecated.Description copied from interface:PostResponse
Sets whether the request was a create request or not.- Specified by:
setCreateRequest
in interfacePostResponse
- Parameters:
isCreateRequest
- true if the request was a create request
-
setError
public void setError(Throwable error)
Deprecated.Description copied from interface:PostResponse
Sets the recorded error causing the operation to fail.- Specified by:
setError
in interfacePostResponse
- Parameters:
error
- the throwable
-
setLocation
public void setLocation(String location)
Deprecated.Description copied from interface:PostResponse
Sets the location of this modification. This is the externalized form of thecurrent path
.- Specified by:
setLocation
in interfacePostResponse
- Parameters:
location
- the location
-
setParentLocation
public void setParentLocation(String parentLocation)
Deprecated.Description copied from interface:PostResponse
Sets the parent location of the modification. This is the externalized form of the parent node of thecurrent path
.- Specified by:
setParentLocation
in interfacePostResponse
- Parameters:
parentLocation
- the parent location of the modification
-
setPath
public void setPath(String path)
Deprecated.Description copied from interface:PostResponse
Sets the absolute path of the item upon which the request operated.- Specified by:
setPath
in interfacePostResponse
- Parameters:
path
- the path
-
setReferer
public void setReferer(String referer)
Deprecated.Description copied from interface:PostResponse
Sets the referer property- Specified by:
setReferer
in interfacePostResponse
- Parameters:
referer
- the referer
-
setStatus
public void setStatus(int code, String message)
Deprecated.Description copied from interface:PostResponse
Sets the response status code properties- Specified by:
setStatus
in interfacePostResponse
- Parameters:
code
- the codemessage
- the message
-
setTitle
public void setTitle(String title)
Deprecated.Description copied from interface:PostResponse
Sets the title of the response message- Specified by:
setTitle
in interfacePostResponse
- Parameters:
title
- the title
-
-