PHP Класс AppserverIo\Appserver\ServletEngine\Security\StandardAuthenticationManager

См. ссылку: https://github.com/appserver-io/appserver
См. ссылку: http://www.appserver.io
Автор: Florian Sydekum ([email protected])
Автор: Bernhard Wick ([email protected])
Наследование: extends AppserverIo\Appserver\Core\AbstractManager, implements AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
addAuthenticator ( AppserverIo\Appserver\ServletEngine\Authenticator\AuthenticatorInterface $authenticator ) : void Register's the passed authenticator.
addMapping ( AppserverIo\Appserver\ServletEngine\Security\MappingInterface $mapping ) : void Register's a new URL pattern to authentication type mapping.
addRealm ( AppserverIo\Appserver\ServletEngine\Security\RealmInterface $realm ) : void Add's the passed realm the the authentication manager.
getAttribute ( string $key ) : mixed Returns the value with the passed name from the context.
getAuthenticator ( AppserverIo\Appserver\ServletEngine\Security\MappingInterface $mapping = null ) : AppserverIo\Storage\StorageInterface Returns the configured authenticator for the passed URL pattern authenticator mapping.
getAuthenticators ( ) : AppserverIo\Storage\StorageInterface Returns the configured authentication types.
getIdentifier ( ) : string Initializes the manager instance.
getMappings ( ) : AppserverIo\Storage\StorageInterface Return's the storage for the URL pattern to authenticator mappings.
getRealm ( string $realmName ) : object Returns the realm with the passed name.
getRealms ( ) : AppserverIo\Collections\MapInterface Returns the map with the security domains.
handleRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : boolean Handles request in order to authenticate.
initialize ( AppserverIo\Psr\Application\ApplicationInterface $application ) : void Initializes the manager instance.
injectAuthenticators ( AppserverIo\Storage\StorageInterface $authenticators ) : void Inject the storage for the authenticators.
injectMappings ( AppserverIo\Storage\StorageInterface $mappings ) : void Inject the storage for the URL pattern to authenticator mappings.
injectRealms ( AppserverIo\Collections\MapInterface $realms ) : void Inject the map with the realms.

Описание методов

addAuthenticator() публичный Метод

Register's the passed authenticator.
public addAuthenticator ( AppserverIo\Appserver\ServletEngine\Authenticator\AuthenticatorInterface $authenticator ) : void
$authenticator AppserverIo\Appserver\ServletEngine\Authenticator\AuthenticatorInterface The authenticator to add
Результат void

addMapping() публичный Метод

Register's a new URL pattern to authentication type mapping.
public addMapping ( AppserverIo\Appserver\ServletEngine\Security\MappingInterface $mapping ) : void
$mapping AppserverIo\Appserver\ServletEngine\Security\MappingInterface The URL pattern to authenticator mapping
Результат void

addRealm() публичный Метод

Add's the passed realm the the authentication manager.
public addRealm ( AppserverIo\Appserver\ServletEngine\Security\RealmInterface $realm ) : void
$realm AppserverIo\Appserver\ServletEngine\Security\RealmInterface The realm to add
Результат void

getAttribute() публичный Метод

Returns the value with the passed name from the context.
public getAttribute ( string $key ) : mixed
$key string The key of the value to return from the context.
Результат mixed The requested attribute

getAuthenticator() публичный Метод

Returns the configured authenticator for the passed URL pattern authenticator mapping.
public getAuthenticator ( AppserverIo\Appserver\ServletEngine\Security\MappingInterface $mapping = null ) : AppserverIo\Storage\StorageInterface
$mapping AppserverIo\Appserver\ServletEngine\Security\MappingInterface The URL pattern to authenticator mapping
Результат AppserverIo\Storage\StorageInterface The storage with the authentication types

getAuthenticators() публичный Метод

Returns the configured authentication types.
public getAuthenticators ( ) : AppserverIo\Storage\StorageInterface
Результат AppserverIo\Storage\StorageInterface The storage with the authentication types

getIdentifier() публичный Метод

Initializes the manager instance.
См. также: AppserverIo\Psr\Application\ManagerInterface::initialize()
public getIdentifier ( ) : string
Результат string

getMappings() публичный Метод

Return's the storage for the URL pattern to authenticator mappings.
public getMappings ( ) : AppserverIo\Storage\StorageInterface
Результат AppserverIo\Storage\StorageInterface The storage instance

getRealm() публичный Метод

Returns the realm with the passed name.
public getRealm ( string $realmName ) : object
$realmName string The name of the requested realm
Результат object The requested realm instance

getRealms() публичный Метод

Returns the map with the security domains.
public getRealms ( ) : AppserverIo\Collections\MapInterface
Результат AppserverIo\Collections\MapInterface The security domains

handleRequest() публичный Метод

Handles request in order to authenticate.
public handleRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest, AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : boolean
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The request instance
$servletResponse AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The response instance
Результат boolean TRUE if the authentication has been successful, else FALSE

initialize() публичный Метод

Initializes the manager instance.
См. также: AppserverIo\Psr\Application\ManagerInterface::initialize()
public initialize ( AppserverIo\Psr\Application\ApplicationInterface $application ) : void
$application AppserverIo\Psr\Application\ApplicationInterface The application instance
Результат void

injectAuthenticators() публичный Метод

Inject the storage for the authenticators.
public injectAuthenticators ( AppserverIo\Storage\StorageInterface $authenticators ) : void
$authenticators AppserverIo\Storage\StorageInterface The storage instance
Результат void

injectMappings() публичный Метод

Inject the storage for the URL pattern to authenticator mappings.
public injectMappings ( AppserverIo\Storage\StorageInterface $mappings ) : void
$mappings AppserverIo\Storage\StorageInterface The storage instance
Результат void

injectRealms() публичный Метод

Inject the map with the realms.
public injectRealms ( AppserverIo\Collections\MapInterface $realms ) : void
$realms AppserverIo\Collections\MapInterface The realms
Результат void