microsoft.hawaii.hawaiiClientLibraryBase

Class PostableServiceAgent<TRequest,TResult extends ServiceResult>

java.lang.Object

microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent<TResult>

microsoft.hawaii.hawaiiClientLibraryBase.PostableServiceAgent<TRequest,TResult>

Type Parameters:

TRequest - Generic request type

TResult - Generic service result type which inherits ServiceResult type

Direct Known Subclasses:

CreateAgent, DeleteByKeysAgent, GetByKeysAgent, SetAgent, SpeechRecognitionAgent

public abstract class PostableServiceAgent<TRequest,TResult extends ServiceResult>
extends ServiceAgent<TResult>

Base class for all Hawaii service agent classes which need to post data to Hawaii server

Field Summary

Fields

Modifier and Type	Field and Description
protected TRequest	request request object

Fields inherited from class microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent

clientIdentity, httpMethod, onCompleteListener, serviceResult, serviceResultClass, serviceUri

Constructor Summary

Constructors

Constructor and Description
PostableServiceAgent(TRequest request, java.lang.Class<TResult> resultClass, java.net.URI baseUri, ClientIdentity identity, HttpMethod httpMethod, java.lang.Object state) Initializes an instance of the PostableServiceAgent class

Method Summary

Methods

Modifier and Type	Method and Description
protected byte[]	getRequestBodyData() Gets the byte array for HTTP request body.

Methods inherited from class microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent

constructHttpRequest, getContentType, getServiceResult, handleException, handleException, OnCompleteRequest, parseOutput, parseServiceResultRequired, processRequest, setServiceResult

Methods inherited from class java.lang.Object

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

Field Detail

request

protected TRequest request

request object

Constructor Detail

PostableServiceAgent

public PostableServiceAgent(TRequest request,
                    java.lang.Class<TResult> resultClass,
                    java.net.URI baseUri,
                    ClientIdentity identity,
                    HttpMethod httpMethod,
                    java.lang.Object state)
                     throws java.lang.Exception

Initializes an instance of the PostableServiceAgent class

Parameters:

request - request object

resultClass - The class object for the generic service result type

baseUri - base URI object

identity - client identity

httpMethod - http method enum

state - user defined state

Throws:

java.lang.Exception

Method Detail

getRequestBodyData

protected byte[] getRequestBodyData()
                             throws HawaiiException

Description copied from class: ServiceAgent

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

Overrides:

getRequestBodyData in class ServiceAgent<TResult extends ServiceResult>

Returns:

Throws:

HawaiiException - byte[]