org.springframework.extensions.webscripts.servlet

Class WebScriptServletResponse

java.lang.Object

org.springframework.extensions.webscripts.WebScriptResponseImpl

org.springframework.extensions.webscripts.servlet.WebScriptServletResponse

All Implemented Interfaces:

WebScriptResponse

Direct Known Subclasses:

WebScriptViewResponse

public class WebScriptServletResponse
extends WebScriptResponseImpl

HTTP Servlet Web Script Response

Author:

davidc

Field Summary

Fields inherited from interface org.springframework.extensions.webscripts.WebScriptResponse

ATOM_FORMAT, HEADER_LOCATION, HTML_FORMAT, JSON_FORMAT, OPENSEARCH_DESCRIPTION_FORMAT, RSS_FORMAT, XML_FORMAT

Constructor Summary

Constructors

Constructor and Description
WebScriptServletResponse(Runtime container, javax.servlet.http.HttpServletResponse res) Construct

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value) Adds a response header with the given name and value.
String	encodeResourceUrl(String url) Encode a resource URL Note: Some Web Script Runtime environments (e.g.
String	encodeScriptUrl(String url) Encode a script URL Note: Some Web Script Runtime environments (e.g.
String	getEncodeResourceUrlFunction(String name) Return a client side javascript function to build resource urls for this service
String	getEncodeScriptUrlFunction(String name) Return a client side javascript function to build urls to this service
javax.servlet.http.HttpServletResponse	getHttpServletResponse() Gets the HTTP Servlet Response
OutputStream	getOutputStream() Gets the Output Stream
Writer	getWriter() Gets the Writer
void	reset() Clears response buffer
void	setCache(Cache cache) Sets the Cache control
void	setContentEncoding(String contentEncoding) Sets the Content Encoding
void	setContentType(String contentType) Sets the Content Type
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 org.springframework.extensions.webscripts.WebScriptResponseImpl

getRuntime

Methods inherited from class java.lang.Object

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

Constructor Detail

WebScriptServletResponse

public WebScriptServletResponse(Runtime container,
                                javax.servlet.http.HttpServletResponse res)

Construct

Parameters:

container - Runtime

res - HttpServletResponse

Method Detail

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse()

Gets the HTTP Servlet Response

Returns:

HTTP Servlet Response

setStatus

public void setStatus(int status)

Description copied from interface: WebScriptResponse

Sets the Response Status

Parameters:

status - int

setHeader

public void setHeader(String name,
                      String value)

Description copied from interface: WebScriptResponse

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)

Description copied from interface: WebScriptResponse

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

setContentType

public void setContentType(String contentType)

Description copied from interface: WebScriptResponse

Sets the Content Type

Parameters:

contentType - String

setContentEncoding

public void setContentEncoding(String contentEncoding)

Description copied from interface: WebScriptResponse

Sets the Content Encoding

Parameters:

contentEncoding - String

setCache

public void setCache(Cache cache)

Description copied from interface: WebScriptResponse

Sets the Cache control

Parameters:

cache - cache control

reset

public void reset()

Description copied from interface: WebScriptResponse

Clears response buffer

getWriter

public Writer getWriter()
                 throws IOException

Description copied from interface: WebScriptResponse

Gets the Writer

Returns:

writer

Throws:

IOException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Description copied from interface: WebScriptResponse

Gets the Output Stream

Returns:

output stream

Throws:

IOException

encodeScriptUrl

public String encodeScriptUrl(String url)

Description copied from interface: WebScriptResponse

Encode a script URL Note: Some Web Script Runtime environments (e.g. JSR-168, JSF) require urls to be re-written.

Parameters:

url - to encode

Returns:

encoded url

getEncodeScriptUrlFunction

public String getEncodeScriptUrlFunction(String name)

Description copied from interface: WebScriptResponse

Return a client side javascript function to build urls to this service

Parameters:

name - Generated function name

Returns:

javascript function definition

encodeResourceUrl

public String encodeResourceUrl(String url)

Description copied from interface: WebScriptResponse

Encode a resource URL Note: Some Web Script Runtime environments (e.g. JSR-268, Surf) require urls to be re-written.

Specified by:

encodeResourceUrl in interface WebScriptResponse

Overrides:

encodeResourceUrl in class WebScriptResponseImpl

Parameters:

url - to encode

Returns:

encoded url

getEncodeResourceUrlFunction

public String getEncodeResourceUrlFunction(String name)

Description copied from interface: WebScriptResponse

Return a client side javascript function to build resource urls for this service

Specified by:

getEncodeResourceUrlFunction in interface WebScriptResponse

Overrides:

getEncodeResourceUrlFunction in class WebScriptResponseImpl

Parameters:

name - Generated function name

Returns:

javascript function definition