de.hybris.platform.hmc.security

Class TypeAccessRightsEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.security.TypeAccessRightsEditorChip

All Implemented Interfaces:

ChangeIndicatorChip, ClipChip, ItemAcceptor, SpecialReloadChip, SpecialSaveChip, ToolbarProvider, Chip, Serializable, Cloneable

public class TypeAccessRightsEditorChip
extends AbstractChip
implements ClipChip, SpecialSaveChip, SpecialReloadChip, ItemAcceptor, ToolbarProvider, ChangeIndicatorChip

This is a editor panel for the type editor representing access rights.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_PRINCIPAL_EVENT
static String	ADINDICATOR
static String	CHANGE_PERMISSION_EVENT
static String	JSP_URI
static String	PERMISSION_EVENT
static String	REMOVE_PRINCIPAL_EVENT
static String	RIGHT_EVENT
static String	SELECT_PRINCIPAL_EVENT
static String	TYPE
static String	TYPEORFD_EVENT

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
TypeAccessRightsEditorChip(DisplayState displayState, Chip parent) Creates a new TypeAccessRightsEditorChip with the given displaystate and parent.

Method Summary

Modifier and Type	Method and Description
protected void	addPrincipal()
boolean	allowsMultipleSelection() Method from ItemAcceptor interface.
AbstractToolbarChip	createToolbar() Creates the toolbar for this chip.
AccessManager	getAccessManager() Returns the accessmanager instance of the current session.
String	getAttributeDescriptorID(AttributeDescriptor attributeDescriptor) Returns the attributedescriptor qualifier for the given AttributeDescriptor, which is (ADINDICATOR + attributedescriptorqualifier).
Set	getAttributeDescriptors() Returns a sorted set of attributedescriptors of the type of this chip.
static String	getCombinedID(Principal principal) For a given Principal this method returns a unique string id.
ComposedType	getComposedType() Returns the type of the item this chip holds.
String	getIcon(Item item)
protected ItemChip	getItemChip() Returns the itemchip which is a parent of this chip.
String	getJSPURI() Returns the jsp uri for this chip.
String	getPermission(String qualifier, String right) For the given qualifier (which is either TYPE or [ADINDICATOR+attributedescriptorqualifier]) and userright string (READ, CHANGE, etc.) this method returns GRANT, DENY or NONE according to the current permission.
Principal	getPrincipalByCombinedId(String combinedId) Returns the principal with the given combined id.
Set	getPrincipals() Returns a list of principals for which userrights are set for the current type.
Principal	getSelectedPrincipal() Returns the currently selected principal.
AbstractToolbarChip	getToolbar() Returns the toolbar for this chip.
boolean	hasItem() Returns true if itemChip.getItem() is not null.
void	initialize() Initially loads the permission maps, selects the default principal and creates the toolbar.
boolean	isChanged()
boolean	isInitialized()
boolean	isPrincipalSelected() Returns true if a principal is selected.
boolean	isSelected(Principal principal) Returns true if the given principal is currently selected.
void	processEvents(Map events) Process the various events coming from the editor chip.
void	reload()
void	save()
void	setChanged(boolean changed)
void	setSelectedItems(List items) Method from ItemAcceptor interface.
void	setSelectedPrincipal(Principal principal) Sets the currently selected principal.
void	setToolbar(AbstractToolbarChip toolbar) Sets the toolbar for this chip.

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

addEventListener, checkValid, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

JSP_URI

public static final String JSP_URI

See Also:

Constant Field Values

TYPEORFD_EVENT

public static final String TYPEORFD_EVENT

See Also:

Constant Field Values

PERMISSION_EVENT

public static final String PERMISSION_EVENT

See Also:

Constant Field Values

RIGHT_EVENT

public static final String RIGHT_EVENT

See Also:

Constant Field Values

SELECT_PRINCIPAL_EVENT

public static final String SELECT_PRINCIPAL_EVENT

See Also:

Constant Field Values

ADD_PRINCIPAL_EVENT

public static final String ADD_PRINCIPAL_EVENT

See Also:

Constant Field Values

REMOVE_PRINCIPAL_EVENT

public static final String REMOVE_PRINCIPAL_EVENT

See Also:

Constant Field Values

CHANGE_PERMISSION_EVENT

public static final String CHANGE_PERMISSION_EVENT

See Also:

Constant Field Values

ADINDICATOR

public static final String ADINDICATOR

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

TypeAccessRightsEditorChip

public TypeAccessRightsEditorChip(DisplayState displayState,
                                  Chip parent)

Creates a new TypeAccessRightsEditorChip with the given displaystate and parent.

Method Detail

initialize

public void initialize()

Initially loads the permission maps, selects the default principal and creates the toolbar. Implements ClipChip interface.

Specified by:

initialize in interface ClipChip

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface ClipChip

Returns:

true if the ClipChip is initalzied.

reload

public void reload()

Specified by:

reload in interface SpecialReloadChip

processEvents

public void processEvents(Map events)

Process the various events coming from the editor chip.

Specified by:

processEvents in interface Chip

addPrincipal

protected void addPrincipal()

getPermission

public String getPermission(String qualifier,
                            String right)

For the given qualifier (which is either TYPE or [ADINDICATOR+attributedescriptorqualifier]) and userright string (READ, CHANGE, etc.) this method returns GRANT, DENY or NONE according to the current permission.

getJSPURI

public String getJSPURI()

Returns the jsp uri for this chip.

Specified by:

getJSPURI in interface Chip

save

public void save()

Specified by:

save in interface SpecialSaveChip

setSelectedItems

public void setSelectedItems(List items)

Method from ItemAcceptor interface. Will be called from modal search to add principals to the list.

Specified by:

setSelectedItems in interface ItemAcceptor

allowsMultipleSelection

public boolean allowsMultipleSelection()

Method from ItemAcceptor interface. Will be called from modal search to find out if multiple selection is allowed, which is currently always true.

Specified by:

allowsMultipleSelection in interface ItemAcceptor

isPrincipalSelected

public boolean isPrincipalSelected()

Returns true if a principal is selected.

hasItem

public boolean hasItem()

Returns true if itemChip.getItem() is not null.

getComposedType

public ComposedType getComposedType()

Returns the type of the item this chip holds.

getPrincipals

public Set getPrincipals()

Returns a list of principals for which userrights are set for the current type.

getPrincipalByCombinedId

public Principal getPrincipalByCombinedId(String combinedId)

Returns the principal with the given combined id. Is used to transform 'select principal' events from jsps which use the 'combined id' as event string (see getCombinedID(Principal) for a description of a combined id).

Returns:

the Principal for the given (combined) id

getCombinedID

public static String getCombinedID(Principal principal)

For a given Principal this method returns a unique string id. The id consists of the type of the given principal (either "user" or "usergroup") followed by its uid (seperated by an underscore). The Reason for this combined id is the fact that it is possible to create a user with the same id as a usergroup. (But you cannot create two users with the same id or two usergroups with the same id!).

Parameters:

principal - the Principal for which to create the id string

Returns:

a String containing an id which consits of ( "user_" | "usergroup_") + uid

isSelected

public boolean isSelected(Principal principal)

Returns true if the given principal is currently selected.

getSelectedPrincipal

public Principal getSelectedPrincipal()

Returns the currently selected principal. If no principal was set then the first principal in the list will be selected and returned automatically!

setSelectedPrincipal

public void setSelectedPrincipal(Principal principal)

Sets the currently selected principal.

createToolbar

public AbstractToolbarChip createToolbar()

Creates the toolbar for this chip.

Specified by:

createToolbar in interface ToolbarProvider

getToolbar

public AbstractToolbarChip getToolbar()

Returns the toolbar for this chip.

Specified by:

getToolbar in interface ToolbarProvider

setToolbar

public void setToolbar(AbstractToolbarChip toolbar)

Sets the toolbar for this chip.

getAttributeDescriptorID

public String getAttributeDescriptorID(AttributeDescriptor attributeDescriptor)

Returns the attributedescriptor qualifier for the given AttributeDescriptor, which is (ADINDICATOR + attributedescriptorqualifier).

getAttributeDescriptors

public Set getAttributeDescriptors()

Returns a sorted set of attributedescriptors of the type of this chip. DONR mr

getItemChip

protected ItemChip getItemChip()

Returns the itemchip which is a parent of this chip.

getAccessManager

public AccessManager getAccessManager()

Returns the accessmanager instance of the current session.

getIcon

public String getIcon(Item item)

isChanged

public boolean isChanged()

Specified by:

isChanged in interface ChangeIndicatorChip

Since:

2.10

setChanged

public void setChanged(boolean changed)

Since:

2.10