About this book

This book, the EAServer API Reference Manual, contains reference pages for EAServer proprietary Java classes, C++ classes, ActiveX interfaces, and C routines. EAServer also supports many standard Java 2 Enterprise Edition (J2EE) and CORBA APIs. For information on these, see:

The EAServer Programmer's Guide for usage information.
The relevant standards document for API reference information. For J2EE standards documents, please see the Sun Microsystems J2EE Web pages . For CORBA standards documentation, please see the Object Management Group (OMG) Web site .

Audience

This book is written as a reference for developers of EAServer applications. Developers should know their development language and programming tools.

How to use this book

Chapter 1, "Java Classes and Interfaces" documents EAServer's Java classes and interfaces. You will need this information to implement Java components or Java clients.

Chapter 2, "ActiveX C++ Interface Reference" documents EAServer's ActiveX C++ interfaces. You will need this information to implement ActiveX components using C++.

Chapter 3, "ActiveX IDispatch Interface Reference" documents EAServer's ActiveX automation interfaces. You will need this information to implement ActiveX components using IDEs that use ActiveX automation such as Microsoft Visual Basic.

Chapter 4, "ActiveX Client Interfaces" documents the interfaces that ActiveX clients use to process result sets returned by a component method invocation.

Chapter 5, "C Routines Reference" documents EAServer's C library routines. You will need this information to implement C components.

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 Property names in the raw format, as when using jagtool to configure applications rather than EAServer Manager
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 EAServer Manager, a command line, or as program text Example program fragments Example output fragments

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 Technical Library CD.

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

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

The EAServer Feature Guide explains application server concepts and architecture, such as supported component models, network protocols, server-managed transactions, and Web applications.

The EAServer System Administration Guide explains how to:

Start the preconfigured Jaguar server and manage it with the EAServer 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 jagtool

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 Web Services Toolkit User's Guide describes Web services support in EAServer, including:

Support for standard Web services protocols such as Simple Object Access Protocol (SOAP), Web Services Description Language (WSDL), and Uniform Description, Discovery, and Integration (UDDI)
Administration tools for deployment and creation of new Web services, WSDL document creation, UDDI registration, and SOAP management

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 Performance and Tuning Guide describes how to tune your server and application settings for best performance.

The EAServer Troubleshooting Guide describes procedures for troubleshooting problems that EAServer users may encounter. This document is available only online; see the EAServer Troubleshooting Guide .

Message Bridge for Java™ 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 5.0 Technical Library CD.

Adaptive Server Anywhere documents EAServer includes a limited-license version of Adaptive Server Anywhere for use in running the samples and tutorials included with EAServer. Adaptive Server Anywhere documents are available on the Sybase Web site .

jConnect for JDBC documents EAServer includes the jConnect™ for JDBC™ driver to allow JDBC access to Sybase database servers and gateways. The Programmer's Reference jConnect for JDBC is available on the Sybase Web site .

Accessibility features

EAServer 5.0 has been tested for compliance with U.S. government Section 508 Accessibility requirements. The online help for this product is also provided in HTML, JavaHelp, and Eclipse help formats, which you can navigate using a screen reader.

EAServer Manager supports working without a mouse. For more information, see "Keyboard navigation" in Chapter 2, "Sybase Central Overview," in the EAServer System Administration Guide.

The WST plug-in for Eclipse supports accessibility features for those that cannot use a mouse, are visually impaired or have other special needs. For information about these features refer to Eclipse help:

Start Eclipse
Select Help | Help Contents
Enter Accessibility in the Search dialog box
Select Accessible user interfaces or Accessibility features for Eclipse

You might need to configure your accessibility tool for optimal use. Some screen readers pronounce text based on its case; for example, they pronounce ALL UPPERCASE TEXT as initials, and MixedCase Text as words. You might find it helpful to configure your tool to announce syntax conventions. Consult the documentation for your tool.

For additional information about how Sybase supports accessibility, see Sybase Accessibility . The Sybase Accessibility site includes links to information on Section 508 and W3C standards.

Other sources of information

Use the Sybase Getting Started CD, the Sybase Technical Library CD and the Technical Library Product Manuals Web site to learn more about your product:

The Getting Started CD contains release bulletins and installation guides in PDF format, and may also contain other documents or updated information not included on the Technical Library CD. It is included with your software. To read or print documents on the Getting Started CD you need Adobe Acrobat Reader (downloadable at no charge from the Adobe Web site, using a link provided on the CD).
The Technical Library CD contains product manuals and is included with your software. The DynaText reader (included on the Technical Library CD) allows you to access technical information about your product in an easy-to-use format.

Refer to the Technical Library Installation Guide in your documentation package for instructions on installing and starting the Technical Library.
The Technical Library Product Manuals Web site is an HTML version of the Technical Library CD that you can access using a standard Web browser. In addition to product manuals, you will find links to EBFs/Updates, Technical Documents, Case Management, Solved Cases, newsgroups, and the Sybase Developer Network.

To access the Technical Library Product Manuals Web site, go to Product Manuals .

Sybase certifications on the Web

Technical documentation at the Sybase Web site is updated frequently.

For the latest information on product certifications

Point your Web browser to Technical Documents .
Select Products from the navigation bar on the left.
Select a product name from the product list.
Select the Certification Report filter, specify a time frame, and click Go.
Click a Certification Report title to display the report.

For the latest information on EBFs and Updates

Point your Web browser to Technical Documents .
Select EBFs/Updates. Enter user name and password information, if prompted (for existing Web accounts) or create a new account (a free service).
Specify a time frame and click Go.
Select a product.
Click an EBF/Update title to display the report.

To create a personalized view of the Sybase Web site (including support pages)

Set up a MySybase profile. MySybase is a free service that allows you to create a personalized view of Sybase Web pages.

Point your Web browser to Technical Documents
Click MySybase and create a MySybase profile.

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.