About this book

This section describes the purpose, organization, and conventions of this document, the WebSphere® Application Server Programming Guide for Edge Components.

Who should read this book

This book describes the application programming interfaces (APIs) that are available for customizing the Edge components of WebSphere Application Server, Version 7.0. This information is intended for programmers who write plug-in applications and make other customizations. Network designers and system administrators also might be interested in this information as an indication of the types of customization that are possible.

What you should already know

Using the information in this book requires understanding of programming procedures using the Java™ or C programming languages, depending on the API that you plan to use. The methods and structures available in each exposed interface are documented, but you must know how to construct your own application, compile it for your system, and test it. Sample code is provided for some interfaces, but the samples are provided only as examples for constructing your own application.

Conventions and terminology used in this book

This documentation uses the following typographical and keying conventions.

Table 1. Conventions used in this book
Convention Meaning
Bold When referring to graphical user interfaces (GUIs), bold face indicates menus, menu items, labels, buttons, icons, and folders. It also can be used to emphasize command names that otherwise might be confused with the surrounding text.
Monospace Indicates text you must enter at a command prompt. Monospace also indicates screen text, code examples, and file excerpts.
Italics Indicates variable values that you must provide (for example, you supply the name of a file for fileName). Italics also indicates emphasis and the titles of books.
Ctrl-x Where x is the name of a key, indicates a control-character sequence. For example, Ctrl-c means hold down the Ctrl key while you press the c key.
Return Refers to the key labeled with the word Return, the word Enter, or the left arrow.
% Represents the Linux and UNIX® command-shell prompt for a command that does not require root privileges.
# Represents the Linux and UNIX command-shell prompt for a command that requires root privileges.
C:\ Represents the Windows command prompt.
Entering commands When instructed to "enter" or "issue" a command, type the command and then press Return. For example, the instruction "Enter the ls command" means type ls at a command prompt and then press Return.
[ ] Enclose optional items in syntax descriptions.
{ } Enclose lists from which you must choose an item in syntax descriptions.
| Separates items in a list of choices enclosed in { }(braces) in syntax descriptions.
... Ellipses in syntax descriptions indicate that you can repeat the preceding item one or more times. Ellipses in examples indicate that information was omitted from the example for the sake of brevity.

Accessibility

Accessibility features help a user who has a physical disability, such as restricted mobility or limited vision, to use software products successfully. These are the major accessibility features in WebSphere Application Server, Version 7.0:

Related documents and Web sites

How to send your comments

Your feedback is important in helping to provide the most accurate and high-quality information. If you have any comments about this book or any other documentation about the Edge components of WebSphere Application Server: