PHP Class AppserverIo\Appserver\ServletEngine\Security\Auth\Spi\DatabasePDOLoginModule

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Inheritance: extends UsernamePasswordLoginModule
Show file Open project: appserver-io/appserver

Protected Properties

Property Type Description
$lookupName AppserverIo\Lang\String The datasource name used to lookup in the naming directory.
$principalsQuery AppserverIo\Lang\String The database query used to load the user.
$rolesQuery AppserverIo\Lang\String The database query used to load the user's roles.

Public Methods

Method Description
initialize ( AppserverIo\Psr\Security\Auth\Subject $subject, AppserverIo\Psr\Security\Auth\Callback\CallbackHandlerInterface $callbackHandler, AppserverIo\Collections\MapInterface $sharedState, AppserverIo\Collections\MapInterface $params ) : void Initialize the login module. This stores the subject, callbackHandler and sharedState and options for the login session. Subclasses should override if they need to process their own options. A call to parent::initialize() must be made in the case of an override.

Protected Methods

Method Description
getRoleSets ( ) : array Execute the rolesQuery against the lookupName to obtain the roles for the authenticated user.
getUsersPassword ( ) : AppserverIo\Lang\String Returns the password for the user from the sharedMap data.

Method Details

getRoleSets() protected method

Execute the rolesQuery against the lookupName to obtain the roles for the authenticated user.
protected getRoleSets ( ) : array
return array Array containing the sets of roles

getUsersPassword() protected method

Returns the password for the user from the sharedMap data.
protected getUsersPassword ( ) : AppserverIo\Lang\String
return AppserverIo\Lang\String The user's password

initialize() public method

The following parameters can by default be passed from the configuration. lookupName: The datasource name used to lookup in the naming directory rolesQuery: The database query used to load the user's roles principalsQuery: The database query used to load the user
public initialize ( AppserverIo\Psr\Security\Auth\Subject $subject, AppserverIo\Psr\Security\Auth\Callback\CallbackHandlerInterface $callbackHandler, AppserverIo\Collections\MapInterface $sharedState, AppserverIo\Collections\MapInterface $params ) : void
$subject AppserverIo\Psr\Security\Auth\Subject The Subject to update after a successful login
$callbackHandler AppserverIo\Psr\Security\Auth\Callback\CallbackHandlerInterface The callback handler that will be used to obtain the user identity and credentials
$sharedState AppserverIo\Collections\MapInterface A map shared between all configured login module instances
$params AppserverIo\Collections\MapInterface The parameters passed to the login module
return void

Property Details

$lookupName protected property

The datasource name used to lookup in the naming directory.
protected String,AppserverIo\Lang $lookupName
return AppserverIo\Lang\String

$principalsQuery protected property

The database query used to load the user.
protected String,AppserverIo\Lang $principalsQuery
return AppserverIo\Lang\String

$rolesQuery protected property

The database query used to load the user's roles.
protected String,AppserverIo\Lang $rolesQuery
return AppserverIo\Lang\String