< Previous | Front page | Next >
Skip to end of metadata
Go to start of metadata

First Steps with SwitchYard

The purpose of this guide is to help new users get up and running with SwitchYard as quickly as possible.  We will pursue this objective with ruthless efficiency.  If you have questions that begin with "why" or "how", check out the other docs in the set.  If you have no time for any of that nonsense, then read on.


If you want to get down with SwitchYard, you'll need some Maven and Java to get the job done.

  • Java 8
  • Maven 3
  • Ant 1.8 (for installation)

Install EAP

SwitchYard is installed on top of an existing EAP installation, so the first step is to install EAP 6.4.  Visit the EAP Downloads page to download and install EAP 6.4 GA.

Install SwitchYard

Go to the SwitchYard Downloads page and download "switchyard-installer.zip" under Current Release.  Once downloaded, extract the zip and execute the ant script.  Assuming you installed EAP in /tmp, it would look something like this:

You will be asked for the location of your EAP server.   Enter the location at the prompts and let the installer complete.

Start the Server

In the bin/ directory of your EAP installation, you'll find a script called standalone.sh (*nix) and another called standalone.bat (Windows).  Execute the appropriate script for your platform.

The server will start in anywhere from 1 - 3 seconds depending on the age and price of your computing device.   You know SwitchYard is ready to rock once you see this:

Deploy an Application

There are many applications to chose from in the quickstarts/ directory of your distribution.  A nice one to start with is the remote-invoker application.  There are a number of ways to deploy an application to the SwitchYard runtime, but we'll go with Maven as it's righteous.  You will need a separate terminal or command window from the one where you started the server.

You will see output similar to the following after a successful deployment.

Invoke the Application

You can send a message to the deployed remote-invoker application using Maven as well.

After running the command, you'll see this in the command output:

You will see some output in the server console as well:


If you've made it this far, you're OK in my book.  Each quickstart has a Readme.md file which provides step-by-step instructions for deploying and testing.  Give some of the other apps a try and see what this crazy project can do.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jun 30, 2013

    Hello gang.

    The instructions are quite clear and a good start to discovering Swithcyard.  One thing to change however, is that the Quickstart  exercises require JAVA_HOME points to the JDK /JRE folder.

    Unfortunately that didn't get me 'moving' on the first example, remote-invoker.  I get a problem with a plugin, maven-site-plugin:

    Oddly, I don't find that module in the main POM or the remote-invoker POM. I looked-up the latest version, the error points to a 3-0-beta3 version.

    Also there's a typo int he remote-invoker POM, the project is called:

    • <name>Quickstart : Remove Invoker</name>

    Please advise on corrections?


    1. Jun 30, 2013

      Thanks for pointing out the typo.  Not sure what the issue is with the maven site plugin - no site goals are specifically used in the example (or any of the quickstarts).  What goal are you invoking with maven to produce this error?

      1. Jul 01, 2013

        Hey Keith,

        Thanks for your note.  I'm on Windows 7 64-bit.  I got as far as the:

        • mvn jboss-as:deploy

        Step.  Which just 'waits' and 'waits' and ... Eventually there's an error. 

        • Failed to execute goal org.jboss.as.plugins:jboss-as-maven-plugin:7.1.1.Final:deploy (default-cli) on project switchyard-quickstart-remote-invoker: Error executing FORCE_DEPLOY: Could not execute operation '{
          "operation" => "read-children-names",
          "child-type" => "deployment"
          }': java.net.ConnectException: JBAS012144: Could not connect to remote://localhost:9999. The connection timed out
          -> [Help 1]

        When I try to use a browser to spot, remote://localhost:9999, they don't "understand" remote:// protocol.  Http://localhost:9999 just times out, so I expect it is the server not responding in part.

        Following that.  I used IntelliJ to load the quickstart projects using Maven import.  I get Maven dependency errors (red underlines) resolving on the "maven-site-plugin" dependency.

        I admit that the two cases may not be related.  However that would mean there's two hiccups.  I dunno if the comments area is the right place for this, is there a Bugzilla page or forum to ask questions?



  2. Jul 01, 2013

    The best place of the discussion would be here:


    Did you start the server on the same machine where you are running the quickstart?   Re; the IntelliJ issue, I'm not sure what's going on there.  The quickstart works fine in Eclipse and from the command-line, so it's something with how the project is being managed in IntelliJ.  I'm not an InteliJ user, so unfortunately I can't provide more advice there.  Perhaps we can continue the discussion in the forum (link posted above) and there may be someone else who has hit the same issue with IntelliJ. 

    1. Jul 01, 2013

      Hi ya,

      Keeping it short; same machine.  Used the mvn command-line until things "didn't resolve" (or work as advertised).

      Yes definitely a forum discussion.