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 and Description
DeleteStreamingTaskResult	deleteHlsStreaming(String spaceId) Deletes a streaming distribution for a space.
DeleteStreamingTaskResult	deleteStreaming(String spaceId) Deletes a streaming distribution for a space.
DisableStreamingTaskResult	disableHlsStreaming(String spaceId) Disables HLS streaming on a space.
DisableStreamingTaskResult	disableStreaming(String spaceId) Disables streaming on a space.
EnableStreamingTaskResult	enableHlsStreaming(String spaceId, boolean secure) Enables HLS streaming on a space.
EnableStreamingTaskResult	enableStreaming(String spaceId, boolean secure) Enables 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
GetSignedUrlTaskResult	getSignedUrl(String spaceId, String contentId, String resourcePrefix) Retrieves a signed URL for a media file that is streamed through a secure distribution; uses default minutes to expire (480) and allows streaming to any IP address
GetSignedUrlTaskResult	getSignedUrl(String spaceId, String contentId, String resourcePrefix, int minutesToExpire, String ipAddress) Retrieves a signed URL for a media file that is streamed through a secure distribution
GetUrlTaskResult	getUrl(String spaceId, String contentId, String resourcePrefix) Retrieves a URL for a media file that is streamed via an open distribution

Method Detail

enableStreaming

EnableStreamingTaskResult enableStreaming(String spaceId,
                                          boolean secure)
                                   throws ContentStoreException

Enables 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

disableStreaming

DisableStreamingTaskResult disableStreaming(String spaceId)
                                     throws ContentStoreException

Disables streaming on a space.

Parameters:

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

Returns:

resulting status

Throws:

ContentStoreException - on erro

deleteStreaming

DeleteStreamingTaskResult deleteStreaming(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

getUrl

GetUrlTaskResult getUrl(String spaceId,
                        String contentId,
                        String resourcePrefix)
                 throws ContentStoreException

Retrieves a URL for a media file that is streamed via an open distribution

Parameters:

spaceId - name of the space where the content to be streamed is stored

contentId - name of the content item to be streamed

resourcePrefix - a prefix on the content item which may be required by the streaming viewer/player (may be null)

Returns:

RTMP streaming URL

Throws:

ContentStoreException - on error

getSignedUrl

GetSignedUrlTaskResult getSignedUrl(String spaceId,
                                    String contentId,
                                    String resourcePrefix)
                             throws ContentStoreException

Retrieves a signed URL for a media file that is streamed through a secure distribution; uses default minutes to expire (480) and allows streaming to any IP address

Parameters:

spaceId - name of the space where the content to be streamed is stored

contentId - name of the content item to be streamed

resourcePrefix - a prefix on the content item which may be required by the streaming viewer/player (may be null)

Returns:

RTMP streaming URL

Throws:

ContentStoreException - on error

getSignedUrl

GetSignedUrlTaskResult getSignedUrl(String spaceId,
                                    String contentId,
                                    String resourcePrefix,
                                    int minutesToExpire,
                                    String ipAddress)
                             throws ContentStoreException

Retrieves a signed URL for a media file that is streamed through a secure distribution

Parameters:

spaceId - name of the space where the content to be streamed is stored

contentId - name of the content item to be streamed

resourcePrefix - a prefix on the content item which may be required by the streaming viewer/player

minutesToExpire - number of minutes that the stream should be available for viewing through the retrieved URL

ipAddress - ip address range where requests to stream must originate, in CIDR notation (e.g. 1.2.3.4/32)

Returns:

RTMP streaming URL

Throws:

ContentStoreException - on error

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