cz.ues.core.security

Interface UESPermission

@UESService
public interface UESPermission

Method Summary

Methods

Modifier and Type	Method and Description
UESPermissionAuthorizeResult	authorize(UESURI entityUri, UESPermissionAuthorize permission) Checks whether the logged user is authorized to the specific use case over the specific entity.
UESStreamHandler	getAuthorityData(UESURI entityUri, UESPermissionGetAuthorityData options) This command returns a permission settings data for the specified artifact and authority.
UESResultList<UESPermissionGetAuthorityListItem,UESPermissionGetAuthorityList>	getAuthorityList(UESURI entityUri, UESPermissionGetAuthorityList criteria) This command returns a list of authorities who have permission on the specified artifact.
UESResultList<UESPermissionGetMaskAttributes,UESPermissionGetMaskList>	getMaskList(UESURI artifactUri, UESPermissionGetMaskList criteria) This command returns a list of permission mask that can be granted on the specified artifact.
UESResultList<UESPermissionGetSystemGroupAttributes,UESPermissionGetSystemGroupList>	getSystemGroupList(UESURI artifactUri, UESPermissionGetSystemGroupList criteria) This command returns a list of system groups that are defined for the specified artifact.
void	grant(UESURI entityUri, UESPermissionGrant permission) The command grants permission for the specified artifact and its aggregated objects.
void	revoke(UESURI entityUri, UESPermissionRevoke permission) The command revokes permissions for the specified artifact and its aggregated objects.

Method Detail

grant

void grant(UESURI entityUri,
UESPermissionGrant permission)
throws UESPermissionRTException

The command grants permission for the specified artifact and its aggregated objects. The permission must be specified for concrete authority (role, group or implicit group). A permission mask (defined on artifact's meta artifact - see UESMetaPermission.getMaskList(cz.ues.core.commons.uri.UESURI, cz.ues.core.security.authz.dto.UESMetaPermissionGetMaskList)) or own settings data (see UESPermissionGrant.data) can be used for permission settings.

Parameters:

entityUri - UESURI of the entity for that the permission is granted

permission - DTO containing attributes of the permission

Throws:

UESPermissionRTException

Since:

UES8-03

authorize

UESPermissionAuthorizeResult authorize(UESURI entityUri,
UESPermissionAuthorize permission)
throws UESPermissionRTException

Checks whether the logged user is authorized to the specific use case over the specific entity. If the user is not authorized to run the specified use case, the authorization exception (UESAuthorizationServiceRTException.E05401.M08) is thrown. Note that authorization entities may differ from main entities of specific uuCommands. For example the uuCommand UU::OS::Property.create uses an artifact as the main entity, but it is authorized over the property group where the property is to be created.

Parameters:

authorityUri - UESURI of the entity (artifact, object) over which the logged user will be authorized. Never null.

useCaseCode - Code of the specific use case according to will be logged user authorized.

Throws:

UESPermissionRTException

revoke

void revoke(UESURI entityUri,
UESPermissionRevoke permission)
throws UESPermissionRTException

The command revokes permissions for the specified artifact and its aggregated objects. The permissions must be specified for a concrete authority (role, group or implicit group). The command can remove all (see UESPermissionRevoke.all) or part (see UESPermissionRevoke.data) of permission settings.

Parameters:

entityUri - UESURI of the entity for that the permission is revoked

permission - DTO containing attributes of the permission to revoke

Throws:

UESPermissionRTException

Since:

UES8-03

getAuthorityList

UESResultList<UESPermissionGetAuthorityListItem,UESPermissionGetAuthorityList> getAuthorityList(UESURI entityUri,
UESPermissionGetAuthorityList criteria)
throws UESPermissionRTException

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

Parameters:

entityUri - UESURI of the entity where permissions are applied

criteria - DTO containing criteria for listing the permissions

Returns:

List of DTO with attributes of authorities

Throws:

UESPermissionRTException

Since:

UES8-03

getAuthorityData

UESStreamHandler getAuthorityData(UESURI entityUri,
UESPermissionGetAuthorityData options)
throws UESPermissionRTException

This command returns a permission settings data for the specified artifact and authority. The 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 UESPermission.grant(cz.ues.core.commons.uri.UESURI, cz.ues.core.security.authz.dto.UESPermissionGrant)) 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:

entityUri - UESURI of the entity where permissions are applied

options - DTO containing options for getting permission settings data

Returns:

List of DTO with attributes of permission masks

Throws:

UESPermissionRTException

Since:

UES8-03

getMaskList

UESResultList<UESPermissionGetMaskAttributes,UESPermissionGetMaskList> getMaskList(UESURI artifactUri,
UESPermissionGetMaskList criteria)
throws UESPermissionRTException

This command returns a list of permission mask that can be granted on the specified 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:

artifactUri - UESURI of the artifact

criteria - DTO containing criteria for listing permission masks

Returns:

List of DTO with attributes of permission masks

Throws:

UESPermissionRTException

Since:

UES8-03

getSystemGroupList

UESResultList<UESPermissionGetSystemGroupAttributes,UESPermissionGetSystemGroupList> getSystemGroupList(UESURI artifactUri,
UESPermissionGetSystemGroupList criteria)
throws UESPermissionRTException

This command returns a list of system groups that are defined for the specified artifact. The list is sorted by order in the configuration all time. The attributes name and description are translated to user language.

Parameters:

artifactUri - UESURI of the artifact

Returns:

List of DTO with attributes of system group

Throws:

UESPermissionRTException

Since:

UES8-03