com.ibm.ecm.extension

Class PluginResponseUtil

java.lang.Object

com.ibm.ecm.extension.PluginResponseUtil

public class PluginResponseUtil
extends java.lang.Object

This class provides utility methods to use to set request parameters.

Since:

2.0.3

Constructor Summary

Constructors

Constructor and Description
PluginResponseUtil()

Method Summary

Modifier and Type	Method and Description
static void	writeJSONResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, JSONResponse jsonResponse, PluginServiceCallbacks callbacks, java.lang.String pluginServiceId) Writes the JSON response object to the HTTP response.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginResponseUtil

public PluginResponseUtil()

Method Detail

writeJSONResponse

public static void writeJSONResponse(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response,
                                     JSONResponse jsonResponse,
                                     PluginServiceCallbacks callbacks,
                                     java.lang.String pluginServiceId)

Writes the JSON response object to the HTTP response.

Parameters:

request - The HttpServletRequest object that provides the request. The service can access the invocation parameters from the request.

response - The HttpServletResponse object that is generated by the service. The service can get the output stream and write the response. The response must be in JSON format.

jsonResponse - The JSONResponse object that contains the JSON to write to the HTTP response.

callbacks - An instance of the PluginServiceCallbacks class that contains several functions that can be used by the service. These functions provide access to the plug-in configuration and content server APIs.

pluginServiceId - The ID of the plugin service writing the JSON response.