public class

AvatarManagerImpl

extends Object
implements AvatarManager
java.lang.Object
   ↳ com.atlassian.jira.avatar.AvatarManagerImpl

Class Overview

Manager for Avatars.

Summary

[Expand]
Inherited Constants
From interface com.atlassian.jira.avatar.AvatarManager
[Expand]
Inherited Fields
From interface com.atlassian.jira.avatar.AvatarManager
Public Constructors
AvatarManagerImpl(AvatarStore store, JiraHome jiraHome, ApplicationProperties applicationProperties, GlobalPermissionManager globalPermissionManager, AvatarTagger avatarTagger, PermissionManager permissionManager, EventPublisher eventPublisher)
AvatarManagerImpl(AvatarStore store, JiraHome jiraHome, ApplicationProperties applicationProperties, GlobalPermissionManager globalPermissionManager, AvatarTagger avatarTagger, AvatarImageDataStorage avatarImageDataStorage, PermissionManager permissionManager, EventPublisher eventPublisher)
Public Methods
@Nonnull 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.
@Nonnull 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.
@Nonnull Avatar create(Avatar avatar)
Creates a database record for the given avatar.
@Nonnull Avatar create(String fileName, String contentType, Project owner, InputStream imageData, Selection croppingSelection)
Creates a database record for the given avatar and uses the content of the InputStream as the image.
@Nonnull 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.
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.
@Nonnull List<Avatar> getAllSystemAvatars(Avatar.Type type)
Provides a list of all system avatars.
Long getAnonymousAvatarId()
Gets the avatar id to use to represent an unknown or anonymous user
@Nonnull 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.
@Nonnull 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.
Long getDefaultAvatarId(Avatar.Type ofType)
Gets the default avatar for the given type.
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, Project 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 hasPermissionToView(ApplicationUser remoteUser, Project project)
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, ApplicationUser owner)
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)
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 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 update(Avatar avatar)
Saves the avatar as an updated version of the avatar with the same id that is already in the database.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.avatar.AvatarManager

Public Constructors

public AvatarManagerImpl (AvatarStore store, JiraHome jiraHome, ApplicationProperties applicationProperties, GlobalPermissionManager globalPermissionManager, AvatarTagger avatarTagger, PermissionManager permissionManager, EventPublisher eventPublisher)

public AvatarManagerImpl (AvatarStore store, JiraHome jiraHome, ApplicationProperties applicationProperties, GlobalPermissionManager globalPermissionManager, AvatarTagger avatarTagger, AvatarImageDataStorage avatarImageDataStorage, PermissionManager permissionManager, EventPublisher eventPublisher)

Public Methods

@Nonnull public 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. Use the return value as the persistent avatar, not the one you passed in.

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
IOException

@Nonnull public 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. Use the return value as the persistent avatar, not the one you passed in.

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

@Nonnull public Avatar create (Avatar avatar)

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

Parameters
avatar must not be null, must have a null id.
Returns
  • the created avatar which has an assigned id.

@Nonnull public Avatar create (String fileName, String contentType, Project owner, InputStream imageData, Selection croppingSelection)

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.

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
IOException

@Nonnull public 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. Use the return value as the persistent avatar, not the one you passed in.

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
IOException

public boolean delete (Long avatarId)

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

Parameters
avatarId must not be null.
Returns
  • true only if there was an avatar with the given id which was deleted.

public boolean delete (Long avatarId, boolean alsoDeleteAvatarFile)

Delete the avatar with the given id.

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.

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

Provides a list of all system avatars.

Parameters
type The type of system avatars to return
Returns
  • the system avatars.

public Long getAnonymousAvatarId ()

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

Returns
  • the avatar id for an anonymous user

@Nonnull public File getAvatarBaseDirectory ()

Returns the directory for storing avatars.

Returns
  • the directory.

public Avatar getById (Long avatarId)

Retrieve the avatar with the given id.

Parameters
avatarId must not be null.
Returns
  • the Avatar if there is one or null if not.

public 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.

Parameters
avatarId must not be null.
Returns
  • the Avatar if there is one or null if not.

@Nonnull public 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.

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.

public Long getDefaultAvatarId (Avatar.Type ofType)

Gets the default avatar for the given type.

Parameters
ofType the Avatar type.
Returns
  • the default Avatar.

public boolean hasPermissionToEdit (ApplicationUser remoteUser, ApplicationUser owner)

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

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.

public boolean hasPermissionToEdit (ApplicationUser remoteUser, Project owner)

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

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.

public 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. 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

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.

public boolean hasPermissionToView (ApplicationUser remoteUser, Project project)

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

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.

public 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. 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

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.

public boolean hasPermissionToView (ApplicationUser remoteUser, ApplicationUser owner)

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

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.

public boolean isAvatarOwner (Avatar avatar, String ownerId)

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

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.

public static boolean isAvatarTranscodeable (Avatar avatar)

public static boolean isSvgContentType (String mimeType)

public 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. The InputStream is closed after the dataAccessor completes. The dataAccessor is immediately invoked on the data for the avatar.

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

public 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. 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.

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

public 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. The InputStream is closed after the dataAccessor completes. The dataAccessor is immediately invoked on the data for the avatar.

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

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

public void update (Avatar avatar)

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

Parameters
avatar must not be null.