Package de.hybris.platform.servicelayer.media

Interface MediaPermissionService

  • All Known Implementing Classes:
    DefaultMediaPermissionService
    public interface MediaPermissionService
    Provides functionality for handling permission for media items

    • Method Detail

      • isReadAccessGranted

        boolean isReadAccessGranted​(MediaModel mediaItem,
                            PrincipalModel principal)
        Checks if the given principal has access to reading medias granted.
        Parameters:
        mediaItem - the media item
        principal - the principal (can be either a user or a user group)
        Returns:
        true, if user has read permission for access the given media, false otherwise.

      • grantReadPermission

        void grantReadPermission​(MediaModel mediaItem,
                         PrincipalModel principal)
        Grants principal the read permission to given mediaItem.
        Parameters:
        mediaItem - the media item
        principal - the principal (can be either a user or a user group)

      • denyReadPermission

        void denyReadPermission​(MediaModel mediaItem,
                        PrincipalModel principal)
        Denies principal the read permission to given mediaItem.
        Parameters:
        mediaItem - the media item
        principal - the principal (can be either a user or a user group)

      • getPermittedPrincipals

        java.util.Collection<PrincipalModel> getPermittedPrincipals​(MediaModel mediaItem)
        Fetches all users, with Read permission for given media item.
        Parameters:
        mediaItem - the media item
        Returns:
        Collection of principals with read access to given media item

      • setPermittedPrincipals

        void setPermittedPrincipals​(MediaModel mediaItem,
                            java.util.Collection<PrincipalModel> principals)
        Updates the list of all assigned principal with ReadPermission for given media item. The permission assignment of already granted items which are not on the given principal list, will be removed.
        Parameters:
        mediaItem - the media item.
        principals - the principal list, representing the expected list of all granted principals for the given media item.

      • getDeniedPrincipals

        java.util.Collection<PrincipalModel> getDeniedPrincipals​(MediaModel mediaItem)
        Fetches all users, where Read permission for given media item is denied.
        Parameters:
        mediaItem - the media item
        Returns:
        Collection of principals with denied read permission to given media item

      • setDeniedPrincipals

        void setDeniedPrincipals​(MediaModel mediaItem,
                         java.util.Collection<PrincipalModel> principals)
        Updates the list of all principal with denied Read Permission for given media item. The permission assignment of already denied items which are not on the given principal list, will be removed.
        Parameters:
        mediaItem - the media item.
        principals - the principal list, representing the expected list of all denied principals for the given media item.