Programmer's Guide

EAServer

Subject

This book contains information about how to build distributed applications that run on Sybase EAServer.

Audience

The EAServer Programmer's Guide is written for application developers who are familiar with their chosen programming languages, specifically Java, C++, C, or an ActiveX scripting language.

Though you do not need to know all of these languages to create EAServer components or clients, the chapters that pertain to each language assume a basic familiarity with that language.

How to use this book

For an overview of EAServer design concepts, and the application development process, see these chapters:

Chapter 1, "Creating Component-Based Applications" provides a level overview of a typical development process.
Chapter 2, "Understanding Transactions and Component Lifecycles" describes how EAServer manages multi-component transactions and component lifecycles.

For general information on developing components for EAServer, see these chapters:

Chapter 3, "Managing Applications and Packages in Jaguar Manager" describes how to create applications and packages in Jaguar Manager. These items are required vehicles for component deployment to EAServer.
Chapter 4, "Defining Components" describes how to define packages and components in Jaguar Manager and configure component properties.
Chapter 5, "Defining Component Interfaces" describes how to create, view, and edit component interfaces in Jaguar Manager.

For information on developing Enterprise Java Beans (EJB) components, see these chapters:

Chapter 6, "Enterprise JavaBeans Overview" introduces the EJB component model.
Chapter 7, "Creating Enterprise JavaBeans Components" describes how to create Enterprise JavaBeans components.
Chapter 8, "Creating Enterprise JavaBeans Clients" describes how to implement a client that uses the EJB client interfaces to call EAServer component methods.
Chapter 9, "EAServer EJB Interoperability" describes how to call non-EJB components from EJB clients or components, and how to call EJB components from non-EJB clients.
Chapter 10, "Creating Application Clients" describes how to create and deploy EJB application clients.

For information on developing components using the Java/CORBA model, see these chapters:

Chapter 11, "Creating CORBA Java Components" contains information about building CORBA-Java components.
Chapter 12, "Creating CORBA Java Clients" describes how to implement a client that uses EAServer's CORBA-compatible Object Request Broker (ORB) to call EAServer component methods. This chapter is also useful to Java developers that use another vendor's Java ORB to interact with EAServer components.

For information on developing components using the CORBA/C++ model, see these chapters:

Chapter 13, "CORBA C++ Overview" describes EAServer's C++ support and explains how EAServer maps CORBA IDL datatypes to C++ datatypes.
Chapter 14, "Creating CORBA C++ Components" contains information about building C++ components.
Chapter 15, "Creating CORBA C++ Clients" describes how to develop C++ clients that connect to EAServer.

For information on developing ActiveX components, see these chapters:

Chapter 16, "ActiveX Overview" describes EAServer's ActiveX support, including how EAServer maps CORBA IDL datatypes to ActiveX datatypes.
Chapter 17, "Creating ActiveX Components" contains information about building ActiveX components.
Chapter 18, "Creating ActiveX Clients" describes how to develop clients that connect to EAServer using the EAServer ActiveX client proxy server.

For information on developing, configuring, and running Web applications, servlets, and Java Server Page, see these chapters:

Chapter 19, "Creating Web Applications" describes how to define and configure Web applications.
Chapter 20, "Creating Java Servlets" describes how to create and run Java servlets in EAServer.
Chapter 22, "Creating JavaServer Pages" describes how to create and run Java ServerPages in EAServer.

For information on advanced component features, see these chapters:

Chapter 23, "Sending Result Sets" describes how to send result sets from a method coded in C, C++, or Java.
Chapter 24, "Using Connection Management" describes how to access connection caches from a method coded in C, C++, or Java.
Chapter 25, "Managing Persistent Component State" describes how to create CORBA or EJB components that store state information in a remote database.
Chapter 26, "Creating JavaMail" describes how to use the JavaMail API to access an Internet mail server from Java components or servlets.
Chapter 27, "Configuring Java XML Parser Support" describes how to configure Java components, application clients, and Web applications to use standard APIs to parse XML.
Chapter 28, "Configuring Custom Java Class Lists" describes how to configure custom Java class lists for components, Web applications, packages, J2EE applications, and servers.
Chapter 29, "Using the Message Service" describes how to use EAServer's asynchronous messaging service to implement event- or message-driven application logic in clients and components.
Chapter 30, "Using the Thread Manager" describes how to create threads to perform asynchronous processing in EAServer components.
Chapter 31, "Creating Service Components" describes how to create components that run as EAServer services.
Chapter 32, "Creating and Using EAServer Pseudocomponents" describes EAServer's C++ and Java pseudocomponent support.

If you have developed applications with Sybase Open Server™ or previous EAServer versions, you may be interested in these features explained in the Appendixes:

Appendix A, "Executing Methods As Stored Procedures" contains reference pages for invoking EAServer methods from any front-end tool that can execute Sybase® stored procedures.
Appendix B, "Migrating Open Server Applications to EAServer" explains how to adapt existing Open Server applications to run in EAServer.
Appendix C, "Creating EAServer 1.1 Java Clients" describes how to program Java clients that use the interface that was defined in EAServer version 1.1.
Appendix D, "Creating C Components" contains information about building C components.

Finally, for information on generating stubs and skeletons with the command-line IDL compiler, see Appendix E, "Using the Command Line IDL Compiler".

Related documents

Core EAServer documentation The core EAServer documents are available in HTML format in your EAServer software installation, and in PDF and DynaText format on the EAServer 4.1.1 Technical Library CD.

The EAServer Installation Guide for your platform explains how to install the EAServer software.

What's New in EAServer 4.1.1 summarizes new functionality in this version.

The EAServer Feature Guide explains application server concepts and architecture, such as components, transactions, and Web applications. This book also explains how to use the optional EAServer products such as:

Message Bridge for Java™
Web Services Toolkit
Application Integrator for CICS, which allows EAServer components to execute CICS programs on a mainframe
Application Integrator for Stored Procedures, which allows you to quickly integrate database stored procedures into component-based applications
Adaptive Server® Anywhere, a full-featured, easy to use, transactional database management system
PowerDynamo™, which you can use for PowerBuilder® Web DataWindow® support

The EAServer Programmer's Guide explains how to:

Create, deploy, and configure components and component-based applications
Create, deploy, and configure Web applications, Java servlets, and JavaServer Pages
Use the industry-standard CORBA and Java APIs supported by EAServer

The EAServer System Administration Guide explains how to:

Start the preconfigured Jaguar server and manage it with the Jaguar Manager plug-in for Sybase Central™
Create, configure, and start new application servers
Define connection caches
Create clusters of application servers to host load-balanced and highly available components and Web applications
Monitor servers and application components
Automate administration and monitoring tasks with command-line tools or the Repository API
Create embedded EAServer installations

The EAServer Security Administration and Programming Guide explains how to:

Understand the EAServer security architecture
Configure role-based security for components and Web applications
Configure SSL certificate-based security for client connections using the Security Manager plug-in for Sybase Central
Implement custom security services for authentication, authorization, and role membership evaluation
Implement secure HTTP and IIOP client applications
Deploy client applications that connect through Internet proxies and firewalls

The EAServer Cookbook contains tutorials and explains how to use the sample applications included with your EAServer software.

The EAServer API Reference Manual contains reference pages for proprietary EAServer Java classes, ActiveX interfaces, and C routines. This document is available only online.

Message Bridge for Java™ documents Message Bridge for Java simplifies the parsing and formatting of structured documents in Java applications. Message Bridge allows you to define structures in XML or other formats, and generates Java classes to parse and build documents and messages that follow the format. The Message Bridge for Java User's Guide describes how to use the Message Bridge tools and runtime APIs. This document is included in PDF and DynaText format on your EAServer 4.1.1 Technical Library CD.

Web Services Toolkit documents Web Services Toolkit allows you to use standard Web services protocols in EAServer, such as Simple Object Access Protocol (SOAP), Web Services Description Language (WSDL), and Uniform Description, Discovery, and Integration (UDDI). The toolkit includes components for runtime support of these protocols, and tools for WSDL document creation, UDDI registration, and SOAP management. The Web Services Toolkit User's Guide describes how to use these features. This document is included in PDF and DynaText format on your EAServer 4.1 Technical Library CD.

Localization feature documents EAServer includes optional components to simplify the creation and deployment of localized applications. Documents for these features are provided in PDF and DynaText format on your EAServer 4.1.1 Technical Library CD. These features and documents include:

The Global Sort component, which provides high performance sorting of small to medium length lists and supports multiple alphabets and sort orders. This feature is documented in Using Global Sort.

The locale formatting library (LFL) consists of C++ CORBA components that use the International Components for Unicode (ICU) C++ formatting APIs for formatting dates, times, numbers, and currency. Using the Locale Formatting Library describes how to use these components in your applications.
The XML conversion module (XCM) tool is a high-performance EAServer component development tool that provides encoding verification and character set conversion for XML data. Using the XCM Tool describes how to use this feature.

PowerDynamo documents PowerDynamo documents are available in PDF and DynaText format on the EAServer 4.1.1 Technical Library CD and in HTML format in the PowerDynamo software installation.

Application Integrator documents Application Integrator documents are available in HTML format in your EAServer software installation, and in DynaText and PDF format on the EAServer 4.1.1 Technical Library CD.

Adaptive Server Anywhere documents EAServer includes a limited-license version of Adaptive Server Anywhere 7.0. PowerDynamo requires Adaptive Server Anywhere, as do many of the samples included with your EAServer software. Adaptive Server Anywhere documents are available on the EAServer 4.1.1 Technical Library CD.

jConnect for JDBC documents EAServer includes the jConnect™ for JDBC™ driver to allow JDBC access to Sybase database servers and gateways. The jConnect for JDBC Programmer's Guide is included on the EAServer 4.1.1 Technical Library CD.

Conventions

The formatting conventions used in this manual are:

Formatting example	To indicate
commands and methods	When used in descriptive text, this font indicates keywords such as: Command names used in descriptive text C++ and Java method or class names used in descriptive text Java package names used in descriptive text
variable, package, or component	Italic font indicates: Program variables, such as myCounter Parts of input text that must be substituted, for example: Server.log File names Names of components, EAServer packages, and other entities that are registered in the EAServer naming service
File \| Save	Menu names and menu items are displayed in plain text. The vertical bar shows you how to navigate menu selections. For example, File \| Save indicates "select Save from the File menu."
`package 1`	Monospace font indicates: Information that you enter in Jaguar Manager, a command line, or as program text Example program fragments Example output fragments

If you need help

Each Sybase installation that has purchased a support contract has one or more designated people who are authorized to contact Sybase Technical Support. If you cannot resolve a problem using the manuals or online help, please have the designated person contact Sybase Technical Support or the Sybase subsidiary in your area.