PHP Class AppserverIo\Appserver\ServletEngine\Security\Mapping

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Inheritance: implements AppserverIo\Appserver\ServletEngine\Security\MappingInterface
Show file Open project: appserver-io/appserver

Protected Properties

Property Type Description
$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.

Public Methods

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

Method Details

__construct() public method

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() public method

Return's the authenticator serial.
public getAuthenticatorSerial ( ) : string
return string The authenticator serial

getHttpMethodOmissions() public method

Return's the HTTP methods that has to b omissed from authentication
public getHttpMethodOmissions ( ) : array
return array The HTTP methods

getHttpMethods() public method

Return's the HTTP methods that has to be authenticated.
public getHttpMethods ( ) : array
return array The HTTP methods

getRoleNames() public method

Return's the role names.
public getRoleNames ( ) : array
return array The role names

getUrlPattern() public method

Return's the URL pattern.
public getUrlPattern ( ) : string
return string The URL pattern

match() public method

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
return boolean TRUE if the request matches, else FALSE

Property Details

$authenticatorSerial protected property

The authenticator serial.
protected string $authenticatorSerial
return string

$httpMethodOmissions protected property

The array with the HTTP methods that has to be omissed from authentication.
protected array $httpMethodOmissions
return array

$httpMethods protected property

The array with the HTTP methods that has to be authenticated.
protected array $httpMethods
return array

$roleNames protected property

The array with the role names.
protected array $roleNames
return array

$urlPattern protected property

The URL pattern.
protected string $urlPattern
return string