com.atlassian.jira.avatar

Class AvatarManagerImpl

java.lang.Object

com.atlassian.jira.avatar.AvatarManagerImpl

All Implemented Interfaces:

AvatarManager

public class AvatarManagerImpl
extends Object
implements AvatarManager

Manager for Avatars.

Since:

v4.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.avatar.AvatarManager

AvatarManager.ImageSize

Field Summary

Fields inherited from interface com.atlassian.jira.avatar.AvatarManager

AVATAR_IMAGE_FORMAT, AVATAR_IMAGE_FORMAT_FULL, AVATAR_IMAGE_FORMAT_SVG, PNG_CONTENT_TYPE, SVG_CONTENT_TYPE, USER_AVATAR_ID_KEY

Constructor Summary

Constructors

Constructor and Description

AvatarManagerImpl(AvatarStore store, ApplicationProperties applicationProperties, GlobalPermissionManager globalPermissionManager, AvatarTagger avatarTagger, AvatarImageDataStorage avatarImageDataStorage, PermissionManager permissionManager, com.atlassian.event.api.EventPublisher eventPublisher, IconTypeDefinitionFactory iconTypeFactory, RequestCacheFactory requestCacheFactory, AvatarTranscoder avatarTranscoder, AvatarManagerStats avatarManagerStats)

Method Summary

Modifier and Type	Method and Description
Avatar	create(Avatar.Type avatarType, String owningObjectId, AvatarImageDataProvider imageDataProvider) Creates a database record for the given avatar and uses the content of the InputStream as the image.
Avatar	create(Avatar avatar) Creates a database record for the given avatar.
Avatar	create(Avatar avatar, InputStream imageData, Selection croppingSelection) Creates a database record for the given avatar and uses the content of the InputStream as the image.
Avatar	create(IconType iconType, IconOwningObjectId owningObjectId, AvatarImageDataProvider imageDataProvider) Creates a database record for the given avatar and uses the content of the InputStream as the image.
Avatar	create(String fileName, String contentType, ApplicationUser owner, InputStream imageData, Selection croppingSelection) Creates a database record for the given avatar and uses the content of the InputStream as the image.
Avatar	create(String fileName, String contentType, IconType iconType, IconOwningObjectId owner, InputStream imageData, Selection croppingSelection) Creates a database record for the given avatar and uses the content of the InputStream as the image.
Avatar	create(String fileName, String contentType, Project project, InputStream imageData, Selection croppingSelection) Creates a database record for the given avatar and uses the content of the InputStream as the image.
boolean	delete(Long avatarId) Delete the avatar with the given id and the file on disk.
boolean	delete(Long avatarId, boolean alsoDeleteAvatarFile) Delete the avatar with the given id.
List<Avatar>	getAllSystemAvatars(Avatar.Type type) Provides a list of all system avatars.
List<Avatar>	getAllSystemAvatars(IconType iconType) Provides a list of all system avatars.
Long	getAnonymousAvatarId() Gets the avatar id to use to represent an unknown or anonymous user
File	getAvatarBaseDirectory() Returns the directory for storing avatars.
Avatar	getById(Long avatarId) Retrieve the avatar with the given id.
Avatar	getByIdTagged(Long avatarId) Retrieve the avatar with the given id, ensuring the avatar file is tagged with metadata identifying the image came from JIRA.
List<Avatar>	getCustomAvatarsForOwner(Avatar.Type type, String ownerId) Provides a list of all avatars that are of the given type which have the given owner.
List<Avatar>	getCustomAvatarsForOwner(IconType iconType, String ownerId) Provides a list of all avatars that are of the given type which have the given owner.
Avatar	getDefaultAvatar(IconType iconType) Gets the default avatar for the given type.
Long	getDefaultAvatarId(Avatar.Type ofType) Gets the default avatar ID for the given type.
Long	getDefaultAvatarId(IconType iconType) Gets the default avatar ID for the given type.
boolean	hasImage(Avatar avatar, Avatar.Size size) Checks if valid image exists for avatar and image can be consumed by AvatarManager.readAvatarData(Avatar, Avatar.Size, AvatarFormatPolicy, MediaConsumer).
boolean	hasPermissionToEdit(ApplicationUser remoteUser, ApplicationUser owner) Determines if the remoteUser provided has permission to edit avatars of a certain type for the owner provided.
boolean	hasPermissionToEdit(ApplicationUser remoteUser, Avatar.Type type, String ownerId) Determines if the remoteUser provided has permission to edit avatars of a certain type for the owner provided.
boolean	hasPermissionToEdit(ApplicationUser remoteUser, Project owner) Determines if the remoteUser provided has permission to edit avatars of a certain type for the owner provided.
boolean	hasPermissionToView(ApplicationUser remoteUser, ApplicationUser owner) Determines if the remoteUser provided has permission to view avatars of a certain type for the owner provided.
boolean	hasPermissionToView(ApplicationUser remoteUser, Avatar.Type type, String ownerId) Determines if the remoteUser provided has permission to view avatars of a certain type for the owner provided.
boolean	hasPermissionToView(ApplicationUser remoteUser, Project project) Determines if the remoteUser provided has permission to view avatars of a certain type for the owner provided.
boolean	isAvatarOwner(Avatar avatar, String ownerId) Tells whether the given avatar is owned by the given ownerId.
static boolean	isAvatarTranscodeable(Avatar avatar)
static boolean	isSvgContentType(String mimeType)
boolean	isValidIconType(IconType iconType) Check if this is a valid icon type.
void	readAvatarData(Avatar avatar, Avatar.Size size, AvatarFormatPolicy avatarFormatPolicy, MediaConsumer mediaConsumer) Provides read-only access to the data of the avatar image as an InputStream passed to the provided dataAccessor.
void	readAvatarData(Avatar avatar, Avatar.Size size, Consumer<InputStream> dataAccessor) Provides read-only access to the data of the avatar image as an InputStream passed to the provided dataAccessor.
void	readAvatarData(Avatar avatar, AvatarManager.ImageSize size, Consumer<InputStream> dataAccessor) Provides read-only access to the data of the avatar image as an InputStream passed to the provided dataAccessor.
void	update(Avatar avatar) Saves the avatar as an updated version of the avatar with the same id that is already in the database.
boolean	userCanCreateFor(ApplicationUser remoteUser, IconType iconType, IconOwningObjectId owningObjectId) Check if the user could create an avatar for this owning object.
boolean	userCanDelete(ApplicationUser remoteUser, Avatar icon) Check if the user can delete the icon.
boolean	userCanView(ApplicationUser remoteUser, Avatar icon) Check if the user can view the icon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AvatarManagerImpl

public AvatarManagerImpl(AvatarStore store,
                         ApplicationProperties applicationProperties,
                         GlobalPermissionManager globalPermissionManager,
                         AvatarTagger avatarTagger,
                         AvatarImageDataStorage avatarImageDataStorage,
                         PermissionManager permissionManager,
                         com.atlassian.event.api.EventPublisher eventPublisher,
                         IconTypeDefinitionFactory iconTypeFactory,
                         RequestCacheFactory requestCacheFactory,
                         AvatarTranscoder avatarTranscoder,
                         AvatarManagerStats avatarManagerStats)

Method Detail

getById

public Avatar getById(Long avatarId)

Description copied from interface: AvatarManager

Retrieve the avatar with the given id.

Specified by:

getById in interface AvatarManager

Parameters:

avatarId - must not be null.

Returns:

the Avatar if there is one or null if not.

getByIdTagged

public Avatar getByIdTagged(Long avatarId)

Description copied from interface: AvatarManager

Retrieve the avatar with the given id, ensuring the avatar file is tagged with metadata identifying the image came from JIRA.

Specified by:

getByIdTagged in interface AvatarManager

Parameters:

avatarId - must not be null.

Returns:

the Avatar if there is one or null if not.

delete

public boolean delete(Long avatarId)

Description copied from interface: AvatarManager

Delete the avatar with the given id and the file on disk.

Specified by:

delete in interface AvatarManager

Parameters:

avatarId - must not be null.

Returns:

true only if there was an avatar with the given id which was deleted.

delete

public boolean delete(Long avatarId,
                      boolean alsoDeleteAvatarFile)

Description copied from interface: AvatarManager

Delete the avatar with the given id.

Specified by:

delete in interface AvatarManager

Parameters:

avatarId - must not be null.

alsoDeleteAvatarFile - if false, the avatar file will be left on disk.

Returns:

true only if there was an avatar with the given id which was deleted.

update

public void update(Avatar avatar)

Description copied from interface: AvatarManager

Saves the avatar as an updated version of the avatar with the same id that is already in the database.

Specified by:

update in interface AvatarManager

Parameters:

avatar - must not be null.

create

@Nonnull
public Avatar create(Avatar avatar)

Description copied from interface: AvatarManager

Creates a database record for the given avatar. Use the return value as the persistent avatar, not the one you passed in.

Specified by:

create in interface AvatarManager

Parameters:

avatar - must not be null, must have a null id.

Returns:

the created avatar which has an assigned id.

create

@Nonnull
public Avatar create(Avatar avatar,
                              InputStream imageData,
                              Selection croppingSelection)
                       throws DataAccessException,
                              IOException

Description copied from interface: AvatarManager

Creates a database record for the given avatar and uses the content of the InputStream as the image. Use the return value as the persistent avatar, not the one you passed in.

Specified by:

create in interface AvatarManager

Parameters:

avatar - must not be null, must have a null id.

imageData - the data of the original avatar image.

croppingSelection - the cropping selection for the image or null to take whole image.

Returns:

the created avatar which has an assigned id.

Throws:

DataAccessException - if there is a back-end database problem.

IOException

create

@Nonnull
public Avatar create(Avatar.Type avatarType,
                              @Nonnull
                              String owningObjectId,
                              @Nonnull
                              AvatarImageDataProvider imageDataProvider)
                       throws IOException

Description copied from interface: AvatarManager

Creates a database record for the given avatar and uses the content of the InputStream as the image. Use the return value as the persistent avatar, not the one you passed in.

Specified by:

create in interface AvatarManager

Parameters:

avatarType - type of new avatar to create.

owningObjectId - id of object (project/user/issuetype) to which this avatar is connected to.

imageDataProvider - provider of image data

Returns:

the created avatar which has an assigned id.

Throws:

IOException - if there are arrors when processing image data

See Also:

CroppingAvatarImageDataProviderFactory

create

@Nonnull
public Avatar create(@Nonnull
                              IconType iconType,
                              @Nonnull
                              IconOwningObjectId owningObjectId,
                              @Nonnull
                              AvatarImageDataProvider imageDataProvider)
                       throws IOException

Description copied from interface: AvatarManager

Creates a database record for the given avatar and uses the content of the InputStream as the image. Use the return value as the persistent avatar, not the one you passed in.

Specified by:

create in interface AvatarManager

Parameters:

iconType - type of new avatar to create.

owningObjectId - id of object (project/user/issuetype) to which this avatar is connected to.

imageDataProvider - provider of image data

Returns:

the created avatar which has an assigned id.

Throws:

IOException - if there are arrors when processing image data

See Also:

CroppingAvatarImageDataProviderFactory

create

@Nonnull
public Avatar create(String fileName,
                              String contentType,
                              IconType iconType,
                              IconOwningObjectId owner,
                              InputStream imageData,
                              Selection croppingSelection)
                       throws DataAccessException,
                              IOException

Description copied from interface: AvatarManager

Creates a database record for the given avatar and uses the content of the InputStream as the image. Use the return value as the persistent avatar, not the one you passed in.

Specified by:

create in interface AvatarManager

Parameters:

fileName - the name of the avatar

contentType - MIME content type for the avatar

iconType - The type of avatar to create.

owner - The object that will own the icon.

imageData - the data of the original avatar image (it will be automatically closed)

croppingSelection - the cropping selection for the image or null to take whole image

Returns:

the created avatar which has an assigned id

Throws:

IOException - If there was a problem consuming the image data, or a problem storing the image data.

DataAccessException

create

@Nonnull
public Avatar create(String fileName,
                              String contentType,
                              Project project,
                              InputStream imageData,
                              Selection croppingSelection)
                       throws DataAccessException,
                              IOException

Description copied from interface: AvatarManager

Creates a database record for the given avatar and uses the content of the InputStream as the image. Use the return value as the persistent avatar, not the one you passed in.

Specified by:

create in interface AvatarManager

Parameters:

fileName - the name of the avatar

contentType - MIME content type for the avatar

imageData - the data of the original avatar image (it will be automatically closed)

croppingSelection - the cropping selection for the image or null to take whole image

Returns:

the created avatar which has an assigned id

Throws:

DataAccessException - if there is a back-end database problem.

IOException

create

@Nonnull
public Avatar create(String fileName,
                              String contentType,
                              ApplicationUser owner,
                              InputStream imageData,
                              Selection croppingSelection)
                       throws DataAccessException,
                              IOException

Description copied from interface: AvatarManager

Creates a database record for the given avatar and uses the content of the InputStream as the image. Use the return value as the persistent avatar, not the one you passed in.

Specified by:

create in interface AvatarManager

Parameters:

fileName - the name of the avatar

contentType - MIME content type for the avatar

imageData - the data of the original avatar image (it will be automatically closed)

croppingSelection - the cropping selection for the image or null to take whole image

Returns:

the created avatar which has an assigned id

Throws:

DataAccessException - if there is a back-end database problem.

IOException

getAvatarBaseDirectory

@Nonnull
public File getAvatarBaseDirectory()

Description copied from interface: AvatarManager

Returns the directory for storing avatars.

Specified by:

getAvatarBaseDirectory in interface AvatarManager

Returns:

the directory.

getAllSystemAvatars

@Nonnull
public List<Avatar> getAllSystemAvatars(Avatar.Type type)

Description copied from interface: AvatarManager

Provides a list of all system avatars.

Specified by:

getAllSystemAvatars in interface AvatarManager

Parameters:

type - The type of system avatars to return

Returns:

the system avatars.

getAllSystemAvatars

@Nonnull
public List<Avatar> getAllSystemAvatars(IconType iconType)

Description copied from interface: AvatarManager

Provides a list of all system avatars.

Specified by:

getAllSystemAvatars in interface AvatarManager

Parameters:

iconType - The type of system avatars to return

Returns:

the system avatars.

getCustomAvatarsForOwner

@Nonnull
public List<Avatar> getCustomAvatarsForOwner(Avatar.Type type,
                                                      String ownerId)

Description copied from interface: AvatarManager

Provides a list of all avatars that are of the given type which have the given owner.

Specified by:

getCustomAvatarsForOwner in interface AvatarManager

Parameters:

type - the desired type of the avatars to retrieve.

ownerId - the id of the owner, matches the type (project id or user key).

Returns:

all the avatars that have the given type and owner, never null.

getCustomAvatarsForOwner

@Nonnull
public List<Avatar> getCustomAvatarsForOwner(IconType iconType,
                                                      String ownerId)

Description copied from interface: AvatarManager

Provides a list of all avatars that are of the given type which have the given owner.

Specified by:

getCustomAvatarsForOwner in interface AvatarManager

Parameters:

iconType - the desired type of the avatars to retrieve.

ownerId - the id of the owner, matches the type (project id or user key).

Returns:

all the avatars that have the given type and owner, never null.

isAvatarOwner

public boolean isAvatarOwner(Avatar avatar,
                             String ownerId)

Description copied from interface: AvatarManager

Tells whether the given avatar is owned by the given ownerId.

Specified by:

isAvatarOwner in interface AvatarManager

Parameters:

avatar - the avatar to check, must not be null.

ownerId - the ownerId to check, must not be null.

Returns:

true only if the given ownerId is the ownerId of the given avatar.

readAvatarData

public void readAvatarData(Avatar avatar,
                           AvatarManager.ImageSize size,
                           Consumer<InputStream> dataAccessor)
                    throws IOException

Description copied from interface: AvatarManager

Provides read-only access to the data of the avatar image as an InputStream passed to the provided dataAccessor. The InputStream is closed after the dataAccessor completes. The dataAccessor is immediately invoked on the data for the avatar.

Specified by:

readAvatarData in interface AvatarManager

Parameters:

avatar - the avatar for which the data is to be processed.

size - the size to return for this avatar

dataAccessor - something to read the data.

Throws:

IOException - if an IOException occurs in the dataAccessor or in acquiring the InputStream for the avatar.

See Also:

AvatarManager.readAvatarData(Avatar, Avatar.Size, AvatarFormatPolicy, MediaConsumer)

readAvatarData

public void readAvatarData(@Nonnull
                           Avatar avatar,
                           @Nonnull
                           Avatar.Size size,
                           @Nonnull
                           Consumer<InputStream> dataAccessor)
                    throws IOException

Description copied from interface: AvatarManager

Provides read-only access to the data of the avatar image as an InputStream passed to the provided dataAccessor. The InputStream is closed after the dataAccessor completes. The dataAccessor is immediately invoked on the data for the avatar.

This is equivalent to calling AvatarManager.readAvatarData(Avatar, Avatar.Size, AvatarFormatPolicy, MediaConsumer) with AvatarFormatPolicy.createOriginalDataPolicy() as the requested type and Optional.empty() as type Accessor.

Specified by:

readAvatarData in interface AvatarManager

Parameters:

avatar - the avatar for which the data is to be processed.

size - the size to return for this avatar

dataAccessor - something to read the data.

Throws:

IOException - if an IOException occurs in the dataAccessor or in acquiring the InputStream for the avatar.

See Also:

AvatarManager.readAvatarData(Avatar, Avatar.Size, AvatarFormatPolicy, MediaConsumer)

readAvatarData

public void readAvatarData(@Nonnull
                           Avatar avatar,
                           @Nonnull
                           Avatar.Size size,
                           @Nonnull
                           AvatarFormatPolicy avatarFormatPolicy,
                           @Nonnull
                           MediaConsumer mediaConsumer)
                    throws IOException

Description copied from interface: AvatarManager

Provides read-only access to the data of the avatar image as an InputStream passed to the provided dataAccessor. The InputStream is closed after the dataAccessor completes. The dataAccessor is immediately invoked on the data for the avatar.

The format that the image will be served in, is determined by the AvatarFormatPolicy that is provided as a parameter. This should be used to set the content type of the data being provided to the @Consumer. If the parameters are non-strict, it will be a best attempt, and to know which content type has been used please provide a typeAccessor.

Specified by:

readAvatarData in interface AvatarManager

Parameters:

avatar - the avatar for which the data is to be processed.

size - the size to return for this avatar

avatarFormatPolicy - the requested format for avatar data.

mediaConsumer - consumer that will read the data.

Throws:

IOException - if an IOException occurs in the dataAccessor or in acquiring the InputStream for the avatar.

getDefaultAvatarId

public Long getDefaultAvatarId(Avatar.Type ofType)

Description copied from interface: AvatarManager

Gets the default avatar ID for the given type.

Specified by:

getDefaultAvatarId in interface AvatarManager

Parameters:

ofType - the Avatar type.

Returns:

the default Avatar ID.

getDefaultAvatarId

public Long getDefaultAvatarId(@Nonnull
                               IconType iconType)

Description copied from interface: AvatarManager

Gets the default avatar ID for the given type.

Specified by:

getDefaultAvatarId in interface AvatarManager

Parameters:

iconType - the Icon type.

Returns:

the default Avatar ID.

getDefaultAvatar

public Avatar getDefaultAvatar(IconType iconType)

Description copied from interface: AvatarManager

Gets the default avatar for the given type.

Specified by:

getDefaultAvatar in interface AvatarManager

Parameters:

iconType - the Icon type.

Returns:

the default Avatar, or null if the default avatar cannot be found for some reason. (e.g. There are no avatars for this type, or the type is invalid.)

isValidIconType

public boolean isValidIconType(@Nonnull
                               IconType iconType)

Description copied from interface: AvatarManager

Check if this is a valid icon type.

Specified by:

isValidIconType in interface AvatarManager

Parameters:

iconType - The icon type to check.

Returns:

True if this iconType is recognised, or false otherwise.

getAnonymousAvatarId

public Long getAnonymousAvatarId()

Description copied from interface: AvatarManager

Gets the avatar id to use to represent an unknown or anonymous user

Specified by:

getAnonymousAvatarId in interface AvatarManager

Returns:

the avatar id for an anonymous user

hasPermissionToView

public boolean hasPermissionToView(ApplicationUser remoteUser,
                                   Avatar.Type type,
                                   String ownerId)

Description copied from interface: AvatarManager

Determines if the remoteUser provided has permission to view avatars of a certain type for the owner provided. For project avatars, this method checks that the user is either and admin, project admin or has browse permission for the owner project. For user avatars, the method checks that the remoteUser has use permission for JIRA or the remoteUser and avatar owner are the same person

Specified by:

hasPermissionToView in interface AvatarManager

Parameters:

remoteUser - The remote user trying to view an avatar

type - The type of avatar

ownerId - The owner id of the avatar being viewed (project id or user key)

Returns:

true if the remote user has permission to view avatars owned by the owner provided.

hasPermissionToView

public boolean hasPermissionToView(ApplicationUser remoteUser,
                                   Project project)

Description copied from interface: AvatarManager

Determines if the remoteUser provided has permission to view avatars of a certain type for the owner provided. For project avatars, this method checks that the user is either and admin, project admin or has browse permission for the owner project. For user avatars, the method checks that the remoteUser has use permission for JIRA or the remoteUser and avatar owner are the same person

Specified by:

hasPermissionToView in interface AvatarManager

Parameters:

remoteUser - The remote user trying to view an avatar

project - The owner of the avatar being viewed

Returns:

true if the remote user has permission to view avatars owned by the owner provided.

hasPermissionToView

public boolean hasPermissionToView(ApplicationUser remoteUser,
                                   ApplicationUser owner)

Description copied from interface: AvatarManager

Determines if the remoteUser provided has permission to view avatars of a certain type for the owner provided. For project avatars, this method checks that the user is either and admin, project admin or has browse permission for the owner project. For user avatars, the method checks that the remoteUser has use permission for JIRA or the remoteUser and avatar owner are the same person

Specified by:

hasPermissionToView in interface AvatarManager

Parameters:

remoteUser - The remote user trying to view an avatar

owner - The owner of the avatar being viewed

Returns:

true if the remote user has permission to view avatars owned by the owner provided.

hasPermissionToEdit

public boolean hasPermissionToEdit(ApplicationUser remoteUser,
                                   Avatar.Type type,
                                   String ownerId)

Description copied from interface: AvatarManager

Determines if the remoteUser provided has permission to edit avatars of a certain type for the owner provided. For project avatars, this method checks that the user is either and admin or project admin for the owner project. For user avatars, the method checks that the remoteUser has admin permissions for JIRA or the remoteUser and avatar owner are the same person. If external user management is enabled this method returns false

Specified by:

hasPermissionToEdit in interface AvatarManager

Parameters:

remoteUser - The remote user trying to edit an avatar

type - The type of avatar

ownerId - The owner id of the avatar being edited (project id or user key)

Returns:

true if the remote user has permission to edit avatars owned by the owner provided.

hasPermissionToEdit

public boolean hasPermissionToEdit(ApplicationUser remoteUser,
                                   ApplicationUser owner)

Description copied from interface: AvatarManager

Determines if the remoteUser provided has permission to edit avatars of a certain type for the owner provided. For project avatars, this method checks that the user is either and admin or project admin for the owner project. For user avatars, the method checks that the remoteUser has admin permissions for JIRA or the remoteUser and avatar owner are the same person. If external user management is enabled this method returns false

Specified by:

hasPermissionToEdit in interface AvatarManager

Parameters:

remoteUser - The remote user trying to edit an avatar

owner - The owner of the avatar being edited

Returns:

true if the remote user has permission to edit avatars owned by the owner provided.

hasPermissionToEdit

public boolean hasPermissionToEdit(ApplicationUser remoteUser,
                                   Project owner)

Description copied from interface: AvatarManager

Determines if the remoteUser provided has permission to edit avatars of a certain type for the owner provided. For project avatars, this method checks that the user is either and admin or project admin for the owner project. For user avatars, the method checks that the remoteUser has admin permissions for JIRA or the remoteUser and avatar owner are the same person. If external user management is enabled this method returns false

Specified by:

hasPermissionToEdit in interface AvatarManager

Parameters:

remoteUser - The remote user trying to edit an avatar

owner - The owner of the avatar being edited

Returns:

true if the remote user has permission to edit avatars owned by the owner provided.

isSvgContentType

public static boolean isSvgContentType(String mimeType)

isAvatarTranscodeable

public static boolean isAvatarTranscodeable(@Nonnull
                                            Avatar avatar)

userCanView

public boolean userCanView(@Nullable
                           ApplicationUser remoteUser,
                           @Nonnull
                           Avatar icon)

Description copied from interface: AvatarManager

Check if the user can view the icon.

Specified by:

userCanView in interface AvatarManager

Parameters:

remoteUser - user whose permissions should be used. Null means anonymous access.

icon - The icon that the user wishes to access.

Returns:

Returns true if the user is allowed to view the avatar, or false otherwise.

userCanDelete

public boolean userCanDelete(@Nullable
                             ApplicationUser remoteUser,
                             @Nonnull
                             Avatar icon)

Description copied from interface: AvatarManager

Check if the user can delete the icon.

Specified by:

userCanDelete in interface AvatarManager

Parameters:

remoteUser - user whose permissions should be used. Null means anonymous access.

icon - The icon that the user wishes to delete.

Returns:

Returns true if the user is allowed to delete the avatar, or false otherwise.

userCanCreateFor

public boolean userCanCreateFor(@Nullable
                                ApplicationUser remoteUser,
                                @Nonnull
                                IconType iconType,
                                @Nonnull
                                IconOwningObjectId owningObjectId)

Description copied from interface: AvatarManager

Check if the user could create an avatar for this owning object.

Specified by:

userCanCreateFor in interface AvatarManager

Parameters:

remoteUser - user whose permissions should be used. Null means anonymous access.

iconType - The type of icon the user is trying to create.

owningObjectId - id of the object to which this avatar is connected to. This helps set the scope for the provider of the IconType to determine permissions for icons that have not been created yet.

hasImage

public boolean hasImage(@Nonnull
                        Avatar avatar,
                        @Nonnull
                        Avatar.Size size)

Description copied from interface: AvatarManager

Checks if valid image exists for avatar and image can be consumed by AvatarManager.readAvatarData(Avatar, Avatar.Size, AvatarFormatPolicy, MediaConsumer). An example of avatar with invalid image would be avatar with its image removed from the filesystem.

Specified by:

hasImage in interface AvatarManager

Parameters:

avatar - Avatar

size - Avatar size

Returns:

true if avatar contains valid image that can be consumed.