#

# Esprit Network Suite

### A Java programming framework for building Agent based client/server applications.
Includes the Esprit-Server, an universal multi channel server for rich clients.

The Esprit Network Suite builds on top of the following frameworks:
Esprit Application Suite, a Java programming framework for building advanced GUI- and database applications.
Esprit Database Suite, an easy to use yet powerful persistency solution (ORM) based on DBObjects.

This documentation describes all classes that make up the Esprit Network Suite software.

See: Description

Common Utilities
Package | Description
--- | ---
de.esprit.common | Contains utiltiy classes of common use that are project independent.
de.esprit.common.anno | Contains standard set of useful annotations
de.esprit.common.clp | Contains standard command line parser and options
de.esprit.common.concurrent | Contains classes supporting async operations executing in Thread pools
de.esprit.common.gui | Contains reuseable GUI components as well helper classes for GUI construction.
de.esprit.common.gui.action | Contains reuseable base classes for common GUI actions.
de.esprit.common.gui.comp | Contains useful frequently needed GUI components.
de.esprit.common.gui.editor | Contains all classes that make up a platform independent text editor.
de.esprit.common.gui.event | Contains events that may be useful in any application.
de.esprit.common.gui.gridbag | Contains classes for making GridBagLayout easy
de.esprit.common.gui.table | Contains GUI support classes for tables of objects.
de.esprit.common.gui.tree | Contains GUI support classes for JTree support.
de.esprit.common.gui.util | Contains non visible GUI support classes like renderers etc.
de.esprit.common.gui.wizzard | Classes that make up a generic wizzard.
de.esprit.common.io | Contains input/output related classes like readers and writers.
de.esprit.common.io.csv | Contains classes for dealing with the CSV format
de.esprit.common.io.filter | Contains various standard file filters
de.esprit.common.lic | Contains classes for dealing with licenses.
de.esprit.common.log | All these classes contribute to a flexible logging system, which is basically reuseable in any project.
de.esprit.common.log.gui | Contains a set of available LogPrinters
de.esprit.common.log.logpr | Contains LogChannel related GUI components
de.esprit.common.type | Contains a set of useful enum constants
de.esprit.common.util | Contains useful GUI utility classes for common usage.

Application Suite
Package | Description
--- | ---
de.esprit.appsuite | Contains basic classes used in every application
de.esprit.appsuite.appstore | These classes implement the Application-Store for remote software installation
de.esprit.appsuite.appstore.app | Contains raw examples and and test Apps
de.esprit.appsuite.appstore.error | Contains Exceptions used by the App-Store
de.esprit.appsuite.appstore.gui | Contains the GUI classes of the App-Store
de.esprit.appsuite.appstore.ndf | Contains all NDF structured models of the App-Store
de.esprit.appsuite.appstore.ndf.template | Contains NDF templates for appStore definitions
de.esprit.appsuite.gui | Contains GUI classes that maintain an ApplicationContext.
de.esprit.appsuite.gui.activity | Contains classes for observing async activity.
de.esprit.appsuite.gui.dialog | Contains reuseable standard dialogs.
de.esprit.appsuite.gui.dialog.memory | Contains a memory monitor dialog for observing memory usage.
de.esprit.appsuite.gui.dialog.misc | Contains a collection of miscellaneous dialogs.
de.esprit.appsuite.gui.dialog.option | Contains dialogs for choosing options by check boxes.
de.esprit.appsuite.gui.instr | Contains graphical measurement and display instruments.
de.esprit.appsuite.gui.list | Contains support classes for dealing with JList and ListModel.
de.esprit.appsuite.gui.pathtree | Contains the path-tree model for watching file system paths
de.esprit.appsuite.gui.pathtree.archive | Contains the path-tree related dialogs
de.esprit.appsuite.gui.pathtree.edit | Contains the path-tree related archiving tools
de.esprit.appsuite.gui.plaf | Contains actions for changing the look and feel.
de.esprit.appsuite.gui.table | Contains classes for Object based application-tables
de.esprit.appsuite.gui.task | Contains GUI support classes for async tasks
de.esprit.appsuite.gui.tree | Contains support classes for working with JTree
de.esprit.appsuite.io | Contains various context based IO tools
de.esprit.appsuite.io.archive | Contains base classes for the archive tools
de.esprit.appsuite.io.archive.javatar | Contains support for tar archives.
de.esprit.appsuite.io.archive.tar | Contains classes for TAR archive support
de.esprit.appsuite.io.archive.zip | Contains classes for ZIP archive support
de.esprit.appsuite.io.parser | Contains base classes for parsing text files
de.esprit.appsuite.io.wrapper | Contains classes for wrapping streams
de.esprit.appsuite.java5 | Contains special classes which need to be compiled under Java5.
de.esprit.appsuite.jversion | Contains classes java version detection and launching various java VMs.
de.esprit.appsuite.launch | Contains classes that make up the launching framework
de.esprit.appsuite.nio.ascii | Contains classes for very fast ascii-file parsing.
de.esprit.appsuite.nio.binary | Contains classes for binary file read/write support.
de.esprit.appsuite.nio.ndf | Contains Parser and Writer for the Neutral Data Format (NDF).
de.esprit.appsuite.nio.watcher | Contains classes for watching the file system.
de.esprit.appsuite.nls | Contains classes related to language specific translations.
de.esprit.appsuite.project | Contains internal classes describing the project
de.esprit.appsuite.swversion | Contains the software version detection manager
de.esprit.appsuite.task | Contains basic classes that make up the AsyncTask framework
de.esprit.appsuite.task.archive | Contains helper classes for executing the archiver tools.
de.esprit.appsuite.task.monitor | Contains support classes for monitoring async tasks
de.esprit.appsuite.task.osproc | Contains tool classes for running OS-processes
de.esprit.appsuite.task.taskmgr | Contains classes for managing asynchronous tasks.
de.esprit.appsuite.task.vm | Contains support classes for running a new VM within as a task
de.esprit.appsuite.transl | Contains the language translation keys for this project.
de.esprit.appsuite.type | Contains definitions for translatable Enum constants
de.esprit.appsuite.util | Contains common application utility classes
de.esprit.appsuite.winregistry | Contains classes for accessing the windows registry
de.esprit.appsuite.workflow | Contains classes for building workflows upon async tasks
de.esprit.appsuite.workflow.monitor | Contains support classes for monitoring workflow tasks
de.esprit.appsuite.workflow.wft | Contains support classes for building workflow tasks
de.esprit.appsuite.xml | Contains support classes for efficient XML reading and writing

Database Support
Package | Description
--- | ---
de.esprit.appsuite.database.compile | Contains classes for DBObject compilation (for developer use only)
de.esprit.appsuite.database.dbase | Contains most of the database related classes.
de.esprit.appsuite.database.dbase.clp | Contains database relevant command line options
de.esprit.appsuite.database.dbase.cred | Contains sample database credentials that may serve as templates.
de.esprit.appsuite.database.dbase.event | Contains events fired by classes of the db-package.
de.esprit.appsuite.database.dbase.meta | Contains classes that represent database meta data.
de.esprit.appsuite.database.dbase.rdbms | Contains classes that encapsulate RDBMS specific things.
de.esprit.appsuite.database.dbase.tools | Contains general purpose database tools.
de.esprit.appsuite.database.dbgui | Contains GUI components that visually display DBRecord instances like lists, tables and forms.
de.esprit.appsuite.database.dbgui.event | Contains special events used by classes in database related packages.
de.esprit.appsuite.database.dbgui.field | Contains a set of input fields for user input of various data types.
de.esprit.appsuite.database.dbgui.field.calendar | Contains all classes that make up the calendar dialogs.
de.esprit.appsuite.database.dbgui.field.editor | Contains all FieldEditors used by the Field input components.
de.esprit.appsuite.database.dbgui.field.model | Contains a set of document models for input fields.
de.esprit.appsuite.database.dbgui.field.option | Contains GUI input components for entering java-VM command line options.
de.esprit.appsuite.database.dbgui.form | Contains form components for graphical editing of DBRecord instances.
de.esprit.appsuite.database.dbgui.list | Contains the DBList component for visualizing DBRecord instances in a list.
de.esprit.appsuite.database.dbgui.table | Contains the DBTable component for visualizing DBRecord instances in a table.
de.esprit.appsuite.database.dbgui.tool | Contains the TableEditTool as an example for a database tool.
de.esprit.appsuite.database.dbo | Contains a set of standard DBObjects for testing purposes.
de.esprit.appsuite.database.io | Contains input/output related classes for DBObjects.
de.esprit.appsuite.database.xml | Contains support tools for advanced XML reading/writing
de.esprit.appsuite.database.xml.handler | Contains standard handlers supporting XML for DBObjects
de.esprit.appsuite.database.xml.model | Contains standard model classes for using XML with DBObjects

Network Suite
Package | Description
--- | ---
de.esprit.netsuite | Contains all classes that make up the EspritNetSuite software.
de.esprit.netsuite.appstore | Contains additional classes to drive an AppStore via an esprit server.
de.esprit.netsuite.client | Contains classes that make up the Client of a dual-port server
de.esprit.netsuite.client.abo | Contains the client's support classes for ABOs (Alive Business Objects)
de.esprit.netsuite.client.abo.std | Contains standard client ABOs
de.esprit.netsuite.client.activity | Contains the client's activity monitoring classes
de.esprit.netsuite.client.activity.abo | Contains GUI classes for working with Alive Business Objects (ABOs)
de.esprit.netsuite.client.activity.agent | Contains Agent activity monitoring classes
de.esprit.netsuite.client.activity.command | Contains ClientCommand activity monitoring classes
de.esprit.netsuite.client.activity.lock | Contains Lock activity monitoring classes
de.esprit.netsuite.client.activity.transfer | Contains Transfer activity monitoring classes
de.esprit.netsuite.client.admin | Contains GUI components that are special to the admin client
de.esprit.netsuite.client.admin.action | Contains admin client actions possibly reusable by other clients
de.esprit.netsuite.client.admin.srvlock | Contains ResourceLock monitoring classes
de.esprit.netsuite.client.evgate | Contains special gates for awaiting events
de.esprit.netsuite.client.gui | Contains GUI related classes of the Duap-Port Servers admin client
de.esprit.netsuite.client.gui.action | Contains network related standard actions used in the client GUI
de.esprit.netsuite.client.gui.db | Contains the client's support classes for managing remote Records
de.esprit.netsuite.client.gui.dialog | Contains standard client dialogs
de.esprit.netsuite.client.gui.event | Contains client internal events
de.esprit.netsuite.client.gui.lock | Contains the client's support classes for handling ResourceLocks
de.esprit.netsuite.client.gui.net | Contains the client's network related classes
de.esprit.netsuite.client.gui.remote | Contains classes used to perform a remote table editing
de.esprit.netsuite.client.gui.rtask | Contains GUI components dealing with remote tasks
de.esprit.netsuite.client.gui.transfer | Contains classes for monitoring all Transfers running on the server
de.esprit.netsuite.client.gui.web | Contains classes that make up the client's web browser
de.esprit.netsuite.client.info | Contains classes for requesting detailed client info
de.esprit.netsuite.client.net | Contains GUI gui components for network controlling and monitoring
de.esprit.netsuite.client.net.event | Contains events fired by the clients network components
de.esprit.netsuite.client.netch | Contains classes that build the client network adapter
de.esprit.netsuite.client.netch.io | Contains the IO specific implementations for the network connections
de.esprit.netsuite.client.tool | Contains tools accessible by the client's toolbar
de.esprit.netsuite.client.tool.chat | Contains classes that make up the client chat tool
de.esprit.netsuite.client.tool.cpu | Contains classes for configuring the server's CPU parameters
de.esprit.netsuite.client.tool.datasrc | Contains classes for displaying the server's data sources
de.esprit.netsuite.client.tool.email | Contains the dialog for configuring mail receipients for server mails
de.esprit.netsuite.client.tool.log | Contains miscellaneous standard client dialogs
de.esprit.netsuite.client.tool.mem | Contains a dialog displaying cliennt/server memory oscilloscope
de.esprit.netsuite.client.tool.messg | Contains classes for the client messaging tool
de.esprit.netsuite.client.tool.passwd | Contains classes for displaying the server's data sources
de.esprit.netsuite.client.tool.pathtree | Contains a PathTree implementation for observing a remote file system.
de.esprit.netsuite.client.tool.pathtree.action | Contains path-tree related standard actions
de.esprit.netsuite.client.tool.pathtree.agent | Contains agents for remote file-tree support
de.esprit.netsuite.client.tool.permission | Contains basic classes for permission management support
de.esprit.netsuite.client.tool.permission.agent | Contains agents for permission management support
de.esprit.netsuite.client.tool.proc | Contains classes for configuring server processes
de.esprit.netsuite.client.tool.sess | Contains classes for moitoring sessions
de.esprit.netsuite.client.tool.srvevent | Contains classes for moitoring sessions
de.esprit.netsuite.client.tool.srvload | Contains a load-meter for measuring the server load.
de.esprit.netsuite.client.tool.user | Contains classes that make up the user manager
de.esprit.netsuite.client.workflow | Contains the Workflow support classes
de.esprit.netsuite.common | Contains miscellaneous classes used on client and server
de.esprit.netsuite.demo | Contains a demo GUI for starting server and clients
de.esprit.netsuite.eclient | Contains classes for launching the client
de.esprit.netsuite.eserver | Contains classes for launching the server
de.esprit.netsuite.io | Contains classes for server side IO support
de.esprit.netsuite.netdata | Contains serializable objects which are interchanged between client and server
de.esprit.netsuite.netdata.agent | Contains base classes for implementing custom network agents
de.esprit.netsuite.netdata.agent.common | Contains network agents for common use
de.esprit.netsuite.netdata.agent.coserver | Contains co-server related Agents
de.esprit.netsuite.netdata.agent.database | Contains database related network agents for reading/writing records from/to the database
de.esprit.netsuite.netdata.agent.internal | Contains network agents for internal useage only
de.esprit.netsuite.netdata.agent.internal.abo | Contains Agents for managing Alive Business Objects (ABOs)
de.esprit.netsuite.netdata.agent.internal.config | Contains Agents dealing with server configuration parameters
de.esprit.netsuite.netdata.agent.internal.session | Contains network agents used for user and group management.
de.esprit.netsuite.netdata.agent.internal.srvlock | Contains Agents dealing with ResourceLocks
de.esprit.netsuite.netdata.agent.internal.srvlog | Contains Agents dealing with server log file management
de.esprit.netsuite.netdata.agent.internal.srvproc | Contains Agents dealing with server processes
de.esprit.netsuite.netdata.agent.internal.transfer | Contains Agents dealing with file transfers
de.esprit.netsuite.netdata.agent.internal.transfer.demo | Contains examples for file transfers
de.esprit.netsuite.netdata.agent.test | Contains network agents for testing purposes only
de.esprit.netsuite.netdata.command | Contains a collection of standard ClientCommands
de.esprit.netsuite.netdata.command.demo | Contains examples for client commands
de.esprit.netsuite.netdata.enums | Contains all constant definitions
de.esprit.netsuite.netdata.event | Contains serializable events that are sent by the server
de.esprit.netsuite.netdata.transfer | Contains base classes for file transfers
de.esprit.netsuite.rtask | Contains extensions for RemoteAsyncTask support
de.esprit.netsuite.rtask.journal | Contains the classes implementing journalled remote tasks
de.esprit.netsuite.server | These classes make up the EsprIT server
de.esprit.netsuite.server.abo | Contains server classes for working with Alive Business Objects (ABOs)
de.esprit.netsuite.server.abo.loadmeter | Contains ABOs that measure the server load
de.esprit.netsuite.server.auth | Contains classes for server side user authentication
de.esprit.netsuite.server.auth.dbuser | Contains a sample User and Group implemantation for database stroage
de.esprit.netsuite.server.auth.error | Contains a collection of errors thrown by the user authorization system
de.esprit.netsuite.server.auth.group | Contains classes defining groups for the esprit server
de.esprit.netsuite.server.auth.member | Contains classes for managing user and group assignments
de.esprit.netsuite.server.auth.user | Contains classes defining users for the esprit server
de.esprit.netsuite.server.batch | Contains classes that implement and manage the available server processes
de.esprit.netsuite.server.chmesg | Contains classes that make up the Dual-Port Servers message service
de.esprit.netsuite.server.chreq | Contains classes that make up the Dual-Port Servers request/response oriented data service
de.esprit.netsuite.server.chxfer | Contains classes that make up the server's transfer channel
de.esprit.netsuite.server.config | Contains classes that define the servers configuration
de.esprit.netsuite.server.config.webdata | Contains resources like default files for the webservice
de.esprit.netsuite.server.core | Contains basic server core classes
de.esprit.netsuite.server.coserver | Contains co-server related classes
de.esprit.netsuite.server.cpu | Contains classes of the positioner tool (MVC-demo)
de.esprit.netsuite.server.db | Contains classes for server side database configuration.
de.esprit.netsuite.server.hist | Contains classes implementing the servers task history
de.esprit.netsuite.server.lock | Contains classes for managing temporary edit locks on server resources
de.esprit.netsuite.server.netch | Contains classes that build the server network adapter
de.esprit.netsuite.server.netch.io | Contains implementation classes for Socket based network IO
de.esprit.netsuite.server.pathtree | Contains classes for remote file-tree access
de.esprit.netsuite.server.pathtree.permission | Contains remote file-tree permission related classes
de.esprit.netsuite.server.permission | These classes implement the permission system of the esprit server
de.esprit.netsuite.server.util | Contains server specific utility classes
de.esprit.netsuite.server.webserver | Contains classes that make up the built in web server
de.esprit.netsuite.transl | Contains classes which define translations for this project

Copyright © 2014 EsprIT-Systems. All Rights Reserved.