org.nuxeo.ecm.webapp.security

Class SecurityActionsBean

java.lang.Object

org.nuxeo.ecm.webapp.base.InputController

org.nuxeo.ecm.webapp.security.SecurityActionsBean

All Implemented Interfaces:

Serializable, SecurityActions

@Name(value="securityActions")
 @Scope(value=CONVERSATION)
public class SecurityActionsBean
extends InputController
implements SecurityActions, Serializable

Provides security related methods.

Author:

Razvan Caraghin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	CACHED_PERMISSION_TO_CHECK
protected List<String>	cachedDeletedUserAndGroups
protected List<String>	cachedValidatedUserAndGroups
protected NuxeoPrincipal	currentUser
protected CoreSession	documentManager
protected PageSelections<String>	entries
protected NavigationContext	navigationContext
protected boolean	obsoleteSecurityData
protected PermissionActionListManager	permissionActionListManager
protected PermissionListManager	permissionListManager
protected PrincipalListManager	principalListManager
protected SecurityData	securityData
protected static String[]	SEED_PERMISSIONS_TO_CHECK
protected List<String>	selectedEntries
protected String	selectedEntry
protected UserManager	userManager

Fields inherited from class org.nuxeo.ecm.webapp.base.InputController

actionManager, currentDocument, eventManager, facesMessages, resourcesAccessor, typeManager, typesTool

Constructor Summary

Constructors

Constructor and Description
SecurityActionsBean()

Method Summary

Modifier and Type	Method and Description
String	addPermission() Adds a permission to the list of permissions for the current document.
String	addPermission(String principalName, String permissionName, boolean grant)
String	addPermissionAndUpdate() Adds a permission to the list of permissions for the current document and automatically update the backend with updateSecurityOnDocument()>.
String	addPermissions() Adds a list of permission to the list of permissions for the current document.
String	addPermissionsAndUpdate() Adds a list of permissions to the list of permissions for the current document and automatically update the backend with updateSecurityOnDocument()>.
protected List<javax.faces.model.SelectItem>	asSelectItems(String... permissions)
String	blockRightInheritance()
Boolean	displayInheritedPermissions()
Boolean	getBlockRightInheritance()
boolean	getCanAddSecurityRules() Returns true if the implementator if the principal has the permission to add new security rules on currentItem.
boolean	getCanRemoveSecurityRules() Returns true if the implementator can provide a list of permissions delete now and the principal has WriteSecurity permission on the currentItem.
List<String>	getCurrentDocumentUsers()
PageSelections<String>	getDataTableModel()
boolean	getDisplayInheritedPermissions() Returns true if inherited permissions have to be displayed (depending on rights blocking)
Map<String,String>	getIconAltMap() Maps the principal type to the icon alt text.
Map<String,String>	getIconPathMap() Maps the principal type to the icon path.
String	getLabel(String permission)
List<String>	getParentDocumentsUsers()
protected String[]	getPermissionsToCheck()
Map<String,String>	getPermissionsToLabels() Returns a Map containing all contributed permissions and their associated labels.
SecurityData	getSecurityData()
List<String>	getSelectedEntries() Returns selected entries used in add/remove methods
String	getSelectedEntry() Returns selected entry used in add/remove methods
List<javax.faces.model.SelectItem>	getSettablePermissions()
List<javax.faces.model.SelectItem>	getUserVisiblePermissionSelectItems(String documentType)
List<UserVisiblePermission>	getVisibleUserPermissions(String documentType)
boolean	isMSIEorEdge()
void	rebuildSecurityData() Rebuilds the security displayable data from the current selected document.
protected void	reconstructTableModel() Update the dataTableModel from the current SecurityData this method is automatically called by rebuildSecurityData method
String	removePermission() Removes a permission from the list of permissions for the current document.
String	removePermissionAndUpdate() Removes a permission from the list of permissions for the current document and automatically update the backend with updateSecurityOnDocument()>.
String	removePermissions()
String	removePermissionsAndUpdate()
void	resetSecurityData() Marks the current security data info as obsolete so that it gets lazily recomputed from the backend the next time it is accessed.
String	saveSecurityUpdates()
void	setBlockRightInheritance(Boolean blockRightInheritance)
void	setSelectedEntries(List<String> selectedEntries) Sets selected entries used in add/remove methods
void	setSelectedEntry(String selectedEntry) Sets selected entry used in add/remove methods
String	updateSecurityOnDocument() Submits the security changes to the backend.

Methods inherited from class org.nuxeo.ecm.webapp.base.InputController

computeOutcome, extractReferences, getAdministrator, logDocumentWithName, logDocumentWithTitle, removeDocumentFromList, setFacesMessage

Methods inherited from class java.lang.Object

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

Field Detail

navigationContext

@In(create=true)
protected transient NavigationContext navigationContext

documentManager

@In(create=true,
    required=false)
protected transient CoreSession documentManager

permissionActionListManager

@In(create=true)
protected PermissionActionListManager permissionActionListManager

permissionListManager

@In(create=true)
protected PermissionListManager permissionListManager

principalListManager

@In(create=true)
protected PrincipalListManager principalListManager

userManager

@In(create=true)
protected transient UserManager userManager

currentUser

@In(create=true)
protected NuxeoPrincipal currentUser

SEED_PERMISSIONS_TO_CHECK

protected static final String[] SEED_PERMISSIONS_TO_CHECK

CACHED_PERMISSION_TO_CHECK

protected String[] CACHED_PERMISSION_TO_CHECK

securityData

protected SecurityData securityData

obsoleteSecurityData

protected boolean obsoleteSecurityData

entries

protected PageSelections<String> entries

cachedValidatedUserAndGroups

protected transient List<String> cachedValidatedUserAndGroups

cachedDeletedUserAndGroups

protected transient List<String> cachedDeletedUserAndGroups

selectedEntry

protected String selectedEntry

selectedEntries

protected List<String> selectedEntries

Constructor Detail

SecurityActionsBean

public SecurityActionsBean()

Method Detail

resetSecurityData

@Observer(value="userAllDocumentTypesSelectionChanged",
          create=false)
 @BypassInterceptors
public void resetSecurityData()

Description copied from interface: SecurityActions

Marks the current security data info as obsolete so that it gets lazily recomputed from the backend the next time it is accessed.

Specified by:

resetSecurityData in interface SecurityActions

rebuildSecurityData

public void rebuildSecurityData()

Description copied from interface: SecurityActions

Rebuilds the security displayable data from the current selected document.

Specified by:

rebuildSecurityData in interface SecurityActions

reconstructTableModel

protected void reconstructTableModel()

Update the dataTableModel from the current SecurityData this method is automatically called by rebuildSecurityData method

getDataTableModel

public PageSelections<String> getDataTableModel()

Specified by:

getDataTableModel in interface SecurityActions

Returns:

a PageSelections used to build a checkboxable listing of managed permissions

getSecurityData

public SecurityData getSecurityData()

Specified by:

getSecurityData in interface SecurityActions

Returns:

the SecurityData object that manages a stateful representation of the permissions mapping that apply to the current document (inherited or not)

updateSecurityOnDocument

public String updateSecurityOnDocument()

Description copied from interface: SecurityActions

Submits the security changes to the backend.

Specified by:

updateSecurityOnDocument in interface SecurityActions

Returns:

the page that will be displayed next

addPermission

public String addPermission(String principalName,
                            String permissionName,
                            boolean grant)

Specified by:

addPermission in interface SecurityActions

addPermission

public String addPermission()

Description copied from interface: SecurityActions

Adds a permission to the list of permissions for the current document. After all client side changes are made, then the list of permissions need to be submitted on backend using updateSecurityOnDocument()>.

Specified by:

addPermission in interface SecurityActions

Returns:

the page that needs to be displayed next

addPermissions

public String addPermissions()

Description copied from interface: SecurityActions

Adds a list of permission to the list of permissions for the current document. After all client side changes are made, then the list of permissions need to be submitted on backend using updateSecurityOnDocument()> .

Specified by:

addPermissions in interface SecurityActions

Returns:

the page that needs to be displayed next

addPermissionAndUpdate

public String addPermissionAndUpdate()

Description copied from interface: SecurityActions

Adds a permission to the list of permissions for the current document and automatically update the backend with updateSecurityOnDocument()>.

Specified by:

addPermissionAndUpdate in interface SecurityActions

Returns:

the page that needs to be displayed next

addPermissionsAndUpdate

public String addPermissionsAndUpdate()

Description copied from interface: SecurityActions

Adds a list of permissions to the list of permissions for the current document and automatically update the backend with updateSecurityOnDocument()>.

Specified by:

addPermissionsAndUpdate in interface SecurityActions

Returns:

the page that needs to be displayed next

saveSecurityUpdates

public String saveSecurityUpdates()

Specified by:

saveSecurityUpdates in interface SecurityActions

removePermission

public String removePermission()

Description copied from interface: SecurityActions

Removes a permission from the list of permissions for the current document. After all client side changes are made, then the list of permissions need to be submitted on backend using updateSecurityOnDocument()> .

Specified by:

removePermission in interface SecurityActions

Returns:

the page that needs to be displayed next

removePermissionAndUpdate

public String removePermissionAndUpdate()

Description copied from interface: SecurityActions

Removes a permission from the list of permissions for the current document and automatically update the backend with updateSecurityOnDocument()>.

Specified by:

removePermissionAndUpdate in interface SecurityActions

Returns:

the page that needs to be displayed next

removePermissions

public String removePermissions()

Specified by:

removePermissions in interface SecurityActions

removePermissionsAndUpdate

public String removePermissionsAndUpdate()

Specified by:

removePermissionsAndUpdate in interface SecurityActions

getCanAddSecurityRules

public boolean getCanAddSecurityRules()

Description copied from interface: SecurityActions

Returns true if the implementator if the principal has the permission to add new security rules on currentItem.

Specified by:

getCanAddSecurityRules in interface SecurityActions

getCanRemoveSecurityRules

public boolean getCanRemoveSecurityRules()

Description copied from interface: SecurityActions

Returns true if the implementator can provide a list of permissions delete now and the principal has WriteSecurity permission on the currentItem.

Specified by:

getCanRemoveSecurityRules in interface SecurityActions

getVisibleUserPermissions

public List<UserVisiblePermission> getVisibleUserPermissions(String documentType)

getSettablePermissions

public List<javax.faces.model.SelectItem> getSettablePermissions()

Specified by:

getSettablePermissions in interface SecurityActions

Returns:

the list of permissions the users can set through the rights management tab

asSelectItems

protected List<javax.faces.model.SelectItem> asSelectItems(String... permissions)

getUserVisiblePermissionSelectItems

public List<javax.faces.model.SelectItem> getUserVisiblePermissionSelectItems(String documentType)

Since:

7.4

getIconAltMap

public Map<String,String> getIconAltMap()

Description copied from interface: SecurityActions

Maps the principal type to the icon alt text.

Specified by:

getIconAltMap in interface SecurityActions

getIconPathMap

public Map<String,String> getIconPathMap()

Description copied from interface: SecurityActions

Maps the principal type to the icon path.

Specified by:

getIconPathMap in interface SecurityActions

getBlockRightInheritance

public Boolean getBlockRightInheritance()

Specified by:

getBlockRightInheritance in interface SecurityActions

setBlockRightInheritance

public void setBlockRightInheritance(Boolean blockRightInheritance)

Specified by:

setBlockRightInheritance in interface SecurityActions

blockRightInheritance

public String blockRightInheritance()

displayInheritedPermissions

public Boolean displayInheritedPermissions()

Specified by:

displayInheritedPermissions in interface SecurityActions

getDisplayInheritedPermissions

public boolean getDisplayInheritedPermissions()

Description copied from interface: SecurityActions

Returns true if inherited permissions have to be displayed (depending on rights blocking)

Specified by:

getDisplayInheritedPermissions in interface SecurityActions

getCurrentDocumentUsers

public List<String> getCurrentDocumentUsers()

Specified by:

getCurrentDocumentUsers in interface SecurityActions

getParentDocumentsUsers

public List<String> getParentDocumentsUsers()

Specified by:

getParentDocumentsUsers in interface SecurityActions

getPermissionsToCheck

protected String[] getPermissionsToCheck()

getSelectedEntry

public String getSelectedEntry()

Description copied from interface: SecurityActions

Returns selected entry used in add/remove methods

Specified by:

getSelectedEntry in interface SecurityActions

setSelectedEntry

public void setSelectedEntry(String selectedEntry)

Description copied from interface: SecurityActions

Sets selected entry used in add/remove methods

Specified by:

setSelectedEntry in interface SecurityActions

getSelectedEntries

public List<String> getSelectedEntries()

Description copied from interface: SecurityActions

Returns selected entries used in add/remove methods

Specified by:

getSelectedEntries in interface SecurityActions

setSelectedEntries

public void setSelectedEntries(List<String> selectedEntries)

Description copied from interface: SecurityActions

Sets selected entries used in add/remove methods

Specified by:

setSelectedEntries in interface SecurityActions

isMSIEorEdge

@Factory(value="isMSIEorEdge",
         scope=SESSION)
public boolean isMSIEorEdge()

getLabel

public String getLabel(String permission)

getPermissionsToLabels

public Map<String,String> getPermissionsToLabels()

Returns a Map containing all contributed permissions and their associated labels.

Since:

8.1