SecurityActions (Nuxeo ECM Projects 9.2-SNAPSHOT API)

All Known Implementing Classes:

SecurityActionsBean
```
public interface SecurityActions
```
Provides security related operations on the current document.

Author:

Razvan Caraghin

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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()>`.
`Boolean`	`displayInheritedPermissions()` Deprecated. use `getDisplayInheritedPermissions()`
`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.
`List<String>`	`getParentDocumentsUsers()`
`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()`
`void`	`rebuildSecurityData()` Rebuilds the security displayable data from the current selected document.
`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.

- Method Detail
  - updateSecurityOnDocument
```
String updateSecurityOnDocument()
```
    Submits the security changes to the backend.
    
    Returns:
    
    the page that will be displayed next
  - addPermission
```
String addPermission()
```
    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()>.
    
    Returns:
    
    the page that needs to be displayed next
  - addPermissions
```
String addPermissions()
```
    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()> .
    
    Returns:
    
    the page that needs to be displayed next
  - addPermission
```
String addPermission(String principalName,
                     String permissionName,
                     boolean grant)
```
  - removePermission
```
String removePermission()
```
    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()> .
    
    Returns:
    
    the page that needs to be displayed next
  - addPermissionAndUpdate
```
String addPermissionAndUpdate()
```
    Adds a permission to the list of permissions for the current document and automatically update the backend with updateSecurityOnDocument()>.
    
    Returns:
    
    the page that needs to be displayed next
  - addPermissionsAndUpdate
```
String addPermissionsAndUpdate()
```
    Adds a list of permissions to the list of permissions for the current document and automatically update the backend with updateSecurityOnDocument()>.
    
    Returns:
    
    the page that needs to be displayed next
  - removePermissionAndUpdate
```
String removePermissionAndUpdate()
```
    Removes a permission from the list of permissions for the current document and automatically update the backend with updateSecurityOnDocument()>.
    
    Returns:
    
    the page that needs to be displayed next
  - removePermissionsAndUpdate
```
String removePermissionsAndUpdate()
```
  - resetSecurityData
```
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.
  - rebuildSecurityData
```
void rebuildSecurityData()
```
    Rebuilds the security displayable data from the current selected document.
  - getDataTableModel
```
PageSelections<String> getDataTableModel()
```
    Returns:
    
    a PageSelections used to build a checkboxable listing of managed permissions
  - getSecurityData
```
SecurityData getSecurityData()
```
    Returns:
    
    the SecurityData object that manages a stateful representation of the permissions mapping that apply to the current document (inherited or not)
  - getCanAddSecurityRules
```
boolean getCanAddSecurityRules()
```
    Returns true if the implementator if the principal has the permission to add new security rules on currentItem.
  - getCanRemoveSecurityRules
```
boolean getCanRemoveSecurityRules()
```
    Returns true if the implementator can provide a list of permissions delete now and the principal has WriteSecurity permission on the currentItem.
  - getSettablePermissions
```
List<javax.faces.model.SelectItem> getSettablePermissions()
```
    Returns:
    
    the list of permissions the users can set through the rights management tab
  - getIconPathMap
```
Map<String,String> getIconPathMap()
```
    Maps the principal type to the icon path.
  - getIconAltMap
```
Map<String,String> getIconAltMap()
```
    Maps the principal type to the icon alt text.
  - getBlockRightInheritance
```
Boolean getBlockRightInheritance()
```
  - setBlockRightInheritance
```
void setBlockRightInheritance(Boolean blockRightInheritance)
```
  - displayInheritedPermissions
```
@Deprecated
Boolean displayInheritedPermissions()
```
    Deprecated. use getDisplayInheritedPermissions()
  - getDisplayInheritedPermissions
```
boolean getDisplayInheritedPermissions()
```
    Returns true if inherited permissions have to be displayed (depending on rights blocking)
  - getCurrentDocumentUsers
```
List<String> getCurrentDocumentUsers()
```
  - getParentDocumentsUsers
```
List<String> getParentDocumentsUsers()
```
  - removePermissions
```
String removePermissions()
```
  - saveSecurityUpdates
```
String saveSecurityUpdates()
```
  - getSelectedEntry
```
String getSelectedEntry()
```
    Returns selected entry used in add/remove methods
  - setSelectedEntry
```
void setSelectedEntry(String selectedEntry)
```
    Sets selected entry used in add/remove methods
  - getSelectedEntries
```
List<String> getSelectedEntries()
```
    Returns selected entries used in add/remove methods
  - setSelectedEntries
```
void setSelectedEntries(List<String> selectedEntries)
```
    Sets selected entries used in add/remove methods

Interface SecurityActions

Method Summary

Method Detail

updateSecurityOnDocument

addPermission

addPermissions

addPermission

removePermission

addPermissionAndUpdate

addPermissionsAndUpdate

removePermissionAndUpdate

removePermissionsAndUpdate

resetSecurityData

rebuildSecurityData

getDataTableModel

getSecurityData

getCanAddSecurityRules

getCanRemoveSecurityRules

getSettablePermissions

getIconPathMap

getIconAltMap

getBlockRightInheritance

setBlockRightInheritance

displayInheritedPermissions

getDisplayInheritedPermissions

getCurrentDocumentUsers

getParentDocumentsUsers

removePermissions

saveSecurityUpdates

getSelectedEntry

setSelectedEntry

getSelectedEntries

setSelectedEntries