JAX-RS With Jersey Example

By -
JAX-RS is an  api that supports REST style of web services.  Following's are some of the implementation of the JAX-RS api
1) Jersey
2) RestEasy
3) Apache CXF

Following example demonstrate a simple Calculator Web service  and it's client using Jersey.

I have used the following tools and libraries
1) Eclipse 3.7 with WTP
2) Tomcat 6
3) Jersey

Full source code with more examples are available on Google Code at Sidd JAX-RS Code.

To start with  created a Java Web project and created some packages in that.
The package com.sidd.aschema contains all XSD, wsdl  etc files.  We also have a shchema file named SiddSimpleCalculator.xsd in the same package.
The project structure in eclipse looks like





Use the xjc command to generate the service classes from the  XSD as follows.

$  xjc -p com.sidd.rs.gent -d ../../../ -xmlschema SiddCalculatorSimple.xsd
where  com.sidd.rs is the package name and -d (directory) is the relative location where the classes should be generated.

The xjc coomand generates  the follwoing files.
com\sidd\rs\gent\MathRequest.java
com\sidd\rs\gent\MathResponse.java
com\sidd\rs\gent\MetaDataInfo.java
com\sidd\rs\gent\ObjectFactory.java
com\sidd\rs\gent\package-info.java

Service Class
Now write the service class.

@Path("/calculate")
public class CalculatorRSImpl implements CalculatorService {
 String operator;
 Integer numA;
 Integer numB;
@GET
 @Path("{opt}/{numa}/{numb}")
 @Produces("application/json") //"application/json"
 public MathOperationRS addTwoNumbers(@PathParam("opt") String opt,
@PathParam("numa") String numa, @PathParam("numb") String numb) {
  Integer result = doCalculateCoreLogic(opt,numa,numb);
  MathOperationRQ rq = new MathOperationRQ();
  MathOperationRS rs = new MathOperationRS();
  rq.setOperandA(new BigInteger(numa));
  rq.setOperandB(new BigInteger(numb));
  rq.setOperationTypeNew("Add");
  rs.setMathOperationRQ(rq);
  rs.setResult(result);
  return rs;
 }
}
The above class defines a webservice whose with path matched to "/calculate" at class level and also path "({opt}/{numa}/{numb}) at method level. So the Context path to invoke this method would be something like http://localhost:8080/MyJRS2/rest/calculate/add/10/20/


web.xml entry
The following declaration in web.xml will make the jersey to be deployed and make all root resources or provider classes in package com.sidd.rs

[servlet]
    [servlet-name]Jersey REST Service[/servlet-name]
    [servlet-class]com.sun.jersey.spi.container.servlet.ServletContainer[/servlet-class]
    [init-param]
      [param-name]com.sun.jersey.config.property.packages[/param-name]
      [param-value]com.sidd.rs[/param-value]
    [/init-param]
    [load-on-startup]1[/load-on-startup]
  [/servlet]


Library Put the required lib's under the web-inf/lib folder. Start Application Deploy the application into your tomcat and start the tomcat installation. You should be able to access the application using the following URL http://{SERVERNAME:PORTNUM}/MyJRS2/rest/calculate/add/10/20/ Result: Upon successful deployement we should be getting json response as follows 

{"MathOperationRQ":{"OperationTypeNew":"Add","OperandA":"10","OperandB":"20"},"Result":"30.0"}

Comments

Post a Comment

Popular posts from this blog

Difference between volatile and synchronized

By -
volatile is a field modifier, while synchronized modifies code blocks and methods. So we can specify three variations of a simple accessor using those two keywords: int i1; int geti1() {return i1;} volatile int i2; int geti2() {return i2;} int i3; synchronized int geti3() {return i3;} geti1() accesses the value currently stored in i1 in the current thread . Threads can have local copies of variables, and the data does not have to be the same as the data held in other threads. In particular, another thread may have updated i1 in it's thread, but the value in the current thread could be different from that updated value. In fact Java has the idea of a "main" memory, and this is the memory that holds the current "correct" value for variables. Threads can have their own copy of data for variables, and the thread copy can be different from the "main" memory. So in fact, it is possible for the "main"
Read more

Converting Java Map to String

By -
Java Collections framework, String manipulation etc is something that we often encounter in Development process. For processing collections (like checking null/empty, Intersection, Disjunction) We do have some of the very use full libraries. Some of the Collection related libraries are Apche Commons Collections and Google  Collections(Guava). Problem Use Case This article explains how to convert a Java Map to String(and vice versa) using different libraries and technique. One way is to use StringBuilder(Or String) and loop though the Map and build the String by applying some sort of separator ( for key:value and entry). Here we have to take care of the null value etc. Without Any Library If we want to convert the map to a String with key value separator and also individual entry seperator in the resulting String, we have to write code for that. For a simple Map, we have to iterate though the map, take care of the null values etc. Following is a sample to get String built
Read more

Masking Credit Card number in Java

By -
Sometimes we need to mask crucial information like Credit Card Numbers, CVV numbers etc before storing  or logging the information. This example mask Credit Card Number (Except last 4 Digit) from a Text which contains information along with Credit Card Number. The following example demonstrates how we can easily mask the credit card with Matcher and Pattern Classes. This Sample Code uses Matcher and Pattern. Pattern Used in this sample is not optimized for Credit Card Numbers, this pattern will get any numerical numbers in the String Content.  Based on the Credit Card Type a more efficient and Strict RegEx can be used to mask the Credit Card. /**Mask the Credit card number but last four digit value **/   Pattern PATTERN = Pattern.compile( "[0-9]+" ); String message = content; Matcher matcher = PATTERN.matcher(message); String maskingChar = "*"; StringBuilder finalMask = new StringBuilder(maskingChar);
Read more