PHP 인터페이스 AppserverIo\Appserver\ServletEngine\Authenticator\AuthenticatorInterface

파일 보기 프로젝트 열기: appserver-io/appserver

공개 메소드들

메소드 설명
authenticate ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : boolean Try to authenticate against the configured adapter.
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.
getPassword ( ) : string | null Returns the password parsed from the request.
getUsername ( ) : string | null Returns the username parsed from the request.
isDefaultAuthenticator ( ) : boolean Query whether or not this is the default authenticator.
setDefaultAuthenticator ( ) : void Mark's the authenticator as the default one.

메소드 상세

authenticate() 공개 메소드

Try to authenticate against the configured adapter.
public authenticate ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : boolean
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 boolean TRUE if authentication has already been processed on a request before, else FALSE

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

getPassword() 공개 메소드

Returns the password parsed from the request.
public getPassword ( ) : string | null
리턴 string | null The password

getUsername() 공개 메소드

Returns the username parsed from the request.
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