My View and Experience: Creating WebService

Let's create a web service.

We will use maven as build tool and it will makes our life easy.

I will be using STS , Spring Tool Suite.

First we create a maven web project using STS.

It will have below structure.

Web Project structure

you can build war file using maven tool.

Go to folder where "pom.xml" file exists. and open a command window

execute the maven command

===============

mvn clean package

==============

above command will build the war file.
eg: Here my folder path is "C:\eclipseWorkSpace\2015-01-19_SpringSecurity\Rest>" where "pom.xml" file reside and remember this the basic web project create with maven using STS. you can create a web project using maven commands directly also. So when i execute the command "mvn clean package " in the command line I have to change the directory to the above mention folder where "pom.xml" resides.
you will see the war file will be created inside target directory. "C:\eclipseWorkSpace\2015-01-19_SpringSecurity\Rest\target"

Web project structure after building war file - Rest.war created

Now get the war file and deploy in the tomcat.
to deploy copy "Rest.war" and paste it inside "webapps" folder inside tomcat.

To refresh your knowledge in tomcat, we can get the tomcat from site and unzip and go to "bin" folder
Here in my case it is "C:\Softwares\Apache\Apache Tomcat\Apache Tomcat 8.0.3\apache-tomcat-8.0.3\bin" and open commad window. set the path to bin directory. execute the command "catalina.bat run"

===================================
C:\Softwares\Apache\Apache Tomcat\Apache Tomcat 8.0.3\apache-tomcat-8.0.3\bin>catalina.bat run
===================================

you will see the starting of the tomcat and trace will shown in the same command window.
If you need you can also run "startup " also, but it will have a seperate window open and run tomcat.

Now you application is deployed in tomcat and to test open browser and type "http://localhost:8080/Rest/" and you will see the default message or default page created with the app showing "Hello World!" in the browser.

Steps we did so far
========
1. create a maven web project using STS
2. build the project using maven - command line "mvn clean package"
3. deploy the web project "war file" in the tomcat and view in the browser.

Above are the simple steps to create a default web project , pakage war file , deploy and test whether create project really works.

Below are the inside of the files created in the web project. Initially we do not have lots of files only basic files and folder structure will be as shown above and i won't try to explain it again.

Web.xml
======================================================================
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
<display-name>Archetype Created Web Application</display-name>
</web-app>
======================================================================

index.jsp
======================================================================
<html>
<body>
<h2>Hello World!</h2>
</body>
</html>
======================================================================

pom.properties
======================================================================
#Generated by Maven
#Fri Jun 26 10:41:37 IST 2015
version=0.0.1-SNAPSHOT
groupId=com.webservice.rest
artifactId=Rest

======================================================================

pom.xml
======================================================================
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.webservice.rest</groupId>
<artifactId>Rest</artifactId>
<packaging>war</packaging>
<version>0.0.1-SNAPSHOT</version>
<name>Rest Maven Webapp</name>
<url>http://maven.apache.org</url>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<finalName>Rest</finalName>
</build>
</project>
======================================================================

Now let's go to create the web service application.

Here we use Apache CXF , spring , Jaxon, JAXB

First I will add all coding

REST Web Service

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

All dependencies

Pom.xml

======================================================================

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<groupId>com.webservice.rest</groupId>

<version>0.0.1-SNAPSHOT</version>

<name>Rest Maven Webapp</name>

<url>http://maven.apache.org</url>

<groupId>junit</groupId>

<artifactId>junit</artifactId>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-core</artifactId>

<version>4.1.2.RELEASE</version>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-context</artifactId>

<version>4.1.2.RELEASE</version>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-web</artifactId>

<version>4.1.2.RELEASE</version>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-beans</artifactId>

<version>4.1.2.RELEASE</version>

</dependency>

<groupId>javax.xml.bind</groupId>

</dependency>

<groupId>org.apache.cxf</groupId>

<artifactId>cxf-rt-frontend-jaxws</artifactId>

</dependency>

<groupId>org.apache.cxf</groupId>

<artifactId>cxf-rt-transports-http</artifactId>

</dependency>

<groupId>org.apache.cxf</groupId>

<artifactId>cxf-rt-transports-http-jetty</artifactId>

</dependency>

<groupId>org.apache.cxf</groupId>

<artifactId>cxf-rt-frontend-jaxrs</artifactId>

</dependency>

<groupId>org.codehaus.jackson</groupId>

<artifactId>jackson-jaxrs</artifactId>

</dependency>

</dependencies>

<build>

</build>

</project>

======================================================================

web.xml

======================================================================

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

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns="http://java.sun.com/xml/ns/javaee"

xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"

id="WebApp_ID" version="3.0">

<display-name>Archetype Created Web Application</display-name>

<welcome-file-list>

<welcome-file>index.jsp</welcome-file>

</welcome-file-list>

<context-param>

<param-name>contextConfigLocation</param-name>

<param-value>/WEB-INF/beans.xml</param-value>

</context-param>

<servlet-name>CXFServlet</servlet-name>

<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>

</servlet>

<servlet-mapping>

<servlet-name>CXFServlet</servlet-name>

<url-pattern>/rest/*</url-pattern>

</servlet-mapping>

<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

</listener>

</web-app>

======================================================================

Employee.java -->model class

======================================================================

package com.rest.cxfrestservice.model;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "employee")

public class Employee {

private String firstName;

private String lastName;

private String employeeId;

private String email;

private String dateOfJoining;

private String department;

public String getFirstName() {

return firstName;

}

public void setFirstName(String firstName) {

this.firstName = firstName;

}

public String getLastName() {

return lastName;

}

public void setLastName(String lastName) {

this.lastName = lastName;

}

public String getEmployeeId() {

return employeeId;

}

public void setEmployeeId(String employeeId) {

this.employeeId = employeeId;

}

public String getEmail() {

return email;

}

public void setEmail(String email) {

this.email = email;

}

public String getDateOfJoining() {

return dateOfJoining;

}

public void setDateOfJoining(String dateOfJoining) {

this.dateOfJoining = dateOfJoining;

}

public String getDepartment() {

return department;

}

public void setDepartment(String department) {

this.department = department;

}

======================================================================

EmployeeDao .java --> dao class

======================================================================

package com.rest.cxfrestservice.dao;

import com.rest.cxfrestservice.model.Employee;

public class EmployeeDao {

public Employee getEmployeeDetails(String employeeId) {

Employee emp = new Employee();

emp.setDateOfJoining("01-02-2001");

emp.setDepartment("Sales");

emp.setEmail("test@example.com");

emp.setEmployeeId("675436");

emp.setFirstName("John");

emp.setLastName("Smith");

return emp;

}

======================================================================

CxfRestService .java --> Interface for Employee Service.

======================================================================

package com.rest.cxfrestservice.service;

import javax.jws.WebService;

import javax.ws.rs.GET;

import javax.ws.rs.Path;

import javax.ws.rs.Produces;

import javax.ws.rs.QueryParam;

import javax.ws.rs.core.MediaType;

import javax.ws.rs.core.Response;

/**

* Interface for Employee Service.

* @author APRASAD

@Path("/")

@WebService(name="employeeService" , targetNamespace="http://localhost/cxf-rest/example")

public interface CxfRestService {

@GET

@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })

@Path("/getemployeedetail")

public Response getEmployeeDetails(

@QueryParam("employeeId") String employeeId);

}

======================================================================

CxfRestServiceImpl .java --> implementation of for Employee Service.

======================================================================

package com.rest.cxfrestservice.service;

import javax.ws.rs.core.Response;

import org.springframework.beans.factory.annotation.Autowired;

import com.rest.cxfrestservice.dao.EmployeeDao;

public class CxfRestServiceImpl implements CxfRestService {

@Autowired

private EmployeeDao employeeDao;

public Response getEmployeeDetails(String employeeId) {

if (employeeId == null) {

return Response.status(Response.Status.BAD_REQUEST).build();

}

return Response.ok(employeeDao.getEmployeeDetails(employeeId)).build();

}

======================================================================

bean.xml

======================================================================

<beans xmlns="http://www.springframework.org/schema/beans"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"

xmlns:jaxws="http://cxf.apache.org/jaxws" xmlns:jaxrs="http://cxf.apache.org/jaxrs"

xsi:schemaLocation="http://www.springframework.org/schema/beans

http://www.springframework.org/schema/beans/spring-beans.xsd

http://cxf.apache.org/jaxrs

http://cxf.apache.org/schemas/jaxrs.xsd

http://cxf.apache.org/jaxws

http://cxf.apache.org/schemas/jaxws.xsd

http://www.springframework.org/schema/context

http://www.springframework.org/schema/context/spring-context-4.1.xsd">

<context:component-scan base-package="com.rest.*" />

<jaxrs:server id="employeeService" address="/employeeservices">

<jaxrs:providers>

</jaxrs:providers>

<jaxrs:serviceBeans>

</jaxrs:serviceBeans>

<jaxrs:extensionMappings>

</jaxrs:extensionMappings>

</jaxrs:server>

</beans>

======================================================================

access above depolyed jar with

http://localhost:8080/Rest/rest/employeeservices/getemployeedetail?employeeId=1

you will get out as

======================================================================

<department>Sales</department>

<email>test@example.com</email>

<lastName>Smith</lastName>

</employee>

======================================================================

http://localhost:8080/Rest/rest/employeeservices?_wadl

======================================================================

</request>

</response>

</method>

</resource>

</resources>

</application>

======================================================================

http://www.lessonslab.com/building-restful-webservices-using-apache-cxf/150/

My View and Experience

Thursday, June 25, 2015

Creating WebService

No comments:

Post a Comment