arlut.csd.ganymede.common

Interface Summary
Interface	Description
ClientMessage	Old-skool 'enumeration' interface for server-to-client messages.
FieldType	Hackified enumeration of defined types for database fields in the Ganymede `DBStore`.
InvidAllocator	This interface is used by the Invid class to provide an Invid when given a short type number and an int object number.
ObjectStatus	Interface constants used to enumerate possible editing states for a `DBEditObject`.
QueryDescriber	A simple interface that can be used on the Ganymede server to provide name lookups for the toString() method of a Query object chain.
RMISSLClientListener	This interface is used to receive notifications when an RMI SSL connection is formed on the Ganymede client.
SchemaConstants	This file defines known constants for pre-defined Schema object types, fields, and certain pre-defined objects that the server depends on for administering default permissions.

Class Summary
Class	Description
adminAsyncMessage	The adminAsyncMessage class is used by the Ganymede server to pass asynchronous messages to the Ganymede admin console.
AdminEntry	Serializable data carrier object used by the Ganymede server to report a row of user status to the Ganymede admin console.
BaseDump	This class is intended to serve as a stub to hold basic information about server side categories for the client to process locally.
BaseListTransport	This class is intended to provide a serializable object that can be used to bulk-dump a static description of the category and base structures on the server to the client.
CategoryDump	This class is intended to serve as a stub to hold basic information about server side categories for the client to process locally.
CategoryTransport	This class is intended to provide a serializable object that can be used to bulk-dump a static description of the category and base structures on the server to the client.
CatTreeNode	This class is a simple `treeNode` subclass with a `Category` data element.
clientAsyncMessage	The clientAsyncMessage class is used by the Ganymede server to pass asynchronous messages to the Ganymede client.
DumpResult	This class is a serializable transport object, used to transmit the results of a data dump query to the client.
DumpResultCol	This class is a simple data carrier for column definitions carried in the DumpResult class.
FieldBook	A data structure which identifies a collection of invids and field identifiers which are to be used for some kind of external processing.
FieldInfo	This class is a serializable object used to return all the value information the client's `containerPanel` needs to render a specific field instance, including the current value held in this field and the current editability/visibility this field has with respect to the user's `GanymedeSession`..
FieldOptionMatrix	Serializable field option matrix object, used to handle field options for a SyncRunner.
FieldTemplate	This class is a serializable object used to return all the static information the client's `containerPanel` needs to render a specific kind of field.
Invid	An Invid is an immutable object id (an INVariant ID) in the Ganymede system.
InvidPool	This InvidPool class is used by the Invid class to provide an Invid when given a short type number and an int object number.
InvidSlot	This (non-public) class is used in the `InvidPool` to softly reference Invids that we are storing for purposes of interning.
ObjectHandle	This class is used to group information about objects.
PermEntry	Serializable and immutable permissions entry object, used to store and transmit permissions for a specific `DBObjectBase` and `DBObjectBaseField`.
PermMatrix	Serializable permissions matrix object, used to handle permissions for a given user, admin, or role.
Query	The Query class is used to submit query requests to the GANYMEDE server, both for complex database searches and for simple object listings.
QueryAndNode	Logical AND node for use in a serialized `Query` object's `QueryNode` tree.
QueryDataNode	Serializable QueryNode that can be used to compare a field against a query parameter.
QueryDeRefNode	This class is used to represent a linked Query in a Query tree.
QueryNode	A QueryNode is a node in a serialized `Query` tree.
QueryNotNode	Logical NOT node for use in a serialized `Query` object's `QueryNode` tree.
QueryOrNode	Logical OR node for use in a serialized `Query` object's `QueryNode` tree.
QueryResult	This class is a serializable object-list result object, which conveys results from a query/list operation along with methods that can be used to extract the results out of the query/list.
QueryResultContainer	This class presents a List-interface on top of a query result set.
Result	The Result class is effectively a serializable, labeled `Invid` that can be passed from the server to the client.
ReturnVal	This class provides a report on the status of the client's requested operation.
RMISSLClientSocketFactory
RMISSLServerSocketFactory
scheduleHandle	Handle object used to help manage background tasks registered in the Ganymede Server's `GanymedeScheduler`.
windowSizer	This utility class handles saving and restoring window sizes for the Ganymede client, using the Java Preferences API that was introduced in Java 1.4.

Enum Summary
Enum	Description
ErrorTypeEnum	This Enum is used to label certain types of error conditions that can be transmitted by a `ReturnVal` from the server to the client As a Java 5 enum, this class is inherently serializable, and the Ganymede server's RMI API involves the transmission of ErrorTypeEnum values to and from Ganymede clients.
scheduleHandle.TaskStatus
scheduleHandle.TaskType
SyncPrefEnum	Enum of synchronization choices for a specific object type or field in the Ganymede server.

Exception Summary
Exception	Description
GanyParseException	This is a Ganymede-specific RemoteException subclass that can be thrown by the server if a parse method is called with a string that does not match the parser's grammar.
GanyPermissionsException	This is a Ganymede-specific RemoteException subclass that can be thrown by the server if a method is called which can cause a reject due to permissions failure.
NotLoggedInException	This is a Ganymede-specific RemoteException subclass that can be thrown by the server if a method is called on a GanymedeSession after that session has terminated.
RegexpException	This is a Ganymede-specific Runtime Exception that can be thrown by the server if a bad regular expression is encountered by the Ganymede server's query engine.
suspendedTaskException	Locally defined exception, used to throw control out of a synchronized block in scheduleHandle.runTask if the task is suspended.

Package arlut.csd.ganymede.common Description

Classes and interfaces that are used in common among the Ganymede server, client, and admin console.

Almost all of the classes in this package implement the Serializable interface so that they can be passed as data transport objects over RMI between the Ganymede server, client, and admin console.

Others, such as the windowSizer class, are not serializable, but instead are intended to be used by code in multiple other Ganymede packages. In the case of windowSizer, it is used in both the admin console and the Swing gui client.

In addition to the classes in this package, there are a handful of interfaces that provide constants which are used across the server, client, and admin console.

While data transport objects are defined in this package, the remote interfaces defining supported remote method calls are defined in the objects can be passed via serialization arlut.csd.ganymede.rmi package.