Package org.ametys.plugins.mobileapp.action

Class AbstractGetTokenAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.plugins.mobileapp.action.AbstractGetTokenAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe, Action

Direct Known Subclasses:

GetTokenFromFormAction, GetTokenFromOIDCAction

public abstract class AbstractGetTokenAction
extends ServiceableAction
implements ThreadSafe

Returns the token for a user (only to be used by the mobile app on one site)

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthenticationTokenManager	_authenticationTokenManager	Authentication Token Manager
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected JSONUtils	_jsonUtils	JSON Utils
protected PopulationContextHelper	_populationContextHelper	The helper for the associations population/context
protected UserPopulationDAO	_userPopulationDAO	The user population DAO

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractGetTokenAction()

Method Summary

Modifier and Type	Method	Description
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
protected Object	getParameter(String name, Map<String,Object> jsonParams, Request request)	Get a parameter from the mobile app, either from the request body or a request parameter
void	service(ServiceManager smanager)
protected abstract UserIdentity	tryConnect(Map<String,Object> params, Request request, String context, UserPopulation userPopulation, CredentialProvider credentialProvider, int credentialProviderIndex)	Try to authenticate the current mobile user

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_authenticationTokenManager

protected AuthenticationTokenManager _authenticationTokenManager

Authentication Token Manager

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

The user population DAO

_populationContextHelper

protected PopulationContextHelper _populationContextHelper

The helper for the associations population/context

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_jsonUtils

protected JSONUtils _jsonUtils

JSON Utils

Constructor Details

AbstractGetTokenAction

public AbstractGetTokenAction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

act

public Map act(Redirector redirector,
 SourceResolver resolver,
 Map objectModel,
 String source,
 Parameters parameters)
        throws Exception

Specified by:

act in interface Action

Throws:

Exception

getParameter

protected Object getParameter(String name,
 Map<String,Object> jsonParams,
 Request request)

Get a parameter from the mobile app, either from the request body or a request parameter

Parameters:

name - the parameter name

jsonParams - the decoded JSON request body, if any

request - the request

Returns:

the parameter value, or null if not found

tryConnect

protected abstract UserIdentity tryConnect(Map<String,Object> params,
 Request request,
 String context,
 UserPopulation userPopulation,
 CredentialProvider credentialProvider,
 int credentialProviderIndex)

Try to authenticate the current mobile user

Parameters:

params - the parameters issued by the mobile app

request - the authentication request

context - the population context

userPopulation - the population

credentialProvider - the CredentialProvider

credentialProviderIndex - the index of the credentialProvider in the given userPopulation

Returns:

the authenticated user, if any