Package org.springframework.extensions.webscripts.servlet.mvc

Class WebScriptViewResponse

java.lang.Object

org.springframework.extensions.webscripts.WebScriptResponseImpl

org.springframework.extensions.webscripts.servlet.WebScriptServletResponse

org.springframework.extensions.webscripts.servlet.mvc.WebScriptViewResponse

All Implemented Interfaces:

WebScriptResponse

public class WebScriptViewResponse
extends WebScriptServletResponse

Used by the web script view to hand back correct resource urls that reference the resource controller.

Author:

muzquiano

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	Description
WebScriptViewResponse(Runtime container, jakarta.servlet.http.HttpServletResponse res)

Method Summary

Modifier and Type	Method	Description
String	encodeResourceUrl(String url)	Encode a resource 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

Methods inherited from class org.springframework.extensions.webscripts.servlet.WebScriptServletResponse

addHeader, encodeScriptUrl, getEncodeScriptUrlFunction, getHttpServletResponse, getOutputStream, getWriter, reset, reset, setCache, setContentEncoding, setContentType, setHeader, setStatus

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 Details

WebScriptViewResponse

public WebScriptViewResponse(Runtime container,
 jakarta.servlet.http.HttpServletResponse res)

Method Details

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 WebScriptServletResponse

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 WebScriptServletResponse

Parameters:

name - Generated function name

Returns:

javascript function definition