Welcome to the Brazil server developer documentation

.

Introduction and Background

The Brazil server began as an extremely small footprint http stack, originally designed to provide a URL based interface to smartcards, so the smartcards could be accessed more easily from an ordinary web browser.

Along the way it grew to provide a more flexible architecture for adding URL based interfaces to arbitrary applications and devices.

Over time it has become a modular, full function web application development system.

Supported Platforms

The Brazil Framework will run on any Java VM version 1.1 or greater, although some of the optional features available from external sources require more recent VM's.

Architectural overview

Introduction

Typical applications of the Brazil system combine one or more existing components together with custom additions, consisting of one or more implementations of:
handlers
The primary extension interface, which allows for the custom handling of URL's.
filters
A special type of handler, used in conjunction with the FilterHandler that permits content obtained from other handlers to be rewritten.
templates
Are classes that work in conjunction with the TemplateFilter or TemplateHandler that allow html/XML content to be processed on a tag by tag basis.
These custom, or domain specific extensions, interoperate with the supplied Handlers, Filters, and Templates that provide generic functionality to produce complete web applications.

How to use this manual

The following pages consist of an alphabetized listing (by package) of the JavaDoc documentation for the Brazil system, followed by a summary of the supplied Handlers and their configuration options. There are different types of classes documented here; their function determines which portions of the javadoc documentation is most relevant.

To get a better idea how the pieces fit together, see the example applications included with the distribution.