com.atlassian.bitbucket.avatar

Class DelegatingCacheableAvatarSupplier

java.lang.Object

com.atlassian.bitbucket.avatar.DelegatingCacheableAvatarSupplier

All Implemented Interfaces:

AvatarSupplier, CacheableAvatarSupplier, InputSupplier<InputStream>

public class DelegatingCacheableAvatarSupplier
extends Object
implements CacheableAvatarSupplier

An CacheableAvatarSupplier implementation which delegates to an AvatarSupplier, storing the avatar's modification timestamp separately. This class can be used to promote an ordinary AvatarSupplier to a CacheableAvatarSupplier.

Field Summary

Fields inherited from interface com.atlassian.bitbucket.avatar.CacheableAvatarSupplier

TIMESTAMP_ETERNAL, TIMESTAMP_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
DelegatingCacheableAvatarSupplier(AvatarSupplier supplier) Constructs a new DelegatingCacheableAvatarSupplier with an unknown timestamp.
DelegatingCacheableAvatarSupplier(AvatarSupplier supplier, long timestamp) Constructs a new DelegatingCacheableAvatarSupplier with the provided timestamp.

Method Summary

Modifier and Type	Method and Description
String	getContentType() The content type of the avatar, e.g., "image/png"
long	getTimestamp() The timestamp at which the avatar was last modified, in milliseconds.
InputStream	open() Provides an InputStream to read the avatar.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingCacheableAvatarSupplier

public DelegatingCacheableAvatarSupplier(@Nonnull
                                         AvatarSupplier supplier)

Constructs a new DelegatingCacheableAvatarSupplier with an unknown timestamp.

Parameters:

supplier - the AvatarSupplier containing the avatar's content type and InputStream

See Also:

DelegatingCacheableAvatarSupplier(AvatarSupplier, long), CacheableAvatarSupplier.TIMESTAMP_UNKNOWN

DelegatingCacheableAvatarSupplier

public DelegatingCacheableAvatarSupplier(@Nonnull
                                         AvatarSupplier supplier,
                                         long timestamp)

Constructs a new DelegatingCacheableAvatarSupplier with the provided timestamp.

Parameters:

supplier - the AvatarSupplier containing the avatar's content type and InputStream

timestamp - the avatar's modification timestamp, which may be CacheableAvatarSupplier.TIMESTAMP_UNKNOWN if no modification timestamp is known, or CacheableAvatarSupplier.TIMESTAMP_ETERNAL if the avatar is unmodifiable

Method Detail

getContentType

public String getContentType()

Description copied from interface: AvatarSupplier

The content type of the avatar, e.g., "image/png"

Specified by:

getContentType in interface AvatarSupplier

Returns:

the string representing the content type

open

@Nonnull
public InputStream open()
                          throws IOException

Description copied from interface: AvatarSupplier

Provides an InputStream to read the avatar. Each call to this method will produce a new stream.

Specified by:

open in interface AvatarSupplier

Specified by:

open in interface InputSupplier<InputStream>

Returns:

a stream from the avatar

Throws:

IOException - in case the avatar could not be opened or read

getTimestamp

public long getTimestamp()

Description copied from interface: CacheableAvatarSupplier

The timestamp at which the avatar was last modified, in milliseconds.

To account for differences in avatar repository implementations:

• If timestamp information is not available, implementations shall return CacheableAvatarSupplier.TIMESTAMP_UNKNOWN. Avatars without timestamps should not be cached, as it may not be possible to reliably detect updates.
• If the avatar cannot be updated, implementations shall return CacheableAvatarSupplier.TIMESTAMP_ETERNAL. Such avatars may be cached more aggressively, as they cannot change.

Specified by:

getTimestamp in interface CacheableAvatarSupplier

Returns:

the avatar's modification timestamp in milliseconds, or CacheableAvatarSupplier.TIMESTAMP_UNKNOWN if no modification date is available, or CacheableAvatarSupplier.TIMESTAMP_ETERNAL if the avatar is unmodifiable