Package org.ametys.plugins.repository.rights

Class ACLAmetysObjectRightAssignmentContext

java.lang.Object

org.ametys.plugins.repository.rights.ACLAmetysObjectRightAssignmentContext

All Implemented Interfaces:

RightAssignmentContext, ClientSideElement, PluginAware, Serviceable

public class ACLAmetysObjectRightAssignmentContext
extends Object
implements RightAssignmentContext, Serviceable, PluginAware

Private RightAssignmentContext for ACLAmetysObject.
This implementation can be used to get a ACLAmetysObject from a JS context.
It is not supposed to be available to get or set assignments.

Nested Class Summary

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

ClientSideElement.Script, ClientSideElement.ScriptFile

Nested classes/interfaces inherited from interface org.ametys.core.right.RightAssignmentContext

RightAssignmentContext.ContextInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_resolver	The Ametys object resolver
static final String	ID	The id if this right context

Fields inherited from interface org.ametys.core.right.RightAssignmentContext

CONTEXT_LABEL_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
ACLAmetysObjectRightAssignmentContext()

Method Summary

Modifier and Type	Method	Description
Object	convertJSContext(Object jsContext)	From a JavaScript context object, converts it into a Java object
String	getContextIdentifier(Object context)	Gets the identifier of the object context
RightAssignmentContext.ContextInfo	getContextInfo(Object context)	Get info about the context and its right assignment context.
Map<String,List<String>>	getDependencies()	This method returns the list of dependencies, sorted by extension point.
String	getId()	Get the id of the element.
Set<Object>	getParentContexts(Object context)	Get the parent contexts of the object context
String	getPluginName()	Get the plugin name where the control was declared
Map<String,String>	getRights(Map<String,Object> contextParameters)	This method return the right that will be needed on client side.
List<Object>	getRootContexts(Map<String,Object> contextParameters)	Get the list of root contexts if the current workspace matches the allowed workspace
List<ClientSideElement.Script>	getScripts(boolean ignoreRights, Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
List<ClientSideElement.Script>	getScripts(Map<String,Object> contextParameters)	This method return the scripts that will be used on client side.
boolean	isPrivate()	Determines if this rights assignment context is a private context
boolean	isSupportedContext(Object context, Map<String,Object> contextualParameters)	Indicate for a given context, if this RightAssignmentContext is able to handle it.
void	service(ServiceManager smanager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
boolean	showInUserProfilesTool()	Determines if this right assignment context should be visible in the user profiles tool

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.right.RightAssignmentContext

matchWorkspace

Field Details

ID

public static final String ID

The id if this right context

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

Constructor Details

ACLAmetysObjectRightAssignmentContext

public ACLAmetysObjectRightAssignmentContext()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getId

public String getId()

Description copied from interface: ClientSideElement

Get the id of the element.

Specified by:

getId in interface ClientSideElement

Returns:

the id. Can not be null.

isPrivate

public boolean isPrivate()

Description copied from interface: RightAssignmentContext

Determines if this rights assignment context is a private context

Specified by:

isPrivate in interface RightAssignmentContext

Returns:

true if is private

showInUserProfilesTool

public boolean showInUserProfilesTool()

Description copied from interface: RightAssignmentContext

Determines if this right assignment context should be visible in the user profiles tool

Specified by:

showInUserProfilesTool in interface RightAssignmentContext

Returns:

true if the right assignment should be visible

convertJSContext

public Object convertJSContext(Object jsContext)

Description copied from interface: RightAssignmentContext

From a JavaScript context object, converts it into a Java object

Specified by:

convertJSContext in interface RightAssignmentContext

Parameters:

jsContext - the JS context object

Returns:

the Java object

getContextIdentifier

public String getContextIdentifier(Object context)

Description copied from interface: RightAssignmentContext

Gets the identifier of the object context

Specified by:

getContextIdentifier in interface RightAssignmentContext

Parameters:

context - The object context

Returns:

the identifier of the object context

getParentContexts

public Set<Object> getParentContexts(Object context)

Description copied from interface: RightAssignmentContext

Get the parent contexts of the object context

Specified by:

getParentContexts in interface RightAssignmentContext

Parameters:

context - The object context

Returns:

The parents if exist or null otherwise

getRootContexts

public List<Object> getRootContexts(Map<String,Object> contextParameters)

Description copied from interface: RightAssignmentContext

Get the list of root contexts if the current workspace matches the allowed workspace

Specified by:

getRootContexts in interface RightAssignmentContext

Parameters:

contextParameters - The contextual parameters

Returns:

The root context object in a list

isSupportedContext

public boolean isSupportedContext(Object context,
 Map<String,Object> contextualParameters)

Description copied from interface: RightAssignmentContext

Indicate for a given context, if this RightAssignmentContext is able to handle it. This method should only be call if the result of RightAssignmentContext.matchWorkspace(java.util.Map<java.lang.String, java.lang.Object>) for the given contextual parameters is true. Otherwise the behavior of the method is not defined. Note that the result of this method should be in coherence with the list of item displayed by in the assignment tool.

Specified by:

isSupportedContext in interface RightAssignmentContext

Parameters:

context - a context

contextualParameters - the application context

Returns:

true if the context is supported

getContextInfo

public RightAssignmentContext.ContextInfo getContextInfo(Object context)

Description copied from interface: RightAssignmentContext

Get info about the context and its right assignment context. Note : this method returns info about the context and the right assignment context to allow implementations to emulate different right assignment contexts based on the context

Specified by:

getContextInfo in interface RightAssignmentContext

Parameters:

context - a context object. The context object must be supported (see RightAssignmentContext.isSupportedContext(java.lang.Object, java.util.Map<java.lang.String, java.lang.Object>)).

Returns:

Info about the context and the right assignment context

getScripts

public List<ClientSideElement.Script> getScripts(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

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

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

Parameters:

ignoreRights - True to ignore the rights verification.

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of scripts or an empty list.

getRights

public Map<String,String> getRights(Map<String,Object> contextParameters)

Description copied from interface: ClientSideElement

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

Specified by:

getRights in interface ClientSideElement

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The rights in a Map of (rightId, context). Can be empty.

getPluginName

public String getPluginName()

Description copied from interface: ClientSideElement

Get the plugin name where the control was declared

Specified by:

getPluginName in interface ClientSideElement

Returns:

The plugin name. Can not be null.

getDependencies

public Map<String,List<String>> getDependencies()

Description copied from interface: ClientSideElement

This method returns the list of dependencies, sorted by extension point.

Specified by:

getDependencies in interface ClientSideElement

Returns:

a map of dependencies ids by extension point.