PHP Class AppserverIo\Appserver\ServletEngine\Security\DependencyInjection\DeploymentDescriptorParser

Show file Open project: appserver-io/appserver Class Usage Examples

Protected Properties

Property Type Description
$authenticationContext AppserverIo\Psr\Servlet\ServletContextInterface The servlet context we want to parse the deployment descriptor for.

Public Methods

Method Description
getApplication ( ) : AppserverIo\Psr\Application\ApplicationInterface Returns the application context instance the servlet context is bound to.
getAuthenticationContext ( ) : AppserverIo\Psr\Servlet\ServletContextInterface Returns the servlet context instance.
injectAuthenticationContext ( AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface $authenticationContext ) : void Inject the authentication context instance.
mapAuthenticator ( string $shortname ) : string Returns the authenticator class name for the passed shortname.
parse ( ) : void Parses the servlet context's deployment descriptor file for servlets that has to be registered in the object manager.

Method Details

getApplication() public method

Returns the application context instance the servlet context is bound to.
public getApplication ( ) : AppserverIo\Psr\Application\ApplicationInterface
return AppserverIo\Psr\Application\ApplicationInterface The application context instance

getAuthenticationContext() public method

Returns the servlet context instance.
public getAuthenticationContext ( ) : AppserverIo\Psr\Servlet\ServletContextInterface
return AppserverIo\Psr\Servlet\ServletContextInterface The servlet context instance

injectAuthenticationContext() public method

Inject the authentication context instance.
public injectAuthenticationContext ( AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface $authenticationContext ) : void
$authenticationContext AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface The authentication context instance
return void

mapAuthenticator() public method

Returns the authenticator class name for the passed shortname.
public mapAuthenticator ( string $shortname ) : string
$shortname string The shortname of the requested authenticator class name
return string The requested authenticator class name

parse() public method

Parses the servlet context's deployment descriptor file for servlets that has to be registered in the object manager.
public parse ( ) : void
return void

Property Details

$authenticationContext protected property

The servlet context we want to parse the deployment descriptor for.
protected ServletContextInterface,AppserverIo\Psr\Servlet $authenticationContext
return AppserverIo\Psr\Servlet\ServletContextInterface