org.alfresco.wcm.preview

Interface PreviewURIService

All Known Implementing Classes:

PreviewURIServiceImpl

public interface PreviewURIService

Client API for retrieving/generating preview URIs

Since:

3.2

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDefaultProviderName() Return default Preview URI service provider
java.lang.String	getPreviewURI(java.lang.String sbStoreId, java.lang.String pathToAsset)
java.util.List	getPreviewURIs(java.lang.String sbStoreId, java.util.List pathsToAssets)
java.lang.String	getProviderName(java.lang.String wpStoreId) Return Preview URI service provider configured for web project
java.util.Set	getProviderNames() Return list of registered Preview URI service providers

Method Detail

getPreviewURI

java.lang.String getPreviewURI(java.lang.String sbStoreId,
                             java.lang.String pathToAsset)

Parameters:

sbStoreId - The sandbox store id to generate the preview URI for.

pathToAsset - The path to the asset to generate the preview URI for (can be null or empty, to return preview URL to store).

Returns:

The Preview URI for the given sandbox and/or asset (may be null).

getPreviewURIs

java.util.List getPreviewURIs(java.lang.String sbStoreId,
                            java.util.List pathsToAssets)

Parameters:

sbStoreId - The sandbox store id to generate the preview URI for.

pathsToAssets - List of paths to the assets to generate the preview URI for.

Returns:

The Preview URI for the given assets (may be null).

getProviderNames

java.util.Set getProviderNames()

Return list of registered Preview URI service providers

Returns:

getDefaultProviderName

java.lang.String getDefaultProviderName()

Return default Preview URI service provider

Returns:

getProviderName

java.lang.String getProviderName(java.lang.String wpStoreId)

Return Preview URI service provider configured for web project

Returns: