org.apache.sling.servlets.post

Class AbstractPostResponse

java.lang.Object

org.apache.sling.servlets.post.AbstractPostResponse

All Implemented Interfaces:

PostResponse

Direct Known Subclasses:

HtmlResponse, JSONResponse

public abstract class AbstractPostResponse
extends java.lang.Object
implements PostResponse

The AbstractPostResponse class provides a basic implementation of the PostResponse interface maintaining properties to be prepared for sending the response in an internal map.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PN_ERROR Name of the error property set by setError(Throwable)
static java.lang.String	PN_IS_CREATED Name of the create status property set by setCreateRequest(boolean)
static java.lang.String	PN_LOCATION Name of the location property set by setLocation(String)
static java.lang.String	PN_PARENT_LOCATION Name of the parent location property set by setParentLocation(String)
static java.lang.String	PN_PATH Name of the path property set by setPath(String)
static java.lang.String	PN_REFERER Name of the referer property set by setReferer(String)
static java.lang.String	PN_STATUS_CODE Name of the status code property set by setStatus(int, String)
static java.lang.String	PN_STATUS_MESSAGE Name of the status message property set by setStatus(int, String)
static java.lang.String	PN_TITLE Name of the title property set by setTitle(String)

Constructor Summary

Constructors

Constructor and Description
AbstractPostResponse()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doSend(javax.servlet.http.HttpServletResponse response)
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.
protected java.lang.Object	getProperty(java.lang.String name) Returns the generic response property with the given name and type or null if no such property exists.
protected <Type> Type	getProperty(java.lang.String name, java.lang.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.
java.lang.String	getReferer() Returns the referer previously set by PostResponse.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 PostResponse.setStatus(int, String) method.
boolean	isCreateRequest() Returns true if this was a create request.
protected boolean	isSafeReferer() determines if the referer has a proper referer including protocol
boolean	isSuccessful() Returns true if no error is set and if the status code is one of the 2xx codes.
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(javax.servlet.http.HttpServletResponse response, boolean setStatus) Writes the response to the given writer and replaces all ${var} patterns by the value of the respective property.
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.
protected void	setProperty(java.lang.String name, java.lang.Object value) Sets a generic response property with the given
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sling.servlets.post.PostResponse

onChange

Field Detail

PN_TITLE

public static final java.lang.String PN_TITLE

Name of the title property set by setTitle(String)

See Also:

Constant Field Values

PN_STATUS_CODE

public static final java.lang.String PN_STATUS_CODE

Name of the status code property set by setStatus(int, String)

See Also:

Constant Field Values

PN_STATUS_MESSAGE

public static final java.lang.String PN_STATUS_MESSAGE

Name of the status message property set by setStatus(int, String)

See Also:

Constant Field Values

PN_LOCATION

public static final java.lang.String PN_LOCATION

Name of the location property set by setLocation(String)

See Also:

Constant Field Values

PN_PARENT_LOCATION

public static final java.lang.String PN_PARENT_LOCATION

Name of the parent location property set by setParentLocation(String)

See Also:

Constant Field Values

PN_PATH

public static final java.lang.String PN_PATH

Name of the path property set by setPath(String)

See Also:

Constant Field Values

PN_REFERER

public static final java.lang.String PN_REFERER

Name of the referer property set by setReferer(String)

See Also:

Constant Field Values

PN_IS_CREATED

public static final java.lang.String PN_IS_CREATED

Name of the create status property set by setCreateRequest(boolean)

See Also:

Constant Field Values

PN_ERROR

public static final java.lang.String PN_ERROR

Name of the error property set by setError(Throwable)

See Also:

Constant Field Values

Constructor Detail

AbstractPostResponse

public AbstractPostResponse()

Method Detail

getReferer

public java.lang.String getReferer()

Returns the referer previously set by PostResponse.setReferer(String)

Specified by:

getReferer in interface PostResponse

Returns:

the referer

setReferer

public void setReferer(java.lang.String referer)

Sets the referer property

Specified by:

setReferer in interface PostResponse

Parameters:

referer - the referer

getPath

public java.lang.String getPath()

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)

setPath

public void setPath(java.lang.String path)

Sets the absolute path of the item upon which the request operated.

Specified by:

setPath in interface PostResponse

Parameters:

path - the path

isCreateRequest

public boolean isCreateRequest()

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

setCreateRequest

public void setCreateRequest(boolean isCreateRequest)

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

getLocation

public java.lang.String getLocation()

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

setLocation

public void setLocation(java.lang.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

getParentLocation

public java.lang.String getParentLocation()

Returns the parent location of the modification. this is the externalized form of the parent node of the current path.

Specified by:

getParentLocation in interface PostResponse

Returns:

the location of the modification.

setParentLocation

public void setParentLocation(java.lang.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

setTitle

public void setTitle(java.lang.String title)

Sets the title of the response message

Specified by:

setTitle in interface PostResponse

Parameters:

title - the title

setStatus

public void setStatus(int code,
                      java.lang.String message)

sets the response status code properties

Specified by:

setStatus in interface PostResponse

Parameters:

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.

Specified by:

getStatusCode in interface PostResponse

Returns:

the status code

getStatusMessage

public java.lang.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)

getError

public java.lang.Throwable getError()

Returns any recorded error or null

Specified by:

getError in interface PostResponse

Returns:

an error or null

setError

public void setError(java.lang.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

isSuccessful

public boolean isSuccessful()

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

onModified

public void onModified(java.lang.String path)

Records a 'modified' change

Specified by:

onModified in interface PostResponse

Parameters:

path - path of the item that was modified

onCreated

public void onCreated(java.lang.String path)

Records a 'created' change

Specified by:

onCreated in interface PostResponse

Parameters:

path - path of the item that was created

onDeleted

public void onDeleted(java.lang.String path)

Records a 'deleted' change

Specified by:

onDeleted in interface PostResponse

Parameters:

path - path of the item that was deleted

onMoved

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

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(java.lang.String srcPath,
                     java.lang.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.

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.

setProperty

protected void setProperty(java.lang.String name,
                           java.lang.Object value)

Sets a generic response property with the given

Parameters:

name - name of the property

value - value of the property

getProperty

protected <Type> Type getProperty(java.lang.String name,
                                  java.lang.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.

Type Parameters:

Type - the return type

Parameters:

name - the name of the requetested property

type - the type of the parameter which should be returned

Returns:

the property as the requested type or null if not available at all or not in the requested type

getProperty

protected java.lang.Object getProperty(java.lang.String name)

Returns the generic response property with the given name and type or null if no such property exists.

Parameters:

name - the name of the response property

Returns:

the requested property (might be null)

isSafeReferer

protected boolean isSafeReferer()

determines if the referer has a proper referer including protocol

Returns:

true if HTTP or HTTPS protocol information is available in the referer

doSend

protected abstract void doSend(javax.servlet.http.HttpServletResponse response)
                        throws java.io.IOException

Throws:

java.io.IOException

send

public final void send(javax.servlet.http.HttpServletResponse response,
                       boolean setStatus)
                throws java.io.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.

Specified by:

send in interface PostResponse

Parameters:

response - to send to

setStatus - whether to set the status code on the response

Throws:

java.io.IOException - if an i/o exception occurs