IBME GeometryService

This page contains the design document for an enhancement or feature. The design should be considered a work in progress and may not represent the final design. As this is a collaborative design, contributions and participation from other developers and users is encouraged. Use the discussion page for providing comments and suggestions.

Contents 1 Architecture Diagram 2 Description 3 Elements 3.1 GeometryService Class 3.2 AccessManager Class 3.3 SessionManager Class 3.4 Session Class 3.5 CommunicationsManager Class 3.6 AbstractPortal Class 3.7 IntraAppPortal Class 3.8 NetSockPortal Class 3.9 JobManager Class 3.10 JobScheduler Class 3.11 JobWorker Class 3.12 AbstractJob Class 3.13 NetMsgActionJob Class 3.14 NewSessionJob Class 3.15 NetMsg Class 3.16 NetMsgActionDefManager Class 3.17 AbstractNetMsgActionDef Class 3.18 NewSessionNMAD Class

[edit] Architecture Diagram

[edit] Description

The Geometry Service(GS) is an application that expands on the functionality of the Geometry Engine (GE) by adding Communications Management, Session Management, Access Controls, and Job Management.

The GS provides:

• A CommunicationsManager that manages AbstractPortal objects which are used to communicate with other applications.
• Two AbstractPortal subclasses are provided: IntraAppPortal and NetSockPortal.
• A SessionManager that manages Session objects to provide persistant access controls, DbObject caching and DbObject locking for users connected to the GS.
• An AccessManager to manage access controls to resources based on authentication.
• A JobManager that manages AbstractJob objects by maintaining a AbstractJob queue and managing multiple JobWorkers.
• A NetMsg object that represents a barebones message recieved from an AbstractPortal. This needs to be changed to include a heirarchy of messages. Need to implement an AbstractMsg class.
• A NetMsgActionDefinition concept: Once a NetMsg is recieved, it can be dynamically mapped with a Job or series of Jobs to be performed by way of a NetMsgActionDefinition object.

---

[edit] Elements

[edit] GeometryService Class

Namespace	GeometryService
Stereotype	Boundary
Scope	Public, Concrete
Description	Top level class for the GeometryService Namespace. Provides the static main() function and contains the main loop. Is the anchorning point for singleton classes like: AccessManager, SessionManager, CommunicationsManager and JobManager.

[edit] AccessManager Class

Namespace	GeometryService
Stereotype	Control
Scope	Public, Concrete
Description	Singleton. Manages access controls to resources based on authentication.

[edit] SessionManager Class

Namespace	GeometryService
Stereotype	Control
Scope	Public, Concrete
Description	Singleton. Manages Session objects and provides access to them.

[edit] Session Class

Namespace	GeometryService
Stereotype	Entity
Scope	Public, Concrete
Description	Contains information pertaining to an individual User's current session.

[edit] CommunicationsManager Class

Namespace	GeometryService
Stereotype	Control
Scope	Public, Concrete
Description	Singleton. Manages AbstractPortal objects and maintains an Inbox and Outbox queue. Manages Remote Hostname Lists.

[edit] AbstractPortal Class

Namespace	GeometryService
Stereotype	Control
Scope	Public, Abstract
Description	Base class for all Portal type objects. Mandates required functionality for subclasses. Allows for extensibility.

[edit] IntraAppPortal Class

Namespace	GeometryService
Stereotype	Boundary
Scope	Public, Concrete
Description	Subclass of AbstractPortal. Currently a Stubbed class. Functionality will be to bridge processess on the same physical computer and allow transfer ot NetMsg objects without the need to serialize the data.

[edit] NetSockPortal Class

Namespace	GeometryService
Stereotype	Boundary
Scope	Public, Concrete
Description	Subclass of AbstractPortal. Functionality will be to allow external connections over Sockets. Will use libpkg as the underlying data transfer protocol.

[edit] JobManager Class

Namespace	Jobs
Stereotype	Entity
Scope	Public, Concrete
Description	Maintains the Job queue and allows for addition of Jobs. Provides management over JobWorkers objects.

[edit] JobScheduler Class

Namespace	Jobs
Stereotype	Control
Scope	Public, Concrete
Description	Provides the ability to submit AbstractJobs to the JobManager on a reocurring basis or a single time delayed basis.

[edit] JobWorker Class

Namespace	Jobs
Stereotype	Control
Scope	Public, Concrete
Description	Works with the JobManager and executes individual jobs based on priority and Job queue status. Will likely run in its own thread.

[edit] AbstractJob Class

Namespace	Job
Stereotype	Control
Scope	Public, Abstract
Description	Bass class that defines the required attributes and operations of any Job.

[edit] NetMsgActionJob Class

Namespace	Job
Stereotype	Control
Scope	Public, Concrete
Description	Subclass of AbstractJob. Provides the routine to take a NetMsg, lookup which NetMsgActionDefinition is applicable to the NetMsg's msgType and peform the actions spelled out by the NetMsgActionDefinition. Most often, this will result in the generation of further AbstractJobs being generated.

[edit] NewSessionJob Class

Namespace	Job
Stereotype	Control
Scope	Public, Concrete
Description	Subclass of AbstractJob. Executes commands necessary to instantiate a new session.

[edit] NetMsg Class

Namespace	GeometryService
Stereotype	Entity
Scope	Public, Concrete
Description	Simple structure type object that contains the contents of a recieved Msg or to be sent Msg via an AbstractPortal.

[edit] NetMsgActionDefManager Class

Namespace	NMAD
Stereotype	Control
Scope	Public, Concrete
Description	Manages all NetMsgActionDefinition objects. Maintains a (int)msgType to AbstractNetMsgActionDef& map. Provides for registering and unregistering of NetMsgActionDefinition objects.

[edit] AbstractNetMsgActionDef Class

Namespace	NMAD
Stereotype	Control
Scope	Public, Abstract
Description	Abstract Base class that mandates certain attributes and operations required to perform the task of a NetMsgActionDef. A NetMsgActionDef is a definition of commands to be performed when a NetMsg of the appropriate msgType is recieved via an AbstractPortal. This makes the NetMsgActionDef system extensible.

[edit] NewSessionNMAD Class

Namespace	NMAD
Stereotype	Control
Scope	Public, Concrete
Description	Subclass of AbstractNetMsgActionDef. Details the actions to be performed in order to instantiate a new session. In specific, this creates a NewSessionJob object and submits it to the JobManager queue for execution.

"It is proper to take alarm at the first experiment on our liberties." - James Madison

All trademarks referenced herein are the properties of their respective owners. This site is not sponsored, endorsed, or run by the U.S. Government.