org.alfresco.wcm.preview

Interface PreviewURIServiceProvider

All Known Implementing Classes:

AbstractPreviewURIServiceProvider, NullPreviewURIService, URITemplatePreviewURIService, VirtualisationServerPreviewURIService

public interface PreviewURIServiceProvider

SPI (Service Provider Interface) abstraction for generating preview URLs.

Since:

3.2

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getPreviewURI(java.lang.String sbStoreId, java.lang.String pathToAsset, PreviewContext previewContext)
java.util.List	getPreviewURIs(java.lang.String sbStoreId, java.util.List pathsToAssets, PreviewContext previewContext)

Method Detail

getPreviewURI

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

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).

previewContext - Additional preview context

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,
                            PreviewContext previewContext)

Parameters:

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

pathsToAssets - The paths to the assets to generate the preview URI for.

previewContext - Additional preview context

Returns:

The Preview URIs for the given asset paths (may be null).