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

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
$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.

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.
logout ( ) : boolean Performs the user logout.

Protected Methods

Method Description
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.

Method Details

getRoleSets() protected method

Get the roles the current user belongs to by querying the rolesPathPrefix + '/' + super.getUsername() JNDI location.
protected getRoleSets ( ) : array
return array The roles the user is assigned to

getUsersPassword() protected method

Returns the password for the user from the naming directory.
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. 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
return void

logout() public method

Performs the user logout.
public logout ( ) : boolean
return boolean Always TRUE

Property Details

$rolesPathPrefix protected property

The naming directory name prefix used to load the user's roles.
protected string $rolesPathPrefix
return string

$userPathPrefix protected property

The naming directroy name prefix used to load the user.
protected string $userPathPrefix
return string