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

См. ссылку: https://github.com/appserver-io/appserver
См. ссылку: http://www.appserver.io
Автор: Tim Wagner ([email protected])
Наследование: implements AppserverIo\Appserver\ServletEngine\Security\MappingInterface
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$authenticatorSerial string The authenticator serial.
$httpMethodOmissions array The array with the HTTP methods that has to be omissed from authentication.
$httpMethods array The array with the HTTP methods that has to be authenticated.
$roleNames array The array with the role names.
$urlPattern string The URL pattern.

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

Метод Описание
__construct ( string $urlPattern, string $authenticatorSerial, array $roleNames = [], array $httpMethods = [], array $httpMethodOmissions = [] ) Initialize the mapping with the passed values.
getAuthenticatorSerial ( ) : string Return's the authenticator serial.
getHttpMethodOmissions ( ) : array Return's the HTTP methods that has to b omissed from authentication
getHttpMethods ( ) : array Return's the HTTP methods that has to be authenticated.
getRoleNames ( ) : array Return's the role names.
getUrlPattern ( ) : string Return's the URL pattern.
match ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest ) : boolean Return's TRUE if the passed request matches the mappings URL patter.

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

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

Initialize the mapping with the passed values.
public __construct ( string $urlPattern, string $authenticatorSerial, array $roleNames = [], array $httpMethods = [], array $httpMethodOmissions = [] )
$urlPattern string The URL pattern
$authenticatorSerial string The authenticator serial
$roleNames array The array with the role names
$httpMethods array The array with the HTTP methods that has to be authenticated
$httpMethodOmissions array The array with the HTTP methods that has to be omissed from authentication

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

Return's the authenticator serial.
public getAuthenticatorSerial ( ) : string
Результат string The authenticator serial

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

Return's the HTTP methods that has to b omissed from authentication
public getHttpMethodOmissions ( ) : array
Результат array The HTTP methods

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

Return's the HTTP methods that has to be authenticated.
public getHttpMethods ( ) : array
Результат array The HTTP methods

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

Return's the role names.
public getRoleNames ( ) : array
Результат array The role names

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

Return's the URL pattern.
public getUrlPattern ( ) : string
Результат string The URL pattern

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

Return's TRUE if the passed request matches the mappings URL patter.
public match ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest ) : boolean
$servletRequest AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The request to match
Результат boolean TRUE if the request matches, else FALSE

Описание свойств

$authenticatorSerial защищенное свойство

The authenticator serial.
protected string $authenticatorSerial
Результат string

$httpMethodOmissions защищенное свойство

The array with the HTTP methods that has to be omissed from authentication.
protected array $httpMethodOmissions
Результат array

$httpMethods защищенное свойство

The array with the HTTP methods that has to be authenticated.
protected array $httpMethods
Результат array

$roleNames защищенное свойство

The array with the role names.
protected array $roleNames
Результат array

$urlPattern защищенное свойство

The URL pattern.
protected string $urlPattern
Результат string