cz.ues.core.security

Interface UESMetaPermission

@UESService
public interface UESMetaPermission

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	createMask(UESURI templateUri, UESMetaPermissionCreateMask mask) This command creates meta permission mask for template.
void	deleteMask(UESURI maskUri) The command deletes the specified permission mask from the system.
UESStreamHandler	getAuthorityData(UESURI templateUri, UESMetaPermissionGetAuthorityData options) This command returns a template of permission settings data for the specified template and authority.
UESResultList<UESMetaPermissionGetAuthorityListItem,UESMetaPermissionGetAuthorityList>	getAuthorityList(UESURI templateUri, UESMetaPermissionGetAuthorityList criteria) This command returns a list of authorities who have template of permission on the specified template.
UESMetaPermissionGetMaskAttributes	getMaskAttributes(UESURI maskUri) This command returns attributes representing the permission mask specified by the permissionMaskUri parameter.
UESStreamHandler	getMaskData(UESURI maskUri, UESMetaPermissionGetMaskData options) The command returns the complete permission mask settings data.
UESResultList<UESMetaPermissionGetMaskAttributes,UESMetaPermissionGetMaskList>	getMaskList(UESURI metaArtifactUri, UESMetaPermissionGetMaskList criteria) This command returns a list of permission mask that are placed on the specified meta artifact.
UESResultList<UESMetaPermissionGetSystemGroupAttributes,UESMetaPermissionGetSystemGroupList>	getSystemGroupList(UESURI entityUri, UESMetaPermissionGetSystemGroupList criteria) This command returns a list of system groups that are defined for the specified template or territory.
void	grant(UESURI templateUri, UESMetaPermissionGrant metaPermission) The command grants template of permission for the specified template.
void	revoke(UESURI templateUri, UESMetaPermissionRevoke metaPermission) The command revokes template of permissions for the specified template.
UESURI	setMaskAttributes(UESURI maskUri, UESMetaPermissionSetMaskAttributes mask) The command sets new attributes of the specified permission mask.
void	setMaskData(UESURI accessRightsMaskUri, UESMetaPermissionSetMaskData maskData) The command stores a permission mask settings.

Method Detail

grant

void grant(UESURI templateUri,
UESMetaPermissionGrant metaPermission)
throws UESMetaPermissionRTException

The command grants template of permission for the specified template. The template of permission must be specified for concrete authority (role, group or implicit group). A own settings data (see UESMetaPermissionGrant.data) can be used for permission settings.

Parameters:

templateUri - UESURI of the template for that the template of permission is granted

metaPermission - DTO containing attributes of the template of permission

Throws:

UESMetaPermissionRTException

Since:

UES8-03

revoke

void revoke(UESURI templateUri,
UESMetaPermissionRevoke metaPermission)
throws UESMetaPermissionRTException

The command revokes template of permissions for the specified template. The template of permissions must be specified for a concrete authority (role, group or implicit group). The command can remove all (see UESMetaPermissionRevoke.all) or part (see UESMetaPermissionRevoke.data) of permission settings.

Parameters:

templateUri - UESURI of the template for that the template of permission is revoked

metaPermission - DTO containing attributes of the template of permission to revoke

Throws:

UESMetaPermissionRTException

Since:

UES8-03

getAuthorityList

UESResultList<UESMetaPermissionGetAuthorityListItem,UESMetaPermissionGetAuthorityList> getAuthorityList(UESURI templateUri,
UESMetaPermissionGetAuthorityList criteria)
throws UESMetaPermissionRTException

This command returns a list of authorities who have template of permission on the specified template.

Parameters:

templateUri - UESURI of the template for that the template of permission are applied

criteria - DTO containing criteria for listing the permissions

Returns:

List of DTO with attributes of authorities

Throws:

UESMetaPermissionRTException

Since:

UES8-03

getAuthorityData

UESStreamHandler getAuthorityData(UESURI templateUri,
UESMetaPermissionGetAuthorityData options)
throws UESMetaPermissionRTException

This command returns a template of permission settings data for the specified template and authority. The template of permission settings is list of pairs: an use case code (access unit or access collection) and a cast level. The list is complete list of the all possibles actions. The result is composed from set actions (set by command UESMetaPermission.grant(cz.ues.core.commons.uri.UESURI, cz.ues.core.security.authz.dto.UESMetaPermissionGrant)) and from rest of actions that are defined in the system catalog.

The result is streamed in JSON or CSV.

JSON format:

• key "useCaseCode" - contains codes of use cases (access units or access collections)
• key "castLevel" - contains cast level value (if it is empty, the settings for this use case is ignored)

CSV format:

• the first column - contains codes of use cases (access units or access collections)
• the second column - contains cast level value (if it is empty, the settings for this use case is ignored)

Possible cast level values:

• ASSISTANCE - gives access rights for executive and assistance cast roles
• EXECUTIVE - gives access rights for executive cast roles
• GUEST - gives access rights for executive, assistance and guest cast roles
• REVOKE - removes access rights

Parameters:

templateUri - UESURI of the template for that the template of permission

options - DTO containing options for getting template of permission settings data

Returns:

List of DTO with attributes of template of permission

Throws:

UESMetaPermissionRTException

Since:

UES8-03

createMask

UESURI createMask(UESURI templateUri,
UESMetaPermissionCreateMask mask)
throws UESMetaPermissionRTException

This command creates meta permission mask for template.

Parameters:

templateUri - UESURI of the meta artifact where the mask is aggregated.

mask - DTO containing attributes of the new permission mask

Returns:

UESURI of the new permission mask

Throws:

UESMetaPermissionRTException

Since:

UES8-03

deleteMask

@UESAudit(propagation=SKIP, useCaseType=COMMAND)

void deleteMask(UESURI maskUri)
throws UESMetaPermissionRTException

The command deletes the specified permission mask from the system.
When the mask is marked as default, the command fails.

Parameters:

maskUri - UESURI of the permission mask which is about to be deleted

Throws:

UESMetaPermissionRTException

Since:

UES8-03

getMaskAttributes

@UESAudit(propagation=SKIP, useCaseType=COMMAND)

UESMetaPermissionGetMaskAttributes getMaskAttributes(UESURI maskUri)
throws UESMetaPermissionRTException

This command returns attributes representing the permission mask specified by the permissionMaskUri parameter.

Parameters:

maskUri - UESURI of the permission mask

Returns:

DTO containing attributes of the permission mask

Throws:

UESMetaPermissionRTException

Since:

UES8-03

getMaskData

@UESAudit(propagation=SKIP, useCaseType=COMMAND)

UESStreamHandler getMaskData(UESURI maskUri,
UESMetaPermissionGetMaskData options)
throws UESMetaPermissionRTException

The command returns the complete permission mask settings data. The mask settings is list of pairs an use case code (access unit or access collection) and a cast level. The list is complete list of the all possibles actions. The result is composed from set actions (set by commands UESMetaPermission#create or UESMetaPermission.setMaskData(cz.ues.core.commons.uri.UESURI, cz.ues.core.security.authz.dto.UESMetaPermissionSetMaskData)) and from rest of actions that are defined in the system catalog. The result is streamed in JSON or CSV.

JSON format:

• key "useCaseCode" - contains codes of use cases (access units or access collections)
• key "castLevel" - contains cast level value (if it is empty, the settings for this use case is ignored)

CSV format:

• the first column - contains codes of use cases (access units or access collections)
• the second column - contains cast level value (if it is empty, the settings for this use case is ignored)

Possible cast level values:

• ASSISTANCE - gives access rights for executive and assistance cast roles
• EXECUTIVE - gives access rights for executive cast roles
• GUEST - gives access rights for executive, assistance and guest cast roles
• REVOKE - removes access rights

Parameters:

maskUri - UESURI of the permission mask

options - DTO containing an options for getting mask settings data.

Returns:

DTO containing the permission mask settings data in a stream.

Throws:

UESMetaPermissionRTException

Since:

UES8-03

getMaskList

UESResultList<UESMetaPermissionGetMaskAttributes,UESMetaPermissionGetMaskList> getMaskList(UESURI metaArtifactUri,
UESMetaPermissionGetMaskList criteria)
throws UESMetaPermissionRTException

This command returns a list of permission mask that are placed on the specified meta artifact. The list of returned masks could be filtered by the name or code. The list is sorted by the name (and codes in case are equal) of a permission mask by default.

Parameters:

metaArtifactUri - UESURI of the meta artifact where permission masks are

criteria - DTO containing criteria for listing permission masks

Returns:

List of DTO with attributes of permission masks

Throws:

UESMetaPermissionRTException

Since:

UES8-03

setMaskAttributes

@UESAudit(propagation=SKIP, useCaseType=COMMAND)

UESURI setMaskAttributes(UESURI maskUri,
UESMetaPermissionSetMaskAttributes mask)
throws UESMetaPermissionRTException

The command sets new attributes of the specified permission mask.

Parameters:

maskUri - UESURI of the permission mask which attributes are to be changed

mask - DTO containing new attributes of the permission mask

Returns:

UESURI of the permission mask

Throws:

UESMetaPermissionRTException

Since:

UES8-03

setMaskData

@UESAudit(propagation=SKIP, useCaseType=COMMAND)

void setMaskData(UESURI accessRightsMaskUri,
UESMetaPermissionSetMaskData maskData)
throws UESMetaPermissionRTException

The command stores a permission mask settings. The mask settings is list of pairs an use case code (access unit or access collection) and a cast level. For more information see UESMetaPermissionSetMaskData.data.

Parameters:

accessRightsMaskUri -

maskData -

Throws:

UESMetaPermissionRTException

Since:

UES8-03

getSystemGroupList

UESResultList<UESMetaPermissionGetSystemGroupAttributes,UESMetaPermissionGetSystemGroupList> getSystemGroupList(UESURI entityUri,
UESMetaPermissionGetSystemGroupList criteria)
throws UESMetaPermissionRTException

This command returns a list of system groups that are defined for the specified template or territory.

Parameters:

entityUri - UESURI of template or territory

Returns:

List of DTO with attributes of system group

Throws:

UESMetaPermissionRTException

Since:

UES8-03