com.atlassian.jira.avatar

Class CachingTaggingAvatarStore

java.lang.Object

com.atlassian.jira.avatar.CachingTaggingAvatarStore

All Implemented Interfaces:

AvatarStore

public class CachingTaggingAvatarStore
extends Object
implements AvatarStore

Avatar store which converts legacy avatar files to the new tagged format during retrieval

Since:

v6.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	AVATAR_ENTITY
static String	AVATAR_TYPE
static String	CONTENT_TYPE
static String	FILE_NAME
static String	ID
static String	OWNER
static String	SYSTEM_AVATAR

Constructor Summary

Constructors

Constructor and Description
CachingTaggingAvatarStore(OfBizDelegator ofBizDelegator, AvatarTagger avatarTagger, com.atlassian.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
Avatar	create(Avatar avatar) Creates an avatar with the properties of the given avatar.
boolean	delete(Long avatarId) Permanently removes the avatar from the system.
List<Avatar>	getAllSystemAvatars(IconType iconType) Provides a list of all system avatars.
Avatar	getById(Long avatarId) Retrieves the Avatar by id.
Avatar	getByIdTagged(Long avatarId) Retrieves the Avatar by id, ensuring the avatar file is tagged with metadata identifying the image came from JIRA.
List<Avatar>	getCustomAvatarsForOwner(IconType iconType, String ownerId) Provides a list of all avatars that are of the given type which have the given owner.
List<Avatar>	getSystemAvatarsForFilename(IconType iconType, String filename) Get the system icon with a particular filename.
void	onClearCache(ClearCacheEvent event)
void	update(Avatar avatar) Updates an avatar's properties to match those in the given avatar.

Methods inherited from class java.lang.Object

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

Field Detail

AVATAR_ENTITY

public static final String AVATAR_ENTITY

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

FILE_NAME

public static final String FILE_NAME

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

AVATAR_TYPE

public static final String AVATAR_TYPE

See Also:

Constant Field Values

OWNER

public static final String OWNER

See Also:

Constant Field Values

SYSTEM_AVATAR

public static final String SYSTEM_AVATAR

See Also:

Constant Field Values

Constructor Detail

CachingTaggingAvatarStore

public CachingTaggingAvatarStore(OfBizDelegator ofBizDelegator,
                                 AvatarTagger avatarTagger,
                                 com.atlassian.cache.CacheManager cacheManager)

Method Detail

getById

public Avatar getById(Long avatarId)

Description copied from interface: AvatarStore

Retrieves the Avatar by id.

Specified by:

getById in interface AvatarStore

Parameters:

avatarId - the avatar's id, must not be null.

Returns:

the avatar with the given id or null if it doesn't exist.

getByIdTagged

public Avatar getByIdTagged(Long avatarId)

Description copied from interface: AvatarStore

Retrieves the Avatar by id, ensuring the avatar file is tagged with metadata identifying the image came from JIRA.

Specified by:

getByIdTagged in interface AvatarStore

Parameters:

avatarId - the avatar's id, must not be null.

Returns:

the avatar with the given id or null if it doesn't exist.

delete

public boolean delete(Long avatarId)

Description copied from interface: AvatarStore

Permanently removes the avatar from the system.

Specified by:

delete in interface AvatarStore

Parameters:

avatarId - the avatar's id, must not be null.

Returns:

the avatar with the given id or null if it doesn't exist.

update

public void update(Avatar avatar)

Description copied from interface: AvatarStore

Updates an avatar's properties to match those in the given avatar. The avatar too change is identified by the id of the given avatar.

Specified by:

update in interface AvatarStore

Parameters:

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

create

public Avatar create(Avatar avatar)

Description copied from interface: AvatarStore

Creates an avatar with the properties of the given avatar.

Specified by:

create in interface AvatarStore

Parameters:

avatar - the to create, must not be null, must have a null id.

Returns:

the avatar with the given id or null if it doesn't exist.

getAllSystemAvatars

public List<Avatar> getAllSystemAvatars(IconType iconType)

Description copied from interface: AvatarStore

Provides a list of all system avatars.

Specified by:

getAllSystemAvatars in interface AvatarStore

Parameters:

iconType - the types of avatar to retrieve

Returns:

the system avatars, never null.

getCustomAvatarsForOwner

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

Description copied from interface: AvatarStore

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

Specified by:

getCustomAvatarsForOwner in interface AvatarStore

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.

getSystemAvatarsForFilename

public List<Avatar> getSystemAvatarsForFilename(IconType iconType,
                                                String filename)
                                         throws DataAccessException

Description copied from interface: AvatarStore

Get the system icon with a particular filename.

Specified by:

getSystemAvatarsForFilename in interface AvatarStore

Parameters:

iconType - The type of icon to return.

filename - The filename.

Returns:

The list of icons.

Throws:

DataAccessException - back end DB problem.

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)