org.alfresco.rest.framework.webscripts

Class WithResponse

java.lang.Object

org.alfresco.rest.framework.webscripts.WithResponse

public class WithResponse
extends Object

Values to be set on the response at the appropriate time. It should be ok to set these variables multiple times but only the latest values are used.

Author:

Gethin James

Constructor Summary

Constructors

Constructor and Description
WithResponse(int status, ContentInfo contentInfo, org.springframework.extensions.webscripts.Cache cache)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value) Adds a response header with the given name and value.
org.springframework.extensions.webscripts.Cache	getCache()
ContentInfo	getContentInfo()
Map<String,List<String>>	getHeaders()
int	getStatus()
void	setCache(org.springframework.extensions.webscripts.Cache cache) Sets the Cache control
void	setContentInfo(ContentInfo contentInfo) Sets the information about the content: mimetype, encoding, locale, length
void	setHeader(String name, String value) Set a response header with the given name and value.
void	setStatus(int status) Sets the Response Status

Methods inherited from class java.lang.Object

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

Constructor Detail

WithResponse

public WithResponse(int status,
                    ContentInfo contentInfo,
                    org.springframework.extensions.webscripts.Cache cache)

Method Detail

setContentInfo

public void setContentInfo(ContentInfo contentInfo)

Sets the information about the content: mimetype, encoding, locale, length

Parameters:

contentInfo -

setStatus

public void setStatus(int status)

Sets the Response Status

Parameters:

status - int

setHeader

public void setHeader(String name,
                      String value)

Set a response header with the given name and value. If the header has already been set, the new value overwrites the previous one.

Parameters:

name - header name

value - header value

addHeader

public void addHeader(String name,
                      String value)

Adds a response header with the given name and value. This method allows a response header to have multiple values.

Parameters:

name - header name

value - header value

setCache

public void setCache(org.springframework.extensions.webscripts.Cache cache)

Sets the Cache control

Parameters:

cache - cache control

getContentInfo

public ContentInfo getContentInfo()

getStatus

public int getStatus()

getCache

public org.springframework.extensions.webscripts.Cache getCache()

getHeaders

public Map<String,List<String>> getHeaders()