PHP Класс AppserverIo\Appserver\ServletEngine\Security\Auth\Spi\DatabasePDOLoginModule

Автор: Tim Wagner ([email protected])
Наследование: extends UsernamePasswordLoginModule
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$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.

Открытые методы

Метод Описание
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.

Защищенные методы

Метод Описание
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.

Описание методов

getRoleSets() защищенный метод

Execute the rolesQuery against the lookupName to obtain the roles for the authenticated user.
protected getRoleSets ( ) : array
Результат array Array containing the sets of roles

getUsersPassword() защищенный метод

Returns the password for the user from the sharedMap data.
protected getUsersPassword ( ) : AppserverIo\Lang\String
Результат AppserverIo\Lang\String The user's password

initialize() публичный метод

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
Результат void

Описание свойств

$lookupName защищенное свойство

The datasource name used to lookup in the naming directory.
protected String,AppserverIo\Lang $lookupName
Результат AppserverIo\Lang\String

$principalsQuery защищенное свойство

The database query used to load the user.
protected String,AppserverIo\Lang $principalsQuery
Результат AppserverIo\Lang\String

$rolesQuery защищенное свойство

The database query used to load the user's roles.
protected String,AppserverIo\Lang $rolesQuery
Результат AppserverIo\Lang\String