Skip to end of metadata
Go to start of metadata

To develop a simple Spring service, you have to provide a Spring context.xml file, which has a .jar file containing the bean classes. Given below is an example of a simple Spring context.xml file specifying a particular bean with an ID and a class name found in the .jar file.

<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
    <bean id="SimpleEchoBean" 

The Echo Bean for this example is shown below. It can contain any type of service implementation.

package org.wso2.test;
 /*** Example EchoBean***/

 public class EchoBean {
   public String echoString(String input) {
     return input;

   public int echoInt(int input) {
     return input;

Deploying Spring Services

Follow the instructions below to deploy a Spring service to a running WSO2 AS instance.

  1. Log on to the product's management console and select Main -> Service -> Add -> Spring Service.
  2. In the Add Spring Service window that appears, specify the relevant files and click Upload. For example,

    Service Hierarchy
    Specifying a service hierarchy is optional. It allows you to customize your service endpoint reference. If the business logic of the same service changes over time, you can maintain multiple versions of the service by using service hierarchy at deployment.

    For example, consider a service named "SpringTest". 
    If the service hierarchy is not mentioned, then the service endpoint reference is ../services/SpringTest. With service hierarchy specified, for example as 1.0.0, the endpoint reference is ../services/1.0.0/SpringTest. Specifying a hierarchy is important if you want to manage services separately.

    If the files are not faulty, the
     Select Beans to Deploy page appears.

    If the beans specified in the spring context.xml file are mentioned in the .jar file, they will be displayed on this page.

  3. Select the Include check box associated with the the beans you want to expose as Web services and click Generate.
  4. If the generation is successful, a message appears prompting you to refresh the page. Click OK.
  5. Refresh the Deployed Services page in your product's management console to view the newly added services listed.

If your service implementation depends on any third-party libraries, you can copy them to the <AS_HOME>/repository/components/extensions directory and restart the server to get your service started.

  • No labels