com.opentext.applicationconnector.httpconnector.impl

Class StandardResponseHandler

java.lang.Object

com.opentext.applicationconnector.httpconnector.impl.AbstractHttpHandler

com.opentext.applicationconnector.httpconnector.impl.StandardResponseHandler

All Implemented Interfaces:

IResponseHandler

Direct Known Subclasses:

RestResponseHandler

public class StandardResponseHandler
extends AbstractHttpHandler
implements IResponseHandler

HTTP connector response handler for Kiwi.

Author:

mpoyhone

Field Summary

Fields

Modifier and Type	Field and Description
protected IMethodConfiguration	method Contains the method configuration to which this handler is attached to.

Constructor Summary

Constructors

Constructor and Description
StandardResponseHandler()

Method Summary

Modifier and Type	Method and Description
protected int	applyAdditionalTransformation(int resNode) Applies additional transformations as laid out by the XSL registered in the method implementation and returns the modified NOM xml
boolean	canProcess(java.lang.String contentType) Checks if the response can be processed by the handler
protected int	convertHttpResponseToXml(HttpMethod httpMethod, Document doc) Converts the HTTP response to XML.
int	convertResponseToXml(HttpMethod httpMethod, IServerConnection serverConnection, Document doc) Converts the response bytes to XML.
protected int	defineParentNode(Document doc) Utility method that gives the concrete classes an opportunity to override and append the HTTP response on a determined parent node.
protected int	executeXslt(int responseNode, IMethodConfiguration method) Executes the XSLT transformation configured for this handler.
java.util.List<java.lang.String>	getSupportedContentTypes() Returns supported content types
protected int	handleResponseXPath(int responseNode, IMethodConfiguration method) Fetches the response element using the configured XPath.
void	initialize(int configXml, IXSLTStore xslStore, IMethodConfiguration method, XPathMetaInfo xmi) Initializes this handler.
protected int	postProcessXml(int reqNode) Method which can do processing of the response XML after the XSLT transform is executed.
protected int	preProcessXml(int reqNode) Method which can do processing of the response XML before the XSLT transform is called.

Methods inherited from class com.opentext.applicationconnector.httpconnector.impl.AbstractHttpHandler

getPerformanceCounters, setPerformanceCounters

Methods inherited from class java.lang.Object

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

Field Detail

method

protected IMethodConfiguration method

Contains the method configuration to which this handler is attached to.

Constructor Detail

StandardResponseHandler

public StandardResponseHandler()

Method Detail

convertResponseToXml

public int convertResponseToXml(HttpMethod httpMethod,
                                IServerConnection serverConnection,
                                Document doc)
                         throws XMLException,
                                ConnectorException,
                                java.io.IOException

Description copied from interface: IResponseHandler

Converts the response bytes to XML.

Specified by:

convertResponseToXml in interface IResponseHandler

Parameters:

httpMethod - HTTP method from which the response will be read.

serverConnection - Server connection information.

doc - NOM document.

Returns:

Response XML root node.

Throws:

XMLException - Thrown if the XML parsing failed.

ConnectorException

java.io.IOException

See Also:

IResponseHandler.convertResponseToXml(HttpMethod, IServerConnection, Document)

applyAdditionalTransformation

protected int applyAdditionalTransformation(int resNode)
                                     throws ConnectorException

Applies additional transformations as laid out by the XSL registered in the method implementation and returns the modified NOM xml

Parameters:

resNode - http response in NOM xml format

Returns:

the transformed xml if there were any XSLs registered in the method implementation

Throws:

ConnectorException

initialize

public void initialize(int configXml,
                       IXSLTStore xslStore,
                       IMethodConfiguration method,
                       XPathMetaInfo xmi)
                throws ConnectorException

Description copied from interface: IResponseHandler

Initializes this handler.

Specified by:

initialize in interface IResponseHandler

Parameters:

configXml - Handler configuration XML from the method configuration.

xslStore - HTTP Connector instance.

method - MethodConfiguration to which this handler belongs to.

xmi - The XPathMetaInfo object containing the prefix ns mapped to the proper namespace.

Throws:

ConnectorException

See Also:

IResponseHandler.initialize(int, IXSLTStore, IMethodConfiguration, XPathMetaInfo)

convertHttpResponseToXml

protected int convertHttpResponseToXml(HttpMethod httpMethod,
                                       Document doc)
                                throws java.io.IOException,
                                       XMLException

Converts the HTTP response to XML.

Parameters:

httpMethod - HTTP method object from which the response data is read.

doc - NOM document for creating the XML.

Returns:

Converted NOM XML.

Throws:

java.io.IOException

XMLException

defineParentNode

protected int defineParentNode(Document doc)

Utility method that gives the concrete classes an opportunity to override and append the HTTP response on a determined parent node. Default behavior would simply return 0.

Parameters:

doc - the NOM document

Returns:

the parent node to which the HTTP response XML will be appended as a children.

executeXslt

protected int executeXslt(int responseNode,
                          IMethodConfiguration method)
                   throws ConnectorException

Executes the XSLT transformation configured for this handler.

Parameters:

responseNode - Response node to be transformed.

method - Current method configuration.

Returns:

Transformed XML.

Throws:

ConnectorException

handleResponseXPath

protected int handleResponseXPath(int responseNode,
                                  IMethodConfiguration method)

Fetches the response element using the configured XPath.

Parameters:

responseNode - Response node to be transformed.

method - Current method configuration.

Returns:

Transformed XML.

postProcessXml

protected int postProcessXml(int reqNode)

Method which can do processing of the response XML after the XSLT transform is executed. If a new node is returned, the parameter node must be deleted by this method.

This implementation just returns the node as-is.

Parameters:

reqNode - Request XML node.

Returns:

Processed XML.

preProcessXml

protected int preProcessXml(int reqNode)
                     throws ConnectorException

Method which can do processing of the response XML before the XSLT transform is called. If a new node is returned, the parameter node must be deleted by this method.

This implementation just returns the node as-is.

Parameters:

reqNode - Request XML node.

Returns:

Processed XML.

Throws:

ConnectorException - Thrown if the operation failed.

canProcess

public boolean canProcess(java.lang.String contentType)

Description copied from interface: IResponseHandler

Checks if the response can be processed by the handler

Specified by:

canProcess in interface IResponseHandler

Parameters:

contentType - response content type

Returns:

true if the handler can process the content type

getSupportedContentTypes

public java.util.List<java.lang.String> getSupportedContentTypes()

Description copied from interface: IResponseHandler

Returns supported content types

Specified by:

getSupportedContentTypes in interface IResponseHandler

Returns:

Collection of content types