Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Scout/Documentation
Contents
Overview
Architecture
Main Parts of a Scout Project
Client,shared,swt,server Equinox client server
Client / Server Communication
Service Tunnel
Proxy services, Service Factories Entry point server (servlet) Outgoing point client
Message Structure
Base64 encoded Serialized objects
Session Handling
ServerSession
ClientSession
Client Concepts
Separation of UI and GUI
Job Queue
Component Model
Client Session
The client session is the main entry point for client-server communication.
Desktop
The desktop is the entry point of every Scout client application. It can (may) consist of top-level menus, active message box stack, set of available outline, active outline, active tableview, active detail form, active search form, form stack (swing: dialogs on desktop as JInternalFrames; eclipse: editors or views), dialog stack of modal and non-modal dialogs (swing: dialogs as JDialog, JFrame; eclipse: dialogs in a new Shell).
Outline
Typically a Desktop holds multiple outlines. They represent different entry points for the navigation within the application. For every outline a tree is available which allows navigating within the application.
Form
A form is both a model structure of a ui concept known as dialog or view and also a model of a wizard page. Wizard buttons are added automatically to the main box if missing.
Form fields
Form fields are the basic elements for user inputs fiels within a form. Examples are:
- TextField
- SmartField
- NumberField
- DateField
- FileChooser
- ListBox
- TreeBox
- CheckBox
- RadioButton
- ToogleButton
Futhermore there exists composites fields like:
- GroupBox
- TabBox
- SequenceBox
- SnapBox
- RangeBox
- RadioButtonGroupBox
Menu
The menu component include all links, functionalities, etc... available within the application.
Tool
Tool component is used for grouping or dividing different views. This can be used for building business views on datas or just structuring your own application.
Wizard
Wizards support a user to work in a process driven approach on a task.
Server Concepts
Server Side Equinox
Jetty, ServerApplication as Startup Point
Transaction Handling
Configuration
SQL Support
Statement Builder
config.ini
Inside of the config.ini in the server it is possible to override the member variables of services.
For example:
com.bsiag.mnet.server.services.common.sql.SqlService#directJ dbcConnection=true
If the service SqlService has a setter method for the member directJdbcConnection then the member has at runtime the value true.
With Scout Eclipse this works for all classes which extends AbstractService
For other classes it must be done by yourself for example with the class FilterConfigInjection at startup.
Security
Authentication and Authorization
JAAS
Security Filters
Granting
Describe the Permisssion Classes, the permission store, ACCESS....
Utilities
Codetypes
NLS-Support
Logging
- How is the logger configured?
- How is the log level changed? How are exceptions for single classes defined (log level is warn, except for class XY?
- How do I get the fired SQLs (including binds) in my log output?
- Changing the Logger
Change the logger to Log4j or something else.
Scout Services
scout.commons
Scheduler
Client Notification
Scout SDK
Idea Behind Scout SDK
Main Features
Building Forms and Outlines
Generation of DTOs (form data, field data)
NLS Editor
Support for Webservices
Architecture of Scout SDK
Describe how JDT and PDE is used
Back to Scout