com.messagebird

Interface MessageBirdService

All Known Implementing Classes:

MessageBirdServiceImpl

public interface MessageBirdService

Created by rvt on 1/7/15.

Method Summary

Modifier and Type	Method and Description
<R> R	delete(String request, Class<R> clazz) Send DELETE request.
void	deleteByID(String request, String id) Delete a object by ID.
String	getBinaryData(String request, String basePath, String fileName) Gets the data from the request URL and stores it to basePath/fileName
<R> R	request(String request, Class<R> clazz) Send GET request .
<R> R	requestByID(String request, String id, Class<R> clazz) Execute a object by ID request.
<R> R	requestByID(String request, String id, Map<String,Object> params, Class<R> clazz)
<E> List<E>	requestByIdAsList(String request, String id, Class<E> elementClass) Execute a object by ID request.
<R> R	requestList(String request, Integer offset, Integer limit, Class<R> clazz) Request a List 'of' object.
<R> R	requestList(String request, Map<String,Object> params, Integer offset, Integer limit, Class<R> clazz) Request a List 'of' object.
<R> R	requestList(String request, PagedPaging pagedPaging, Class<R> clazz) Request a List 'of' object.
<R,P> R	sendPayLoad(String request, P payload, Class<R> clazz) Send a payload with the POST method and receive a payload object.
<R,P> R	sendPayLoad(String method, String request, Map<String,String> headers, P payload, Class<R> clazz) Send a payload with the provided method and headers and receive a payload object.
<R,P> R	sendPayLoad(String method, String request, P payload, Class<R> clazz) Send a payload with the provided method and receive a payload object.

Method Detail

request

<R> R request(String request,
              Class<R> clazz)
       throws UnauthorizedException,
              GeneralException,
              NotFoundException

Send GET request . It will retrieve a json object R back.

Parameters:

request - path to the request, for example "/messages/id/language"

clazz - Class type to return

Returns:

new class with returned dataset

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException - if id not found

requestByID

<R> R requestByID(String request,
                  String id,
                  Class<R> clazz)
           throws UnauthorizedException,
                  GeneralException,
                  NotFoundException

Execute a object by ID request. It will add the id to the request parameter and retreive a json object R back.

Parameters:

request - path to the request, for example "/messages"

id - id of the object to request. id can be null in case request's that don't need a id, for example /balance

clazz - Class type to return

Returns:

new class with returned dataset

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException

requestByID

<R> R requestByID(String request,
                  String id,
                  Map<String,Object> params,
                  Class<R> clazz)
           throws UnauthorizedException,
                  GeneralException,
                  NotFoundException

Throws:

UnauthorizedException

GeneralException

NotFoundException

requestByIdAsList

<E> List<E> requestByIdAsList(String request,
                              String id,
                              Class<E> elementClass)
                       throws UnauthorizedException,
                              GeneralException,
                              NotFoundException

Execute a object by ID request. It will add the id to the request parameter and retrieve a list of an object E back.

Parameters:

request - path to the request, for example "/messages"

id - id of the object to request. id can be null in case request's that don't need a id, for example /balance

elementClass - Class type of List to return

Returns:

new list of elementClass

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException

deleteByID

void deleteByID(String request,
                String id)
         throws UnauthorizedException,
                GeneralException,
                NotFoundException

Delete a object by ID.

Parameters:

request - path to the request, for example "/messages"

id - id of the object to delete

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException - if id not found

delete

<R> R delete(String request,
             Class<R> clazz)
      throws UnauthorizedException,
             GeneralException,
             NotFoundException

Send DELETE request. It will retrieve a json object R back.

Parameters:

request - path to the request, for example "/messages/id/language"

clazz - Class type to return

Returns:

class with returned dataset

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException - if id not found

requestList

<R> R requestList(String request,
                  Integer offset,
                  Integer limit,
                  Class<R> clazz)
           throws UnauthorizedException,
                  GeneralException

Request a List 'of' object. Allow to request a listMessage or listViewMessages objects.

Parameters:

request - request from client

offset - offset of data to return

limit - limit number of objects, incase you notice you pass in '1' a lot, please consider using requestByID if you know the ID of the message

clazz - object type to return

Returns:

base class

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

See Also:

MessageList

requestList

<R> R requestList(String request,
                  Map<String,Object> params,
                  Integer offset,
                  Integer limit,
                  Class<R> clazz)
           throws UnauthorizedException,
                  GeneralException

Request a List 'of' object. Allow to request a listMessage or listViewMessages objects.

Parameters:

request - request from client

params - additional query params

offset - offset of data to return

limit - limit number of objects, incase you notice you pass in '1' a lot, please consider using requestByID if you know the ID of the message

clazz - object type to return

Returns:

base class

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

See Also:

MessageList

requestList

<R> R requestList(String request,
                  PagedPaging pagedPaging,
                  Class<R> clazz)
           throws UnauthorizedException,
                  GeneralException

Request a List 'of' object. Allow to request a listMessage or listViewMessages objects.

Parameters:

request - request from client

pagedPaging - includes page and page size

clazz - object type to return

Returns:

base class

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

See Also:

MessageList

sendPayLoad

<R,P> R sendPayLoad(String request,
                    P payload,
                    Class<R> clazz)
             throws UnauthorizedException,
                    GeneralException

Send a payload with the POST method and receive a payload object.

Parameters:

request - path to the request, for example "/messages"

payload - payload to send to the server

clazz - object type to return

Returns:

base class

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

sendPayLoad

<R,P> R sendPayLoad(String method,
                    String request,
                    P payload,
                    Class<R> clazz)
             throws UnauthorizedException,
                    GeneralException

Send a payload with the provided method and receive a payload object.

Parameters:

method - HTTP method to use for the request

request - path to the request, for example "/messages"

payload - payload to send to the server

clazz - object type to return

Returns:

base class

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

sendPayLoad

<R,P> R sendPayLoad(String method,
                    String request,
                    Map<String,String> headers,
                    P payload,
                    Class<R> clazz)
             throws UnauthorizedException,
                    GeneralException

Send a payload with the provided method and headers and receive a payload object.

Parameters:

method - HTTP method to use for the request

request - path to the request, for example "/messages"

headers - additional headers to set on the request

payload - payload to send to the server

clazz - object type to return

Returns:

base class

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

getBinaryData

String getBinaryData(String request,
                     String basePath,
                     String fileName)
              throws UnauthorizedException,
                     GeneralException,
                     NotFoundException

Gets the data from the request URL and stores it to basePath/fileName

Parameters:

request - path to the request, for example "/messages"

basePath - base path for storing directory

fileName - the fileName that is going to be stored.

Returns:

the path that file is stored

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException - if the file is not found