com.opentext.applicationconnector.httpconnector.impl

Class StandardRequestHandler

java.lang.Object

com.opentext.applicationconnector.httpconnector.impl.AbstractHttpHandler

com.opentext.applicationconnector.httpconnector.impl.StandardRequestHandler

All Implemented Interfaces:

IRequestHandler

Direct Known Subclasses:

RestRequestHandler

public class StandardRequestHandler
extends AbstractHttpHandler
implements IRequestHandler

Standard HTTP connector request handler. This will execute the XSLT transformation, if configured

Author:

mpoyhone

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_CONTENT_TYPE Default content type for the HTTP request.
protected IMethodConfiguration	m_method Contains the method configuration to which this handler is attached to.

Constructor Summary

Constructors

Constructor and Description
StandardRequestHandler()

Method Summary

Modifier and Type	Method and Description
protected byte[]	convertXmlToBytes(int requestNode) Converts the XML structure into a byte array.
protected int	executeXslt(int requestNode, IMethodConfiguration method, boolean mustDelete) Executes the XSLT transformation configured for this handler.
protected java.lang.String	getContentType() Returns the content type information as defined on the method implementation xml.
protected byte[]	getPostData(int requestNode, IServerConnection connection) This method returns the data that should be put into the post data.
protected java.lang.String	getRequestUri(int requestNode, IServerConnection connection, HttpClient httpClient) Returns the URI for this request.
protected int	handleRequestXPath(int requestNode, IMethodConfiguration method, boolean mustDelete) Fetches the request element using the configured XPath.
void	initialize(int configXml, IXSLTStore xslStore, IMethodConfiguration method, XPathMetaInfo xmi) Initializes this handler.
protected int	postProcessXml(int reqNode, boolean mustDelete) Method which can do processing of the request XML after the XSLT transform is executed.
protected int	preProcessXml(int reqNode, boolean mustDelete) Method which can do processing of the request XML before the XSLT transform is called.
HttpMethod	process(int requestNode, IServerConnection connection, HttpClient httpClient) Converts the request XML in HTTP method which can be sent using the HTTP connection.

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

DEFAULT_CONTENT_TYPE

protected static final java.lang.String DEFAULT_CONTENT_TYPE

Default content type for the HTTP request.

See Also:

Constant Field Values

m_method

protected IMethodConfiguration m_method

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

Constructor Detail

StandardRequestHandler

public StandardRequestHandler()

Method Detail

initialize

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

Description copied from interface: IRequestHandler

Initializes this handler.

Specified by:

initialize in interface IRequestHandler

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:

HandlerException - In case of any exceptions.

See Also:

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

process

public HttpMethod process(int requestNode,
                          IServerConnection connection,
                          HttpClient httpClient)
                   throws HandlerException

Description copied from interface: IRequestHandler

Converts the request XML in HTTP method which can be sent using the HTTP connection.

Specified by:

process in interface IRequestHandler

Parameters:

requestNode - Request XML root node.

connection - Current connection.

httpClient - HTTP client instance.

Returns:

Converted byte array.

Throws:

HandlerException - Thrown if the operation failed.

See Also:

IRequestHandler.process(int, IServerConnection, HttpClient)

convertXmlToBytes

protected byte[] convertXmlToBytes(int requestNode)
                            throws HandlerException

Converts the XML structure into a byte array.

Parameters:

requestNode - node XML node to be converted.

Returns:

A byte array containing the XML data.

Throws:

HandlerException

executeXslt

protected int executeXslt(int requestNode,
                          IMethodConfiguration method,
                          boolean mustDelete)
                   throws HandlerException

Executes the XSLT transformation configured for this handler.

Parameters:

requestNode - Request node to be transformed.

method - Current method configuration.

mustDelete - If true the parameter node must be deleted, if a new XML node is returned. Otherwise the node cannot be deleted.

Returns:

Transformed XML.

Throws:

HandlerException

getContentType

protected java.lang.String getContentType()

Returns the content type information as defined on the method implementation xml.

This method differs from #getContentType(HttpMethod) in following manner

This method reads the content type info as defined on the method (webservice) implementation; whereas #getContentType(HttpMethod) returns the content type on the HttpMethod

Returns:

Content type as defined in the method implementation xml. when nothing is defined then DEFAULT_CONTENT_TYPE is returned

getPostData

protected byte[] getPostData(int requestNode,
                             IServerConnection connection)
                      throws HandlerException

This method returns the data that should be put into the post data.

Parameters:

requestNode - The current request XML.

connection - The current server connection.

Returns:

The byte data to post.

Throws:

HandlerException - In case of any exceptions.

getRequestUri

protected java.lang.String getRequestUri(int requestNode,
                                         IServerConnection connection,
                                         HttpClient httpClient)
                                  throws HandlerException

Returns the URI for this request.

Parameters:

requestNode - Incoming request XML node.

connection - Current connection.

httpClient - HTTP client object.

Returns:

Request URI. This cannot be null.

Throws:

HandlerException - In case of any exceptions.

handleRequestXPath

protected int handleRequestXPath(int requestNode,
                                 IMethodConfiguration method,
                                 boolean mustDelete)

Fetches the request element using the configured XPath.

Parameters:

requestNode - Request node to be transformed.

method - Current method configuration.

mustDelete - If true the parameter node must be deleted, if a new XML node is returned. Otherwise the node cannot be deleted.

Returns:

Transformed XML.

postProcessXml

protected int postProcessXml(int reqNode,
                             boolean mustDelete)
                      throws HandlerException

Method which can do processing of the request XML after the XSLT transform is executed. This implementation just returns the node as-is.

Parameters:

reqNode - Request XML node.

mustDelete - If true the parameter node must be deleted, if a new XML node is returned. Otherwise the node cannot be deleted.

Returns:

Processed XML.

Throws:

HandlerException - in case of any errors.

preProcessXml

protected int preProcessXml(int reqNode,
                            boolean mustDelete)
                     throws HandlerException

Method which can do processing of the request XML before the XSLT transform is called. This implementation returns the first child element of the request XML as the root is the SOAP request method node.

Parameters:

reqNode - Request XML node.

mustDelete - If true the parameter node must be deleted, if a new XML node is returned. Otherwise the node cannot be deleted.

Returns:

Processed XML.

Throws:

HandlerException - In case of any errors.