PHP Class AppserverIo\Appserver\ServletEngine\Authenticator\AbstractAuthenticator

See link: https://github.com/appserver-io/appserver

Author: Tim Wagner ([email protected])

Inheritance: implements AppserverIo\Appserver\ServletEngine\Authenticator\AuthenticatorInterface

Afficher le fichier Open project: appserver-io/appserver

Protected Properties

Свойство	Type	Description
$authenticationManager	AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface	The authentication manager instance.
$configData	AppserverIo\Appserver\Core\Api\Node\LoginConfigNodeInterface	Holds the configuration data given for authentication type.
$defaultAuthenticator	AppserverIo\Lang\Boolean	Mark's the authenticator as the default one.
$serial	string	The UUID of the authenticator.
$username	string	The name of the user to authenticate.

Méthodes publiques

Méthode	Description
__construct ( AppserverIo\Appserver\Core\Api\Node\LoginConfigNodeInterface $configData, AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface $authenticationManager, boolean $defaultAuthenticator = null )	Constructs the authentication type.
getAuthType ( ) : string	Returns the authentication type token.
getAuthenticationManager ( ) : AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface	Return's the authentication manager instance.
getConfigData ( ) : object	Returns the configuration data given for authentication type.
getRealmName ( ) : string	Return's the realm name.
getSerial ( ) : string	Return's the authenticator's UUID.
getUsername ( ) : string \| null	Returns the parsed username.
isDefaultAuthenticator ( ) : boolean	Query whether or not this is the default authenticator.
setDefaultAuthenticator ( ) : void	Mark's the authenticator as the default one.

Method Details

__construct() public méthode

Constructs the authentication type.

public __construct ( AppserverIo\Appserver\Core\Api\Node\LoginConfigNodeInterface $configData, AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface $authenticationManager, boolean $defaultAuthenticator = null )
$configData	AppserverIo\Appserver\Core\Api\Node\LoginConfigNodeInterface	The configuration data for auth type instance
$authenticationManager	AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface	The authentication manager instance
$defaultAuthenticator	boolean	The flag for the default authenticator

getAuthType() public méthode

Returns the authentication type token.

public getAuthType ( ) : string
Résultat	string

getAuthenticationManager() public méthode

Return's the authentication manager instance.

public getAuthenticationManager ( ) : AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface
Résultat	AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface	The authentication manager instance

getConfigData() public méthode

Returns the configuration data given for authentication type.

public getConfigData ( ) : object
Résultat	object	The configuration data

getRealmName() public méthode

Return's the realm name.

public getRealmName ( ) : string
Résultat	string	The realm name

getSerial() public méthode

Return's the authenticator's UUID.

public getSerial ( ) : string
Résultat	string	The UUID

getUsername() public méthode

Returns the parsed username.

public getUsername ( ) : string \| null
Résultat	string \| null	The username

isDefaultAuthenticator() public méthode

Query whether or not this is the default authenticator.

public isDefaultAuthenticator ( ) : boolean
Résultat	boolean	TRUE if this is the default authenticator, else FALSE

setDefaultAuthenticator() public méthode

Mark's the authenticator as the default one.

public setDefaultAuthenticator ( ) : void
Résultat	void

Property Details

$authenticationManager protected_oe property

The authentication manager instance.

protected AuthenticationManagerInterface,AppserverIo\Appserver\ServletEngine\Security $authenticationManager
Résultat	AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface

$configData protected_oe property

Holds the configuration data given for authentication type.

protected LoginConfigNodeInterface,AppserverIo\Appserver\Core\Api\Node $configData
Résultat	AppserverIo\Appserver\Core\Api\Node\LoginConfigNodeInterface

$defaultAuthenticator protected_oe property

Mark's the authenticator as the default one.

protected Boolean,AppserverIo\Lang $defaultAuthenticator
Résultat	AppserverIo\Lang\Boolean

$serial protected_oe property

The UUID of the authenticator.

protected string $serial
Résultat	string

$username protected_oe property

The name of the user to authenticate.

protected string $username
Résultat	string