PHP Interface AppserverIo\Appserver\ServletEngine\Security\MappingInterface

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Show file Open project: appserver-io/appserver Interface Usage Examples

Public Methods

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

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