TIBCO ActiveMatrix Service Bus Getting Started. Software Release 2.3 February 2010

Transcription

1 TIBCO ActiveMatrix Service Bus Getting Started Software Release 2.3 February 2010

2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN TIBCO ACTIVEMATRIX SERVICE BUS INSTALLATION) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIB, TIBCO, TIBCO Software, TIBCO ActiveMatrix, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO AutoMediate, AutoMediate, TIBCO Business Studio, and TIBCO ActiveMatrix BusinessWorks are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. PLEASE SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3 iii Contents Preface v Related Documentation vi TIBCO Matrix Documentation vi Third-Party Documentation vi Typographical Conventions viii How to Contact TIBCO Support xi Chapter 1 Introduction Before You Begin What is ActiveMatrix Service Bus? What ActiveMatrix Service Bus Does About This Guide What You ll Learn in this Guide Where to Find More Information Chapter 2 Working with TIBCO Business Studio Working with TIBCO Business Studio Starting TIBCO Business Studio Working with ActiveMatrix SOA Projects Creating ActiveMatrix SOA Projects Importing Projects and Files Chapter 3 Hello World Mediation Example Hello World Mediation Example Overview Sample Code Setting up the Hello World ActiveMatrix SOA Project Starting TIBCO Business Studio Creating the Hello World ActiveMatrix SOA Project and Folders Importing the WSDL Files Into the Hello World Project Developing the Hello World Mediation Component Creating the Hello World Mediation Flow Diagram Creating the Hello World Mediation Component Creating Shared Resources and Profiles Creating Shared Resources

4 iv Contents Adding Shared Resource Profiles to the Composite Creating the Hello World SOAP Services and References Creating the HelloWorld Service Configuring the Transport: Adding the HTTP Connection to the Service Binding the Service to the Target Component Service Creating the HelloWorld Reference Adding the JMS Connection to the Reference Binding the Reference to the Target Component Reference Final Composite Packaging the Hello World Example Updating the HelloWorld Service Assembly Creating the Deployable Archive Deploying and Starting the Hello World Service Assembly Uploading the Service Assembly Archive Enabling and Installing Shared Resources Mapping Resources Deploying and Starting the Service Assembly Generating the Concrete WSDL File Running the HelloWorld Example Executing the Target Services Sending a Message to the Mediation Service Chapter 4 Setting up and Starting ActiveMatrix Administrator and Runtime Overview Starting the Database Server Creating TIBCO ActiveMatrix Administrator Server and ActiveMatrix Node Starting TIBCO Servers Starting the TIBCO Management Daemon Process Starting the TIBCO ActiveMatrix Administrator Server Starting the TIBCO Enterprise Message Service Server Logging Into TIBCO ActiveMatrix Administrator User Interface Default Environment and Node Viewing the Default Environment Creating the Default Environment and Node Starting the node1 Node Enabling Monitoring Creating the JMS Monitoring Shared Resource Definition Configuring Monitoring

5 v Preface TIBCO ActiveMatrix is a scalable and extensible platform for developing, deploying, and managing applications that conform to a service-oriented architecture. Mediation within ActiveMatrix allows your enterprise to easily adapt to changing requirements by providing an easy-to-use interface for managing mediation flows. TIBCO ActiveMatrix Service Bus is an enterprise service bus that helps organizations bridge the mediation gap in their SOA infrastructures. Topics Related Documentation, page vi Typographical Conventions, page viii How to Contact TIBCO Support, page xi

6 vi Related Documentation Related Documentation This section lists documentation resources you may find useful. TIBCO Matrix Documentation The following documents form the TIBCO Matrix documentation set: TIBCO ActiveMatrix Service Bus Installation Read this manual for instructions on site preparation and installation. TIBCO ActiveMatrix Concepts Read this manual before reading any other manual in the documentation set. This manual describes terminology and concepts of the ActiveMatrix platform. The other manuals in the documentation set assume you are familiar with the information in this manual. TIBCO ActiveMatrix Administration Read this manual to learn how to manage the ActiveMatrix runtime and deploy and manage ActiveMatrix services. TIBCO ActiveMatrix Composite Editor User s Guide Read this manual to learn how to develop, debug, and package ActiveMatrix composites. Read this manual for a quick introduction to the product that walks you through a brief tutorial. TIBCO ActiveMatrix Service Bus Mediation Design Guide Read this manual to learn how to develop mediation flows using the Mediation Editor. TIBCO ActiveMatrix Service Bus Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release. Third-Party Documentation TIBCO ActiveMatrix software supports the following standards: Service Component Architecture ecifications

7 Preface vii World Wide Web Consortium web services activity Simple Object Access Protocol (SOAP) 1.1 W3C Note WSDL 1.1 W3C Note OASIS UDDI Version 2 OASIS Standard

8 viii Typographical Conventions Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention TIBCO_HOME ENV_NAME ENV_HOME AMX_HOME AMX_ADMIN_HOME code font Use Many TIBCO products are installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The value of TIBCO_HOME depends on the operating system. For example, on Windows systems the default value is C:\tibco. Other TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments. An installation environment consists of the following properties: Name Identifies the installation environment. The name is appended to the name of Windows services created by the installer and is used in the path to the product in the Windows Start > All Programs menu. This directory is referenced in documentation as ENV_NAME. Description Provides information about what the environment contains or is used for. Path The directory into which the product is installed. This directory is referenced in documentation as ENV_HOME. The value of ENV_HOME depends on the operating system. For example, on Windows systems the default value is C:\tibco. TIBCO ActiveMatrix installs into a directory inside ENV_HOME. This directory is referenced in documentation as AMX_HOME. The value of AMX_HOME depends on the operating system. For example, on Windows systems the default value is C:\tibco\amx\. TIBCO ActiveMatrix Administrator installs into a directory inside ENV_HOME. This directory is referenced in documentation as AMX_ADMIN_HOME. The value of AMX_ADMIN_HOME depends on the operating system. For example, on Windows systems the default value is C:\tibco\amxadministrator\. Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process.

9 Preface ix Table 1 General Typographical Conventions (Cont d) Convention bold code font Use Bold code font is used in the following ways: In procedures, to indicate what a user types. For example: Type admin. In large code samples, to indicate the parts of the sample that are of particular interest. In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable disable] italic font Italic font is used in the following ways: To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal. To indicate a variable in a command or code syntax that you must replace. For example: MyCommand pathname Key combinations Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C. Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q. The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances. The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result. The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

10 x Typographical Conventions Table 2 Syntax Typographical Conventions Convention Use [ ] An optional item in a command or code syntax. For example: MyCommand [optional_parameter] required_parameter A logical OR that separates multiple items of which only one may be chosen. For example, you can select only one of the following parameters: MyCommand para1 param2 param3 { } A logical group of items in a command. Other syntax notations may appear within each logical group. For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4. MyCommand {param1 param2} {param3 param4} In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4: MyCommand {param1 param2} {param3 param4} In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4. MyCommand param1 [param2] {param3 param4}

11 Preface xi How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows. For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: If you already have a valid maintenance or support contract, visit this site: Entry to this site requires a user name and password. If you do not have a user name, you can request one.

12 xii How to Contact TIBCO Support

13 1 Chapter 1 Introduction This guide introduces TIBCO ActiveMatrix Service Bus, which is a service development and deployment product in the ActiveMatrix family of products. Topics Before You Begin, page 2 What is ActiveMatrix Service Bus?, page 3 About This Guide, page 5 Where to Find More Information, page 7

14 2 Chapter 1 Introduction Before You Begin Before starting this guide, it s a good idea to become familiar with ActiveMatrix platform concepts and terminology. It is not necessary to learn all aspects of the ActiveMatrix platform, but do read Chapter 1 of TIBCO ActiveMatrix Concepts to learn about the terminology that is used in this guide. It s also a good idea to become familiar with TIBCO Business Studio, which ActiveMatrix Service Bus uses as its design environment. Chapter 2, Working with TIBCO Business Studio, is a general guide to working with Business Studio and ActiveMatrix SOA projects. If you re not familiar with Business Studio, step through that chapter before working on the Hello World example in Chapter 3.

15 What is ActiveMatrix Service Bus? 3 What is ActiveMatrix Service Bus? TIBCO ActiveMatrix is a platform for building and deploying applications based on a service-oriented architecture (SOA). ActiveMatrix Service Bus is a service development and deployment product within the TIBCO ActiveMatrix family of products. TIBCO Business Studio is the ActiveMatrix Service Bus design environment. Chapter 2 of this guide introduces Business Studio, which you ll use as you follow the Hello World Mediation example in Chapter 3. ActiveMatrix Service Bus includes: TIBCO Business Studio The ActiveMatrix Service Bus design environment, which includes the Composite Editor and the Mediation Flow Editor. In this guide, you ll use Business Studio to create a Hello World ActiveMatrix SOA project and to develop a Hello World mediation component. Mediation, SOAP, Adapter, and JMS containers ActiveMatrix runtime entities that host component implementations and service bindings. TIBCO Enterprise Message Service Manages message exchanges. TIBCO ActiveMatrix Administrator Manages the enterprise, environment, and services. Policy Agent Enforces policies such as security authentication at end-points (URLs at which a consumer can access a service). What ActiveMatrix Service Bus Does The ActiveMatrix Service Bus layer of the ActiveMatrix product is designed for easy implementation of service mediation. ActiveMatrix Service Bus service mediation manages interactions across heterogeneous, deployed services without affecting how consumers invoke and use those services.

16 4 Chapter 1 Introduction For example, in an IT group with multiple silos of services, each silo might have its own transport protocol or data format. If the business requires sharing services across silos, it can use ActiveMatrix Service Bus to enable mediation among those services. ActiveMatrix software supports the SOA principles of application architecture, in which applications are composed of services that interact by exchanging messages. ActiveMatrix services use Web Services Description Language (WSDL) documents to specify the messages that are required to access a service. Each service in an interaction is either a service provider, or a service consumer: The service provider publishes a WSDL document that describes the services it offers. The service consumer uses the WSDL document to determine the available services and the messages that are required to access those services. The services that ActiveMatrix Service Bus can mediate can be created in BusinessWorks, ActiveMatrix, J2EE, or.net. See TIBCO ActiveMatrix Concepts for a complete overview of ActiveMatrix and the SOA architecture, as well as a glossary that describes terms used in the ActiveMatrix family of products ActiveMatrix Service Bus provides: Transport protocol bridging Makes deployed services available on different transport protocols, without the need to make changes to the service and then re-deploy it. For example, an organization that has standardized on using SOAP over JMS for its services, but wants these services available on HTTP or SMTP, can use ActiveMatrix Service Bus to bridge the protocols. Routing and service version management Ensures that an incoming request from a consumer is routed to the appropriate version of the service. Transformations Transforms data formats from an incoming request to the format that is expected by the service. Re-use enablement Abstracts common functionality across services into the mediation layer for example, validation, logging, and error-handling. Mediation Enables combining internal services into public services, or hiding internal services, so that users of the public services are insulated from changes to the internal services. Efficient on-boarding of services Enables you to quickly on-board a large number of services, so that you can efficiently manage multiple versions of services that are deployed on different platforms.

17 About This Guide 5 About This Guide The guide uses examples to show how to: Create services, components, mediation flows, and shared resources, and package them into a deployment packaged (called a service assembly) Create and start the ActiveMatrix run-time environment Deploy and run the services you created Invoke the services with a simple SOAP client The services in this guide are simple, so that you can focus on how to use the ActiveMatrix development and administration tools. After you complete this guide, you will be able to apply the methodology to your own services. What You ll Learn in this Guide This guide steps you through these processes: Developing ActiveMatrix Service Bus components and services Starting TIBCO and TIBCO ActiveMatrix servers Creating and Starting the TIBCO ActiveMatrix run-time environment Deploying the components and services to the run-time environment Here s an overview of what you ll learn in this guide, chapter-by-chapter: Chapter 2, Working with TIBCO Business Studio Describes the basic operations in TIBCO Business Studio that you might need to perform in the Hello World example in Chapter 3. In this chapter you ll: Start TIBCO Business Studio Create a TIBCO ActiveMatrix SOA project, and import abstract WSDL files into the project The procedures in this chapter are generic, and are not tailored to the Hello World example. Familiarize yourself with the procedures in this chapter, but do not perform them you ll perform specific procedures in Chapter 3, Hello World Mediation Example.

18 6 Chapter 1 Introduction Chapter 3, Hello World Mediation Example Chapter 4, Setting up and Starting ActiveMatrix Administrator and Runtime Includes a simple tutorial to introduce you to service mediation in TIBCO ActiveMatrix. In this chapter, you ll: Create and configure a mediation component and mediation flow diagram Create and configure a SOAP service and a JMS reference Package the service, components, and implementation artifacts into a service assembly Upload the service assembly to the environment, map service units to nodes, and map shared resource profiles to a shared resource Deploy and start the service assembly Invoke a SOAP service from a client Describes how to configure and start the infrastructure and administration environment that is required to run the example in Chapter 3. Because the environment requires some overhead that might slow the design environment, follow the example in Chapter 3 until instructed to perform the procedures described in this chapter. In this chapter, you ll: Start TIBCO and TIBCO ActiveMatrix infrastructure servers Set up and start the ActiveMatrix runtime environment, including an ActiveMatrix node

19 Where to Find More Information 7 Where to Find More Information After you complete this guide, you can find more information in these guides: Defining and packaging ActiveMatrix services in TIBCO ActiveMatrix Composite Editor User s Guide Developing ActiveMatrix components in TIBCO ActiveMatrix Service Grid Component Developer s Guide Developing mediation flows in TIBCO ActiveMatrix Service Bus Mediation Design Guide Administration and deployment in TIBCO ActiveMatrix Administration

20 8 Chapter 1 Introduction

21 9 Chapter 2 Working with TIBCO Business Studio The TIBCO ActiveMatrix service development tools consist of TIBCO Business Studio and a set of ActiveMatrix plug-ins. This chapter is a general guide to working with TIBCO Business Studio and ActiveMatrix SOA projects you can review it before you begin, then refer to it as you follow the tutorial information in this guide. Topics Working with TIBCO Business Studio, page 10 Working with ActiveMatrix SOA Projects, page 11

22 10 Chapter 2 Working with TIBCO Business Studio Working with TIBCO Business Studio The TIBCO ActiveMatrix development tools consist of TIBCO Business Studio Workbench and a set of TIBCO ActiveMatrix plug-ins. This section describes how to start TIBCO Business Studio. For information on TIBCO Business Studio, refer to the Workbench User Guide in the Workbench online help. To view the online help, select Help > Help Contents. Starting TIBCO Business Studio To start TIBCO Business Studio: ] 1. Execute one of these platform-specific commands: ] Windows From the Start menu, follow the path All Programs > TIBCO > ENV_NAME > TIBCO Business Studio 2.3 > TIBCO Business Studio. From the command line on the Windows platform, run ENV_HOME/BusinessStudio/TIBCOBusinessStudio.exe. UNIX Run ENV_HOME/BusinessStudio/TIBCOBusinessStudio. 1. The Workspace Launcher appears. Accept the default workspace or browse to a new workspace. 2. Click OK. 3. The first time you run TIBCO Business Studio it displays a Welcome screen. Dismiss the screen by clicking the X next to Welcome.

23 Working with ActiveMatrix SOA Projects 11 Working with ActiveMatrix SOA Projects This section describes how to create ActiveMatrix SOA projects, import files into a project, and import sample projects. Creating ActiveMatrix SOA Projects ActiveMatrix SOA projects are containers for the ActiveMatrix resources that you can develop with TIBCO Business Studio. To create anactivematrix SOA project: 1. Select File > New > ActiveMatrix Resources... > ActiveMatrix SOA Project. 2. Click Next. 3. Type a name in the Project name field. 4. Select the appropriate template. 5. Click Finish. The new project is created. It appears in the Project Explorer tree with these ActiveMatrix folders: Composites Deployment Packages Mediation Flows Service Descriptors Shared Resources A composite and service assembly are created in the project, based on the project name you typed in step 3. If the name you typed is ProjName, for example, a composite named ProjName.composite is created in the Composites folder and a service assembly named ProjName.saf is created in Deployment Packages folder. Importing Projects and Files This section describes how to import sample projects into a workspace, and how to import WSDL files into an ActiveMatrix SOA project.

24 12 Chapter 2 Working with TIBCO Business Studio Importing Sample Projects When running Business Studio on Linux when using JDK 1.6 you may see multiple errors when importing samples. This occurs because of the maximum number of open files allowed. To change the limit of the maximum files that can be open: 1. Log in as a root user. 2. Edit /etc/security/limits.cof. 3. Add or edit the line: * hard nofile The * refers to any user. Alternatively you may put a user name where the user that will run Business Studio belongs to the group somegroup. Set the number indicating the limit to a large number. 4. Save the file, log out and log back in and then start Business Studio. To import sample projects: 1. Select File > Import... to open the Import dialog box. 2. Expand the General node. 3. Select Existing Projects into Workspace. 4. Click Next to open the Import Projects dialog box. 5. Click the Browse... button to the right of the Select root directory field. a. Navigate to AMX_HOME/2.3/samples/amsb or AMX_HOME/2.3/samples/amsg. b. Select one of the sample directories. c. Click OK. 6. In the Projects area, check the checkboxes next to the projects to import. 7. Ensure that the Copy projects into workspace checkbox is selected. 8. Click Finish. The projects you imported are now listed in the Project Explorer tree. Importing WSDL Files At various points throughout the example, you need to import WSDL files into the ActiveMatrix SOA project. To import WSDL files from the file system:

25 Working with ActiveMatrix SOA Projects In the Project Explorer view, right-click the ProjName > Service Descriptors folder and select Import > Service Import Wizard. 2. Accept the default selection Import from a File and click Next to open the WSDL Selection dialog box. 3. Click the Ellipsis button to the right of the Source Location field. a. Navigate to a directory containing the WSDL file. b. Click the file and then click Open. 4. Click Next. 5. Click Finish to import the WSDL file into your project.

26 14 Chapter 2 Working with TIBCO Business Studio

27 15 Chapter 3 Hello World Mediation Example This chapter is a tutorial that guides you through creating a mediation example, using mediation components. Topics Hello World Mediation Example Overview, page 16 Setting up the Hello World ActiveMatrix SOA Project, page 18 Developing the Hello World Mediation Component, page 21 Creating Shared Resources and Profiles, page 25 Creating the Hello World SOAP Services and References, page 29 Packaging the Hello World Example, page 33 Deploying and Starting the Hello World Service Assembly, page 34 Running the HelloWorld Example, page 38

28 16 Chapter 3 Hello World Mediation Example Hello World Mediation Example Overview This getting started example introduces mediation flows and mediation components using a simple application that sends a simple SOAP message to a service, and receives a simple SOAP reply message from the service. As Figure 1 shows, the example enables a SOAP client to access a JMS service. The mediation component is implemented by a mediation flow that forwards the message from the SOAP client to the target service. The target service returns an acknowledgement string when the Hello World SOAP client submits a name. The mediation component writes an entry to the log, including the message data sent by the SOAP client. Figure 1 Hello World Mediation Example www Hello World SOAP Client Hello World JMS Target Service Hello World SOAP Service Hello World Mediation Component Hello World JMS Reference The Hello World mediation component is implemented by a mediation flow and executes in the mediation container. For the service to be accessible by way of the SOAP protocol, the example includes a Hello World SOAP service. The Hello World SOAP client sends requests to the SOAP service, which forwards the requests to the Hello World mediation component. The mediation component executes the mediation flow that contains a Log task to write the incoming message to the log file. The request is then forwarded to the JMS reference to be sent to the target service. The response message from the target service is returned to the SOAP client through the same set of steps. This chapter describes how to: Create an ActiveMatrix SOA project and import an abstract WSDL file into the project Create the Hello World mediation component and implementation in a mediation flow Create the Hello World SOAP service Create the Hello World JMS reference to the target service

29 Hello World Mediation Example Overview 17 Package the service, component, and implementation artifacts into a service assembly Upload the service assembly to the ActiveMatrix environment, map service units to nodes, and map shared resource profiles to a shared resource Deploy and start the service assembly Invoke the Hello World service from a SOAP client Sample Code This chapter describes how to create and run the HelloWorld sample project. If you are already familiar with the TIBCO ActiveMatrix design environment and only want to deploy and run this project, you can find a complete working example in AMX_HOME\2.3\samples\amsb\HelloWorld\com.tibco.amsb.sample.mediat ion.helloworld. You can import the project into a workspace by following the procedure described in Importing Sample Projects on page 8. If you import the sample project, you can skip to Deploying and Starting the Hello World Service Assembly on page 34 to deploy and run the sample.

30 18 Chapter 3 Hello World Mediation Example Setting up the Hello World ActiveMatrix SOA Project When you set up a SOA project in TIBCO Business Studio, you: Create the SOA project and folders Import WSDL files into the project Starting TIBCO Business Studio To start Business Studio: 1. Run one of these platform-specific commands: ] Windows Start > All Programs > TIBCO > ENV_NAME > TIBCO Business Studio 2.3 > TIBCO Business Studio. Or, from the Windows command line, run ENV_HOME/BusinessStudio/TIBCOBusinessStudio.exe. UNIX Run ENV_HOME/BusinessStudio/TIBCOBusinessStudio. 1. The Workspace Launcher opens. Accept the default workspace or browse to a new workspace. 2. Click OK. The first time you run Business Studio, the Welcome screen opens. Dismiss the screen by clicking the X next to Welcome. Creating the Hello World ActiveMatrix SOA Project and Folders ActiveMatrix SOA projects are containers for the ActiveMatrix resources that you develop using TIBCO Business Studio. To create an ActiveMatrix SOA project for the Hello World example: \\\ 1. Start Business Studio and select File > New > ActiveMatrix Resources... > ActiveMatrix SOA Project. 2. Click Next.

31 Setting up the Hello World ActiveMatrix SOA Project Type HelloWorld in the Project name field, and ensure that Basic SOA Project template is selected the Available Templates list. 4. Click Next. The Asset Type Selection dialog box opens, showing the assets selected for the new project. 5. Click Finish. The HelloWorld project appears in the Project Explorer, with these folders: Composites Deployment Packages Mediation Flows Service Descriptors Shared Resources

32 20 Chapter 3 Hello World Mediation Example A composite and a service assembly are created in the project, using the project name you specified in step 3 HelloWorld: The composite named HelloWorld.composite is created in the Composites folder. The service assembly named HelloWorld.saf is created in the Deployment Packages folder. Importing the WSDL Files Into the Hello World Project ActiveMatrix services are described using WSDL files WSDL files specify the messages that are required to access a service. To add the WSDL files to your HelloWorld project: 1. In the Project Explorer, right-click the HelloWorld > Service Descriptors folder and select Import > Service Import Wizard. 2. Accept the default selection Import from a File and click Next to open the WSDL Selection dialog box. 3. Click the Ellipsis button to the right of the Source Location field. 4. Navigate to the directory AMX_HOME\2.3\samples\amsb\HelloWorld\com.tibco.amsb.sample.me diation.helloworld\service Descriptors 5. Click the file HelloWorld.wsdl, then click Open. 6. Click Next. 7. Click Finish to import the WSDL file into your project. The HelloWorld.wsdl file is an abstract WSDL and therefore has no binding to its target service. Later in this tutorial you ll bind the WSDL to the target service, using the Composite Editor.

33 Developing the Hello World Mediation Component 21 Developing the Hello World Mediation Component In this section of the tutorial you ll: Create the Hello World mediation flow diagram Create the Hello World mediation component Creating the Hello World Mediation Flow Diagram To create the Hello World mediation flow diagram: 1. In the Project Explorer, open the HelloWorld project and right-click the Mediation Flows folder. 2. Choose New > Mediation Flow from the popup menu, to open the Create Mediation Flow wizard. 3. Select the method Single empty mediation flow, then click Next. 4. In the Mediation Flow Name field, type HelloWorld. 5. Click Finish. The newly created mediation flow diagram HelloWorld.mediation opens in the Mediation Flow Editor: Click the arrow to show or hide the palette. The left pane of the mediation flow, Mediation Interfaces, shows a mediation interface to which SOAP clients send messages. The right pane of the mediation flow, Target Interfaces, shows the interface for the target service where the messages are sent. The center pane of the mediation flow is the Mediation Path between the mediation and target interfaces. The Palette to the right of the mediation flow includes the tools you ll use as you create the HelloWorld example.

34 22 Chapter 3 Hello World Mediation Example 6. Open the Service Descriptors folder, and drag and drop the HelloWorld > Service Descriptors > HelloWorld.wsdl file into the center pane of the mediation flow diagram. 7. Click the sayhello operation in the Mediation Interfaces pane, then click the sayhello operation in the Target Interfaces pane. A wire shows the mediation path from the mediation operation to the target operation. 8. Add a Log task to the input mediation path: a. Click the Log icon in the palette. b. Click the arrow between the sayhello mediation operation and the corresponding sayhello target operation. 9. Right-click the Log task on the mediation path and select Show Properties View from the drop-down menu. The Properties view opens at the bottom of the workspace.

35 Developing the Hello World Mediation Component Click the Log tab on the Properties view to configure the log task. 11. Select the Message Data item on the Log tab, to specify that the content of the message is to be written to the log file. When this mediation flow executes, the message sent by the SOAP client to the target service travels along the mediation path, and the Log task on the path causes the message data to be written to the log file. 12. Save your project click the Save icon in the toolbar, or click Ctrl + S. Creating the Hello World Mediation Component To create the Hello World Mediation component: 1. In the Project Explorer, open HelloWorld > Composites and double-click HelloWorld.composite. The HelloWorld composite opens, showing the Services, Components, and References panes. 2. Click the Mediation component icon in the Components section of the Palette, then click on the Components canvas to add the component. To add resources to a composite, you can either select a resource and click on the canvas, or drag and drop resources from the palette to the canvas.

36 24 Chapter 3 Hello World Mediation Example 3. Type HelloWorldMediationComp in the component s activated input area. 4. Click the Implementation tab in the Properties view at the bottom of the workspace. 5. Click the Browse button on the tab to locate and select the HelloWorld.mediation mediation flow resource. 6. Click OK. 7. Click the Save icon. The component shows an error icon configure the rest of the composite., indicating that you need to

37 Creating Shared Resources and Profiles 25 Creating Shared Resources and Profiles In this section of the tutorial, you ll: Create shared resources. Shared resources are files that contain configuration information for resources that will be available for sharing among composites and components. Add shared resource profiles to the composite. Composites and components use shared resource profiles to reference shared resources. Creating Shared Resources For the mediation service and target service to be accessible from external clients, you must create these shared resources: HTTP Server JMS JNDI These resources are used by the services that expose the Hello World SOAP service to clients, and by the references to the target HelloWorld JMS service. To create shared resources: 1. In the Project Explorer, right-click HelloWorld > Shared Resources and select New > HTTP Server. The HTTP Server dialog box opens, showing the location and file name of the HTTP Server shared resource.

38 26 Chapter 3 Hello World Mediation Example 2. Click Finish. The HTTP Server Shared Resource Editor opens, showing the shared resource configuration. 3. In the Port field, type Do not change the remaining default values in the HTTP Server Shared Resource Editor. 4. Save the resource, then close the editor. 5. In the Project Explorer, right-click HelloWorld > Shared Resources and select New > JNDI. The JNDI Shared Resource dialog box opens, showing the location and file name of the JNDI shared resource. 6. Click Finish. The JNDI Shared Resource Editor opens, showing the shared resource configuration. 7. Do not change the default values in the JNDI Shared Resource Editor. Save the resource, then close the editor.

39 Creating Shared Resources and Profiles In the Project Explorer, right-click HelloWorld > Shared Resources and select New > JMS. The JMS Shared Resource dialog box opens, showing the location and file name of the JMS shared resource. 9. Click Finish. The JMS Shared Resource Editor opens, showing the configuration of the shared resource. 10. In the Connection Type field, select JNDI from the drop-down list. The JNDI Configuration Name field appears. 11. Click the JNDI Configuration Name icon to open the drop-down menu, and click Browse. Open the JNDI Configuration Name icon and click Browse. 12. In the JNDI Configuration Name dialog, select the shared resource JNDI Shared Resource.sharedjndiconfig from the Matching Resources list, and click OK. 13. Save the resource, then close the editor. Adding Shared Resource Profiles to the Composite Now that you ve created the shared resources, you ll add them to the HelloWorld composite. To add the shared resource profiles to the HelloWorld composite: 1. If HelloWorld.composite is open, activate it by clicking the title tab of the composite editor. If HelloWorld.composite is not open, go to Project Explorer > HelloWorld > Composites and double-click HelloWorld.composite.

40 28 Chapter 3 Hello World Mediation Example 2. In the Properties view of HelloWorld.composite, click the Shared Resource Profiles view tab. 3. Add a new row to the table in one of these ways: Click the Add button to the right of the Shared Resource Profiles table. Click the ellipsis button in the Name column. 4. In the new row: Click in the Name column and type HTTP_Server. In the Type column, select HTTP. Click in the Target column, and within the column click the ellipsis button to open the Select Shared Resource dialog box. Select HTTP Server Shared Resource.sharedhttp and click OK. 5. Add another row to the table by clicking the Add button to the right of the table, or the ellipsis button in the Name column. 6. In the new row: Click in the Name column and type JMS. In the Type column, select JMS. Click the Target column, and within the column click the ellipsis button to open the Select Shared Resource dialog box. Select JMS Shared Resource.sharedjmscon and click OK. 7. Click the Save icon in the toolbar, or click Ctrl + S.

41 Creating the Hello World SOAP Services and References 29 Creating the Hello World SOAP Services and References When specifying services and references, you select the port type, the supported transport, and the target service. In this section of the tutorial you ll: Create the Hello World service with a SOAP binding Create the target HelloWorld reference with a JMS binding. Creating the HelloWorld Service To create the Hello World service with a SOAP binding: 1. If HelloWorld.composite is open, activate it by clicking the title tab of the composite editor. If HelloWorld.composite is not open, go to Project Explorer > HelloWorld > Composites and double-click HelloWorld.composite. 2. Click the SOAP service icon in the Services group in the Palette and click the canvas. A service is added to the Services area of the canvas. 3. Type HelloWorld_Service in the activated input area. 4. In the service s Properties view, click the General view tab. 5. Click the Browse button at the right of the Port Type field to open the Resource Picker. a. Type the letter h in the List of Files field. The nodes in the Resource Picker expand. b. Click the HelloWorld node and click OK. The Port Type field and WSDL Location fields are set. 6. Click the Save icon in the toolbar, or click Ctrl + S. The service shows an error icon configured., indicating that its transport must be Configuring the Transport: Adding the HTTP Connection to the Service To add the HTTP connection to the service: 1. In the service s Properties view, click the Binding tab. 2. Click the HelloWorld_EP endpoint node on the left side of the Binding view tab.

42 30 Chapter 3 Hello World Mediation Example 3. Expand the Transport Configuration area on the right side of the Binding view tab. The Transport Type is set to HTTP, and the Resource Profile field is set to HTTP_Server, to correspond to the resource profile you created in Adding Shared Resource Profiles to the Composite on page 27. The endpoint URI (Uniform Resource Identifier) forms part of the URL that clients of the endpoint invoke. The Endpoint Path is helloworld, and the Endpoint URI field is /localhost:9095/helloworld. 4. Click the Save icon or click Ctrl + S to set the endpoint URI. The error icon is removed. Binding the Service to the Target Component Service The target of a service is a component service. To bind the service to the component service: 1. In the service s Properties view, click the Target view tab. 2. Click the button next to HelloWorldMediationComp->HelloWorld. A wire is drawn between the service and the component, connecting them. If the HelloWorldMediationComp->HelloWorld entry does not appear, close the composite by clicking the X in the title of the editor window, then reopen the composite. 3. Click the Save icon. Creating the HelloWorld Reference To create the Hello World reference with a JMS binding: 1. Drag the JMS reference icon from the References group in the Palette and drop it onto the canvas. A reference is added to the References area of the canvas. 2. Type HelloWorld_Reference in the activated input area. 3. In the reference s Properties view, click the General tab.

43 Creating the Hello World SOAP Services and References Click the Browse button at the right of the Port Type field. a. Type the letter h in the List of Files field. The nodes in the Resource Picker expand. b. Click the HelloWorld node and click OK. The Port Type field and WSDL Location fields are set. 5. Click the Save icon in the toolbar, or click Ctrl + S. The service shows an error icon configured., indicating that its transport must be Adding the JMS Connection to the Reference To add the JMS connection to the reference: 1. In the reference s Properties view, click the Binding tab. 2. Click the endpoint node on the left side of the Binding tab 3. Expand the Endpoint area on the right. The Connection Config field is set to JMS, to correspond to the resource profile created in Adding Shared Resource Profiles to the Composite on page Set the Target Destination Name field to helloworld.sayhello. Binding the Reference to the Target Component Reference To bind the reference to the component reference: 1. Click the component reference icon on the HelloWorldMediationComp resource. Click the component reference icon to open its Properties view. 2. In the reference s Properties view, click the button next to the HelloWorld_Reference of type Composite Reference.

44 32 Chapter 3 Hello World Mediation Example 3. A wire is drawn between the component reference and the composite reference. Click the HelloWorld_Reference button to wire the component reference to the composite reference. 4. Click the Save icon. Final Composite The final composite looks like this wires connect the HelloWorld SOAP service to the mediation component resource, and the mediation component resource to the HelloWorld JMS reference:

45 Packaging the Hello World Example 33 Packaging the Hello World Example To deploy the services and components you created, you must package them into a service assembly. When you created the composite, a service assembly named HelloWorld.saf was automatically created in the Deployment Packages folder. Now you ll update the service assembly, to package the elements and resources you ve created. Updating the HelloWorld Service Assembly To update the Hello World service assembly: 1. Go to Project Explorer > HelloWorld > Deployment Packages and double-click HelloWorld.saf. 2. Click the Refresh icon in the top right of the editor. SOAP, JMS, and Mediation service units are created and populated with the corresponding components. 3. Click the Save icon. Creating the Deployable Archive To create a deployable archive, either right-click the service assembly in the Project Explorer view and select Build Archive, or click the build archive icon in the top right of the service assembly editor. The archive HelloWorld.zip is created in the Deployment Packages folder of your project.