com.indexdata.serviceproxy
Interface ServiceResponse

All Known Implementing Classes:

SimpleServiceResponse

public interface ServiceResponse

Represents current service response.

Author:

jakub

Method Summary

javax.servlet.http.HttpServletResponse	getResponse() Current direct (wrapped) HTTP response.
Document	getResponseDocument() Returns the current response XML document that plugins should append to.
boolean	isDocumentMode() Once a plugin in the chain calls getResponseDocument, the response switches to the document mode and any consecutive call to output stream will cause an exception.
void	setDocumentMode(boolean mode) Used when a plug-in needs to force direct mode after another plug-in in the chain has triggered document mode by setting a response document.
void	setResponseDocument(Document doc) (Re)set the response document.

Method Detail

getResponse

javax.servlet.http.HttpServletResponse getResponse()

Current direct (wrapped) HTTP response.

Returns:

getResponseDocument

Document getResponseDocument()

Returns the current response XML document that plugins should append to. If nessesary a new response document will be created.

Returns:

setResponseDocument

void setResponseDocument(Document doc)

(Re)set the response document.

Parameters:

doc -

isDocumentMode

boolean isDocumentMode()

Once a plugin in the chain calls getResponseDocument, the response switches to the document mode and any consecutive call to output stream will cause an exception.

Returns:

setDocumentMode

void setDocumentMode(boolean mode)

Used when a plug-in needs to force direct mode after another plug-in in the chain has triggered document mode by setting a response document.

Parameters:

mode -

See Also:

isDocumentMode