Package org.nuxeo.ecm.platform.actions

Class ActionService

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.actions.ActionService

All Implemented Interfaces:

Serializable, ActionManager, Adaptable, Component, Extensible, TimestampedService

public class ActionService
extends DefaultComponent
implements ActionManager

Author:

Bogdan Stefanescu

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ComponentName	ID
protected final io.dropwizard.metrics5.MetricRegistry	metrics
static final String	XP_ACTIONS
static final String	XP_FILTERS

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
ActionService()

Method Summary

Modifier and Type	Method	Description
void	activate(ComponentContext context)	Activates the component.
void	addAction(Action action)
boolean	checkFilter(String filterId, ActionContext context)	Returns false if given filter evaluation is supposed to deny access when checking for this filter.
boolean	checkFilters(List<String> filterIds, ActionContext context)	Returns false if given filters evaluation is supposed to deny access when checking for this filter.
protected boolean	checkFilters(Action action, List<String> filterIds, ActionContext context)
boolean	checkFilters(Action action, ActionContext context)
void	deactivate(ComponentContext context)	Deactivates the component.
Action	getAction(String actionId)
Action	getAction(String actionId, ActionContext context, boolean hideUnavailableAction)	Returns action with given id, evaluating its filters in given context, and returning null if filters evaluation denies access or if action is not found.
List<Action>	getActions(String category, ActionContext context)	Gets actions for a category (filters are evaluated).
List<Action>	getActions(String category, ActionContext context, boolean hideUnavailableActions)	Gets actions for a category (filters are evaluated).
List<Action>	getAllActions(String category)	Gets all actions in a category (filters are NOT evaluated).
ActionFilter	getFilter(String filterId)
ActionFilter[]	getFilters(String actionId)
boolean	isEnabled(String actionId, ActionContext context)
boolean	isEnabled(Action action, ActionContext context)
boolean	isRegistered(String actionId)
protected boolean	isTimeTracerLogEnabled()
protected boolean	register(String xp, Descriptor descriptor)
void	remove()	Cleanup method.
Action	removeAction(String actionId)
void	start(ComponentContext context)	Start the component.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

addRuntimeMessage, addRuntimeMessage, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, stop, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

XP_ACTIONS

public static final String XP_ACTIONS

Since:

2025.0

See Also:

• Constant Field Values

XP_FILTERS

public static final String XP_FILTERS

Since:

2025.0

See Also:

• Constant Field Values

ID

public static final ComponentName ID

metrics

protected final io.dropwizard.metrics5.MetricRegistry metrics

Constructor Details

ActionService

public ActionService()

Method Details

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

checkFilters

public boolean checkFilters(Action action,
 ActionContext context)

Specified by:

checkFilters in interface ActionManager

getActions

public List<Action> getActions(String category,
 ActionContext context)

Description copied from interface: ActionManager

Gets actions for a category (filters are evaluated).

Only actions available in the given context are returned

Specified by:

getActions in interface ActionManager

getAllActions

public List<Action> getAllActions(String category)

Description copied from interface: ActionManager

Gets all actions in a category (filters are NOT evaluated).

Specified by:

getAllActions in interface ActionManager

getActions

public List<Action> getActions(String category,
 ActionContext context,
 boolean hideUnavailableActions)

Description copied from interface: ActionManager

Gets actions for a category (filters are evaluated).

If hideUnavailableActions, all actions of the category are returned but actions are flagged with an available flag depending on filters evaluation.

Specified by:

getActions in interface ActionManager

isTimeTracerLogEnabled

protected boolean isTimeTracerLogEnabled()

getAction

public Action getAction(String actionId,
 ActionContext context,
 boolean hideUnavailableAction)

Description copied from interface: ActionManager

Returns action with given id, evaluating its filters in given context, and returning null if filters evaluation denies access or if action is not found.

If hideUnavailableActions is false, the action is always returned but it is flagged with an available flag depending on filters evaluation.

Specified by:

getAction in interface ActionManager

getAction

public Action getAction(String actionId)

Specified by:

getAction in interface ActionManager

isRegistered

public boolean isRegistered(String actionId)

Specified by:

isRegistered in interface ActionManager

isEnabled

public boolean isEnabled(String actionId,
 ActionContext context)

Specified by:

isEnabled in interface ActionManager

isEnabled

public boolean isEnabled(Action action,
 ActionContext context)

getFilters

public ActionFilter[] getFilters(String actionId)

Specified by:

getFilters in interface ActionManager

getFilter

public ActionFilter getFilter(String filterId)

Specified by:

getFilter in interface ActionManager

checkFilter

public boolean checkFilter(String filterId,
 ActionContext context)

Description copied from interface: ActionManager

Returns false if given filter evaluation is supposed to deny access when checking for this filter.

Specified by:

checkFilter in interface ActionManager

checkFilters

public boolean checkFilters(List<String> filterIds,
 ActionContext context)

Description copied from interface: ActionManager

Returns false if given filters evaluation is supposed to deny access when checking for this filter.

Specified by:

checkFilters in interface ActionManager

checkFilters

protected boolean checkFilters(Action action,
 List<String> filterIds,
 ActionContext context)

addAction

public void addAction(Action action)

Specified by:

addAction in interface ActionManager

register

protected boolean register(String xp,
 Descriptor descriptor)

Overrides:

register in class DefaultComponent

removeAction

public Action removeAction(String actionId)

Specified by:

removeAction in interface ActionManager

remove

public void remove()

Description copied from interface: ActionManager

Cleanup method.

Specified by:

remove in interface ActionManager