com.ibm.ecm.extension

Class PluginResponseFilter

java.lang.Object

com.ibm.ecm.extension.PluginResponseFilter

public abstract class PluginResponseFilter
extends java.lang.Object

Provides an abstract class that is extended to create a filter for responses from a particular service. The response from the service is provided to the filter in JSON format before it is returned to the web browser. The filter can then modify that response, and the modified response is returned to the web browser.

Constructor Summary

Constructors

Constructor and Description
PluginResponseFilter()

Method Summary

Modifier and Type	Method and Description
abstract void	filter(java.lang.String serverType, PluginServiceCallbacks callbacks, javax.servlet.http.HttpServletRequest request, com.ibm.json.java.JSONObject jsonResponse) Filters the response from the service.
abstract java.lang.String[]	getFilteredServices() Returns an array of the services that are extended by this filter.
PluginServletResponseWrapper	wrapResponse(PluginServiceCallbacks callbacks, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, com.ibm.json.java.JSONArtifact jsonRequest) Allows a request filter to wrap the incoming response object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginResponseFilter

public PluginResponseFilter()

Method Detail

getFilteredServices

public abstract java.lang.String[] getFilteredServices()

Returns an array of the services that are extended by this filter.

Returns:

A String array of names of the services. These are the servlet paths or Struts action names.

wrapResponse

public PluginServletResponseWrapper wrapResponse(PluginServiceCallbacks callbacks,
                                                 javax.servlet.http.HttpServletRequest request,
                                                 javax.servlet.http.HttpServletResponse response,
                                                 com.ibm.json.java.JSONArtifact jsonRequest)
                                          throws java.lang.Exception

Allows a request filter to wrap the incoming response object.

Parameters:

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

request - The HttpServletRequest object that provides the request. The service can access the invocation parameters from the request. Note: The request object can be passed to a response filter to allow a plug-in to communicate information between a request and response filter.

response - The HttpServletResponse object that provides the response. The service can set headers and/or wrap this response in an instance of PluginServletResponseWrapper

jsonRequest - A JSONArtifact that provides the request in JSON format. If the request does not include a JSON Artifact object, this parameter returns null.

Returns:

An instance of PluginServletResponseWrapper, that wraps the passed in response object, can be returned. Return null if the response is not to be wrapped.

Throws:

java.lang.Exception

Since:

2.0.3.6

filter

public abstract void filter(java.lang.String serverType,
                            PluginServiceCallbacks callbacks,
                            javax.servlet.http.HttpServletRequest request,
                            com.ibm.json.java.JSONObject jsonResponse)
                     throws java.lang.Exception

Filters the response from the service.

Parameters:

serverType - A String that indicates the type of server that is associated with the service. This value can be one or more of the following values separated by commas:

Server Type	Description
p8	IBM FileNet P8
cm	IBM Content Manager
od	IBM Content Manager OnDemand
common	For services that are not associated with a particular server

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

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

jsonResponse - The JSONObject object that is generated by the service. Typically, this object is serialized and sent as the response. The filter modifies this object to change the response that is sent.

Throws:

java.lang.Exception - For exceptions that occur when the service is running. Information about the exception is logged as part of the client logging and an error response is automatically generated and returned.