Borland VisiBroker® 7.0 - Borland Technical Publications

vbsec::LoginModulevbsec::LoginModuleLoginModule serves as the parent of all login modules. User plugin login modules mustextend this class. Login modules are configured in the authentication configuration fileand called during the login process. Login modules are responsible of authenticatingthe given subject and associating relevant Principals and Credentials with the subject.It is also responsible for removing and disposing of such security information duringlogout.Include FileThe vbauthn.h file should be included when you use this class.MethodsArgumentsReturnsReturnsReturnsReturnsReturnsvoid initialize (Subject* subj=0,CallbackHandler *handler=0,LoginModule::states* sharedStates=0,LoginModule::options* options=0)This method initializes the login module.This method utilizes the following four arguments:■■■■subj: the subject to be authenticated.handler: the callback handler to use.sharedStates: additional authentication state provided by other login modules.Currently not used.options: configuration options specified in the authentication configuration file.Void.bool login()Performs the login. This is called during the login process. The login module shallauthenticate the subject located in the module and determine if the login is successful.true if the login succeeds, false otherwise.bool logout()Performs the logout. This is called during the logout process. The login module shalllogout the subject located in the module and determine if the logout is successful. Thelogin module might remove any credentials or identities that were established duringlogin and dispose of them.true if the logout succeeds, false otherwise.bool commit()Commits the login. This is part of the login process, called when the login succeedsaccording to the configuration options specified in the pertinent login modules. Thelogin module then associates relevant Principals and Credentials with the Subjectlocated in the module if its own authentication attempt succeeded. Or if not, it shallremove and destroy any state was saved before.true if the commit succeeds, false otherwise.bool abort()Aborts the login. This is part of the login process, called when the overall login failsaccording to the configuration options specified in the login modules. The login moduleshall remove and destroy any state was saved before.true if the abort succeeds, false otherwise.120 VisiBroker Security Guide