Interface ResponseWriter
-
- All Known Implementing Classes:
AbstractResourceWebScript
,DiscoveryApiWebscript
,NetworksWebScriptGet
,NetworkWebScriptGet
,PublicApiTenantWebScriptServletRuntime
,ResourceWebScriptDelete
,ResourceWebScriptGet
,ResourceWebScriptPost
,ResourceWebScriptPut
,SearchApiWebscript
,SearchSQLApiWebscript
public interface ResponseWriter
-
-
Field Summary
Fields Modifier and Type Field Description static org.springframework.extensions.webscripts.Cache
CACHE_NEVER
static ContentInfo
DEFAULT_JSON_CONTENT
static WithResponse
DEFAULT_SUCCESS
static String
UTF8
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default void
renderErrorResponse(ErrorResponse errorResponse, org.springframework.extensions.webscripts.WebScriptResponse res, JacksonHelper jsonHelper)
Renders a JSON error responsedefault void
renderException(Exception exception, org.springframework.extensions.webscripts.WebScriptResponse response, ApiAssistant assistant)
Renders an exception to the output stream as Json.default void
renderJsonResponse(org.springframework.extensions.webscripts.WebScriptResponse res, Object toSerialize, JacksonHelper jsonHelper)
Renders the result of an execution.default org.apache.commons.logging.Log
resWriterLogger()
default void
setContentInfoOnResponse(org.springframework.extensions.webscripts.WebScriptResponse res, ContentInfo contentInfo)
Sets the response headers with any information we know about the contentdefault void
setResponse(org.springframework.extensions.webscripts.WebScriptResponse res, int status, org.springframework.extensions.webscripts.Cache cache, ContentInfo contentInfo, Map<String,List<String>> headers)
The response status must be set before the response is written by Jackson (which will by default close and commit the response).default void
setResponse(org.springframework.extensions.webscripts.WebScriptResponse res, WithResponse withResponse)
Sets the response using the WithResponse object
-
-
-
Field Detail
-
UTF8
static final String UTF8
- See Also:
- Constant Field Values
-
DEFAULT_JSON_CONTENT
static final ContentInfo DEFAULT_JSON_CONTENT
-
CACHE_NEVER
static final org.springframework.extensions.webscripts.Cache CACHE_NEVER
-
DEFAULT_SUCCESS
static final WithResponse DEFAULT_SUCCESS
-
-
Method Detail
-
resWriterLogger
default org.apache.commons.logging.Log resWriterLogger()
-
setContentInfoOnResponse
default void setContentInfoOnResponse(org.springframework.extensions.webscripts.WebScriptResponse res, ContentInfo contentInfo)
Sets the response headers with any information we know about the content- Parameters:
res
- WebScriptResponsecontentInfo
- Content Information
-
setResponse
default void setResponse(org.springframework.extensions.webscripts.WebScriptResponse res, int status, org.springframework.extensions.webscripts.Cache cache, ContentInfo contentInfo, Map<String,List<String>> headers)
The response status must be set before the response is written by Jackson (which will by default close and commit the response). In a r/w txn, web script buffered responses ensure that it doesn't really matter but for r/o txns this is important. If you set content information via the contentInfo object and ALSO the headers then "headers" will win because they are set last.- Parameters:
res
-status
-cache
-contentInfo
-headers
-
-
setResponse
default void setResponse(org.springframework.extensions.webscripts.WebScriptResponse res, WithResponse withResponse)
Sets the response using the WithResponse object- Parameters:
res
-withResponse
-
-
renderErrorResponse
default void renderErrorResponse(ErrorResponse errorResponse, org.springframework.extensions.webscripts.WebScriptResponse res, JacksonHelper jsonHelper) throws IOException
Renders a JSON error response- Parameters:
errorResponse
- The errorres
- web script response- Throws:
IOException
-
renderException
default void renderException(Exception exception, org.springframework.extensions.webscripts.WebScriptResponse response, ApiAssistant assistant) throws IOException
Renders an exception to the output stream as Json.- Parameters:
exception
-response
-- Throws:
IOException
-
renderJsonResponse
default void renderJsonResponse(org.springframework.extensions.webscripts.WebScriptResponse res, Object toSerialize, JacksonHelper jsonHelper) throws IOException
Renders the result of an execution.- Parameters:
res
- WebScriptResponsetoSerialize
- result of an execution- Throws:
IOException
-
-