Namespace: Consultingwerk.Framework
Class 
GuiClientStartupManager Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Server.AppServerStartupManager
Consultingwerk.Framework.GuiClientStartupManager

Inherits: Consultingwerk.Framework.Server.AppServerStartupManager
Implements: IStartupManager, Consultingwerk.Framework.IStartupManagerWaitForEvents

File:GuiClientStartupManager
Purpose:CCS-SSS compliant implementation of the Ccs.Common.IStartupManager
Interface for GUI for .NET Client sessions
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Jul 25 12:06:38 CEST 2018
Notes:https://github.com/progress/CCS/blob/master/Specs/Startup_Session_Service_Managers/v1_0/Startup_Manager_1_0.pdf
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094594/JSON+Configuration+File+Format

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
# DisplayDatabaseStatus (integer, integer, character) Displays the Database connection progress
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:DisplayDatabaseStatus (integer, integer, character)
# DisplayServiceStatus (integer, integer, character) Displays the launching services progress
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:DisplayServiceStatus (integer, integer, character)
+ dispose () Destroy/Shutdown/Anti-Initializer
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# DisposeDatabaseStatus () Finishes the status display for database connections
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:DisposeDatabaseStatus ()
# DisposeServiceStatus () Finishes the status display for launching services
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:DisposeServiceStatus ()
# DisposeStartupFormStatus () Finishes the status display for launching services
+ Ccs.Common.IManager getManager (Class) Retrieve an instance of the specified IManager object.
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# CHARACTER GetServiceFiles (JsonArray) Returns the combines array of service.xml file names
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# ImportServicesFromJsonObject (JsonObject) Imports services from the given JsonObject into the ttServiceLoader temp-table
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
+ initialize () Initializer/Startup
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# InitializeContextDataset () Initializes the ContextDataset
# InitializeDatabaseStatus () Initializes the status display for database connections
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:InitializeDatabaseStatus ()
# InitializeServiceStatus () Initializes the status display for launching services
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:InitializeServiceStatus ()
# InitializeStartupFormStatus () Initializes the status display for launching services
# InitializeTaskbarManager (character) Initializes the TaskbarManager instance
# LoadingServiceHandler (LoadingServiceEventArgs) Event handler for the LoadingService event of the ServiceLoader
# OnAfterWaitFor (EventArgs) Raises the AfterWaitFor event
# OnBeforeWaitFor (EventArgs) Raises the BeforeWaitFor event
# SetAlertBoxDefaults () Sets defaults for GUI alert boxes
# Startup (JsonObject) Performs the actual framework bootstrap
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:Startup (JsonObject)
# StartupAliases (JsonObject) Sets Database Aliases
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# StartupApplicationSettings (JsonObject) Initializes the ConfigurationProvider service
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:StartupApplicationSettings (JsonObject)
+ StartupAppServerConnection (JsonObject) Connects to the AppServer if required
# StartupCustomLogEntrySettings (JsonObject) Sets the Custom Log Entry settings
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# StartupDatabases (JsonObject) Performs Database Connections
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# StartupEnvironment (JsonObject) Performs Environment Configuration
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# StartupExport (JsonObject) Sets the SESSION:EXPORT
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# StartupFactory (JsonObject) Initializes the Factory implementation from factory.xml files
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# StartupManagers (JsonObject) Launches the Manager instance
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# StartupProfiler (JsonObject) Enables the Profiler
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# StartupRoutine (JsonObject) Implements the actual session startup
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:StartupRoutine (JsonObject)
# StartupServices (JsonObject) Launches Services from service.xml files
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
# StartupStaticProperties (JsonObject) Processes the static properties
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:StartupStaticProperties (JsonObject)
# ValidateAppServerFrameworkVersion () Performs validation of the AppServer and client Framework version
# WriteBanner () Writes a Banner to the AppServer logfile
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager

Top Constructor Summary
Options Name Purpose
+ GuiClientStartupManager (character) Constructor for the GuiClientStartupManager class
+ GuiClientStartupManager (JsonObject) Constructor for the GuiClientStartupManager class

Top Event Summary
Options Name Purpose
+ AfterWaitFor (Object, EventArgs) Raised after the WAIT-FOR Application:Run() is executed
+ BeforeWaitFor (Object, EventArgs) Raised before the WAIT-FOR Application:Run() is executed

Top Property Summary
Options Name Purpose
+ LOGICAL QuitAfterWaitFor
+ LOGICAL QuitOnError
+ Consultingwerk.OERA.IServiceManager ServiceManager
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
+ ISessionManager SessionManager
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
+ CHARACTER StartupForm
+ CHARACTER TaskbarApplicationId
+ LOGICAL UseNotifyIconWaitStateManager
+ LOGICAL ValidateAppServerFrameworkVersion


Method Detail
Top

PROTECTED DisplayDatabaseStatus (integer, integer, character)
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:DisplayDatabaseStatus (integer, integer, character)
Purpose: Displays the Database connection progress
Notes:

Parameters:
piCounter INTEGER
The number of the current database
piCount INTEGER
The total number of databases
pcDatabaseName CHARACTER
The name of the current database
Top

PROTECTED DisplayServiceStatus (integer, integer, character)
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:DisplayServiceStatus (integer, integer, character)
Purpose: Displays the launching services progress
Notes:

Parameters:
piCounter INTEGER
The number of the current service
piCount INTEGER
The total number of service
pcDatabaseName CHARACTER
The name of the current service
Top

PUBLIC dispose ()
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Destroy/Shutdown/Anti-Initializer
Notes: Disposes the Service Manager first. The Service Manager
is expected to dispose all services. This way, it's expected
that during disposal of the "ordinary" services, the Managers
are still present

Top

PROTECTED DisposeDatabaseStatus ()
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:DisposeDatabaseStatus ()
Purpose: Finishes the status display for database connections
Notes:

Top

PROTECTED DisposeServiceStatus ()
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:DisposeServiceStatus ()
Purpose: Finishes the status display for launching services
Notes:

Top

PROTECTED DisposeStartupFormStatus ()
Purpose: Finishes the status display for launching services
Notes:

Top

PUBLIC Ccs.Common.IManager getManager (Class)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Retrieve an instance of the specified IManager object.
Notes: If a manager is not configured, no error should be raised, but if it is
configured and fails to load, an exception must be raised.

Parameters:
pServiceType Progress.Lang.Class
The Progress.Lang.Class representing the required service.
Returns Ccs.Common.IManager
IManager implementation of the requested type, or ? if its not configured.
Top

PROTECTED CHARACTER GetServiceFiles (JsonArray)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Returns the combines array of service.xml file names
Notes:

Parameters:
poServices Progress.Json.ObjectModel.JsonArray
The JSON object with service.xml file names or direct service definitions
Returns CHARACTER
The Character Array with service.xml file names
Top

PROTECTED ImportServicesFromJsonObject (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Imports services from the given JsonObject into the ttServiceLoader
temp-table
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JsonObject to import from
Top

PUBLIC initialize ()
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Initializer/Startup
Notes:

Top

PROTECTED InitializeContextDataset ()
Purpose: Initializes the ContextDataset
Notes:

Top

PROTECTED InitializeDatabaseStatus ()
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:InitializeDatabaseStatus ()
Purpose: Initializes the status display for database connections
Notes:

Top

PROTECTED InitializeServiceStatus ()
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:InitializeServiceStatus ()
Purpose: Initializes the status display for launching services
Notes:

Top

PROTECTED InitializeStartupFormStatus ()
Purpose: Initializes the status display for launching services
Notes:

Top

PROTECTED InitializeTaskbarManager (character)
Purpose: Initializes the TaskbarManager instance
Notes: Sets the ApplicationId to Control Window Icon Grouping in the Taskbar

Parameters:
pcTaskbarApplicationId CHARACTER
The value for the Taskbar ApplicationId property
Top

PROTECTED LoadingServiceHandler (LoadingServiceEventArgs)
Purpose: Event handler for the LoadingService event of the ServiceLoader
Notes:

Parameters:
e Consultingwerk.Framework.LoadingServiceEventArgs
The LoadingServiceEventArgs with the data for this call
Top

PROTECTED OnAfterWaitFor (EventArgs)
Purpose: Raises the AfterWaitFor event
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
Top

PROTECTED OnBeforeWaitFor (EventArgs)
Purpose: Raises the BeforeWaitFor event
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
Top

PROTECTED SetAlertBoxDefaults ()
Purpose: Sets defaults for GUI alert boxes
Notes:

Top

PROTECTED Startup (JsonObject)
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:Startup (JsonObject)
Purpose: Performs the actual framework bootstrap
Notes: Invokes the IStartupValidationService after the session
has been started

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupAliases (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Sets Database Aliases
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupApplicationSettings (JsonObject)
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:StartupApplicationSettings (JsonObject)
Purpose: Initializes the ConfigurationProvider service
Notes: The applicationSettings property of the configuration does either
contain a CHARACTER value used as the name of a JSON file (.applicationsettings)
or a JSON Object with configuration strings

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PUBLIC StartupAppServerConnection (JsonObject)
Purpose: Connects to the AppServer if required
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JSON Configuration
Top

PROTECTED StartupCustomLogEntrySettings (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Sets the Custom Log Entry settings
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupDatabases (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Performs Database Connections
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupEnvironment (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Performs Environment Configuration
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupExport (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Sets the SESSION:EXPORT
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupFactory (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Initializes the Factory implementation from factory.xml files
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupManagers (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Launches the Manager instance
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupProfiler (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Enables the Profiler
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupRoutine (JsonObject)
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:StartupRoutine (JsonObject)
Purpose: Implements the actual session startup
Notes: This method may be overridden in child classes to extend the
startup process

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JSON Configuration
Top

PROTECTED StartupServices (JsonObject)
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Launches Services from service.xml files
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED StartupStaticProperties (JsonObject)
Overrides Consultingwerk.Framework.Server.AppServerStartupManager:StartupStaticProperties (JsonObject)
Purpose: Processes the static properties
Notes: Supports integer, character and logical properties

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration data
Top

PROTECTED ValidateAppServerFrameworkVersion ()
Purpose: Performs validation of the AppServer and client Framework version
Notes:

Top

PROTECTED WriteBanner ()
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager
Purpose: Writes a Banner to the AppServer logfile
Notes: The Banner file to be used can be configured using the
FrameworkSettings:BannerFile BannerFile property



Constructor Detail
Top

PUBLIC GuiClientStartupManager (character)
Purpose: Constructor for the GuiClientStartupManager class
Notes:

Parameters:
pcConfigurationFileName CHARACTER
The name of the JsonFile containing the configuration
Top

PUBLIC GuiClientStartupManager (JsonObject)
Purpose: Constructor for the GuiClientStartupManager class
Notes:

Parameters:
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject containing the configuration


Event Detail
Top

PUBLIC AfterWaitFor (Object, EventArgs)
Purpose: Raised after the WAIT-FOR Application:Run() is executed
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the AfterWaitFor event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
Top

PUBLIC BeforeWaitFor (Object, EventArgs)
Purpose: Raised before the WAIT-FOR Application:Run() is executed
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the BeforeWaitFor event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event


Property Detail
Top

PUBLIC LOGICAL QuitAfterWaitFor

Returns LOGICAL
Top

PUBLIC LOGICAL QuitOnError

Returns LOGICAL
Top

PUBLIC Consultingwerk.OERA.IServiceManager ServiceManager
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager

Returns Consultingwerk.OERA.IServiceManager
Top

PUBLIC ISessionManager SessionManager
Inherited from Consultingwerk.Framework.Server.AppServerStartupManager

Returns ISessionManager
Top

PUBLIC CHARACTER StartupForm

Returns CHARACTER
Top

PUBLIC CHARACTER TaskbarApplicationId

Returns CHARACTER
Top

PUBLIC LOGICAL UseNotifyIconWaitStateManager

Returns LOGICAL
Top

PUBLIC LOGICAL ValidateAppServerFrameworkVersion

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2024 18:37:03