PHP 클래스 AppserverIo\Appserver\ServletEngine\Authenticator\AbstractAuthenticator

상속: implements AppserverIo\Appserver\ServletEngine\Authenticator\AuthenticatorInterface
파일 보기 프로젝트 열기: appserver-io/appserver

보호된 프로퍼티들

프로퍼티 타입 설명
$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.

공개 메소드들

메소드 설명
__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.

메소드 상세

__construct() 공개 메소드

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() 공개 메소드

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

getAuthenticationManager() 공개 메소드

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

getConfigData() 공개 메소드

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

getRealmName() 공개 메소드

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

getSerial() 공개 메소드

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

getUsername() 공개 메소드

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

isDefaultAuthenticator() 공개 메소드

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

setDefaultAuthenticator() 공개 메소드

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

프로퍼티 상세

$authenticationManager 보호되어 있는 프로퍼티

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

$configData 보호되어 있는 프로퍼티

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

$defaultAuthenticator 보호되어 있는 프로퍼티

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

$serial 보호되어 있는 프로퍼티

The UUID of the authenticator.
protected string $serial
리턴 string

$username 보호되어 있는 프로퍼티

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