com.gfycat.core.creation

Class DefaultUploadManager

java.lang.Object

com.gfycat.core.creation.DefaultUploadManager

All Implemented Interfaces:

UploadManager

public class DefaultUploadManager
extends java.lang.Object
implements UploadManager

Created by dekalo on 23.03.17.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultUploadManager.GetGfycatByName

Nested classes/interfaces inherited from interface com.gfycat.core.creation.UploadManager

UploadManager.CanNotCreateKeyException, UploadManager.CanNotGetGfycatStatusException, UploadManager.CanNotUploadGfycatException, UploadManager.CreationTimeoutException, UploadManager.FailedToCreateGfycatException, UploadManager.GfycatWasDeletedBeforeCompletionException, UploadManager.InternalCreationException

Field Summary

Fields inherited from interface com.gfycat.core.creation.UploadManager

DEFAULT_SERVER_PROCESSING_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
DefaultUploadManager(CreationAPI creationAPI, OkHttpClient uploadClient, java.lang.String fileUploadEndpoint, DefaultUploadManager.GetGfycatByName getGfycatByName)
DefaultUploadManager(CreationAPI creationAPI, OkHttpClient uploadClient, java.lang.String fileUploadEndpoint, DefaultUploadManager.GetGfycatByName getGfycatByName, long expected, long initial, long ping)

Method Summary

Modifier and Type	Method and Description
Gfycat	createGfycat(CreateGfycatRequest creationParams, java.io.InputStream inputStream) Encapsulates all three steps of creation flow.
Gfycat	createGfycat(CreateGfycatRequest creationParams, java.io.InputStream inputStream, UploadListener listener) Same as UploadManager.createGfycat(CreateGfycatRequest, InputStream) but with progress reporting.
Gfycat	getGfycatIfReady(java.lang.String gfyName)
boolean	isGfycatReady(java.lang.String gfyName)
java.lang.String	requestCreationKey(CreateGfycatRequest creationParams) Creation key request.
void	upload(java.lang.String creationKey, java.io.InputStream inputStream) Upload video file with creation key provided by UploadManager.requestCreationKey(CreateGfycatRequest).
void	upload(java.lang.String creationKey, java.io.InputStream inputStream, UploadListener listener) Same as UploadManager.upload(String, InputStream) but with progress reporting.
Gfycat	waitUntilReady(java.lang.String creationKey) Same as UploadManager.waitUntilReady(String) but with UploadManager.DEFAULT_SERVER_PROCESSING_TIMEOUT
Gfycat	waitUntilReady(java.lang.String creationKey, long timeout) Synchronously wait for server processing result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultUploadManager

public DefaultUploadManager(CreationAPI creationAPI,
                            OkHttpClient uploadClient,
                            java.lang.String fileUploadEndpoint,
                            DefaultUploadManager.GetGfycatByName getGfycatByName)

DefaultUploadManager

public DefaultUploadManager(CreationAPI creationAPI,
                            OkHttpClient uploadClient,
                            java.lang.String fileUploadEndpoint,
                            DefaultUploadManager.GetGfycatByName getGfycatByName,
                            long expected,
                            long initial,
                            long ping)

Method Detail

requestCreationKey

public java.lang.String requestCreationKey(CreateGfycatRequest creationParams)
                                    throws UploadManager.CanNotCreateKeyException

Description copied from interface: UploadManager

Creation key request. This is the first creation flow step.

Call UploadManager.upload(String, InputStream) method next, by providing returned key.

Specified by:

requestCreationKey in interface UploadManager

Parameters:

creationParams - creation parameters.

Returns:

Returns a unique creation key. Needed for upload and processing status check.

Throws:

UploadManager.CanNotCreateKeyException - in case of request failure.

upload

public void upload(java.lang.String creationKey,
                   java.io.InputStream inputStream)
            throws UploadManager.CanNotUploadGfycatException

Description copied from interface: UploadManager

Upload video file with creation key provided by UploadManager.requestCreationKey(CreateGfycatRequest). This is a second creation flow step.

Specified by:

upload in interface UploadManager

Parameters:

creationKey - unique key for this upload.

inputStream - gfycat content from stream.

Throws:

UploadManager.CanNotUploadGfycatException - thrown error happens during uploading.

upload

public void upload(java.lang.String creationKey,
                   java.io.InputStream inputStream,
                   UploadListener listener)
            throws UploadManager.CanNotUploadGfycatException

Description copied from interface: UploadManager

Same as UploadManager.upload(String, InputStream) but with progress reporting.

Specified by:

upload in interface UploadManager

Throws:

UploadManager.CanNotUploadGfycatException

waitUntilReady

public Gfycat waitUntilReady(java.lang.String creationKey)
                      throws UploadManager.CanNotGetGfycatStatusException,
                             UploadManager.FailedToCreateGfycatException,
                             UploadManager.GfycatWasDeletedBeforeCompletionException

Description copied from interface: UploadManager

Same as UploadManager.waitUntilReady(String) but with UploadManager.DEFAULT_SERVER_PROCESSING_TIMEOUT

Specified by:

waitUntilReady in interface UploadManager

Throws:

UploadManager.CanNotGetGfycatStatusException

UploadManager.FailedToCreateGfycatException

UploadManager.GfycatWasDeletedBeforeCompletionException

waitUntilReady

public Gfycat waitUntilReady(java.lang.String creationKey,
                             long timeout)
                      throws UploadManager.CanNotGetGfycatStatusException,
                             UploadManager.FailedToCreateGfycatException,
                             UploadManager.GfycatWasDeletedBeforeCompletionException

Description copied from interface: UploadManager

Synchronously wait for server processing result. This is the third creation flow step.

Gfycat will be returned once it becomes available on server.

Specified by:

waitUntilReady in interface UploadManager

Parameters:

creationKey - unique key for this upload provided by UploadManager.requestCreationKey(CreateGfycatRequest)

timeout - wait timeout.

Returns:

Returns Gfycat available on server.

Throws:

UploadManager.CanNotGetGfycatStatusException - if Gfycat was not returned by server within a specified timeout.

UploadManager.FailedToCreateGfycatException

UploadManager.GfycatWasDeletedBeforeCompletionException

createGfycat

public Gfycat createGfycat(CreateGfycatRequest creationParams,
                           java.io.InputStream inputStream)
                    throws UploadManager.CanNotCreateKeyException,
                           UploadManager.CanNotGetGfycatStatusException,
                           UploadManager.CanNotUploadGfycatException,
                           UploadManager.FailedToCreateGfycatException,
                           UploadManager.GfycatWasDeletedBeforeCompletionException

Description copied from interface: UploadManager

Encapsulates all three steps of creation flow. Calls the following methods in the corresponding order: UploadManager.requestCreationKey(CreateGfycatRequest), UploadManager.upload(String, InputStream), UploadManager.waitUntilReady(String)

Specified by:

createGfycat in interface UploadManager

Parameters:

creationParams - creation parameters.

inputStream - gfycat content from stream.

Returns:

Returns Gfycat available on server.

Throws:

UploadManager.CanNotGetGfycatStatusException - if Gfycat was not returned by server within a default UploadManager.DEFAULT_SERVER_PROCESSING_TIMEOUT timeout.

UploadManager.CanNotCreateKeyException

UploadManager.CanNotUploadGfycatException

UploadManager.FailedToCreateGfycatException

UploadManager.GfycatWasDeletedBeforeCompletionException

createGfycat

public Gfycat createGfycat(CreateGfycatRequest creationParams,
                           java.io.InputStream inputStream,
                           UploadListener listener)
                    throws UploadManager.CanNotCreateKeyException,
                           UploadManager.CanNotGetGfycatStatusException,
                           UploadManager.CanNotUploadGfycatException,
                           UploadManager.FailedToCreateGfycatException,
                           UploadManager.GfycatWasDeletedBeforeCompletionException

Description copied from interface: UploadManager

Same as UploadManager.createGfycat(CreateGfycatRequest, InputStream) but with progress reporting.

Specified by:

createGfycat in interface UploadManager

Throws:

UploadManager.CanNotCreateKeyException

UploadManager.CanNotGetGfycatStatusException

UploadManager.CanNotUploadGfycatException

UploadManager.FailedToCreateGfycatException

UploadManager.GfycatWasDeletedBeforeCompletionException

getGfycatIfReady

public Gfycat getGfycatIfReady(java.lang.String gfyName)

Specified by:

getGfycatIfReady in interface UploadManager

Parameters:

gfyName - of uploaded gfycat

Returns:

Returns Gfycat if it exists, null otherwise.

isGfycatReady

public boolean isGfycatReady(java.lang.String gfyName)

Specified by:

isGfycatReady in interface UploadManager

Parameters:

gfyName - of uploaded gfycat.

Returns:

Returns true if Gfycat is available, false otherwise. Tip: use FeedManager.getGfycat(String) to get it if true returned.