de.hybris.platform.permissionsfacades

Interface PermissionsFacade

All Known Implementing Classes:

DefaultPermissionsFacade

public interface PermissionsFacade

Facade for calculating permissions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	READ_ACCESS_TYPE
static java.lang.String	WRITE_ACCESS_TYPE

Method Summary

Modifier and Type	Method and Description
java.util.List<PermissionsData>	calculateAttributesPermissions(java.lang.String principalUid, java.util.List<java.lang.String> attributes, java.util.List<java.lang.String> permissionNames) Calculate permissions for attributes
java.util.List<CatalogPermissionsData>	calculateCatalogPermissions(java.lang.String principalUid, java.util.List<java.lang.String> catalogIds, java.util.List<java.lang.String> catalogVersions) Calculate permissions for catalog version
PermissionsData	calculateGlobalPermissions(java.lang.String principalUid, java.util.List<java.lang.String> permissionNames) Calculate global permissions for a principal.
java.util.List<PermissionsData>	calculateTypesPermissions(java.lang.String principalUid, java.util.List<java.lang.String> types, java.util.List<java.lang.String> permissionNames) Calculate permissions for a principal and multiple types.

Field Detail

READ_ACCESS_TYPE

static final java.lang.String READ_ACCESS_TYPE

See Also:

Constant Field Values

WRITE_ACCESS_TYPE

static final java.lang.String WRITE_ACCESS_TYPE

See Also:

Constant Field Values

Method Detail

calculateTypesPermissions

java.util.List<PermissionsData> calculateTypesPermissions(java.lang.String principalUid,
                                                          java.util.List<java.lang.String> types,
                                                          java.util.List<java.lang.String> permissionNames)

Calculate permissions for a principal and multiple types.

Parameters:

principalUid - principal uid to retrieve the permissions for.

types - type ids

permissionNames - permission names

Returns:

calculated types permissions (based on principal, its groups, the types and super types)

calculateGlobalPermissions

PermissionsData calculateGlobalPermissions(java.lang.String principalUid,
                                           java.util.List<java.lang.String> permissionNames)

Calculate global permissions for a principal. This will look in the user group hierarchy as well.

Parameters:

principalUid - principal uid to retrieve the permissions for.

permissionNames - permissions names to look for

Returns:

calculated global permissions (based on principal and its groups)

calculateAttributesPermissions

java.util.List<PermissionsData> calculateAttributesPermissions(java.lang.String principalUid,
                                                               java.util.List<java.lang.String> attributes,
                                                               java.util.List<java.lang.String> permissionNames)

Calculate permissions for attributes

Parameters:

principalUid - principal uid to retrieve the permissions for.

attributes - fully qualified attribute of the for .

permissionNames - permissions names to look for

Returns:

calculated permissions for attributes

calculateCatalogPermissions

java.util.List<CatalogPermissionsData> calculateCatalogPermissions(java.lang.String principalUid,
                                                                   java.util.List<java.lang.String> catalogIds,
                                                                   java.util.List<java.lang.String> catalogVersions)

Calculate permissions for catalog version

Parameters:

principalUid - principal uid to retrieve the permissions for.

catalogIds - filter of catalog ids to consider

catalogVersions - filter of catalog version to consider

Returns:

list of permissions for catalog versions that match any of the ids in catalogIds and any of the versions in catalogVersions