microsoft.hawaii.hawaiiClientLibraryBase

Class ServiceAgent<T extends ServiceResult>

java.lang.Object

microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent<T>

Type Parameters:

T - Generic service result type which inherits ServiceResult type

Direct Known Subclasses:

AssociateIdAgent, CreateEndPointAgent, CreateGroupAgent, DeleteAgent, DeleteEndPointAgent, DeleteGroupAgent, DisassociateIdAgent, GetAgent, GetByKeyAgent, GetLanguagesForSpeakAgent, GetLanguagesForTranslateAgent, JoinGroupAgent, LeaveGroupAgent, LookupNameAgent, OcrAgent, PostableServiceAgent, PredictLocationAgent, ReceiveMessagesAgent, RegisterNameAgent, SendMessageAgent, SpeakAgent, SpeechGrammarsAgent, TranslateAgent, UnregisterNameAgent

public abstract class ServiceAgent<T extends ServiceResult>
extends java.lang.Object

Base class for all Hawaii service agent classes. These agents are wrapping the communication tasks specific to each service. ServiceAgent provides functionality common to all these clases.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientIdentity	clientIdentity client identity object for authentication
protected HttpMethod	httpMethod HttpMethod enum
protected OnCompleteListener<T>	onCompleteListener completion callback for service operation
protected T	serviceResult service result
protected java.lang.Class<T>	serviceResultClass class object of service result
protected java.net.URI	serviceUri service uri

Constructor Summary

Constructors

Constructor and Description
ServiceAgent(java.lang.Class<T> objClass) Initializes an instance of the ServiceAgent class
ServiceAgent(java.lang.Class<T> objClass, HttpMethod httpMethod, java.lang.Object state) Initializes an instance of the ServiceAgent class

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpRequestBase	constructHttpRequest(java.lang.String token) construct http request object
java.lang.String	getContentType() Gets the required content type used by Content-Type HTTP header.
protected byte[]	getRequestBodyData() Gets the byte array for HTTP request body.
T	getServiceResult() Gets service result
protected void	handleException(java.lang.Exception ex) handle unexpected exception
protected void	handleException(java.lang.String errorMessage, java.lang.Throwable cause) handle specified exception message and Throwable object
protected void	OnCompleteRequest() A method can be overridden by sub classes.
protected void	parseOutput(java.io.InputStream inputStream) Parses the response from server.
protected boolean	parseServiceResultRequired() gets the flag to indicate whether service result are required to be parsed.
void	processRequest(OnCompleteListener<T> callback) Send HTTP request and process response
protected void	setServiceResult(T result) Sets the service result object

Methods inherited from class java.lang.Object

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

Field Detail

httpMethod

protected HttpMethod httpMethod

HttpMethod enum

serviceResult

protected T extends ServiceResult serviceResult

service result

serviceResultClass

protected java.lang.Class<T extends ServiceResult> serviceResultClass

class object of service result

serviceUri

protected java.net.URI serviceUri

service uri

clientIdentity

protected ClientIdentity clientIdentity

client identity object for authentication

onCompleteListener

protected OnCompleteListener<T extends ServiceResult> onCompleteListener

completion callback for service operation

Constructor Detail

ServiceAgent

public ServiceAgent(java.lang.Class<T> objClass)
             throws java.lang.Exception

Initializes an instance of the ServiceAgent class

Parameters:

objClass - The class object for the generic type

Throws:

java.lang.Exception

ServiceAgent

public ServiceAgent(java.lang.Class<T> objClass,
            HttpMethod httpMethod,
            java.lang.Object state)
             throws java.lang.Exception

Initializes an instance of the ServiceAgent class

Parameters:

objClass - The class object for the generic service result type

httpMethod - HttpMethod enum

state - user state object

Throws:

java.lang.Exception

Method Detail

getServiceResult

public T getServiceResult()

Gets service result

Returns:

T

setServiceResult

protected void setServiceResult(T result)

Sets the service result object

Parameters:

result - void

getContentType

public java.lang.String getContentType()

Gets the required content type used by Content-Type HTTP header. This method can be overridden by sub classes to use different content type header

Returns:

String content type

parseServiceResultRequired

protected boolean parseServiceResultRequired()

gets the flag to indicate whether service result are required to be parsed. This method can be overridden by sub classes to change to not required

Returns:

boolean

getRequestBodyData

protected byte[] getRequestBodyData()
                             throws HawaiiException

Gets the byte array for HTTP request body. This method can be overridden by sub classes to generate their specific request body if necessary

Returns:

Throws:

HawaiiException - byte[]

parseOutput

protected void parseOutput(java.io.InputStream inputStream)

Parses the response from server. This method must be overridden by sub classes to do their own processing logic

Parameters:

inputStream -

Throws:

HawaiiException - void

processRequest

public void processRequest(OnCompleteListener<T> callback)

Send HTTP request and process response

Parameters:

callback - callback method after response has been processed

constructHttpRequest

protected org.apache.http.client.methods.HttpRequestBase constructHttpRequest(java.lang.String token)
                                                                       throws HawaiiException

construct http request object

Parameters:

token - access token

Returns:

Throws:

HawaiiException - HttpRequestBase

handleException

protected void handleException(java.lang.String errorMessage,
                   java.lang.Throwable cause)

handle specified exception message and Throwable object

Parameters:

errorMessage - specified error message

cause - inner Throwable object

handleException

protected void handleException(java.lang.Exception ex)

handle unexpected exception

Parameters:

ex - unexpected exception

OnCompleteRequest

protected void OnCompleteRequest()

A method can be overridden by sub classes. It is invoked after completing the service request. The implementation of this base class will invoke the client's "on complete" callback method. Classes that inherit from ServiceAgent can overwrite this method to further process the service call result before calling the client's "on complete" callback method. OnCompleteRequest void