com.edorasware.one.preview

Interface PreviewManager

All Known Implementing Classes:

DefaultPreviewManager

public interface PreviewManager

Exposes API for retrieving preview.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PreviewManager.ErrorMessage Error message class which is used to generate a proper error response.

Method Summary

Modifier and Type	Method and Description
void	evictCachedFile(String ambiguousId) Evicts cached file for the given work object ID.
String	getJsonErrorMessage(String messageKey, String cause) Utility method to get error message and cause in a json string.
void	getPreviewContent(String ambiguousId, boolean forceDownload, String acceptHeader, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get preview content of a work object.
void	getPreviewInfo(String ambiguousId, String acceptHeader, javax.servlet.http.HttpServletResponse response) Get preview information of a work object.

Method Detail

getPreviewInfo

void getPreviewInfo(String ambiguousId,
                    String acceptHeader,
                    javax.servlet.http.HttpServletResponse response)
             throws IOException

Get preview information of a work object.

Parameters:

ambiguousId - the ID of the work object (either work object ID value or global ID value)

acceptHeader - accept header

response - HttpServletResponse

Throws:

IOException - in case of error while retrieving preview info

getPreviewContent

void getPreviewContent(String ambiguousId,
                       boolean forceDownload,
                       String acceptHeader,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws IOException

Get preview content of a work object.

Parameters:

ambiguousId - the ID of the work object (either work object ID value or global ID value)

forceDownload - force download flag

acceptHeader - accept header

request - HttpServletRequest

response - HttpServletResponse

Throws:

IOException - in case of error while retrieving preview content

evictCachedFile

void evictCachedFile(String ambiguousId)

Evicts cached file for the given work object ID.

Parameters:

ambiguousId - the ID of the work object (either work object ID value or global ID value)

getJsonErrorMessage

String getJsonErrorMessage(String messageKey,
                           String cause)

Utility method to get error message and cause in a json string.

Parameters:

messageKey - error message key

cause - cause for the error

Returns:

json string