Package org.ametys.core.ui.right

Class ExplainUserRightTool

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.core.ui.right.ExplainUserRightTool

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class ExplainUserRightTool
extends StaticClientSideElement

Client side element for the explain user tool. Notably, the class will provide a list of all the registered TargetToContextConvertor

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
protected RightAssignmentContextExtensionPoint	_rightAssignmentContextEP	RightAssignmentContextExtensionPoint
protected TargetToContextConvertorExtensionPoint	_targetToContextConvertorEP	TargetToContextConvertorExtensionPoint
protected UserHelper	_userHelper	UserHelper
static final String	RIGHT_EXPLAIN_ALL_USERS_RIGHTS	rights to explain rights for any user
static final String	RIGHT_EXPLAIN_OWN_RIGHTS	rights to explain rights for their own user

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
ExplainUserRightTool()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	explainCurrentUserRight(String rightId, Object contextJS, String targetToContextConvertorId)	Explain why the current user has a given right or not on a context.
Map<String,Object>	explainRight(String rightId, Map<String,Object> user, Object contextJS, String targetToContextConvertorId)	Explain why the user has a given right or not on a context.
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, hasRight, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

RIGHT_EXPLAIN_ALL_USERS_RIGHTS

public static final String RIGHT_EXPLAIN_ALL_USERS_RIGHTS

rights to explain rights for any user

See Also:

• Constant Field Values

RIGHT_EXPLAIN_OWN_RIGHTS

public static final String RIGHT_EXPLAIN_OWN_RIGHTS

rights to explain rights for their own user

See Also:

• Constant Field Values

_targetToContextConvertorEP

protected TargetToContextConvertorExtensionPoint _targetToContextConvertorEP

TargetToContextConvertorExtensionPoint

_userHelper

protected UserHelper _userHelper

UserHelper

_rightAssignmentContextEP

protected RightAssignmentContextExtensionPoint _rightAssignmentContextEP

RightAssignmentContextExtensionPoint

Constructor Details

ExplainUserRightTool

public ExplainUserRightTool()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

getScripts

public List<ClientSideElement.Script> getScripts(boolean ignoreRights,
 Map<String,Object> contextParameters)

Description copied from interface: ClientSideElement

This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.

Specified by:

getScripts in interface ClientSideElement

Overrides:

getScripts in class StaticFileImportsClientSideElement

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

explainCurrentUserRight

public Map<String,Object> explainCurrentUserRight(String rightId,
 Object contextJS,
 String targetToContextConvertorId)

Explain why the current user has a given right or not on a context.

Parameters:

rightId - the right to explain

contextJS - the context has provided by the TargetToContextConvertor

targetToContextConvertorId - the role of the TargetToContextConvertor that provided the context

Returns:

the explanations

explainRight

public Map<String,Object> explainRight(String rightId,
 Map<String,Object> user,
 Object contextJS,
 String targetToContextConvertorId)

Explain why the user has a given right or not on a context.

Parameters:

rightId - the right to explain

user - the user identity as JSON

contextJS - the context has provided by the TargetToContextConvertor

targetToContextConvertorId - the role of the TargetToContextConvertor that provided the context

Returns:

the explanations