Scanning Sample Web Services Client

eip-wsdl-import

Creates the Web Service Java Proxy classes representing the Outgoing and Incoming EIP Web Service artifacts. Must build/install prior to running the eip-client.

eip-client

Contains the infrastructure necessary to communicate with the EIP services. Additionally within the Unit Testing classes there is a Scanning class containing examples of the basic scanning operations.
This project is dependent on the eip-wsdl-import project.

<plugin>

                <groupId>org.codehaus.mojo</groupId>

                <artifactId>jaxws-maven-plugin</artifactId>

                <version>1.12</version>

                <executions>

                    <execution>

                        <goals>

                            <goal>wsimport</goal>

                        </goals>

                    </execution>

                </executions>

                <!--TODO: Need to replace wsdlUrl with production versions -->

                <configuration>

                    <wsdlUrls>

                        <wsdlUrl>http://sdqesdevvgw4.devqes.omnitracs.com:8184/eipWebWS/EIPOutMsgSvcs1.0?wsdl</wsdlUrl>

                        <wsdlUrl>http://sdqesdevvgw4.devqes.omnitracs.com:8184/eipWebWS/EIPInMsgSvcs1.0?wsdl</wsdlUrl>

                    </wsdlUrls>

                    <packageName>com.omnitracs.eip.ws.schema</packageName>

                    <sourceDestDir>${basedir}/src/main/java</sourceDestDir>

                    <verbose>true</verbose>

                </configuration>

            </plugin>

            <plugin>

/**

     * getOutgoingMessages

     *

     * @param GetMessagesRequest

     * @return GetMessagesResponse

     * @throws Exception

     */

    public GetMessagesResponse getOutgoingMessages(GetMessagesRequest request) throws ServicesException

    {

        log.debug("getOutgoingMessages");

        GetMessagesResponse response = (GetMessagesResponse) wsCaller(eipOutMsgTemplate, request);

        return response;

    }

    /**

     * getOutgoingMessagesCount

     *

     * @param GetMessagesCountRequest

     * @return GetMessagesCountResponse

     * @throws Exception

     */

    public GetMessagesCountResponse getOutgoingMessagesCount( GetMessagesCountRequest request) throws ServicesException

    {

        log.debug("getOutgoingMessagesCount");

        GetMessagesCountResponse response = (GetMessagesCountResponse) wsCaller(eipOutMsgTemplate, request);

        return response;

    }

    /**

     * sendMessages

     *

     * @param SendMessagesRequest

     * @return SendMessagesResponse

     * @throws Exception

     */

    public SendMessagesResponse sendMessages(SendMessagesRequest request) throws ServicesException

    {

        log.debug("sendMessages");

        SendMessagesResponse response = (SendMessagesResponse) wsCaller(eipInMsgTemplate, request);

        return response;

    }

    /**

     * getSentMessages

     *

     * @param GetSentMessagesRequest

     * @return GetSentMessagesResponse

     * @throws Exception

     */

    public GetSentMessagesResponse getSentMessages( GetSentMessagesRequest request) throws ServicesException

    {

        log.debug("getSentMessages");

        GetSentMessagesResponse response = (GetSentMessagesResponse) wsCaller( eipInMsgTemplate, request);

        return response;

    }

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration(locations = { "classpath:func-test-context.xml", "classpath:web-service-test-context.xml" })

public class ScanningTest implements Constants {

    @Resource

    protected Services eipService;

    /**

     * Setter for EIP Messaging Services

     *

     * @param eipOutMsgTemplate

     */

    public void setEipService(Services eipService)

    {

        this.eipService = eipService;

    }

    /**

     * testGetScannedMessageCounts

     *

     * Example of how to look up a count for available unread, read and failed scanned messages.

     *

     * @throws Exception

     */

    @Test

    public void testGetScannedMessageCounts() throws Exception

    {

        // Create a RoutingType and assign the Scanning Service/IdentityType

        RoutingType routing = helper.createSimpleServiceRouting(SCANNING_PRIMARY_SERVICE_ID);

        // Create the GetMessagesCountRequest

        GetMessagesCountRequest countRequest = new GetMessagesCountRequest();

        // Assign the RoutingType

        countRequest.setRouting(routing);

        GetMessagesCountResponse countResponse = null;

        try

        {

            /*------------------------------------------------------*/

            // Set for UNREAD message counts

            countRequest.setReadState(OutgoingReadStatesType.UNREAD);

            // Call the EIP Outgoing Messages Count Service API

            countResponse = eipService.getOutgoingMessagesCount(countRequest);

            // check the response for a count:

            log.info("The number of available UNREAD scanning messages are: " + countResponse.getMessageCount());

            /*------------------------------------------------------*/

            // Set for READ message counts

            countRequest.setReadState(OutgoingReadStatesType.READ);

            // Call the EIP Outgoing Messages Count Service API

            countResponse = eipService.getOutgoingMessagesCount(countRequest);

            // check the response for a count:

            log.info("The number of available READ scanning messages are: " + countResponse.getMessageCount());

            /*------------------------------------------------------*/

            // Set for FAILED message counts

            countRequest.setReadState(OutgoingReadStatesType.FAILED);

            // Call the EIP Outgoing Messages Count Service API

            countResponse = eipService.getOutgoingMessagesCount(countRequest);

            // check the response for a count:

            log.info("The number of available FAILED scanning messages are: " + countResponse.getMessageCount());

        }

        catch (ServicesException exp)

        {

            handleServicesException(exp);

        }

    }

<!-- Web Service client specific bean instantiations -->

  <oxm:jaxb2-marshaller id="wsJaxbMarshaller" contextPath="com.omnitracs.eip.ws.schema" />

  <bean id="messageFactory" class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory">

  </bean>

  <bean id="xwsSecurityInterceptor" class="org.springframework.ws.soap.security.xwss.XwsSecurityInterceptor">

    <property name="policyConfiguration" value="securityPolicyClient.xml" />

    <property name="callbackHandlers">

      <list />

    </property>

  </bean>

  <bean id="eipOutMsgTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">

    <constructor-arg ref="messageFactory" />

    <property name="marshaller" ref="wsJaxbMarshaller"></property>

    <property name="unmarshaller" ref="wsJaxbMarshaller"></property>

    <property name="messageSender">

      <bean class="org.springframework.ws.transport.http.CommonsHttpMessageSender"/>

    </property>

    <property name="defaultUri" value="${eip.outgoing.url}" />

    <property name="interceptors">

      <list>

        <ref bean="xwsSecurityInterceptor" />

      </list>

    </property>

  </bean>

  <bean id="eipInMsgTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">

    <constructor-arg ref="messageFactory" />

    <property name="marshaller" ref="wsJaxbMarshaller"></property>

    <property name="unmarshaller" ref="wsJaxbMarshaller"></property>

    <property name="messageSender">

      <bean class="org.springframework.ws.transport.http.CommonsHttpMessageSender"/>

    </property>

    <property name="defaultUri" value="${eip.incoming.url}" />

    <property name="interceptors">

      <list>

        <ref bean="xwsSecurityInterceptor" />

      </list>

    </property>

  </bean>

eip.outgoing.url=http://sdqesintvgw4.devqes.omnitracs.com:8184/eipWebWS/EIPOutMsgSvcs1.0

eip.incoming.url=http://sdqesintvgw4.devqes.omnitracs.com:8184/eipWebWS/EIPInMsgSvcs1.0

<bean id="propertyPlaceHolder" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">

    <property name="locations">

      <list>

        <value>classpath:dev.properties</value>

      </list>

    </property>

  </bean>

  <bean id="eipService" class="com.omnitracs.eip.ws.client.Services" scope="singleton"

    p:eipOutMsgTemplate-ref="eipOutMsgTemplate"

    p:eipInMsgTemplate-ref="eipInMsgTemplate" />

<xwss:SecurityConfiguration dumpMessages="true" xmlns:xwss="http://java.sun.com/xml/ns/xwss/config">

    <xwss:Timestamp />

    <xwss:UsernameToken name="USER@COMPANY" password="somepassword" digestPassword="false" useNonce="true" />

</xwss:SecurityConfiguration>

/**

 * testGetScannedMessages

 *

 * Example of how to look up scanned messages.

 *

 * @throws Exception

 */

@Test

public void testGetScannedMessages() throws Exception

{

    // decide which type of read state to look

    OutgoingReadStatesType readState = OutgoingReadStatesType.UNREAD;

    // Create a RoutingType and assign the Scanning Service/IdentityType

    RoutingType routing = helper.createSimpleServiceRouting(SCANNING_PRIMARY_SERVICE_ID);

    // Creat the messages request

    GetMessagesRequest messagesRequest = new GetMessagesRequest();

    // Assign the routing info

    messagesRequest.setRouting(routing);

    // Set read state

    messagesRequest.setReadState(readState);

    // Set max messages (Scanning has a limit of 2 messages per request).

    messagesRequest.setMaxMessages(SCANNING_MAX_OUTGOING_MESSAGE);

    // For UnRead Messages management

    // For testing purposes we will not acknowledge the reading of an unread scanned message.

    // NEED TO SET TO TRUE DURING ACTUAL USAGE

    messagesRequest.setAutoAck(false);

    try

    {

        GetMessagesResponse countResponse = null;

        // internal count so we can report how many scanned processed

        int processedCnt = 0;

        // Lookup number of available messages

        // only take 1/2 as we are only able to get 2 scanned messages per request

        int availableMessagesCnt = roundUp( lookupMessageCounts(readState) , 2);

        // loop through all the available messages

        while ( (availableMessagesCnt--) > 0)

        {

            // Call the EIP Outgoing Messages Service API

            countResponse = eipService.getOutgoingMessages(messagesRequest);

            // retrieve the list of scanned messages

            List<OutgoingMessageType> list = countResponse.getMessage();

            if (list != null)

            {

                for (OutgoingMessageType scanMsg : list)

                {

                    String fileName = scanMsg.getPayload().getFilename();

                    log.info("filename: " + fileName);

                    // do not need the content type if the file name has the appropriate extension

                    String contentType = scanMsg.getPayload().getContentType();

                    log.info("contentType: " + contentType);

                    StringBuilder sb = new StringBuilder();

                    // collect the associated meta data

                    for (NameValueType nameValue : scanMsg.getMetaData())

                    {

                        sb.append(nameValue.getName()).append("=").append(nameValue.getValue()).append("\n");

                    }

                    log.info("MetaData for file:\n" + sb);

                    fileWriteBytes(fileName, scanMsg.getPayload().getBinary());

                    ++processedCnt;

                }

            }

        }

        // check the response for a count:

        log.info("The number of scanning messages processed: " + processedCnt);

    }

    catch (ServicesException exp)

    {

        handleServicesException(exp);

    }

}