Namespace: Consultingwerk.Framework
Class 
StartupParameterAppServerServiceManager Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.StartupParameterAppServerServiceManager

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.IAppServerServiceManager
USE-WIDGET-POOL

File:StartupParameterAppServerServiceManager
Purpose:IAppServerServiceManager implementation that provides
two partitions: "client" and "server". The "server" partition
is the default partition.
Syntax:FrameworkSettings:AppServerServiceManager
Description:The AppServer connection parameters for the "server"
partition are obtained from the -param startup parameter
in the form of: AppServer=AppServer://server/AppServerName or
AppServer=http://server/aia/Aia1?AppService=AppServerName
or another ABL supported AppServer URL syntax. The -param
can contain other settings as well - comma delimited
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Aug 31 12:24:04 CEST 2015
Notes:SCL-994

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



Top Method Summary
Options Name Purpose
+ HANDLE ConnectService (character) Connects a single AppServer partition
+ DisconnectService (character) Disconnects a single AppServer partition
+ HANDLE GetServiceHandle (character) Returns the handle to a AppServer partition - if connected - returns ? when not connected.
+ HANDLE GetServiceHandle (character, logical) Returns the handle to a AppServer partition
+ LOGICAL IsConnected (character) Returns TRUE if the specified AppServer Partition is known and connected.

Top Constructor Summary
Options Name Purpose
+ StartupParameterAppServerServiceManager () Constructor for the StartupParameterAppServerServiceManager class
+ StartupParameterAppServerServiceManager (character) Constructor for the StartupParameterAppServerServiceManager class
+ StartupParameterAppServerServiceManager (CharacterDictionary) Constructor for the StartupParameterAppServerServiceManager class

Top Property Summary
Options Name Purpose
+ CHARACTER Partitions


Method Detail
Top

PUBLIC HANDLE ConnectService (character)
Purpose: Connects a single AppServer partition
Notes: Returns the Handle to the AppServer partition (Server handle or
session handle). Throws error when connection fails

Parameters:
pcServicePartition CHARACTER
The partition to return a server handle for
Returns HANDLE
The HANDLE of the server object
Top

PUBLIC DisconnectService (character)
Purpose: Disconnects a single AppServer partition
Notes:

Parameters:
pcServicePartition CHARACTER
The partition to disconnect from
Top

PUBLIC HANDLE GetServiceHandle (character)
Purpose: Returns the handle to a AppServer partition - if connected -
returns ? when not connected.
Notes:

Parameters:
pcServicePartition CHARACTER
The name of the partition to return the handle for
Returns HANDLE
The HANDLE of the server object
Top

PUBLIC HANDLE GetServiceHandle (character, logical)
Purpose: Returns the handle to a AppServer partition
Notes: When plConnectIfRequired is set to TRUE, the partition will be
connected if required.

Parameters:
pcServicePartition CHARACTER
The name of the partition to return the handle for
plConnectIfRequired LOGICAL
Connect if not already connected
Returns HANDLE
The HANDLE of the server object
Top

PUBLIC LOGICAL IsConnected (character)
Purpose: Returns TRUE if the specified AppServer Partition is known and
connected.
Notes:

Parameters:
pcServicePartition CHARACTER
The name of the partition to check if connection is established
Returns LOGICAL
Logical value indicating if the service is connected


Constructor Detail
Top

PUBLIC StartupParameterAppServerServiceManager ()
Purpose: Constructor for the StartupParameterAppServerServiceManager class
Notes: Fails when the startup parameter do not contain the -param AppServer=...

Top

PUBLIC StartupParameterAppServerServiceManager (character)
Purpose: Constructor for the StartupParameterAppServerServiceManager class
Notes: Fails when the URL provided is empty

Parameters:
pcAppServerUrl CHARACTER
The AppServer URL
Top

PUBLIC StartupParameterAppServerServiceManager (CharacterDictionary)
Purpose: Constructor for the StartupParameterAppServerServiceManager class
Notes: Fails when the startup parameter do not contain the -param AppServer=...
Expects to find it in an entry with the key "AppServer" here

Parameters:
poParameters Consultingwerk.Framework.Collections.CharacterDictionary
The CharacterDictionary with the parsed -param values


Property Detail
Top

PUBLIC CHARACTER Partitions

Returns CHARACTER


©2006-2019 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.08.2019 23:27:38