LOAD-DOMAINS( ) method

Loads registered domains from the specified (and connected) OpenEdge RDBMS into the ABL session domain registry. The AVM uses this registry to validate client-principal objects and set the user identity through a user authentication or single sign-on (SSO) operation for the session and its available database connections using the SET-CLIENT( ) method on the SECURITY-POLICY system handle, and for database connections using the SET-DB-CLIENT function—but only for connected databases that are configured to use the session (application) registry.

Return type:

LOGICAL

Applies to:

SECURITY-POLICY system handle

Syntax
LOAD-DOMAINS ( integer-expression \| logical-name \| alias )

integer-expression

The sequence number of a connected database from which to load registered domains. For example, invoking LOAD-DOMAINS(2) loads registered domains from the second database.

logical-name or alias

The logical name or alias of a connected database from which to load registered domains. These forms require a quoted character string or a character expression.

ABL raises ERROR if you:

Pass the parameter as the Unknown value (?)

Pass an integer-expression, logical-name, or alias that evaluates to the Unknown value (?)

Specify an integer-expression, logical-name, or alias that does not correspond to a connected database

Call LOAD-DOMAINS( ) a second or additional time and the integer-expression, logical-name, or alias does not correspond to the database used in the initial LOAD-DOMAINS( ) call

If successful, this method returns TRUE. Otherwise, it returns FALSE and you can find the cause of the failure using the ERROR-STATUS system handle.

You cannot call this method if the LOCK-REGISTRATION( ) method is successfully called. Otherwise, you can call this method multiple times per session, as long as the database used in the initial call maintains an unbroken connection and you use the same database for all subsequent calls. (OpenEdge identifies the database using a combination of the full directory path to the .db file and the database creation date.) Thus, each subsequent call to this method completely replaces the previous contents of the session registry.

Without a session registry loaded using this method (or the REGISTER-DOMAIN( ) method), any attempt to set an identity using the session registry fails and returns a message.

For more information on domains and domain registries, see OpenEdge Getting Started: Identity Management.