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
Fields Modifier and Type Field Description protected static intHeartbeatFrequencyDefault-
Fields inherited from class microsoft.exchange.webservices.data.core.request.HangingServiceRequestBase
BUFFER_SIZE, heartbeatFrequencyMilliseconds
-
-
Constructor Summary
Constructors Constructor Description GetStreamingEventsRequest(ExchangeService service, HangingServiceRequestBase.IHandleResponseObject serviceObjectHandler, Iterable<String> subscriptionIds, int connectionTimeout)Initializes a new instance of the GetStreamingEventsRequest class.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected HttpWebRequestbuildEwsHttpWebRequest()Builds the HttpWebRequest object for current service request with exception handling.protected ExchangeVersiongetMinimumRequiredServerVersion()Gets the request version.protected StringgetResponseXmlElementName()Gets the name of the response XML element.StringgetXmlElementName()Gets the name of the XML element.protected GetStreamingEventsResponseparseResponse(EwsServiceXmlReader reader)Parses the response.protected static voidsetHeartbeatFrequency(int heartbeatFrequency)region Test hooks Allow test code to change heartbeat valueprotected voidwriteElementsToXml(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
-
-
-
-
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 serviceserviceObjectHandler- The serviceObjectHandlersubscriptionIds- The subscriptionIdsconnectionTimeout- The connectionTimeout- Throws:
ServiceVersionException
-
-
Method Detail
-
getXmlElementName
public String getXmlElementName()
Gets the name of the XML element.- Specified by:
getXmlElementNamein classServiceRequestBase<GetStreamingEventsResponse>- Returns:
- XmlElementNames
-
getResponseXmlElementName
protected String getResponseXmlElementName()
Gets the name of the response XML element.- Specified by:
getResponseXmlElementNamein classServiceRequestBase<GetStreamingEventsResponse>- Returns:
- XmlElementNames
-
writeElementsToXml
protected void writeElementsToXml(EwsServiceXmlWriter writer) throws ServiceXmlSerializationException, XMLStreamException
Writes the elements to XML writer.- Specified by:
writeElementsToXmlin classServiceRequestBase<GetStreamingEventsResponse>- Parameters:
writer- the writer- Throws:
XMLStreamException- the XML stream exceptionServiceXmlSerializationException
-
getMinimumRequiredServerVersion
protected ExchangeVersion getMinimumRequiredServerVersion()
Gets the request version.- Specified by:
getMinimumRequiredServerVersionin classServiceRequestBase<GetStreamingEventsResponse>- Returns:
- ExchangeVersion
-
parseResponse
protected GetStreamingEventsResponse parseResponse(EwsServiceXmlReader reader) throws Exception
Parses the response.- Specified by:
parseResponsein classServiceRequestBase<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:ServiceRequestBaseBuilds the HttpWebRequest object for current service request with exception handling.- Overrides:
buildEwsHttpWebRequestin classServiceRequestBase<GetStreamingEventsResponse>- Returns:
- An HttpWebRequest instance
- Throws:
Exception- on error
-
-