microsoft.exchange.webservices.data.GetStreamingEventsResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of exchange-ws-api Show documentation
The source came from http://archive.msdn.microsoft.com/ewsjavaapi Support for Maven has been added.
There is a newer version: 1.1.5.2
/**************************************************************************
 * copyright file="GetStreamingEventsResponse.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the GetStreamingEventsResponse.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

import java.util.ArrayList;
import java.util.List;

/**
 * Represents the response to a subscription event retrieval operation.
 */
final class GetStreamingEventsResponse extends ServiceResponse {
	
	private GetStreamingEventsResults results = new GetStreamingEventsResults();
    private HangingServiceRequestBase request;
    
    /**
     * Enumeration of ConnectionStatus that can be returned by the server.
     */
    private enum ConnectionStatus
    {
        /**
         * Simple heartbeat
         */
        OK,

        /**
         * Server is closing the connection.
         */
        Closed
    }
    
    /**
     * Initializes a new instance of the GetStreamingEventsResponse class.
     * @param request The request
     * Request to disconnect when we get a close message.
     */
    protected GetStreamingEventsResponse(HangingServiceRequestBase request) {
    	super();
    	List string = new ArrayList();
    	this.setErrorSubscriptionIds(string);
    	this.request = request;
    }
    
    /**
     * Reads response elements from XML.
     * @throws Exception 
     */
    @Override
    protected void readElementsFromXml(EwsServiceXmlReader reader)
    throws Exception {
    	super.readElementsFromXml(reader);

    	reader.read();

    	if(reader.getLocalName() == XmlElementNames.Notifications) {
    		this.results.loadFromXml(reader);
    	}
    	else if(reader.getLocalName() == XmlElementNames.ConnectionStatus) {
    		String connectionStatus = reader.readElementValue(XmlNamespace. 
    				Messages,XmlElementNames.ConnectionStatus);

    		if (connectionStatus.equals(ConnectionStatus.Closed.toString())) {
    			this.request.disconnect(
    					HangingRequestDisconnectReason.Clean, null);
    		}
    	}
    }
    
    /**
     * Loads extra error details from XML
     * @throws Exception 
     */
    @Override
    protected  boolean loadExtraErrorDetailsFromXml(EwsServiceXmlReader reader, 
    		String xmlElementName) throws Exception {
    	boolean baseReturnVal = super.
    	loadExtraErrorDetailsFromXml(reader, xmlElementName);

    	if (reader.isStartElement(XmlNamespace.Messages, XmlElementNames.ErrorSubscriptionIds)) {
    		do {
    			reader.read();

    			if (reader.getNodeType().getNodeType() == XMLNodeType.START_ELEMENT &&
    					reader.getLocalName() == XmlElementNames.SubscriptionId) {
    				this.getErrorSubscriptionIds().add(
    						reader.readElementValue(XmlNamespace.Messages,
    								XmlElementNames.SubscriptionId));
    			}
    		}
    		while (!reader.isEndElement(XmlNamespace.Messages, 
    				XmlElementNames.ErrorSubscriptionIds));

    		return true;
    	}
    	else {
    		return baseReturnVal;
    	}
    }
    
    /**
     * Gets event results from subscription.
     */
    protected GetStreamingEventsResults getResults() {
         return this.results; 
    }
    
    private List errorSubscriptionIds;

    /**
     * Gets the error subscription ids.
     */
    protected List getErrorSubscriptionIds() {
        return this.errorSubscriptionIds;
    }
    
    /**
     * Sets the error subscription ids.
     */
    private void setErrorSubscriptionIds(List value) {
    	this.errorSubscriptionIds = value;
    }
    

}