fr.zebasto.dailymotion.sdk.client.DailymotionClient Maven / Gradle / Ivy

Go to download
package fr.zebasto.dailymotion.sdk.client;


import fr.zebasto.dailymotion.sdk.api.communication.ApiError;
import fr.zebasto.dailymotion.sdk.api.communication.ApiResponse;
import fr.zebasto.dailymotion.sdk.api.Connection;
import fr.zebasto.dailymotion.sdk.api.Endpoint;

import java.util.List;
import java.util.Map;

/**
 * Implementation of DailyMotion Client
 * Handles the following URL patterns :
 * 
 * /endpoints
 * /endpoint/{id}
 * /me/endpoint
 * 
 * And the following connection patterns :
 * 
 * /endpoint/{id}/connection
 * /endpoint/{id}/connection/{subId}
 * 
 * And also takes some optional parameters given in a map
 * Support the HTTP Methods :
 * 
 * GET
 * POST
 * PUT
 * 
 *
 * @see http://www.dailymotion.com/doc/api/graph-api.html
 */
public interface DailymotionClient {

    /**
     * Performs a GET HTTP request on Dailymotion API
     *
     * @param endPoint The endpoint to call
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doGet(Endpoint endPoint) throws ApiError;

    /**
     * Performs a GET HTTP request on Dailymotion API
     *
     * @param endPoint The endpoint to call
     * @param params   The list of parameters given for the request
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doGet(Endpoint endPoint, Map> params) throws ApiError;

    /**
     * Performs a GET HTTP request on Dailymotion API
     *
     * @param endPoint The endpoint to call
     * @param id       The id that will be used to filter the request on the endpoint
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doGet(Endpoint endPoint, String id) throws ApiError;

    /**
     * Performs a GET HTTP request on Dailymotion API
     *
     * @param endPoint The endpoint to call
     * @param id       The id that will be used to filter the request on the endpoint
     * @param params   The list of parameters given for the request
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doGet(Endpoint endPoint, String id, Map> params) throws ApiError;

    /**
     * Performs a GET HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @return The response containing the list of T elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doGet(Connection connection, String id) throws ApiError;

    /**
     * Performs a GET HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @param params     The list of parameters given for the request
     * @return The response containing the list of T elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doGet(Connection connection, String id, Map> params) throws ApiError;

    /**
     * Performs a GET HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @param subId      The id that will be used to filter the request on the connection
     * @return The response containing the list of T elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doGet(Connection connection, String id, String subId) throws ApiError;

    /**
     * Performs a GET HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @param subId      The id that will be used to filter the request on the connection
     * @param params     The list of parameters given for the request
     * @return The response containing the list of T elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doGet(Connection connection, String id, String subId, Map> params) throws ApiError;

    /**
     * Performs a POST HTTP request on Dailymotion API
     *
     * @param endPoint The endpoint to call
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doPost(Endpoint endPoint) throws ApiError;

    /**
     * Performs a POST HTTP request on Dailymotion API
     *
     * @param endPoint The endpoint to call
     * @param params   The list of parameters given for the request
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doPost(Endpoint endPoint, Map> params) throws ApiError;

    /**
     * Performs a POST HTTP request on Dailymotion API
     *
     * @param endPoint The endpoint to call
     * @param id       The id that will be used to filter the request on the endpoint
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doPost(Endpoint endPoint, String id) throws ApiError;

    /**
     * Performs a POST HTTP request on Dailymotion API
     *
     * @param endPoint The endpoint to call
     * @param id       The id that will be used to filter the request on the endpoint
     * @param params   The list of parameters given for the request
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doPost(Endpoint endPoint, String id, Map> params) throws ApiError;

    /**
     * Performs a POST HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doPost(Connection connection, String id) throws ApiError;

    /**
     * Performs a POST HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @param params     The list of parameters given for the request
     * @return The response containing the list of T elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doPost(Connection connection, String id, Map> params) throws ApiError;

    /**
     * Performs a POST HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @param subId      The id that will be used to filter the request on the connection
     * @return The response containing the list of T elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doPost(Connection connection, String id, String subId) throws ApiError;

    /**
     * Performs a POST HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @param subId      The id that will be used to filter the request on the connection
     * @param params     The list of parameters given for the request
     * @return The response containing the list of T elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doPost(Connection connection, String id, String subId, Map> params) throws ApiError;

    /**
     * Performs a DELETE HTTP request on Dailymotion API
     *
     * @param endPoint The endpoint to call
     * @param id       The id that will be used to filter the request on the endpoint
     * @return The response containing the list of E elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doDelete(Endpoint endPoint, String id) throws ApiError;

    /**
     * Performs a DELETE HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @return The response containing the list of T elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doDelete(Connection connection, String id) throws ApiError;

    /**
     * Performs a DELETE HTTP request on Dailymotion API
     *
     * @param connection The connection to call
     * @param id         The id that will be used to filter the request on the endpoint
     * @param subId      The id that will be used to filter the request on the connection
     * @return The response containing the list of T elements
     * @throws ApiError The error returned by the WebService
     */
    ApiResponse doDelete(Connection connection, String id, String subId) throws ApiError;
}