WebServices with CXF - Configuration files - web.xml

<web-app 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"> <display-name>Archetype Created Web Application</display-name> <context-param> <param-name>webAppRootKey</param-name> <param-value>my-web-app</param-value> </context-param> <!--Log4J Configuration --> <context-param> <param-name>log4jConfigLocation</param-name> <param-value>/WEB-INF/conf/log4j/log4j-config.xml</param-value> </context-param> <!--Spring Context Configuration --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/conf/spring/daoApplicationContext.xml, /WEB-INF/conf/spring/serviceApplicationContext.xml, /WEB-INF/conf/cxf/cxf-services.xml </param-value> </context-param> <!--Log4J Listener --> <listener> <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener> <!--Spring Context Listener --> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <!--Another Context Listener --> <listener> <listener-class>mx.com.mylibrary.web.listener.ContextListener</listener-class> </listener> <!--Servlet Declarations --> <servlet> <servlet-name>webApplicationServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/conf/spring/webApplicationContext.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet> <display-name>CXF Servlet</display-name> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/services/*</url-pattern> </servlet-mapping> <!--Servlet Mappings --> <servlet-mapping> <servlet-name>webApplicationServlet</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping> <!--Session Time-out in minutes --> <session-config> <session-timeout>30</session-timeout> </session-config> <!--Welcome file --> <welcome-file-list> <welcome-file>/index.jsp</welcome-file> </welcome-file-list> <!--Reference to a DB Conection --> <resource-ref> <description>DB Connection</description> <res-ref-name>jdbc/bookStoreDS</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> <res-sharing-scope>Shareable</res-sharing-scope> </resource-ref> </web-app>

WebServices with CXF - Testing using JUnit

As you know JUnit is for Testing, so basically I'm going to test my running/deployed WebApplication by declaring this Test Cases:

This one is just a TestCase which tests my Spring Bean Service public void testGetAllBooks(){ List<BookDTO> books = null; try{ books = this.libraryService.getAllBooks(); }catch(Exception ex){ log.warn(ex); } for(BookDTO bookDTO: books){ log.debug(bookDTO); } assertNotNull(books); }
And this fellow tests our WebService public void testWebService(){ List<BookDTO> books = null; try{ JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean(); factoryBean.setDataBinding(new AegisDatabinding()); factoryBean.getInInterceptors().add(new LoggingInInterceptor()); factoryBean.getOutInterceptors().add(new LoggingOutInterceptor()); factoryBean.setAddress("http://127.0.0.1:9080/little-library/services/LibraryService"); factoryBean.setServiceClass(LibraryService.class); LibraryService libraryService = (LibraryService)factoryBean.create(); books = libraryService.getAllBooks(); }catch(Exception ex){ log.warn(ex); } for(BookDTO bookDTO: books){ log.debug(bookDTO); } Assert.assertNotNull(books); }

As you can see, we need to link using our Service Interface (LibraryService.class) to this JaxWsProxyFactoryBean instance

That was easy! Isn't it???

WebServices with CXF - Configuration files III

Now I'll cover my Apache CXF configuration file

<?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:cxf="http://cxf.apache.org/core" xmlns:jaxws="http://cxf.apache.org/jaxws" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd http://cxf.apache.org/core http://cxf.apache.org/schemas/core.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"> <!-- =========================== Useful Imports ===========================--> <import resource="classpath:META-INF/cxf/cxf.xml" /> <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" /> <import resource="classpath:META-INF/cxf/cxf-servlet.xml" /> <!-- =========================== Aegis data binding ===========================--> <bean id="AegisDatabindingBean" class="org.apache.cxf.aegis.databinding.AegisDatabinding" scope="prototype"/> <bean id="JaxWsServiceFactoryBean" class="org.apache.cxf.jaxws.support.JaxWsServiceFactoryBean" scope="prototype"> <property name="dataBinding" ref="AegisDatabindingBean"/> <property name="serviceConfigurations"> <list> <bean class="org.apache.cxf.jaxws.support.JaxWsServiceConfiguration"/> <bean class="org.apache.cxf.aegis.databinding.AegisServiceConfiguration"/> <bean class="org.apache.cxf.service.factory.DefaultServiceConfiguration"/> </list> </property> </bean> <!-- =========================== Web Services ===========================--> <jaxws:endpoint id="libraryService" implementorClass="mx.com.mylibrary.core.business.service.impl.LibraryServiceImpl" implementor="#LibraryService" address="/LibraryService"> <jaxws:serviceFactory> <ref bean='JaxWsServiceFactoryBean' /> </jaxws:serviceFactory> </jaxws:endpoint> </beans>

As I said before this is not rocket science. It follows the same logic used in every Spring configuration file, everything is based on Beans tags

If you remember my serviceApplicationContext, I declared a Bean called LibraryService

<!--================== Business Objects/Service Objects =============--> <bean id="LibraryService" class="mx.com.mylibrary.core.business.service.impl.LibraryServiceImpl"/>

Well, we're going to make reference to this particular Bean on our CXF configuration file, so we can expose it (We already changed our Interface & Implementation using annotations)

Now if you analyze carefully my CXF configuration file, this section links my Spring Bean (Service) with my endpoint on CXF through implementor & implementorClass attributes, which basically link my Java Code (implementorClass) and my Spring Bean (implementor);
The only thing you must add is "#" character before Spring's Bean name: #LibraryService

<!-- =========================== Web Services ===========================--> <jaxws:endpoint id="libraryService" implementorClass="mx.com.mylibrary.core.business.service.impl.LibraryServiceImpl" implementor="#LibraryService" address="/LibraryService"> <jaxws:serviceFactory> <ref bean='JaxWsServiceFactoryBean' /> </jaxws:serviceFactory> </jaxws:endpoint>

Finally, I'm using another attribute called address to declare the address for this WebService, by declaring it as address="/LibraryService", this will be my URI for this WebService: http://localhost:8080/little-library-lite/services/LibraryService

Why /services/LibraryService?? I declared on my web.xml that URL Pattern.

In my next and last entry I'll test this WebService using JUnit, if you want to see the WSDL file for all your available WebServices, you can do it by going to http://localhost:8080/little-library-lite/services

There you'll see a list of available WebServices and by clicking them you'll see each one's WSDL

WebServices with CXF - Configuration files II

I'll just include my Spring configuration files.
Why files? -I though Spring only needs an applicationConext??? Well... Because I prefer to split configuration files according to it's purpose:

• One will have everything related to the Persistence layer
• and the second one will have all my Business layer -services

Following this logic I should have another one for my Web layer

daoApplicationContext <?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:jee = "http://www.springframework.org/schema/jee" xsi:schemaLocation = " http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-2.5.xsd"> <!--========================= Data Sources ============================= --> <jee:jndi-lookup id="myDataSource" jndi-name="java:comp/env/jdbc/bookStoreDS"/> <!--============================= SessionFactory ===============================--> <bean id = "sessionFactory" class = "org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean"> <property name = "dataSource" ref = "myDataSource"/> <property name = "configLocation"> <value>/WEB-INF/conf/mapping/mapping.cfg.xml</value> </property> <property name = "hibernateProperties"> <props> <prop key = "hibernate.dialect">org.hibernate.dialect.MySQLInnoDBDialect</prop> <prop key = "hibernate.show_sql">true</prop> <prop key = "hibernate.format_sql">true</prop> <prop key = "hibernate.order_updates">true</prop> <prop key = "hibernate.generate_statistics">true</prop> <prop key = "hibernate.use_sql_comments">false</prop> <prop key = "hibernate.bytecode.use_reflection_optimizer">false</prop> <prop key = "hibernate.jdbc.batch_size">15</prop> <prop key = "hibernate.jdbc.batch_versioned_data">true</prop> <prop key = "hibernate.query.factory_class">org.hibernate.hql.ast.ASTQueryTranslatorFactory</prop> <prop key = "hibernate.connection.isolation">4</prop> </props> </property> </bean> <!--============================ DAOs ================================== --> <bean id = "AuthorDAO" class = "mx.com.mylibrary.core.persistence.dao.impl.AuthorDAOImpl"> <property name = "sessionFactory"> <ref bean = "sessionFactory"/> </property> </bean> <bean id = "BookDAO" class = "mx.com.mylibrary.core.persistence.dao.impl.BookDAOImpl"> <property name = "sessionFactory"> <ref bean = "sessionFactory"/> </property> </bean> <bean id = "EditorDAO" class = "mx.com.mylibrary.core.persistence.dao.impl.EditorDAOImpl"> <property name = "sessionFactory"> <ref bean = "sessionFactory"/> </property> </bean> </beans>

serviceApplicationContext <?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:aop = "http://www.springframework.org/schema/aop" xmlns:tx = "http://www.springframework.org/schema/tx" xsi:schemaLocation = " http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd"> <!--=============== JTA ==========================================--> <bean id = "transactionManager" class = "org.springframework.orm.hibernate3.HibernateTransactionManager"> <property name = "sessionFactory"> <ref bean = "sessionFactory"/> </property> </bean> <!--====================== Transaction Managers =====================--> <tx:annotation-driven transaction-manager = "transactionManager"/> <!--================== Business Objects/Service Objects =============--> <bean id = "LibraryService" class = "mx.com.mylibrary.core.business.service.impl.LibraryServiceImpl"/> </beans>

When I met Annotations, I just felt in love with them, because one of the main advantages you gain is small configuration files.

On my next entry I'll cover my Apache CXF configuration file and how it fits.

Don't forget to add @Autowired, in case that you want to use this feature by <beans ... xmlns:context="http://www.springframework.org/schema/context" ... http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd"> ... <context:annotation-config /> ... </beans>

WebServices with CXF - Configuration files I

I'll show 2 basic configuration files: web.xml & my hibernate configuration file (mapping.cfg.xml)

<web-app 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"> <display-name>Archetype Created Web Application</display-name> <context-param> <param-name>webAppRootKey</param-name> <param-value>my-web-app</param-value> </context-param> <!--Log4J Configuration --> <context-param> <param-name>log4jConfigLocation</param-name> <param-value>/WEB-INF/conf/log4j/log4j-config.xml</param-value> </context-param> <!--Spring Context Configuration --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/conf/spring/daoApplicationContext.xml, /WEB-INF/conf/spring/serviceApplicationContext.xml, /WEB-INF/conf/cxf/cxf-services.xml </param-value> </context-param> <!--Log4J Listener --> <listener> <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener> <!--Spring Context Listener --> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <!--Servlet Declarations --> <servlet> <servlet-name>webApplicationServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/conf/spring/webApplicationContext.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet> <display-name>CXF Servlet</display-name> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/services/*</url-pattern> </servlet-mapping> <!--Servlet Mappings --> <servlet-mapping> <servlet-name>webApplicationServlet</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping> <!--Session Time-out in minutes --> <session-config> <session-timeout>30</session-timeout> </session-config> <!--Welcome file --> <welcome-file-list> <welcome-file>/index.jsp</welcome-file> </welcome-file-list> <!--Reference to a my DB Conection --> <resource-ref> <description>DB Connection</description> <res-ref-name>jdbc/bookStoreDS</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> <res-sharing-scope>Shareable</res-sharing-scope> </resource-ref> </web-app>

As you noticed I'm using Spring MVC (see webApplicationServlet), but for now let's focus on Spring and CXF:

My 3 main configuration files are listed here, where the 3rd one is for CXF (really obvious file name) and to enable Apache CXF is so simple, Did you remember XFire? <!--Spring Context Configuration --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/conf/spring/daoApplicationContext.xml, /WEB-INF/conf/spring/serviceApplicationContext.xml, /WEB-INF/conf/cxf/cxf-services.xml </param-value> </context-param> ... ... ... <servlet> <display-name>CXF Servlet</display-name> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/services/*</url-pattern> </servlet-mapping>

This is not rocket science! So simple :)


Now let's see my (small) Hibernate configuration file (which I just called mapping.cfg.xml) <hibernate-configuration> <session-factory> <mapping class="mx.com.mylibrary.core.persistence.domain.Author"/> <mapping class="mx.com.mylibrary.core.persistence.domain.Book"/> <mapping class="mx.com.mylibrary.core.persistence.domain.Editor"/> </session-factory> </hibernate-configuration> Instead of using resource=, I'm using class=, because I don't have any hbm.xml file. I'm mapping directly to the class (due to Java Annotations, my mapping it was declared on each POJO).

Now what do you think? Is not as complex as looks like.

WebServices with CXF - Integrating with CXF II

This is going to be a really small entry, because we're going to finish with my ServiceImplementation.
On the next entries we'll discuss configuration files & finally we'll see everything working (Obviously I'll need to test it).

But before that, let's analyze my implementation:

@WebService(serviceName="LibraryService", endpointInterface = "mx.com.mylibrary.core.business.service.LibraryService", targetNamespace="http://juca-cruz-utilities.blogspot.com") public class LibraryServiceImpl implements LibraryService { //Method's Implemented }

As I've been doing I'm using a lot of WebServices Annotations

What I did???

• Define service name of the Web Service
• Declare the complete name of the service endpoint interface defining the service's abstract Web Service contract (My Interface)
• And set my targetNamespace: the targetNamespace is used for the namespace for the wsdl:portType (and associated XML elements)

WebServices with CXF - Integrating with CXF I

As I said before on Service Interface & Implementation, somehow we'll have to retake that code to implement CXF, and that's what we're going to do.
I want to expose as WebService my LibraryService and as WebMethods these methods:

• public List getAllAuthors()
• public List getAllBooks()
• public List getAllEditors()
• public List getAllOnlyEditors()
• public BookDTO getBook(Integer bookId)

Ok, everything looks nice, but what happens if my client is asking for a "subService" (WebMethod) which returns AllAuthors, but he/she doesn't expect a WebMethod called getAuthors, retrieveAuthors or returnAuthors.

What can we do??? -We're done with our coding and that method (getAllAuthors) is being used in many places in our App.
Are you going to rename your code just because your client doesn't like your naming convention???. Later you'll see my answer.

Let's modify my code, first, Interface then Implementation;
By adding Java WebServices API Annotations @WebService @SOAPBinding(style=Style.DOCUMENT) public interface LibraryService And don't forget for every method we must declare it like a WebMethod @WebMethod(operationName="getAuthors", action="getAuthors") public List<AuthorDTO> getAllAuthors(); In this case I'm declaring a couple of additional attributes, which basically let me give another name to WebMethod, a different name to my original Java Method - this will be the name available on my WebService/WebMethod (this is the second option for my client)

And finally, what can I do if have logic on this interface that I don't want to make it public (available as WebMethod)???
This is the answer: "Just exclude it" @WebMethod(exclude=true) public void updateBook(BookDTO bookDTO);