com.communote.plugins.confluence.image

Class ConfluenceUserImageProvider

java.lang.Object

com.communote.server.api.core.image.ImageProvider

com.communote.server.core.image.HttpExternalImageProvider<C>

com.communote.server.core.image.type.HttpExternalUserImageProvider<ConfluenceConfiguration>

com.communote.plugins.confluence.image.ConfluenceUserImageProvider

public class ConfluenceUserImageProvider
extends HttpExternalUserImageProvider<ConfluenceConfiguration>

This image provider loads the image from Confluence, if the user is a Confluence user.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_PROPERTY_KEY_CONFIG_MODIFIED Key of a plugin property to store the last modification timestamp of the confluence configuration since the configuration does not provide this information.

Fields inherited from class com.communote.server.core.image.type.HttpExternalUserImageProvider

USER_PROPERTY_KEY_IMAGE_LAST_MODIFIED, USER_PROPERTY_KEY_IMAGE_VERSION_STRING

Constructor Summary

Constructors

Constructor and Description
ConfluenceUserImageProvider(String symbolicName, String pathToDefaultImage)

Method Summary

Modifier and Type	Method and Description
boolean	canLoad(String imageIdentifier) Test whether a provider can load the image.
protected ConfluenceConfiguration	getConfiguration()
protected Long	getConfigurationChangeTimestamp(ConfluenceConfiguration config) Get the timestamp of the last configuration change.
protected String	getImageURL(String imageIdentifier, ConfluenceConfiguration config) Get the URL under which the image with the given identifier can be downloaded
protected org.apache.http.protocol.HttpContext	getRequestContext(URI imageUrl, String imageIdentifier, ConfluenceConfiguration config) Get request context to be used when downloading the given image.
int	getTimeToLive() Get the number of seconds until a cached image should expire and thus be reloaded
void	imageChanged(String imageIdentifier) If imageIdentifier is not null the version string property is removed so that a new one is created the next time the image with the identifier is accessed.

Methods inherited from class com.communote.server.core.image.type.HttpExternalUserImageProvider

getPropertyKeyGroup, getPropertyManagement, getUserId, getVersionString, imageNotDownloaded, imageSuccessfullyDownloaded, isAuthorized, updateUserProperty

Methods inherited from class com.communote.server.core.image.HttpExternalImageProvider

assertNotDisabled, cleanup, disableTemporarily, enable, extractImageFromEntity, getConnectionManagerTimeout, getConnectionTimeout, getDefaultImageVersionString, getDefaultRequestConfig, getDisabledUntilTimestamp, getHttpClient, getLastModifiedHeaderValue, getNotDisablingStatusCodes, getRequestHeaders, getSocketTimeout, hasDefaultImage, isDisabled, isDisablingException, isExternalProvider, isProvideDefaultImageIfDisabled, loadDefaultImage, loadImage, prepareHttpClient, setHttpClient, setProvideDefaultImageIfDisabled, validateContentType, validateStatusCode

Methods inherited from class com.communote.server.api.core.image.ImageProvider

getDefaultImageMimeType, getDefaultImageResourceLastModificationTimestamp, getIdentifier

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_PROPERTY_KEY_CONFIG_MODIFIED

public static final String CLIENT_PROPERTY_KEY_CONFIG_MODIFIED

Key of a plugin property to store the last modification timestamp of the confluence configuration since the configuration does not provide this information.

See Also:

Constant Field Values

Constructor Detail

ConfluenceUserImageProvider

public ConfluenceUserImageProvider(String symbolicName,
                                   String pathToDefaultImage)

Parameters:

symbolicName - the the symbolic name of the bundle which will be used as property key group

pathToDefaultImage - The path to the default image.

Method Detail

canLoad

public boolean canLoad(String imageIdentifier)

Description copied from class: ImageProvider

Test whether a provider can load the image. This should for instance return false if the provider was disabled completely or partially for certain identifiers. Checking whether the identified image exists is not necessary because ImageProvider.loadImage(String) will handle it.

Specified by:

canLoad in class ImageProvider

Parameters:

imageIdentifier - the identifier of the image

Returns:

whether the image can be loaded

getConfiguration

protected ConfluenceConfiguration getConfiguration()

Specified by:

getConfiguration in class HttpExternalImageProvider<ConfluenceConfiguration>

Returns:

the current configuration of the external image provider. During loadImage the same configuration object is passed to all called methods.

getConfigurationChangeTimestamp

protected Long getConfigurationChangeTimestamp(ConfluenceConfiguration config)

Description copied from class: HttpExternalUserImageProvider

Get the timestamp of the last configuration change. This timestamp is used to decide whether the image version string property of a user should be refreshed. For instance if the configuration changed after the version timesstamp was added it is likely that another image will be returned. In this case the version string is updated.

Specified by:

getConfigurationChangeTimestamp in class HttpExternalUserImageProvider<ConfluenceConfiguration>

Parameters:

config - the configuration as returned by HttpExternalImageProvider.getConfiguration()

Returns:

timestamp of the last tracked configuration change or null if this information is not available

getImageURL

protected String getImageURL(String imageIdentifier,
                             ConfluenceConfiguration config)

Description copied from class: HttpExternalImageProvider

Get the URL under which the image with the given identifier can be downloaded

Specified by:

getImageURL in class HttpExternalImageProvider<ConfluenceConfiguration>

Parameters:

imageIdentifier - the ID of the image to download

config - the configuration of the image provider, can be null

Returns:

the URL to the image. If null is returned the load method will throw an ImageNotFoundException

getRequestContext

protected org.apache.http.protocol.HttpContext getRequestContext(URI imageUrl,
                                                                 String imageIdentifier,
                                                                 ConfluenceConfiguration config)

Description copied from class: HttpExternalImageProvider

Get request context to be used when downloading the given image. Implementations could use this method to provide authentication details. The default implementation returns null.

Overrides:

getRequestContext in class HttpExternalImageProvider<ConfluenceConfiguration>

Parameters:

imageUrl - the URL pointing to the image

imageIdentifier - the ID of the image to get

config - the configuration of the image provider, can be null

Returns:

the request context

getTimeToLive

public int getTimeToLive()

Description copied from class: ImageProvider

Get the number of seconds until a cached image should expire and thus be reloaded

Overrides:

getTimeToLive in class ImageProvider

Returns:

time to live in the cache

imageChanged

public void imageChanged(String imageIdentifier)

Description copied from class: HttpExternalUserImageProvider

If imageIdentifier is not null the version string property is removed so that a new one is created the next time the image with the identifier is accessed. If imageIdentifier is null the provider is re-enabled if it was temporarily disabled.

Overrides:

imageChanged in class HttpExternalUserImageProvider<ConfluenceConfiguration>

Parameters:

imageIdentifier - the identifier of the changed image. Can be null in the case that all images have changed.