Admin::getUserCredentials

Description

In BBj 11.0 and higher, this method obtains BBj user credentials from the end user. A dialog appears to the user, if necessary.

Syntax

Return Value

Method

UserCredentials

getUserCredentials()

Parameters

None.

Return Values

Returns a UserCredentials object with information as obtained from the end user.

Remarks

If the user does not provide authenticated credentials, null() will be returned.

Example

rem Admin Utility Demo

 rem Use Statements
 use ::admin.bbj::Admin
 use ::admin.bbj::UserCredentials

 rem Declares
 declare Admin admin!
 declare UserCredentials userCredentials!

 rem Authenticate the user jsmith
 admin! = new Admin()
 admin!.setUser("jsmith")
 userCredentials! = admin!.getUserCredentials()
 if (userCredentials! <> null())
    print "User: " + userCredentials!.getUser()
    print "Password: " + userCredentials!.getPassword()
    print "Host: " + userCredentials!.getHost()
    print "Port: " + str(userCredentials!.getPort())
    print "SSL: " + str(userCredentials!.getSSL())
    print "Timeout: " + str(userCredentials!.getTimeout())
    end
 else
    print "Could not authenticate user"
 endif
 end 

See Also

BBj Object Syntax

Admin

Admin API