Getting started with Cougar

This guide is intended as a 5 minute guide to getting a service up and running with Cougar. Cougar has a rich set of features which we couldn’t hope to cover in such a manner, so for other guides and references, please check out our documentation hub.

We’re going to create an initial Cougar based project, define and implement an operation on a service interface, run it and call it.

Basic project structure

Creating the basic project structure and config can be a little tedious, so we’re going to use the cougar archetype to generate the basic layout:

mvn archetype:generate -DarchetypeRepository= -DarchetypeGroupId= -DarchetypeArtifactId= -DarchetypeVersion=

Enter the values shown when prompted.

Your first service interface

Now we need to define an operation that we can call later, we’re going to expose a little echo operation to show you the basics.

Service interfaces are described in an XML document called an IDD (Interface Definition Document), which meets the Cougar IDL Schema. This document is enhanced by extensions which provide transport specific binding information, which can either be held in a seperate document, or added inline. We’ll put them inline to make life simple.

TODO

Generate your stubs

Simply building your project will generate the required stubs. Compilation will fail in the application module since the new operation hasn’t been implemented yet:

mvn install

Code your implementation

Now we’ve got our interface stub generated we can implement our new method. We’re just going to be implementing the synchronous version of the interface for now, as it’s simpler.

Open up blah/blha/blah/SomeServiceImpl.java in your favourite editor (or open the whole project in your IDE) and add the following method body:

TODO

TODO: what does this all mean

Running your service

Before we can run your new service we need to build it:

mvn install

And now to launch:

cd launch
mvn exec:java

You will now see a bunch of console output, which should end with the last few lines as follows:

XYZ

We’re now ready to call our operation.