org.alfresco.wcm.preview

Interface PreviewURIService

All Known Implementing Classes:

PreviewURIServiceImpl

public interface PreviewURIService

Client API for retrieving/generating preview URIs

Since:

3.2

Author:

janv

Method Summary

Methods

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

Method Detail

getPreviewURI

String getPreviewURI(String sbStoreId,
                   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

List<String> getPreviewURIs(String sbStoreId,
                          List<String> 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

Set<String> getProviderNames()

Return list of registered Preview URI service providers

Returns:

getDefaultProviderName

String getDefaultProviderName()

Return default Preview URI service provider

Returns:

getProviderName

String getProviderName(String wpStoreId)

Return Preview URI service provider configured for web project

Returns: