JBoss.orgCommunity Documentation

Chapter 3. CDL Conformance

3.1. Purchasing Example
3.1.1. Running the Example
3.2. Brokerage Example
3.2.1. Running the Example

There are two examples to demonstrate the conversation aware ESB actions, and the conformance checking against a choreography. These are purchasing, a simple customer/supplier example with two associated Eclipse projects (purchasing-store and purchasing-models), and brokerage which extends the purchasing example through the introduction of a broker that mediates between potentially multiple suppliers to find the best deal, defined within three Eclipse projects (brokerage-broker, brokerage-supplier and brokerage-models).

These examples make use of a common Credit Agency service, defined within the common-creditAgency Eclipse project, and are executed through the use of client applications defined in the ${OverlordCDL}/samples/client folder.

Warning

At the moment, the conversation aware ESB runtime doesn't support the hot-deploy. That means if you update the business pojo class, such as $creditAgency/src/main/com/acme/services/creditAgency/CreditAgencyPurchase.java file, You need to re-deploy it, and then restart the server to cause it to take effect. This issue has been tracked under https://jira.jboss.org/jira/browse/SOAG-72. Will be fixed in the next release.

3.1. Purchasing Example

The purchasing example describes the interactions between a Buyer, Store and Credit Agency. The flow for this example would be:

To check conformance, we need to refer to the model and service implementation projects in the Eclipse environment. The purchasing-models project contains the CDL used to perform conformance checking on the src/main/resources/META-INF/jboss-esb.xml files within the other projects. A full explanation of the conversation aware ESB actions can be found in the Conversational Aware ESB section of the User Guide in the docs folder.

To provide a simple demonstration of the conformance checking:

  1. Double click on purchasing-store/src/main/resources/META-INF/jboss-esb.xml
  2. Scroll down to the second action, within the first service. This represents a ReceiveMessageAction and has a property defining the message type to be received.
  3. Edit the 'messageType' property value, e.g. by adding an 'X' to the end of the value.
  4. Then save the file. This should result in an error being generated, complaining about a type mismatch.

The information regarding the expected message type is obtained from the choreography description in the purchasing-models project. To identify the precise interaction within the choreography that this error relates to, select the context menu associated with the error and choose the Quick Fix menu item. This will display a dialog with a list of fixes, select the Show referenced description option and press OK. This will cause the relevant interaction within the choreography description to be displayed.

Another Quick Fix option associated with this error is Update from Referenced Description. By selecting this option, you will notice that the message type is changed back to the value without the 'X'.

  1. First step is to install the ESB services. (Presumely the JBoss ESB server started already) In a command window,
    • Go to the $Overlord/samples/purchasing/store folder and execute ant deploy
    • Go to the $Overlord/samples/common/creditAgency folder and execute ant deploy
  2. Go to the $Overlord/samples/client folder and execute ant runPurchasingClient, which will send a 'BuyRequest' message to the Store, which will then perform the credit check before returning a response to the client.

To see a different response from the client, change the isCreditValid method on the CreditAgencyPurchase class to return false, within the common/creditAgency ESB service implementation, and then re-deploy the Credit Agency service. Then when the client is re-run, a 'BuyFailed' message will be returned.

Tip

You can undeploy the corresponding esb artifact by through command ant undeploy in its directory, such as $Overlord/samples/purchasing/store

3.2. Brokerage Example

The brokerage example describes the interactions between a Customer, Broker, Supplier and Credit Agency. The flow for this example would be:

To check conformance, we need to refer to the model and service implementation projects in the Eclipse environment. The brokerage-models project contains the CDL used to perform conformance checking on the src/main/resources/META-INF/jboss-esb.xml files within the other brokerage projects. A full explanation of the conversation aware ESB actions can be found in the Conversational Aware ESB section of the User Guide in the docs folder.

To provide a simple demonstration of the conformance checking:

  1. Double click on brokerage-broker/src/main/resources/META-INF/jboss-esb.xml
  2. Scroll down to the second action, within the first service. This represents a ReceiveMessageAction and has a property defining the message type to be received.
  3. Edit the 'messageType' property value, e.g. by adding an 'X' to the end of the value.
  4. Then save the file. This should result in an error being generated, complaining about a type mismatch.

The information regarding the expected message type is obtained from the choreography description in the brokerage-models project. To identify the precise interaction within the choreography that this error relates to, select the context menu associated with the error and choose the Quick Fix menu item. This will display a dialog with a list of fixes, select the Show referenced description option and press OK. This will cause the relevant interaction within the choreography description to be displayed.

  1. First step is to install the ESB services (Presumely the JBoss ESB server started already) In a command window,
    • Go to the $Overlord/samples/brokerage/supplier folder and execute ant deploy
    • Go to the $Overlord/samples/brokerage/broker folder and execute ant deploy
    • Go to the $Overlord/samples/common/creditAgency folder and execute ant deploy
  2. Go to the $Overlord/samples/client folder and execute ant runBrokerageClient, which will initially send an 'enquiry' message to the Broker, which will communicate with the set of Suppliers to obtain the best quote. The client will then send a 'buy' request, which will result in the Broker performing a credit check before returning a response to the client.

Tip

You can undeploy the corresponding esb artifact by through command ant undeploy in its directory, such as $Overlord/samples/brokerage/supplier