org.apache.camel.component.soroushbot.service

Class SoroushService

java.lang.Object

org.apache.camel.component.soroushbot.service.SoroushService

public final class SoroushService
extends Object

singleton class that allows interacting with the Soroush server to exchange messages.

Method Summary

Modifier and Type	Method and Description
<T> T	assertSuccessful(javax.ws.rs.core.Response response, Class<T> responseType, SoroushMessage soroushMessage) throw IOException if the exception is instance of SoroushException it indicates that the soroush does not accept the message and therefore resending the request will never be succeed
SoroushResponse	assertSuccessful(javax.ws.rs.core.Response response, SoroushMessage soroushMessage) check if the response is successfully sent to soroush, by default it assumes that the response type is SoroushResponse
javax.ws.rs.client.WebTarget	createDownloadFileTarget(String token, String fileId, Integer timeOut) create WebTarget for downloading file from server
javax.ws.rs.client.WebTarget	createSendMessageTarget(String token, Integer timeOut) create WebTarget for sending message to server
javax.ws.rs.client.WebTarget	createUploadFileTarget(String token, Integer timeOut) create WebTarget for uploading file to server
String	generateUrl(String token, SoroushAction type, String fileId) create fully qualified URL, given the token, endpoint and fileId if needed.
static SoroushService	get()
void	setAlternativeUrl(String alternativeUrl) set alternativeUrl that should be used for testing

Methods inherited from class java.lang.Object

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

Method Detail

get

public static SoroushService get()

Returns:

soroush server instance.

generateUrl

public String generateUrl(String token,
                          SoroushAction type,
                          String fileId)

create fully qualified URL, given the token, endpoint and fileId if needed.

Parameters:

token -

type -

fileId -

Returns:

createUploadFileTarget

public javax.ws.rs.client.WebTarget createUploadFileTarget(String token,
                                                           Integer timeOut)

create WebTarget for uploading file to server

Parameters:

token -

timeOut -

Returns:

createSendMessageTarget

public javax.ws.rs.client.WebTarget createSendMessageTarget(String token,
                                                            Integer timeOut)

create WebTarget for sending message to server

Parameters:

token -

timeOut -

Returns:

createDownloadFileTarget

public javax.ws.rs.client.WebTarget createDownloadFileTarget(String token,
                                                             String fileId,
                                                             Integer timeOut)

create WebTarget for downloading file from server

Parameters:

token -

fileId -

timeOut -

Returns:

assertSuccessful

public SoroushResponse assertSuccessful(javax.ws.rs.core.Response response,
                                        SoroushMessage soroushMessage)
                                 throws IOException,
                                        SoroushException

check if the response is successfully sent to soroush, by default it assumes that the response type is SoroushResponse

Parameters:

response - the response

soroushMessage - the message that we are checking its success, only for logging purpose

Returns:

SoroushResponse

Throws:

IOException - if can not connect to soroush server

SoroushException - if soroush reject the response

assertSuccessful

public <T> T assertSuccessful(javax.ws.rs.core.Response response,
                              Class<T> responseType,
                              SoroushMessage soroushMessage)
                       throws IOException,
                              SoroushException

throw IOException if the exception is instance of SoroushException it indicates that the soroush does not accept the message and therefore resending the request will never be succeed

Type Parameters:

T - the class that we expect the response should be of this type

Parameters:

response - the response

responseType - expecting response type from soroush

soroushMessage - the message that we are checking its success, only for logging purpose

Throws:

IOException - if sending message to soroush server is not successful

SoroushException - if soroush reject the response with an error code

setAlternativeUrl

public void setAlternativeUrl(String alternativeUrl)

set alternativeUrl that should be used for testing

Parameters:

alternativeUrl -