microsoft.exchange.webservices.data.core.request
Class GetStreamingEventsRequest

java.lang.Object
  microsoft.exchange.webservices.data.core.request.ServiceRequestBase<T>
      microsoft.exchange.webservices.data.core.request.HangingServiceRequestBase<GetStreamingEventsResponse>
          microsoft.exchange.webservices.data.core.request.GetStreamingEventsRequest

public class GetStreamingEventsRequest
extends HangingServiceRequestBase<GetStreamingEventsResponse>

Defines the GetStreamingEventsRequest class.

Nested Class Summary

Nested classes/interfaces inherited from class microsoft.exchange.webservices.data.core.request.HangingServiceRequestBase

HangingServiceRequestBase.IHandleResponseObject, HangingServiceRequestBase.IHangingRequestDisconnectHandler

Field Summary

protected static int

HeartbeatFrequencyDefault

Fields inherited from class microsoft.exchange.webservices.data.core.request.HangingServiceRequestBase

BUFFER_SIZE, heartbeatFrequencyMilliseconds

Constructor Summary

GetStreamingEventsRequest(ExchangeService service, HangingServiceRequestBase.IHandleResponseObject serviceObjectHandler, Iterable<String> subscriptionIds, int connectionTimeout)
Initializes a new instance of the GetStreamingEventsRequest class.

Method Summary

protected HttpWebRequest	buildEwsHttpWebRequest() Builds the HttpWebRequest object for current service request with exception handling.
protected ExchangeVersion	getMinimumRequiredServerVersion() Gets the request version.
protected String	getResponseXmlElementName() Gets the name of the response XML element.
String	getXmlElementName() Gets the name of the XML element.
protected GetStreamingEventsResponse	parseResponse(EwsServiceXmlReader reader) Parses the response.
protected static void	setHeartbeatFrequency(int heartbeatFrequency) region Test hooks Allow test code to change heartbeat value
protected void	writeElementsToXml(EwsServiceXmlWriter writer) Writes the elements to XML writer.

Methods inherited from class microsoft.exchange.webservices.data.core.request.HangingServiceRequestBase

addOnDisconnectEvent, clearDisconnectEvents, disconnect, disconnect, internalExecute, isConnected, isLogAllWireBytes, readPreamble, removeDisconnectEvent, setLogAllWireBytes

Methods inherited from class microsoft.exchange.webservices.data.core.request.ServiceRequestBase

buildEwsHttpPoolingWebRequest, getEwsHttpWebResponse, getResponseStream, getService, processWebException, readResponse, readResponse, readSoapFault, throwIfNotSupportedByRequestedServerVersion, traceResponse, validate, validateAndEmitRequest, writeAttributesToXml, writeBodyToXml, writeToXml

Methods inherited from class java.lang.Object

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

Field Detail

HeartbeatFrequencyDefault

protected static final int HeartbeatFrequencyDefault

See Also:

Constant Field Values

Constructor Detail

GetStreamingEventsRequest

public GetStreamingEventsRequest(ExchangeService service,
                                 HangingServiceRequestBase.IHandleResponseObject serviceObjectHandler,
                                 Iterable<String> subscriptionIds,
                                 int connectionTimeout)
                          throws ServiceVersionException

Initializes a new instance of the GetStreamingEventsRequest class.

Parameters:

service - The service

serviceObjectHandler - The serviceObjectHandler

subscriptionIds - The subscriptionIds

connectionTimeout - The connectionTimeout

Throws:

ServiceVersionException

Method Detail

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<GetStreamingEventsResponse>

Returns:

XmlElementNames

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<GetStreamingEventsResponse>

Returns:

XmlElementNames

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws ServiceXmlSerializationException,
                                  XMLStreamException

Writes the elements to XML writer.

Specified by:

writeElementsToXml in class ServiceRequestBase<GetStreamingEventsResponse>

Parameters:

writer - the writer

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<GetStreamingEventsResponse>

Returns:

ExchangeVersion

parseResponse

protected GetStreamingEventsResponse parseResponse(EwsServiceXmlReader reader)
                                            throws Exception

Parses the response.

Specified by:

parseResponse in class ServiceRequestBase<GetStreamingEventsResponse>

Parameters:

reader - The reader.

Returns:

the Response Object.

Throws:

Exception - the exception

setHeartbeatFrequency

protected static void setHeartbeatFrequency(int heartbeatFrequency)

region Test hooks Allow test code to change heartbeat value

buildEwsHttpWebRequest

protected HttpWebRequest buildEwsHttpWebRequest()
                                         throws Exception

Description copied from class: ServiceRequestBase

Builds the HttpWebRequest object for current service request with exception handling.

Overrides:

buildEwsHttpWebRequest in class ServiceRequestBase<GetStreamingEventsResponse>

Returns:

An HttpWebRequest instance

Throws:

Exception - on error