Package org.ametys.plugins.mobileapp.action

Class AbstractLoggedAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.plugins.mobileapp.action.AbstractLoggedAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

GetAuthAction, GetEventTypesAction, GetFeedsAction, GetFeedsContentsAction, GetFeedsContentUnreadAction, GetNotificationsPrefsAction, GetProjectsAction, GetProjectsFeedAction, GetProjectsFeedsUnreadAction, LogoutAction, SetNotificationsPrefsAction

public abstract class AbstractLoggedAction
extends ServiceableAction

An action that requires to be logged in

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected JSONUtils	_jsonUtils	JSON Utils

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
AbstractLoggedAction()

Method Summary

Modifier and Type	Method	Description
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
Map<String,Object>	doAction(Request request, Map<String,Object> jsonParams)	Execute the action
protected abstract Map<String,Object>	doLoggedInAction(Request request, Map<String,Object> jsonParams)	Execute the action that requires to be logged in
protected Object	getParameter(String name, Map<String,Object> jsonParams, Request request)	Get a parameter either from the POST body or directly from the request parameters
protected Map<String,Object>	getParameters(Map objectModel)	Get a map of parameters from the POST body
void	service(ServiceManager smanager)

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

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_jsonUtils

protected JSONUtils _jsonUtils

JSON Utils

Constructor Details

AbstractLoggedAction

public AbstractLoggedAction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

doAction

public Map<String,Object> doAction(Request request,
 Map<String,Object> jsonParams)

Execute the action

Parameters:

request - the request

jsonParams - map of parameters passed in the post body as json

Returns:

the json map to return

doLoggedInAction

protected abstract Map<String,Object> doLoggedInAction(Request request,
 Map<String,Object> jsonParams)

Execute the action that requires to be logged in

Parameters:

request - the request

jsonParams - map of parameters passed in the post body as json

Returns:

the json map to return

act

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

Throws:

Exception

getParameters

protected Map<String,Object> getParameters(Map objectModel)
                                    throws IOException

Get a map of parameters from the POST body

Parameters:

objectModel - the objectModel from whidh the body will be read

Returns:

a Map representing the body, parsed as json

Throws:

IOException - something went wrong

getParameter

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

Get a parameter either from the POST body or directly from the request parameters

Parameters:

name - the name of the parameter to fetch

jsonParams - the json parameters passed

request - the request to read from

Returns:

an Object (if from json) or a String (if from the request)