org.openestate.is24.restapi

Class ImportExport.VideoUploadService

java.lang.Object

org.openestate.is24.restapi.ImportExport.VideoUploadService

Enclosing class:

ImportExport

public static final class ImportExport.VideoUploadService
extends Object

Low level methods for the VideoUploadTicket Webservice.

The VideoUploadTicket Webservice is used in the Import-/Export-API to obtain a ticket to upload a video and to transfer the video itself.

Since:

0.1

Author:

Andreas Rudolph

See Also:

description for video uploads, Import-/Export-API

Method Summary

Methods

Modifier and Type	Method and Description
static String	doVideoUpload(AbstractClient client, InputStream videoInput, String videoFileName, long videoFileSize) Upload a video.
static VideoUploadTicket	get(AbstractClient client) Calls the GET method of the VideoUploadTicket Webservice.

Methods inherited from class java.lang.Object

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

Method Detail

doVideoUpload

public static String doVideoUpload(AbstractClient client,
                   InputStream videoInput,
                   String videoFileName,
                   long videoFileSize)
                            throws IOException,
                                   oauth.signpost.exception.OAuthException,
                                   JAXBException,
                                   RequestFailedException

Upload a video.

This helper method obtains an upload ticket and sends the video file to the destination, that is specified in the upload ticket.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

videoInput - content of the video file to transfer

videoFileName - name of the video file to transfer

videoFileSize - size of the video file to transfer (in bytes)

Returns:

ID of the ticket, that was used to upload the video file

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

description for video uploads

get

public static VideoUploadTicket get(AbstractClient client)
                             throws IOException,
                                    oauth.signpost.exception.OAuthException,
                                    JAXBException,
                                    RequestFailedException

Calls the GET method of the VideoUploadTicket Webservice.

This method retrieves a ticket from the Webservice, that is required to upload a new video file.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

Returns:

created ticket for the video upload

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

description for video uploads