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

링크 보기: https://github.com/appserver-io/appserver
링크 보기: http://www.appserver.io
저자: Tim Wagner ([email protected])
상속: extends AbstractAuthenticator
파일 보기 프로젝트 열기: appserver-io/appserver

보호된 프로퍼티들

프로퍼티 타입 설명
$password string The password to authenticate the user with.

공개 메소드들

메소드 설명
authenticate ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : boolean Try to authenticate the user making this request, based on the specified login configuration.
getPassword ( ) : AppserverIo\Lang\String Returns the parsed password.
login ( string $username, string $password, AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest ) : AppserverIo\Psr\Security\PrincipalInterface Tries the login the passed username/password combination for the login configuration.
logout ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest ) : void Logout the actual user from the session.

보호된 메소드들

메소드 설명
forwardToErrorPage ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void Forward's the request to the configured error page.
forwardToFormRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void Forward's the request to the stored one or, if the user has not been on any page before, the application's base URL.
forwardToLoginPage ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void Forward's the request to the configured login page.
matchRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest ) : boolean Does this request match the saved one, so that it must be the redirect we signaled after successful authentication?
onCache ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void Will be invoked to handle a cached authentication request.
onCredentials ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void Will be invoked to load the credentials from the request.
onFailure ( AppserverIo\Appserver\ServletEngine\Security\RealmInterface $realm, AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void Will be invoked when login fails for some reasons.
onLogin ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void Will be invoked to request authentication.
onResubmit ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void Will be invoked when login will be re-submitted.
onSuccess ( AppserverIo\Psr\Security\PrincipalInterface $userPrincipal, AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void Will be invoked on a successfull login.
register ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse, AppserverIo\Psr\Security\PrincipalInterface $userPrincipal ) : void Register's the user principal and the authenticytion in the request and session.
restoreRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpSessionInterface $session ) : void Populates the passed request with the request data of the original request found in the also passed session.
saveRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpSessionInterface $session ) : void Stores the data of the passed request in the also passed session.

메소드 상세

authenticate() 공개 메소드

Return TRUE if any specified constraint has been satisfied, or FALSE if we have created a response challenge already.
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

forwardToErrorPage() 보호된 메소드

Forward's the request to the configured error page.
protected forwardToErrorPage ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 void

forwardToFormRequest() 보호된 메소드

Forward's the request to the stored one or, if the user has not been on any page before, the application's base URL.
protected forwardToFormRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 void

forwardToLoginPage() 보호된 메소드

Forward's the request to the configured login page.
protected forwardToLoginPage ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 void

getPassword() 공개 메소드

Returns the parsed password.
public getPassword ( ) : AppserverIo\Lang\String
리턴 AppserverIo\Lang\String The password

login() 공개 메소드

Tries the login the passed username/password combination for the login configuration.
public login ( string $username, string $password, AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest ) : AppserverIo\Psr\Security\PrincipalInterface
$username string The username used to login
$password string The password used to authenticate the user
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
리턴 AppserverIo\Psr\Security\PrincipalInterface The authenticated user principal

logout() 공개 메소드

Logout the actual user from the session.
public logout ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
리턴 void

matchRequest() 보호된 메소드

Does this request match the saved one, so that it must be the redirect we signaled after successful authentication?
protected matchRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest ) : boolean
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
리턴 boolean TRUE if the request matches the saved one, else FALSE

onCache() 보호된 메소드

Will be invoked to handle a cached authentication request.
protected onCache ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 void

onCredentials() 보호된 메소드

Will be invoked to load the credentials from the request.
protected onCredentials ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 void

onFailure() 보호된 메소드

Will be invoked when login fails for some reasons.
protected onFailure ( AppserverIo\Appserver\ServletEngine\Security\RealmInterface $realm, AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void
$realm AppserverIo\Appserver\ServletEngine\Security\RealmInterface The realm instance containing the exception stack
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 void

onLogin() 보호된 메소드

Will be invoked to request authentication.
protected onLogin ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 void

onResubmit() 보호된 메소드

Will be invoked when login will be re-submitted.
protected onResubmit ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 void

onSuccess() 보호된 메소드

Will be invoked on a successfull login.
protected onSuccess ( AppserverIo\Psr\Security\PrincipalInterface $userPrincipal, AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : void
$userPrincipal AppserverIo\Psr\Security\PrincipalInterface The user principal logged into the system
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
리턴 void

register() 보호된 메소드

Register's the user principal and the authenticytion in the request and session.
protected register ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse, AppserverIo\Psr\Security\PrincipalInterface $userPrincipal ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The servlet response instance
$userPrincipal AppserverIo\Psr\Security\PrincipalInterface The actual user principal
리턴 void

restoreRequest() 보호된 메소드

Populates the passed request with the request data of the original request found in the also passed session.
protected restoreRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpSessionInterface $session ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$session AppserverIo\Psr\Servlet\Http\HttpSessionInterface The session instance
리턴 void

saveRequest() 보호된 메소드

Stores the data of the passed request in the also passed session.
protected saveRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpSessionInterface $session ) : void
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The servlet request instance
$session AppserverIo\Psr\Servlet\Http\HttpSessionInterface The session instance
리턴 void

프로퍼티 상세

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

The password to authenticate the user with.
protected string $password
리턴 string