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

См. ссылку: https://github.com/appserver-io/appserver

См. ссылку: http://www.appserver.io

Автор: Tim Wagner ([email protected])

Наследование: extends UsernamePasswordLoginModule

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

Свойство	Тип	Описание
$rolesPathPrefix	string	The naming directory name prefix used to load the user's roles.
$userPathPrefix	string	The naming directroy name prefix used to load the user.

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

Метод	Описание
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.
logout ( ) : boolean	Performs the user logout.

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

Метод	Описание
getRoleSets ( ) : array	Get the roles the current user belongs to by querying the rolesPathPrefix + '/' + super.getUsername() JNDI location.
getUsersPassword ( ) : AppserverIo\Lang\String	Returns the password for the user from the naming directory.

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

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

Get the roles the current user belongs to by querying the rolesPathPrefix + '/' + super.getUsername() JNDI location.

protected getRoleSets ( ) : array
Результат	array	The roles the user is assigned to

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

Returns the password for the user from the naming directory.

protected getUsersPassword ( ) : AppserverIo\Lang\String
Результат	AppserverIo\Lang\String	The user's password

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

The following parameters can by default be passed from the configuration. rolesPathPrefix: The naming directory prefix used to load the user's roles userPathPrefix: The naming directory prefix 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

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

Performs the user logout.

public logout ( ) : boolean
Результат	boolean	Always TRUE

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

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

The naming directory name prefix used to load the user's roles.

protected string $rolesPathPrefix
Результат	string

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

The naming directroy name prefix used to load the user.

protected string $userPathPrefix
Результат	string