org.itsnat.core

Interface ItsNatServletResponse

All Superinterfaces:

ItsNatUserData

All Known Subinterfaces:

ItsNatHttpServletResponse

public interface ItsNatServletResponse
extends ItsNatUserData

Is the ItsNat wrapper of the javax.servlet.ServletResponse object.

Author:

Jose Maria Arranz Santamaria

Method Summary

Methods

Modifier and Type	Method and Description
void	addCodeToSend(Object code) Add JavaScript code to send to the client as return of this request.
ItsNatDocument	getItsNatDocument() Returns the ItsNat document associated to this response.
ItsNatServlet	getItsNatServlet() Returns the ItsNat servlet associated to this response.
ItsNatSession	getItsNatSession() Returns the ItsNat session associated to this response.
javax.servlet.ServletResponse	getServletResponse() Returns the wrapped javax.servlet.ServletResponse object.

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getServletResponse

javax.servlet.ServletResponse getServletResponse()

Returns the wrapped javax.servlet.ServletResponse object.

Returns:

the wrapped servlet response object. Can not be null.

getItsNatServlet

ItsNatServlet getItsNatServlet()

Returns the ItsNat servlet associated to this response.

Returns:

the ItsNat servlet. Can not be null.

getItsNatSession

ItsNatSession getItsNatSession()

Returns the ItsNat session associated to this response.

Returns:

the ItsNat session. Can not be null.

getItsNatDocument

ItsNatDocument getItsNatDocument()

Returns the ItsNat document associated to this response.

Returns:

the ItsNat document. If null no document could be loaded/accessed.

addCodeToSend

void addCodeToSend(Object code)

Add JavaScript code to send to the client as return of this request.

If this request is a document load request, the code is added to the JavaScript initialization code, otherwise is an event based request and the code is added to the JavaScript event response.

Use this method exceptionally if you need to send custom code in this circumstance, otherwise use ItsNatDocument.addCodeToSend(Object) or ClientDocument.addCodeToSend(Object).

Parameters:

code - the code to send, Object.toString() is called to convert to string.

See Also:

ScriptUtil