com.qencode.api.java.client

Class QencodeApiClient

java.lang.Object

com.qencode.api.java.client.QencodeApiClient

public class QencodeApiClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_URL

Constructor Summary

Constructors

Constructor and Description
QencodeApiClient(String api_key) Constructs a new QencodeApiClient.
QencodeApiClient(String api_key, String url)

Method Summary

Modifier and Type	Method and Description
TranscodingTask	CreateTask() Creates new transcoding task
String	getAccessToken()
String	getApiKey() gets Qencode Project API Key for this client instance
String	getApiUrl() gets API endpoint url
String	getLastResponseRaw() returns Last Response in raw string (JSON)
org.codehaus.jackson.map.ObjectMapper	getMapper()
org.springframework.web.client.RestTemplate	getRestTemplate()
String	Request(String path, Map<String,String> parameters) Performs request to a specified API method
String	Request(String path, String parameters) Performs request to a specified API method
void	setApiKey(String api_key) sets Qencode Project API Key for this client instance
void	setApiUrl(String api_url) sets API endpoint url
void	setRestTemplate(org.springframework.web.client.RestTemplate rt)

Methods inherited from class java.lang.Object

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

Field Detail

API_URL

public static final String API_URL

See Also:

Constant Field Values

Constructor Detail

QencodeApiClient

public QencodeApiClient(String api_key)
                 throws UnsupportedEncodingException,
                        QencodeException

Constructs a new QencodeApiClient.

Parameters:

api_key - Qencode Project API Key

Throws:

QencodeException - if there's an error communicating Qencode API or API Key is not valid

UnsupportedEncodingException

QencodeApiClient

public QencodeApiClient(String api_key,
                        String url)
                 throws UnsupportedEncodingException,
                        QencodeException

Throws:

UnsupportedEncodingException

QencodeException

Method Detail

getAccessToken

public String getAccessToken()

getMapper

public org.codehaus.jackson.map.ObjectMapper getMapper()

getApiKey

public String getApiKey()

gets Qencode Project API Key for this client instance

setApiKey

public void setApiKey(String api_key)

sets Qencode Project API Key for this client instance

getApiUrl

public String getApiUrl()

gets API endpoint url

setApiUrl

public void setApiUrl(String api_url)

sets API endpoint url

getRestTemplate

public org.springframework.web.client.RestTemplate getRestTemplate()

setRestTemplate

public void setRestTemplate(org.springframework.web.client.RestTemplate rt)

getLastResponseRaw

public String getLastResponseRaw()

returns Last Response in raw string (JSON)

Request

public String Request(String path,
                      Map<String,String> parameters)
               throws QencodeException,
                      UnsupportedEncodingException

Performs request to a specified API method

Parameters:

path - API method path, e.g. "create_task"

parameters - key-value pairs specifying method params

Returns:

Method Response Raw JSON string

Throws:

QencodeException - if there's an error communicating Qencode API or some params not valid

UnsupportedEncodingException

Request

public String Request(String path,
                      String parameters)
               throws QencodeException

Performs request to a specified API method

Parameters:

path - API method path, e.g. "create_task"

parameters - an URL-encoded params string, e.g. param1=value1¶m2=value2...

Returns:

Method Response Raw JSON string

Throws:

QencodeException - if there's an error communicating Qencode API or some params not valid

CreateTask

public TranscodingTask CreateTask()
                           throws UnsupportedEncodingException,
                                  QencodeException

Creates new transcoding task

Returns:

TranscodingTask object

Throws:

UnsupportedEncodingException

QencodeException - if there's an error communicating Qencode API or access token not valid