PHP Interface AppserverIo\Appserver\ServletEngine\Authenticator\AuthenticatorInterface

Author: Tim Wagner ([email protected])

Exibir arquivo Open project: appserver-io/appserver

Public Methods

Method	Description
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.

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

Returns the authentication type token.

public getAuthType ( ) : string
return	string

Return's the authentication manager instance.

public getAuthenticationManager ( ) : AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface
return	AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface	The authentication manager instance

Returns the configuration data given for authentication type.

public getConfigData ( ) : object
return	object	The configuration data

Returns the password parsed from the request.

public getPassword ( ) : string \| null
return	string \| null	The password

Returns the username parsed from the request.

public getUsername ( ) : string \| null
return	string \| null	The username

Query whether or not this is the default authenticator.

public isDefaultAuthenticator ( ) : boolean
return	boolean	TRUE if this is the default authenticator, else FALSE

Mark's the authenticator as the default one.

public setDefaultAuthenticator ( ) : void
return	void