Package com.intuit.qbmsconnector.servlet

Provides servlet support for handling callbacks POSTed by QBMS.

See:
Description

Interface Summary

QbmsCallbackListener

Applications using this API must create an implementation of this interface to receive callbacks in response to notifications sent by Intuit.

Class Summary

QbmsCallbackHandler	Example of how to handle a POST from QBMS for applications using the hosted security model.
QbmsCallbackHandlingServlet	Servlet example of receiving a POST from QBMS for applications using the hosted security model.

Exception Summary

QbmsCallbackProcessingException

Exception thrown if there is a problem retrieving data from a POST from QBMS for applications using the hosted security model.

Package com.intuit.qbmsconnector.servlet Description

Provides servlet support for handling callbacks POSTed by QBMS.

There are two ways in which QBMS Connector supports QBMS callbacks: a "plain vanilla" servlet, and a Spring Controller. This documentation covers the servlet configuration - for Spring configuration, please see the Spring package documentation.

To set up your application to handle QBMS callbacks in a plain servlet environment, you must define a QbmsCallbackHandlingServlet in your web.xml. An example web.xml configuration is shown below:

<?xml version="1.0" encoding="UTF-8"?>

<web-app id="QBMSConnector" version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

        <!-- This servlet processes callbacks from QBMS -->
        <servlet>
                <servlet-name>qbmsCallbackHandler</servlet-name>
                <servlet-class>com.intuit.qbmsconnector.servlet.QbmsCallbackHandlingServlet</servlet-class>

                <!-- This is required -->
                <init-param>
                        <param-name>qbmsCallbackListenerClass</param-name>
                        <param-value>com.myapp.MyQbmsCallbackListener</param-value>
                </init-param>

                <!-- This is optional - use it if you'd like to encrypt your connection tickets -->
                <init-param>
                        <param-name>connectionTicketEncryptorClass</param-name>
                        <param-value>com.intuit.qbmsconnector.crypto.DesConnectionTicketEncryptor</param-value>
                </init-param>

                <load-on-startup>1</load-on-startup>
        </servlet>

        <servlet-mapping>
                <servlet-name>qbmsCallbackHandler</servlet-name>
                <url-pattern>/myQbmsCallbackUrl</url-pattern>
        </servlet-mapping>

</web-app>

Note the two parameters passed to the servlet: qbmsCallbackListenerClass and connectionTicketEncryptorClass.

• qbmsCallbackListenerClass: This is the name of the class that you have created to process callbacks for your application. See the QbmsCallbackListener documentation for details on how to do this.
• connectionTicketEncryptorClass: This is the name of the class that the API will use for encrypting incoming connection tickets. If you don't specify one [you don't want encryption], the connection tickets will not be encrypted. If you do specify one [you want encryption], you can use the out-of-the-box DesConnectionTicketEncryptor, as in the above example, or create your own implementation of ConnectionTicketEncryptor if you have custom encryption requirements.