PHP Class AppserverIo\Appserver\ServletEngine\Authenticator\BasicAuthenticator

Author: Johann Zelger ([email protected])
Author: Bernhard Wick ([email protected])
Author: Tim Wagner ([email protected])
Inheritance: extends AbstractAuthenticator
Show file Open project: appserver-io/appserver

Protected Properties

Property Type Description
$password string The password to authenticate the user with.

Public Methods

Method Description
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.
getAuthenticateHeader ( ) : string Returns the authentication header for response to set
getPassword ( ) : string Returns the parsed password

Method Details

authenticate() public method

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
return boolean TRUE if authentication has already been processed on a request before, else FALSE

getAuthenticateHeader() public method

Returns the authentication header for response to set
public getAuthenticateHeader ( ) : string
return string

getPassword() public method

Returns the parsed password
public getPassword ( ) : string
return string

Property Details

$password protected property

The password to authenticate the user with.
protected string $password
return string