PHP Class AppserverIo\Appserver\ServletEngine\Authenticator\AbstractAuthenticator

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Inheritance: implements AppserverIo\Appserver\ServletEngine\Authenticator\AuthenticatorInterface
Show file Open project: appserver-io/appserver

Protected Properties

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

Public Methods

Method 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 method

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 method

Returns the authentication type token.
public getAuthType ( ) : string
return string

getAuthenticationManager() public method

Return's the authentication manager instance.
public getAuthenticationManager ( ) : AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface
return AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface The authentication manager instance

getConfigData() public method

Returns the configuration data given for authentication type.
public getConfigData ( ) : object
return object The configuration data

getRealmName() public method

Return's the realm name.
public getRealmName ( ) : string
return string The realm name

getSerial() public method

Return's the authenticator's UUID.
public getSerial ( ) : string
return string The UUID

getUsername() public method

Returns the parsed username.
public getUsername ( ) : string | null
return string | null The username

isDefaultAuthenticator() public method

Query whether or not this is the default authenticator.
public isDefaultAuthenticator ( ) : boolean
return boolean TRUE if this is the default authenticator, else FALSE

setDefaultAuthenticator() public method

Mark's the authenticator as the default one.
public setDefaultAuthenticator ( ) : void
return void

Property Details

$authenticationManager protected property

The authentication manager instance.
protected AuthenticationManagerInterface,AppserverIo\Appserver\ServletEngine\Security $authenticationManager
return AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface

$configData protected property

Holds the configuration data given for authentication type.
protected LoginConfigNodeInterface,AppserverIo\Appserver\Core\Api\Node $configData
return AppserverIo\Appserver\Core\Api\Node\LoginConfigNodeInterface

$defaultAuthenticator protected property

Mark's the authenticator as the default one.
protected Boolean,AppserverIo\Lang $defaultAuthenticator
return AppserverIo\Lang\Boolean

$serial protected property

The UUID of the authenticator.
protected string $serial
return string

$username protected property

The name of the user to authenticate.
protected string $username
return string