Exposing your service as SOAP Enpoint using Apache Camel

Today I will be telling you about how to expose your service as SOAP endpoint using Apache Camel.


The four steps for it.

1) creating of  cxf-server.xml -- which contain detail about your soap endpoint.

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:cxf="http://camel.apache.org/schema/cxf"
       xmlns:util="http://www.springframework.org/schema/util"
       xmlns:soap="http://cxf.apache.org/bindings/soap"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
                           http://camel.apache.org/schema/cxf http://camel.apache.org/schema/cxf/camel-cxf.xsd
                           http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd
                           http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd
                           http://cxf.apache.org/bindings/soap http://cxf.apache.org/schemas/configuration/soap.xsd">


    <import resource="classpath:META-INF/cxf/cxf.xml" />
    <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />

   
    <!-- Create SOAP endpoint  -->
    <cxf:cxfEndpoint id="mySoapEndPoint"
                     address="http://localhost:{{port}}/test/SOAP"
                     serviceClass="com.test.Broker">
        <cxf:binding>
            <soap:soapBinding version="1.2"/>  <!-- this allow you accept soap 1.2 request, as  by default camel accept only soap 1.1 request-->
        </cxf:binding>
        <cxf:properties>
            <entry key="dataFormat" value="PAYLOAD"/>
        </cxf:properties>
    </cxf:cxfEndpoint>
   
 
   
</beans>


2) Creation of your camel-server.xml -- defining your route.


<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:camel="http://camel.apache.org/schema/spring"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
                           http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring-2.11.0.xsd
                           http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd">

    <import resource="classpath:META-INF/cxf/cxf-config.xml" />


<!-- Define your route here -->
    <camel:camelContext id="camel-server">

        <!-- Externally Exposed Routes -->
        <camel:routeBuilder ref="soapHandlerRoute"/>
     
    </camel:camelContext>

<bean id="soapHandlerRoute"  class="com.test.SoapRoute "/>




3)  Define your route -- the actual implementation.

package com.test;

public class SoapRoute extends RouteBuilder {

@Override
    public void configure() throws Exception {

     from("cxf:bean:mySoapEndPoint")
                .routeId("soapRouteId")
                .convertBodyTo(String.class)
                .end(); //  add your logic here to handle the input soap request.

    }


}


4) Define your dummy endpoint broker class


package com.test;

@WebServiceProvider() @ServiceMode(Mode.PAYLOAD)

public class Broker implements Provider<SOAPMessage>{

    public SOAPMessage invoke(SOAPMessage message) {

        // Requests should not come here as the Camel route will

        // intercept the call before this is invoked.

        throw new UnsupportedOperationException("Placeholder method");

    }

 

}

}


That is it your have exposed your service as SOAP Request and Response.

Refer : cxf-example and cxf.html for more detail

Mongodb and scripting

To do house keeping job on Mongo DB we can use scripting for it

Steps involved will be

1) Write a java script file using the details given in http://docs.mongodb.org/manual/tutorial/write-scripts-for-the-mongo-shell/

2) To run a script use comand : mongo .js

3) If you want to get the shell also when executing like this : mongo testConnction.js --shell

testJsScript.js

` db = connect("localhost:27017/myDatabase"); // db contain the reference of the database printjson(db.getCollectionNames()); // mongodb provided print command print(db.getCollectionNames()); //js print command cursor = db.collection.find(); // this will return a cursor, this cursor can be used to iterate over all the collection object.

you can even use this cursor for updating items, but the catch is you have to fire a query which actually return only the json object which can be directly used in the query.

Mongo DB indexing pitfalls and how to avoid it.

Querying and adding Index to Mongo DB is a bit straight forward. But to use both together to optimize the response time can be a bit tricky.

As adding Index, can help to reduce to response time to find an item, similarly adding unwanted index can lead to other memory and response time-related issue.

So below are some quick  rules/suggestion which should be followed to avoid any pitfalls of indexing

1.  If you have a field X on which you have an index with a unique key constraint.  Then you don't have to have any other index with other fields along with this X field.

e.g

db.myCollection.ensureIndex({X:1},{unique:true})

Then there is no point of having index like:

db.myCollection.ensureIndex({X:1,b:1})  // no need can be removed db.myCollection.ensureIndex({X:1,b:1,c:1}) // no need can be removed

2. If you have a compound index and you want to use this index in your query then make sure your query being fired always have the first element of the index.

e.g

compound index : { w:1,x: 1, y: 1, z: 1 }

Then you can fire any query having the FIRST element (w) to use the index.

wxy wxz wyz xyw yxw zxw

All above query will use the compound index defined above.

But you CAN'T fire any query which does not have the first element of the indexed as it won't use the index.

e.g  

xyz xy zy

For more info read : compound-index   and index-intersection-compound-indexes

3. You should always check your index and write query against it and  not to do vise-verse. If there is no index to cater your query first add the index and then make the query against it.

Camel Technical learnings

Whenever you use a `choice()` in your camel route always use `end()` to end it as opposed to `endChoice()`. Using `endChoice()` drops the exchange from the route.

-------------------------------------

How are bean method is called :
Camel uses a Camel’s method-selection algorithm for selecting a method in the Bean class.
Also uses Bean parameter binding as defined below :
generally this steps are performed:
The BeanProcessor uses the input message to bind its body to the first parameter
of the method of called Bean.

see the different annotation that can be used in defining Bean methods: http://camel.apache.org/parameter-binding-annotations.html

Also see 4.5.1 Binding with multiple parameters in camel in acton.


----------------------------

Configure method of a Routebuilder is called only once at the startup of the camelContext. So any value added to route cant be changed even though  you may have used variable to define them (and variables being dynamically loaded from properties file).