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.
handlers
filters
FilterHandler
that permits content obtained from other handlers to be rewritten.
templates
TemplateFilter
or TemplateHandler
that allow html/XML content to be processed on a tag by
tag basis.
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.
Handler
, Filter
or
Template
provide functionality that may be used as-is with an
appropriate server configuration. The most important part of the documentation
for these classes are
the configuration parameters; these classes are rarely accessed directly from your
Java code.
Many applications of the Brazil framework have been implemented using only these
classes, with no custom Java code required at all.
Handler
,
Filter
and,
TemplateInterface
,
as well as classes whose instances are passed as parameters to those interfaces, such as
Server
,
and RewriteContext
define the primary mechanisms for extending the system, by writing
Handlers, Filters, or Templates.
The descriptions of the public methods and fields are most useful, as they will be
referenced by your code.
SesionManager
, used to control session state,
Guid
, to install your own unique ID generator, or
SocketFactory
to change the underlying client socket protocol.
When writing new implementations of core services, perusing the source code (which is included in the distribution) is likely to be helpful as well, as all of the some times subtle semantics of these classes are not properly captured in the javadocs.
util
package, as well as
classes in the handler
or template
packages that are not
themselves handlerss or templatess are
utility or helper classes, they provide commonly used capabilities; the descriptions of
their public methods and fields would be most useful.
Some of the classes duplicate functionality that is now included in recent versions
of the JDK, but was not previously available. They are retained (and used by the
core system) to maximize the portability of the Brazil system across different
Java versions.
To get a better idea how the pieces fit together, see the example applications included with the distribution.