TIBCO ActiveMatrix® BPM · TIBCO ActiveMatrix® BPM Web Application Component Development Software...

Two-Second Adv

TIBCO ActiveMatrix® BPM

Web Application Component DevelopmentSoftware Release 2.1February 2013

antage®

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 THE LICENSE FILE) 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.TIBCO, Two-Second Advantage, TIBCO ActiveMatrix, TIBCO Enterprise Message Service 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. SEE THE README 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 © 1999-2013 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

| iii

Contents

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii

Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viii

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixTIBCO ActiveMatrix Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixThird Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xivHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xivHow to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xivHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv

Chapter 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Approaches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2 Web Application Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Creating a Web Application Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Configuring a Web Application Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Configuring a Web Application Using Web.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Configuring a Web Application Component's Custom Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Configuring a Web Application Component’s External Custom Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Updating a Web Application Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

ZeroConfiguration DAA Creation Using WAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Chapter 3 Web Application Component Implementations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Opening an Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Generating an Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Generate Web Application Implementation Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Regenerating an Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Refreshing an Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

TIBCO ActiveMatrix Web Application Component Development

iv | Contents

Accessing a Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Invoking a Reference Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Handling Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Chapter 4 URL Mappings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Use of URL Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Specification of Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Implicit Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

TIBCO ActiveMatrix Web Application Component Development

Tables | v

Tables

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Table 2 Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Table 3 Code generation details dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Table 4 Create Servlet dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Table 5 Example Set of Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Table 6 Incoming Paths Applied to Example Maps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

TIBCO ActiveMatrix BPM Web Application Component Development

vi | Tables


| vii

Preface

TIBCO ActiveMatrix® is a scalable and extensible platform for developing, deploying, and managing applications that conform to a service-oriented architecture. The Web Application component conforms to the SCA Java EE Integration Specification and allows you to create Web Applications based on these specifications.

Topics

• Changes from the Previous Release of this Guide, page viii

• Related Documentation, page ix

• Typographical Conventions, page xi

• Connecting with TIBCO Resources, page xiv


viii | Changes from the Previous Release of this Guide

Changes from the Previous Release of this Guide

This section itemizes the major changes from the previous release of this guide.

Configuring a Web Application using a Web.xml

A new section provides additional details on configuring a web application using a Web.xml file. See Configuring a Web Application Using Web.xml, page 10.


Preface | ix

Related Documentation

This section lists documentation resources you may find useful.

TIBCO ActiveMatrix DocumentationThe following documents form the TIBCO ActiveMatrix documentation set:

• Concepts: Read this manual before reading any other manual in the documentation set. This manual describes terminology and concepts of the TIBCO ActiveMatrix platform. The other manuals in the documentation set assume you are familiar with the information in this manual.

• Development Tutorials: Read this manual for a step-by-step introduction to the process of creating, packaging, and running composites in TIBCO Business Studio.

• Composite Development: Read this manual to learn how to develop and package composites.

• Java Component Development: Read this manual to learn how to configure and implement Java components.

• Mediation Component Development: Read this manual to learn how to configure and implement Mediation components.

• Mediation API Reference: Read this manual to learn how to configure and implement Mediation components.

• Spring Component Development: Read this manual to learn how to configure and implement Spring components.

• Web Application Component Development: Read this manual to learn how to configure and implement Web Application components.

• Administration: Read this manual to learn how to manage the runtime and deploy and manage applications.

• Release Notes: Read this manual for a list of new and changed features, steps for migrating from a previous release, and lists of known issues and closed issues for the release.

Other TIBCO Product DocumentationYou may find it useful to read the documentation for the following TIBCO products:

• TIBCO ActiveMatrix® Service Bus


x | Related Documentation

• TIBCO ActiveMatrix® Service Grid

• TIBCO ActiveMatrix® Registry

• TIBCO ActiveMatrix® Policy Manager

• TIBCO Enterprise Message Service™

• TIBCO Adapter™

• TIBCO Administrator™

• TIBCO Hawk®

• TIBCO Rendezvous®

Third Party DocumentationTIBCO ActiveMatrix software supports the following standards:

• Service Component Architecture

http://www.osoa.org/display/Main/Service+Component+Architecture+Specifications

• Java Servlet 2.5 Specification

http://jcp.org/aboutJava/communityprocess/mrel/jsr154/index2.html

• World Wide Web Consortium web services activity

http://www.w3.org/2002/ws/

— Simple Object Access Protocol (SOAP) 1.1 W3C Note

http://www.w3.org/TR/2000/NOTE-SOAP-20000508/

— WSDL 1.1 W3C Note

http://www.w3.org/TR/wsdl

• OASIS

http://www.oasis-open.org/committees/tc_cat.php?cat=ws

— UDDI Version 3 OASIS Standard

http://www.oasis-open.org/specs/index.php#uddiv2

TIBCO ActiveMatrix Web Application Component supports the following standards:

• SCA Java EE Integration Specification

http://www.osoa.org/download/attachments/35/SCA_JAVAEE_Integration_V100.pdf?version=1


http://www.osoa.org/display/Main/Service+Component+Architecture+Specifications

http://www.w3.org/2002/ws/

http://www.w3.org/TR/2000/NOTE-SOAP-20000508/

http://www.w3.org/TR/wsdl

http://www.oasis-open.org/committees/tc_cat.php?cat=ws

http://www.oasis-open.org/specs/index.php#uddiv2

http://jcp.org/aboutJava/communityprocess/mrel/jsr154/index2.html



Preface | xi

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

TIBCO_HOME

ENV_NAME

Many TIBCO products must be installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The default 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. Incompatible products and multiple instances of the same product are installed into different installation environments. An environment home directory is referenced in documentation as ENV_HOME. The default value of ENV_HOME depends on the operating system. For example, on Windows systems the default value is C:\tibco.

code font Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code font 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


xii | Typographical Conventions

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.

Table 1 General Typographical Conventions (Cont’d)

Convention Use

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


Preface | xiii

{ } 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}

Table 2 Syntax Typographical Conventions

Convention Use


xiv | Connecting with TIBCO Resources

Connecting with TIBCO Resources

How to Join TIBCOmmunityTIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts, a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to http://www.tibcommunity.com.

How to Access All TIBCO DocumentationAfter you join TIBCOmmunity, you can access the documentation for all supported product versions here:

http://docs.tibco.com/TibcoDoc

How to Contact TIBCO SupportFor 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:

http://www.tibco.com/services/support

• If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you can request one.


http://www.tibcommunity.com

http://docs.tibco.com/TibcoDoc

http://www.tibco.com/services/support

https://support.tibco.com

| 1

Chapter 1 Overview

This chapter provides an overview of the component and the approaches to the component development process.

Topics

• Introduction, page 2

• Approaches, page 3


2 | Chapter 1 Overview

Introduction

A Web application is a group of HTML pages, JSP pages, servlets, resources and source file, which can be managed as a single unit.

Web applications can be simple (consisting of only static Web pages) or they can be advanced and include JavaServer Pages (JSP) files and Java servlets. These resources, along with an XML deployment descriptor (and other Web resources), are contained within a Web project during development. When you are ready to publish the Web Application to the Web, you deploy the Web project to the server in the form of a Web archive (WAR) file. The end user can then view the Web application as a Web site from a URL.

The structure of a standard web module is:

The Web Application component integrates Java EE web applications into the TIBCO ActiveMatrix Service Grid and TIBCO ActiveMatrix BPM platform. The integration conforms to the SCA Java EE Integration Specification (http://www.osoa.org/download/attachments/35/SCA_JAVAEE_Integration_V100.pdf?version=1).




Approaches | 3

Approaches

A Web Application component can be used either in:

• Top-down You can start with a WSDL and complete the component reference implementation using a WTP (Web Tools Platform) project created in SDS during Generate Servlet Implementation.

• Bottom-up You can bring an already existing Web Application in the TIBCO ActiveMatrix platform. The existing Web Application could either be a WAR (Web ARchive) file, WTP project, or an OSGi-fied Web Application.

— Start with an existing WAR file.

You cannot add Properties or References on a component. The DAA has the WAR file bundled in it.

— Start with an existing WTP project.

You can add Servlets, References, and properties if required. In this case, the WTP project is exported into a WAR file and bundled inside the DAA.

— Start with a web.xml file.

This option is used when you want to OSGify your web application. Here, the Web Application is composed as a set of OSGi bundles (and not as a single WAR file). OSGi bundles are simply jar files, that typically contain the Java class files of the service interfaces, their implementation, and some more meta information in a METAINF/manifest.mf file. Services are Java interfaces and once your bundle is registered as a service with the OSGi framework, other bundles can use your "published" service.

You can add Servlets, References, and properties if required. In this case, the DAA just bundles the web.xml and the Servlets and all static content (HTML, JPEGs and so on, if any) reside in Java plug-ins.


4 | Chapter 1 Overview


Web Application Components | 5

Chapter 2 Web Application Components

This chapter describes how to create and configure a Web Application component.

Topics

• Creating a Web Application Component, page 6

• Configuring a Web Application Component, page 8

• Configuring a Web Application Using Web.xml, page 10

• Configuring a Web Application Component's Custom Feature, page 11

• Configuring a Web Application Component’s External Custom Feature, page 12

• Updating a Web Application Component, page 13

• ZeroConfiguration DAA Creation Using WAR, page 14


6 | Chapter 2 Web Application Components

Creating a Web Application Component

Creating an SOA Project

To create a new SOA project:

1. Select File > New > TIBCO SOA Resources.

2. Click TIBCO SOA Project and click Next.

3. In the Project name field, type a name for the project and click Next twice.

4. In the Project Types list, choose one of the following ways to create a project:

— SOA Project From Implementation

You can create a Web Application project from an existing WAR file, WTP file, or a web.xml file.

— Empty SOA Project

— SOA Project From WSDL

You can create a Web Application project from an existing WSDL file.

— Basic SOA Project

5. Click Finish.

Adding an Empty Web Application Component

To add an empty Web Application component, do one of the following:

• Right-click the composite canvas and select Add > WebApp.

• Click the canvas and click the WebApp icon in the pop-up toolbar.

• Click the WebApp icon in the Palette and click the canvas.

Starting with an Existing Implementation

• Bottom-up approach:

— Approach 1: Drag and drop the existing WAR file, Web.xml file from the Project Explorer to the composite canvas.

— Approach 2: In the Properties tab, Implementation section, specify a WTP project, WAR file, or Web.xml file.


Creating a Web Application Component | 7

• Top-down approach:

a. Drag and drop the Web Application component on the composite canvas.

b. Add reference on Web Application component and attach WSDL port type to reference.

c. Generate the Servlet Implementation.



Configuring a Web Application Component

Implementation Options and Features

Select the Web Application component on the canvas and in the Properties view, click the Implementation tab.

The Options section allows you to specify the approach for component development and the Features section allows you to specify the custom features on which the implementation depends.

Properties

Select the Web Application component on the canvas and in the Properties view, click the Properties tab. The Context Root and Connector Name properties must always be set.

You can configure a Web Application component using the ZeroConfiguration WAR file. For details, refer ZeroConfiguration DAA Creation Using WAR, page 14.

Field Description

WTP Project Start with the Eclipse WTP project containing the web application component implementation.

WAR Start with the WAR file containing the web application component implementation.

Deployment Descriptor (web.xml)

Start with the deployment descriptor of the web application, that is, the web.xml file.

Field Description

Feature ID The ID of the feature.

Version Range The range of feature versions that the component requires.


Configuring a Web Application Component | 9

Property Description

contextRoot The context root of a web application determines which URLs are to be delegated to your web application. If your application's context root is myapp, any request for /myapp or /myapp/* are handled. For example, http://localhost:8080/myapp/index.html.

NOTE: A Web Application component must have an unique context root.

defaultConnector This property defines the name for an HTTP Inbound connector. For a Web Application, a browser is only way of communication and as browser uses HTTP to communicate with any Web Application. In TIBCO ActiveMatrix, you need to configure this HttpInbound Resource template in Administrator before deploying a Web Application.



Configuring a Web Application Using Web.xml

This section summarizes the procedure for configuring a web application using a Web.xml file.

1. Point to the Web.xml file in the Web Application Component implementation:

— Approach 1: Drag and drop the existing Web.xml file from the Project Explorer to the composite canvas.

— Approach 2: Select the Web Application Component on the canvas and in the Properties view, Implementation section, specify the Web.xml file.

2. Generate the Servlet implementation.

a. In the Properties View, General section, Validation Report area, click the fix... link.

b. Select Generate Servlet Implementation.

The OSGI Plug-in project is created.

3. For static resources, create a folder named resources under the src folder in the generated OSGI Plug-in.

4. Export this non-Java package as an Exported Package from the OSGI Plug-in:

a. Open the MANIFEST.MF file in the META-INF folder of the Plug-in project.

b. In the Runtime tab, click Add for Exported Packages section, select the Show non-Java packages check box, select the resources package and assign any valid version as 1.0.0.

c. Save the MANIFEST.MF file.

5. Add an Import package for the resources package exported from the generated OSGI plug-in using override requirements for the configured Web component.

a. Open the General tab of the WebApp component in the composite.

b. Click the Override link under Administrator Requirements. This creates SOAProjectName.override.requirements.

c. Open the Bundles & Features tab, click the + icon under the Import Packages (OSGi) section and enter the Package Name as resources.

As override requirements is used, you need to explicitly add a custom feature as a required feature in the override requirements file. In this case, the details are not picked up from what is specified in the composite.


Configuring a Web Application Component's Custom Feature | 11

Configuring a Web Application Component's Custom Feature

For more information on a custom feature, see TIBCO ActiveMatrix Java Component Development.

When you create a Web Application starting with a web.xml file and generate a servlet implementation, a custom feature is automatically created and configured. A custom feature is not automatically created for the WTP and WAR file options.

If you manually configure the component's implementation, you must manually create and configure the custom feature by selecting File > Create > New > Custom Feature. If the component implementation uses a library, add the custom feature containing the library in the Properties view.

Starting Point Procedure

Properties View 1. Click the component.

2. In the Properties view, click the Implementation tab.

3. Click the button to the right of the Features table.

The Select a Feature dialog displays.

4. In the Select an item to open field, type a partial feature name. The feature that matches the name displays in the Matching items list.

5. Click a feature and click OK. The feature is added to the Features list.



Configuring a Web Application Component’s External Custom

Feature

For more information on a custom feature, see TIBCO ActiveMatrix Java Component Development.

If your Web Application component implementation references a plug-in containing a shared library, you must add the custom feature that contains the plug-in to the Web Application component’s configuration.

1. Click the component.

2. In the Properties view, click the Implementation tab.

3. Click the button to the right of the Features table.

The Select a Feature dialog displays.

4. Click the feature containing the shared library plug-in.

5. Click OK.

The feature is added to the component’s Features list.


Updating a Web Application Component | 13

Updating a Web Application Component

You can update a component after you have configured its implementation.

Control Procedure

Canvas Right-click the component and select Refresh from Implementation.

Canvas Right-click a component and select Quick Fixes > Update Component from Implementation. (The "Quick Fixes" option is available when you add, delete or update a service, reference and property from the Web Application component.)

Properties View 1. In the Validation Report area on the General tab of the component’s Property

View click the fix... link.

2. Select Generate Servlet Implementation.

Problems View 1. In the Problems view, right-click an error of the form "The component <ComponentName> is out of sync with its implementation" and select Quick Fix. (The "Quick Fix" option is available when you add, delete or update a service, reference and property from the Web Application component.)

2. In the Quick Fix dialog select Update Component from Implementation.

3. Click Finish.



ZeroConfiguration DAA Creation Using WAR

ZeroConfiguration DAA creation is based on SDS command-line support. You can create a DAA using existing Web Application components (WAR files) on Active Matrix platform, without using the composite editor.

For details, refer SDS Commandline help.

Sample build configuration file:

<?xml version="1.0" encoding="UTF-8"?><project name="project" default="default"><description>WebApp War DAA creation</description><target name="default" description="description"><sds.createSoaProject projectname="webapphelloworld"/><sds.createComposite compositename="webapphelloworld" projectname="webapphelloworld"/><sds.createComponent componentname="helloworld" compositename="webapphelloworld" projectname="webapphelloworld" implementationloc="<absolute path to war>"/><sds.promoteAll projectName="webapphelloworld" compositeName="webapphelloworld" componentName="helloworld"/><sds.createDAA daaloc="webappsample.daa" projectname="webapphelloworld"><application compositename="webapphelloworld" projectname="webapphelloworld" /></sds.createDAA></target></project>

Specify the <absolute path to war> in the above build configuration file.

ZeroConfiguration DAA creation supports existing Web Applications, which do not invoke any SCA reference.

You must not bundle the following files inside the WAR file's WEB-INF/lib: j2ee.jar, jasper-*.jar, jsp-api.jar, rt.jar, tools.jar, servlet.jar, servlet-api.jar, xerce.jar, xerces.jar, and xercesImpl.jar.


Web Application Component Implementations | 15

Chapter 3 Web Application Component Implementations

This chapter describes how to generate a servlet implementation.

Topics

• Opening an Implementation, page 16

• Generating an Implementation, page 17

• Generate Web Application Implementation Reference, page 18

• Regenerating an Implementation, page 20

• Refreshing an Implementation, page 21

• Accessing a Property, page 22

• Invoking a Reference Operation, page 23

• Logging, page 24

• Handling Errors, page 25


16 | Chapter 3 Web Application Component Implementations

Opening an Implementation

In case of the WTP and web.xml options, the web.xml file is opened. In case of the WAR file option, the WAR file is just highlighted in the Project explorer.

Control Procedure

Canvas Double-click the component.

Project Explorer Select the WTP project and open the implementation.

Canvas Right-click the component and select Open Implementation.


Generating an Implementation | 17

Generating an Implementation

The Code generation details dialog displays.

1. Complete the Generate Web Application Implementation Reference, page 18.

2. Click Finish.

A WTP implementation is generated.

The WebContent folder contains items to be published to the server. By default, this folder will be named WebContent for newly created static and dynamic Web projects.

• META-INF — This directory contains the MANIFEST.MF file, which is used to map class paths for dependent JAR files that exist in other projects in the same Enterprise Application project. An entry in this file will update the run-time project class path and Java build settings to include the referenced JAR files.

• WEB-INF — The directory where supporting Web resources for a Web application are kept (for example: .xmi files, .xml files, and web.xml.)

Control Procedure

Properties View 1. In the Validation Report area on the General tab of the component’s Property View, click the fix... link.

2. Select Generate Servlet Implementation.

Canvas Right-click the component and select Quick Fixes > Generate Servlet Implementation.

Canvas Right-click the component and select Generate Servlet Implementation.

Problems View 1. In the Problems view, right-click an error of the form "Component <ComponentName> is not configured" and select Quick Fix.

2. In the Quick Fix dialog, click Generate Servlet Implementation.

3. Click Finish.



Generate Web Application Implementation Reference

Table 3 Code generation details dialog

Field Description

Project The name of the web application project to contain the implementation.

Default:

• For WTP: "WebApp" + <name of component>

• For web.xml: "com.tibco.webapp" + <name of component>

Source Location The name of the source folder in the plug-in project.

Default: src

Package The name of the package of the implementation.

Class The name of the class of the implementation.

Default: The name of component is the default class name.

Use default location for generated super class

Default: checked.

Super-class package The name of the package of the abstract superclass of the implementation class.

Super-class class The name of the abstract superclass of the implementation class.

Default: Abstract<WebappComponentName>

Table 4 Create Servlet dialog

Field Description

Name Name of the servlet.

Description Description of the servlet.

Initialization Parameters

Name-value initialization parameters are used to convey setup information. Typical examples are a Webmaster’s e-mail address, or the name of a system that holds critical data.


Generate Web Application Implementation Reference | 19

URL Mappings

Upon receipt of a client request, the URL mappings determine the Web application to which to forward it. For more information, see URL Mappings, page 27.

Table 4 Create Servlet dialog

Field Description



Regenerating an Implementation

This option allows you to regenerate an implementation without recreating everything. For example, if you have a Web Application with a Java SOA project each having their respective implementations. After developing the component, if you need to make a change to the WSDL (for example: a change to the datatype), you can use this option to change the existing implementation to use the updated WSDL instead of creating everything from scratch again.

The implementation must have been originally generated before you can regenerate.

You should regenerate the component implementation after you add (or delete) a service, reference, or property to the component.

The implementation is updated to match the component.

Control Procedure

Canvas Right-click the component and select Regenerate Servlet Implementation.

Problems View 1. In the Problems view, right-click an error of the form "The component <ComponentName> is out of sync with its implementation" and select Quick Fix.

2. In the Quick Fix dialog select Update Component from Implementation or Update/Create Servlet.

3. Click Finish.


Refreshing an Implementation | 21

Refreshing an Implementation

This option updates the SDS Web Application component based on an underlying implementation. For example, a Web Application component is configured with two properties and an implementation is generated. If one of the properties is accidentally deleted, you can use the refresh option. The SDS component reads the underlying implementation and refreshes the UI with the two properties.

Control Procedure

Canvas Right-click the component and select Refresh from Implementation.

Problems View 1. In the Problems view, right-click an error of the form "The component <ComponentName> is out of sync with its implementation" and select Quick Fix.

2. In the Quick Fix dialog select Update Component from Implementation or Update/Create Servlet.

3. Click Finish.



Accessing a Property

When you generate a Web Application component implementation for a component with a property, TIBCO Business Studio adds a field that represents the property and accessor methods to the Web Application component's abstract implementation servlet.

See TIBCO ActiveMatrix Java Component Development for details.


Invoking a Reference Operation | 23

Invoking a Reference Operation

When you add an In-* reference to a Web Application component, a field and accessor methods are added to the component.




Logging

TIBCO ActiveMatrix Service Grid supports logging to standard out and using a logging API. For simple demonstration applications, you can log to standard out. However, for product applications you should use the logging API.



Handling Errors | 25

Handling Errors

The Web Application component handles errors in the same way as the Java component. See TIBCO ActiveMatrix Java Component Development for details on handling declared and undeclared faults.




URL Mappings | 27

Chapter 4 URL Mappings

This chapter describes mapping techniques required for Web containers mapping client requests to servlets.

Topics

• Use of URL Paths, page 28

• Specification of Mappings, page 29


28 | Chapter 4 URL Mappings

Use of URL Paths

Upon receipt of a client request, the Web container determines the Web application to which to forward it. The Web application selected must have the longest context path that matches the start of the request URL. The matched part of the URL is the context path when mapping to servlets.

The Web container next must locate the servlet to process the request using the path mapping procedure described below.

The path used for mapping to a servlet is the request URL from the request object minus the context path and the path parameters. The URL path mapping rules below are used in order. The first successful match is used with no further matches attempted:

1. The container will try to find an exact match of the path of the request to the path of the servlet. A successful match selects the servlet.

2. The container will recursively try to match the longest path-prefix. This is done by stepping down the path tree a directory at a time, using the ’/’ character as a path separator. The longest match determines the servlet selected.

3. If the last segment in the URL path contains an extension (for example, jsp), the servlet container will try to match a servlet that handles requests for the extension. An extension is defined as the part of the last segment after the last ’.’ character.

4. If neither of the previous three rules result in a servlet match, the container will attempt to serve content appropriate for the resource requested. If a "default" servlet is defined for the application, it will be used. The container must use case-sensitive string comparisons for matching.


Specification of Mappings | 29

Specification of Mappings

In the Web Application deployment descriptor, the following syntax is used to define mappings:

• A string beginning with a ‘/’ character and ending with a ‘/*’ suffix is used for path mapping.

• A string beginning with a ‘*.’ prefix is used as an extension mapping.

• A string containing only the ’/’ character indicates the "default" servlet of the application. In this case the servlet path is the request URI minus the context path and the path info is null.

• All other strings are used for exact matches only.

Implicit MappingsIf the container has an internal JSP container, the *.jsp extension is mapped to it, allowing JSP pages to be executed on demand. This mapping is termed an implicit mapping. If a *.jsp mapping is defined by the Web application, its mapping takes precedence over the implicit mapping.

A servlet container is allowed to make other implicit mappings as long as explicit mappings take precedence. For example, an implicit mapping of *.shtml could be mapped to include functionality on the server.

Example Mapping Set

Consider the following set of mappings:

Table 5 Example Set of Maps

Path Pattern Servlet

/foo/bar/* servlet1

/baz/* servlet2

/catalog servlet3

*.bop servlet4


30 | Chapter 4 URL Mappings

The following behavior would result:

Note: In the case of /catalog/index.html and /catalog/racecar.bop, the servlet mapped to “/catalog” is not used because the match is not exact.

Table 6 Incoming Paths Applied to Example Maps

Incoming Path Servlet Handling Request

/foo/bar/index.html servlet1

/foo/bar/index.bop servlet1

/baz servlet2

/baz/index.html servlet2

/catalog servlet3

/catalog/index.html “default” servlet

/catalog/racecar.bop servlet4

/index.bop servlet4


| 31

Index

B

bottom-up approach 3

C

changes from the previous release viiicontextRoot 9custom feature 11customer support xiv

D

defaultConnector 9

E

external custom feature 12

H

handling errors 25

L

logging 24

M

mapping specification 29META-INF folder 17

P

propertiesmandatory 8

R

related documentation ix, ix

S

structureweb module 2

support, contacting xiv

T

technical support xivTIBCO_HOME xitop-down approach 3

U

URL mappings 27


32 | Index

W

WEB-INF folder 17

Z

zero configuration 14

Date post:	10-Oct-2020
Category:	Documents
Upload:	others
View:	9 times
Download:	0 times

TIBCO ActiveMatrix® BPM · TIBCO ActiveMatrix® BPM Web Application Component Development Software...

Documents