Client-principal object handle

A handle to a Client-principal object. Each Client-principal object instance contains information specific to one user login session. This login session may be used as an application or database user identity from an authentication domain registered in a trusted authentication domain registry. You create an instance of a Client-principal object at run time using the CREATE CLIENT-PRINCIPAL statement.

Note: You use a Client-principal object with the SET-CLIENT( ) method or SET-DB-CLIENT function to set the user identity for an ABL session or OpenEdge database. You can have only one active Client-principal object set as the current user at any one point in time for a session or database connection.

Syntax

client-principal-handle [ :attribute | :method ]

client-principal-handle

A variable of type HANDLE that references a Client-principal object.

attribute

An attribute of the Client-principal object handle.

method

A method of the Client-principal object handle.

Attributes

AUDIT-EVENT-CONTEXT attribute	CLIENT-TTY attribute
CLIENT-WORKSTATION attribute	DOMAIN-DESCRIPTION attribute
DOMAIN-NAME attribute	DOMAIN-TYPE attribute
HANDLE attribute	INSTANTIATING-PROCEDURE attribute
LOGIN-EXPIRATION-TIMESTAMP attribute	LOGIN-HOST attribute
LOGIN-STATE attribute	ROLES attribute
SEAL-TIMESTAMP attribute	SESSION-ID attribute
STATE-DETAIL attribute	TYPE attribute
USER-ID attribute	–

Methods

AUTHENTICATION-FAILED( ) method	EXPORT-PRINCIPAL( ) method
GET-PROPERTY( ) method	IMPORT-PRINCIPAL( ) method
LIST-PROPERTY-NAMES( ) method	LOGOUT( ) method
SEAL( ) method	SET-PROPERTY( ) method
VALIDATE-SEAL( ) method	–

See also

AUDIT-CONTROL system handle, AUDIT-POLICY system handle, CREATE CLIENT-PRINCIPAL statement, SECURITY-POLICY system handle, SET-CLIENT( ) method, SETUSERID function, SET-DB-CLIENT function

OpenEdge Release 10.2B

Copyright © 2009 Progress Software Corporation