LOGIN-STATE attribute

Returns a character value that represents the current state of the client-principal object.

Data type:

CHARACTER

Access:

Read-only

Applies to:

Client-principal object handle

Table 88 lists the valid values and how they can be set.

 

Table 88:

Client-principal LOGIN-STATE attribute values

This value...	Is set...
"INITIAL"	(Default value]) From the creation of an unsealed client-principal object using the CREATE CLIENT-PRINCIPAL statement until the object is sealed, and after calling the INITIALIZE( ) method on a sealed or unsealed client-principal object in any state
"LOGIN"	After the user identity represented by an unsealed client-principal object is successfully authenticated and the object is sealed using the SEAL( ) method, SECURITY-POLICY:SET-CLIENT( ) method, or the SET-DB-CLIENT function
"LOGOUT"	After executing the LOGOUT( ) method on a sealed client-principal object in the LOGIN state
"EXPIRED"	After executing the SEAL( ) method, SET-CLIENT( ) method, SET-DB-CLIENT function, or IMPORT-PRINCIPAL( ) method, or VALIDATE-SEAL( ) method, and the date and time set for the LOGIN-EXPIRATION-TIMESTAMP attribute has expired
"FAILED"	After executing the AUTHENTICATION-FAILED( ) method on an unsealed client-principal object or after a user authentication operation fails on an unsealed client-principal object when calling the SET-CLIENT( ) method or SET-DB-CLIENT function.

Figure 2 shows the supported transitions between states as described in Figure 88.

Figure 2:

Valid changes to LOGIN-STATE attribute value

When the AVM sets this attribute, it also sets the STATE-DETAIL attribute with a description of the current state. If this setting occurs as a result of invoking the AUTHENTICATION-FAILED( ) method, the AVM uses any string value you pass to this method to set the STATE-DETAIL attribute.

Attempting to write to this attribute returns a warning message.

See also:

AUTHENTICATION-FAILED( ) method, CREATE CLIENT-PRINCIPAL statement, IMPORT-PRINCIPAL( ) method, INITIALIZE( ) method, LOGIN-EXPIRATION-TIMESTAMP attribute, LOGOUT( ) method, SEAL( ) method, SET-CLIENT( ) method, SET-DB-CLIENT function, STATE-DETAIL attribute, VALIDATE-SEAL( ) method