Chapter 8. Getting Started with SwitchYard

Create a new SwitchYard project in JBoss Developer Studio.

1. Select File → New → Project. Then select the appropriate wizard: SwitchYard → SwitchYard Project and select Next.
2. Choose a project name (we are using switchyard-example) and select Next.
3. You are now prompted to provide SwitchYard Project Configuration. Choose the Bean and Scheduling SwitchYard components.
   This automatically adds the following dependencies to the project's pom.xml file so they are included when the project is built:

   <dependency>
     <groupId>org.switchyard.components</groupId>
     <artifactId>switchyard-component-bean</artifactId>
     <version>${switchyard.version}</version>
   </dependency>
   <dependency>
     <groupId>org.switchyard.components</groupId>
     <artifactId>switchyard-component-camel-quartz</artifactId>
     <version>${switchyard.version}</version>
   </dependency>

4. Select Finish to proceed.

<?xml version="1.0" encoding="UTF-8"?>
<sy:switchyard ... >
  <sca:composite name="switchyard-example" targetNamespace="urn:com.example.switchyard:switchyard-example:1.0">
  </sca:composite>
</sy:switchyard>

Add a Bean implementation.

1. Click back to the Design tab for the switchyard.xml file.
2. Click and drag a Bean implementation from the SwitchYard Palette onto your composite. This will automatically invoke the New Bean Service wizard. If the Palette is not yet visible, select Window → Show View → Other, then expand General and select Palette.
   
3. In the New Bean Service wizard, select the Interface link. This will open the New Java Interface wizard.
4. In the New Java Interface wizard, set the interface name to GreetingService and select Finish. This will take you back to the previous wizard.
5. Select Finish and save your changes.

<sca:component name="GreetingServiceBean">
  <bean:implementation.bean class="com.example.switchyard.switchyard_example.GreetingServiceBean"/>
    <sca:service name="GreetingService">
      <sca:interface.java interface="com.example.switchyard.switchyard_example.GreetingService"/>
    </sca:service>
</sca:component>

Customize the Bean.

1. Double-click on the component service (the small green chevron) and add the following greet() method.

   package com.example.switchyard.switchyard_example;
   
   public interface GreetingService {
   
   	void greet();
   }

2. Save your changes to the GreetingService file.
3. Now double-click on the GreetingServiceBean component and update the code as follows.

   package com.example.switchyard.switchyard_example;
   
   import org.switchyard.component.bean.Service;
   
   @Service(GreetingService.class)
   public class GreetingServiceBean implements GreetingService {
   
       private int times;
   
       @Override
       public final void greet() {
           System.out.println((times++) + ". Service executed.");
       }
   
   }

4. Save your changes to the GreetingServiceBean file.

Add a Service.

1. Click and drag a Service from the SwitchYard Palette onto your composite. This will automatically invoke the New Service wizard.
2. In the New Service wizard, select Browse. Then choose the GreetingService interface which was created in the previous step, and select OK.
3. Select Finish and save your changes to the switchyard.xml file.

<sca:service name="GreetingService">
  <sca:interface.java interface="com.example.switchyard.switchyard_example.GreetingService"/>
</sca:service>

Promote the component service.

1. Click on the tip of the large green chevron (representing the composite service), and drag your cursor to connect it to the tail of the smaller green chevron (representing the component service).
   
2. Save your changes.

<sca:service name="GreetingService" promote="GreetingServiceBean/GreetingService">
  <sca:interface.java interface="com.example.switchyard.switchyard_example.GreetingService"/>
</sca:service>

Add a Scheduling binding.

1. Click and drag a Scheduling binding from the SwitchYard Palette onto your composite service (the large green chevron). You will be prompted to provide Scheduling Binding Details.
2. Enter a name for your binding (we are using EverySecondJob) and enter the following value for Cron.

   * * * * * ?

   Important

   Ensure there is a single space between each of the characters above. Otherwise, the binding will not be created successfully.
3. Select Finish and save your changes.

<quartz:binding.quartz name="EverySecondJob">
  <quartz:name>EverySecondJob</quartz:name>
  <quartz:cron>* * * * * ?</quartz:cron>
</quartz:binding.quartz>

Build and deploy the application.

1. From within the application's top directory (containing the application's pom.xml file), build the application with the following command:

   mvn clean install

2. Start the application server.

   [me@localhost jboss-eap-6.1]$ ./bin/standalone.sh

3. Open a browser and navigate to http://localhost:9990/console/index.html.
4. Select Server → Manage Deployments from the Runtime view.
5. Select Add to open the Create Deployment wizard. Select Browse and then select the file to deploy from the project's target folder; for example, ~/workspace/switchyard-example/target/switchyard-example-0.0.1-SNAPSHOT.jar. Select Open.
6. Select Next to proceed to Step 2, then select Save.
7. Your deployment has been added to the list of Available Deployments but now you need to enable it. Select the deployment from the list, select the En/Disable button and then Confirm.

16:06:43,020 INFO  [stdout] (DefaultQuartzScheduler-camel-1_Worker-2) 1. Service executed.
16:06:44,019 INFO  [stdout] (DefaultQuartzScheduler-camel-1_Worker-3) 2. Service executed.
16:06:45,009 INFO  [stdout] (DefaultQuartzScheduler-camel-1_Worker-4) 3. Service executed.
16:06:46,009 INFO  [stdout] (DefaultQuartzScheduler-camel-1_Worker-5) 4. Service executed.
16:06:47,010 INFO  [stdout] (DefaultQuartzScheduler-camel-1_Worker-6) 5. Service executed.
16:06:48,011 INFO  [stdout] (DefaultQuartzScheduler-camel-1_Worker-7) 6. Service executed.
...

$ mvn clean install

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns2:reverse xmlns:ns2="urn:switchyard-quickstart:camel-soap-proxy:1.0">
            <text>Hello world!</text>
        </ns2:reverse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:reverseResponse xmlns:ns2="urn:switchyard-quickstart:camel-soap-proxy:1.0">
         <text>!dlrow olleH</text>
      </ns2:reverseResponse>
   </soap:Body>
</soap:Envelope>

Create a new SwitchYard project in JBoss Developer Studio.

1. Select File → New → Project. Then select the appropriate wizard: SwitchYard → SwitchYard Project and select Next.
2. Choose a project name (we are using switchyard-example) and select Next.
3. Select Finish to proceed.

Add the WSDL file for the web service as a resource.

1. Copy the WSDL file for the deployed service to .../switchyard-example/src/main/resources/META-INF. You can do this using wget. For example, on the command line, from within the application's META-INF directory, run:

   wget http://localhost:8080/ReverseService?wsdl -O ReverseService.wsdl

2. In JBoss Developer Studio, right-click on the project in the Project Explorer view, and select Refresh. Navigate the project files to confirm the file has been added as a resource.

Add a Camel (XML) implementation.

1. Open the Design tab for the switchyard.xml file.
2. Click and drag a Camel (XML) implementation from the SwitchYard Palette onto the composite (the blank canvas). This invokes a wizard to help you create a new Camel route file resource. If the Palette is not yet visible, select Window → Show View → Other, then expand General and select Palette.
3. In the wizard, select the WSDL option, and browse to select the ReverseService.wsdl file for the interface.
4. Change the Service Name to ProxyService.
5. Select Finish and save the project.

Promote the component service.

1. Move your cursor over the component service and select Promote Service.
   
2. You are prompted to provide details for the promotion. Leave the default values. Select Finish, and save the project.
   Your component service has now been promoted to a corresponding composite service (represented by the large green chevron):
   

Create a component reference.

1. Move your cursor over the component and select Reference.
   
2. You are prompted to provide details for the new reference. Select the WSDL option, and browse to select the ReverseService.wsdl file for the interface. Leave the default Service Name as ReverseService.
3. Select Finish and save the project.
   Your component now has a component reference (small purple chevron). An error appears until it is promoted in the next step.
   

Promote the component reference.

1. Move your cursor over the component reference and select Promote Reference.
   
2. You are prompted to provide details for the promotion. Leave the default values. Select Finish, and save the project.
   Your component reference has now been promoted to a corresponding composite reference (represented by the large purple chevron):
   

Create a route from the proxy endpoint to the web service endpoint.

1. Open the route.xml file. You can open it from the Project Explorer or by double-clicking on the Camel Route component. By default it opens in the Design view. Select the Source view to expose the Spring XML.
2. From looking at the XML, you can see that, currently, any traffic received from the proxy service will be logged.
   To forward this traffic on to the web service, add the web service as an endpoint:

   <?xml version="1.0" encoding="ASCII"?>
   <routes xmlns="http://camel.apache.org/schema/spring">
     <route>
       <from uri="switchyard://ProxyService"/>
       <log message="ProxyService - message received: ${body}"/>
       <to uri="switchyard://ReverseService"/>
     </route>
   </routes>

3. Save your changes.

Add a SOAP binding to the composite service.

1. Drag a SOAP binding from the SwitchYard Palette onto the composite service (ProxyService).
2. You are prompted for SOAP binding details. Set the following values, leaving all other default values:

   Property	Value
   Name	soap-proxy
   Context path	proxy
   Server Port	:${webPort}

3. Select Finish and save your changes.

Add a SOAP binding to the composite reference.

1. Drag a SOAP binding from the SwitchYard Palette onto the composite reference (ReverseService).
2. You are prompted for SOAP binding details. Set the following values, leaving all other default values:

   Property	Value
   Name	soap-service
   Endpoint Address	http://localhost:${webPort}/ReverseService

3. Select Finish and save your changes.

Define the value of webPort.

1. From the Domain view of the switchyard.xml file, add a domain property with the following values:

   Name	Value
   webPort	${org.switchyard.component.http.standalone.port:8080}

2. Save your changes.

Build and deploy the web service proxy.

1. From within the application's top directory (containing the application's pom.xml file), build the application with the following command:

   mvn clean install

2. Open a browser and navigate to http://localhost:9990/console/index.html.
3. Select Server → Manage Deployments from the Runtime view.
4. Select Add to open the Create Deployment wizard. Select Browse and then select the file to deploy from the project's target folder; for example, ~/workspace/switchyard-example/target/switchyard-example-0.0.1-SNAPSHOT.jar. Select Open.
5. Select Next to proceed to Step 2, then select Save.
6. Your deployment has been added to the list of Available Deployments but now you need to enable it. Select the deployment from the list, select the En/Disable button and then Confirm.

Test your application.

1. Use your favorite SOAP client to send a message to test the proxy service in the same way as you did when you tested the web service, only use the proxy address instead. After sending a message, you receive a response with the text reversed, the same as when it was sent directly to the web service. However, when sending to the proxy, you can see that the message is also logged on the server as prescribed by the route.xml in the proxy service; for example:

   11:50:29,100 INFO  [route2] (http-/127.0.0.1:8080-14) ProxyService - message received:
   	<ns2:reverse xmlns:ns2="urn:switchyard-quickstart:camel-soap-proxy:1.0">
   		<text>Hello world!</text>
   	</ns2:reverse>