Package org.duracloud.client.task

Interface S3TaskClient

All Known Implementing Classes:

S3TaskClientImpl

public interface S3TaskClient

Provides a client interface for S3StorageProvider's set of tasks.

Author:

Bill Branan Date: 3/6/15

Method Summary

Modifier and Type	Method	Description
DeleteStreamingTaskResult	deleteHlsStreaming(String spaceId)	Deletes a streaming distribution for a space.
DisableStreamingTaskResult	disableHlsStreaming(String spaceId)	Disables HLS streaming on a space.
EnableStreamingTaskResult	enableHlsStreaming(String spaceId, boolean secure)	Enables HLS streaming on a space.
GetUrlTaskResult	getHlsUrl(String spaceId, String contentId)	Returns a URL representing an HLS streamable resource.
GetSignedCookiesUrlTaskResult	getSignedCookiesUrl(String spaceId, String ipAddress, int minutesToExpire, String redirectUrl)	Generates signed cookies and provides a URL at which those cookies can be set on the user's browser

Method Detail

enableHlsStreaming

EnableStreamingTaskResult enableHlsStreaming(String spaceId,
                                             boolean secure)
                                      throws ContentStoreException

Enables HLS streaming on a space. Streaming can be either open or secure.

Parameters:

spaceId - the ID of the space where streaming will be enabled

secure - true if signed URLs should be required to stream space content

Returns:

resulting status and streaming host value

Throws:

ContentStoreException - on error

disableHlsStreaming

DisableStreamingTaskResult disableHlsStreaming(String spaceId)
                                        throws ContentStoreException

Disables HLS streaming on a space.

Parameters:

spaceId - the ID of the space where streaming will be disabled

Returns:

resulting status

Throws:

ContentStoreException - on erro

deleteHlsStreaming

DeleteStreamingTaskResult deleteHlsStreaming(String spaceId)
                                      throws ContentStoreException

Deletes a streaming distribution for a space. This ensures that content that was available for streaming will no longer be available.

Parameters:

spaceId - the ID of the space where streaming will be disabled

Returns:

resulting status

Throws:

ContentStoreException - on error

getHlsUrl

GetUrlTaskResult getHlsUrl(String spaceId,
                           String contentId)
                    throws ContentStoreException

Returns a URL representing an HLS streamable resource.

Parameters:

spaceId - the space ID that contains the content to be streamed

contentId - the content ID to be converted to a streaming URL

Returns:

Throws:

ContentStoreException

getSignedCookiesUrl

GetSignedCookiesUrlTaskResult getSignedCookiesUrl(String spaceId,
                                                  String ipAddress,
                                                  int minutesToExpire,
                                                  String redirectUrl)
                                           throws ContentStoreException

Generates signed cookies and provides a URL at which those cookies can be set on the user's browser

Parameters:

spaceId -

ipAddress -

minutesToExpire -

Returns:

Throws:

ContentStoreException