microsoft.exchange.webservices.data.SubscribeRequest 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="SubscribeRequest.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the SubscribeRequest.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

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

import javax.xml.stream.XMLStreamException;

/**
 * The Class SubscribeRequest.
 * 
 * @param 
 *            the generic type
 */
abstract class SubscribeRequest extends
		MultiResponseServiceRequest> {

	/** The folder ids. */
	private FolderIdWrapperList folderIds = new FolderIdWrapperList();

	/** The event types. */
	private List eventTypes = new ArrayList();

	/** The watermark. */
	private String watermark;

	/**
	 * * Validate request.
	 * 
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected void validate() throws Exception {
		super.validate();
		EwsUtilities.validateParam(this.getFolderIds(), "FolderIds");
		EwsUtilities.validateParamCollection(this.getEventTypes().iterator(),
				"EventTypes");
		this.getFolderIds().validate(
				this.getService().getRequestedServerVersion());
		// Check that caller isn't trying
		//to subscribe to Status events.		  
		if (this.getEventTypes().contains(EventType.Status)) {
			throw new ServiceValidationException(
					Strings.CannotSubscribeToStatusEvents);
		}
		
		// If Watermark was specified, make sure it's not a blank string.
		if (!(this.getWatermark() == null || 
				this.getWatermark().isEmpty())) {			
            EwsUtilities.validateNonBlankStringParam(this.
            		getWatermark(), "Watermark");
        }

        for (EventType eventType : this.getEventTypes()) {
        	EwsUtilities.validateEnumVersionValue(eventType, 
        			this.getService().getRequestedServerVersion());			
		}
		
	}

	/**
	 * Gets the name of the subscription XML element.
	 * 
	 * @return XML element name
	 */
	protected abstract String getSubscriptionXmlElementName();

	/***
	 * Gets the expected response message count.
	 * 
	 * @return Number of expected response messages.
	 */
	@Override
	protected int getExpectedResponseMessageCount() {
		return 1;
	}

	/**
	 * Gets the name of the XML element.
	 * 
	 * @return XML element name
	 */
	@Override
	protected String getXmlElementName() {
		return XmlElementNames.Subscribe;
	}

	/**
	 * Gets the name of the response XML element.
	 * 
	 * @return XML element name
	 */
	@Override
	protected String getResponseXmlElementName() {
		return XmlElementNames.SubscribeResponse;
	}

	/**
	 * Gets the name of the response message XML element.
	 * 
	 * @return XML element name
	 */
	@Override
	protected String getResponseMessageXmlElementName() {
		return XmlElementNames.SubscribeResponseMessage;
	}

	/**
	 * Internal method to write XML elements.
	 * 
	 * @param writer
	 *            the writer
	 * @throws XMLStreamException
	 *             the xML stream exception
	 * @throws ServiceXmlSerializationException
	 *             the service xml serialization exception
	 */
	protected abstract void internalWriteElementsToXml(
			EwsServiceXmlWriter writer) throws XMLStreamException,
			ServiceXmlSerializationException;

	/**
	 * Writes XML elements.
	 * 
	 * @param writer
	 *            the writer
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected void writeElementsToXml(EwsServiceXmlWriter writer)
			throws Exception {
		writer.writeStartElement(XmlNamespace.Messages, this
				.getSubscriptionXmlElementName());

		if (this.getFolderIds().getCount() == 0) {
			writer.writeAttributeValue(XmlAttributeNames.SubscribeToAllFolders,
					true);
		}

		this.getFolderIds().writeToXml(writer, XmlNamespace.Types,
				XmlElementNames.FolderIds);

		writer
				.writeStartElement(XmlNamespace.Types,
						XmlElementNames.EventTypes);
		for (EventType eventType : this.getEventTypes()) {
			writer.writeElementValue(XmlNamespace.Types,
					XmlElementNames.EventType, eventType);
		}
		writer.writeEndElement();

		if (!(this.getWatermark() == null || this.getWatermark().isEmpty())) {
			writer.writeElementValue(XmlNamespace.Types,
					XmlElementNames.Watermark, this.getWatermark());
		}

		this.internalWriteElementsToXml(writer);

		writer.writeEndElement();
	}

	/**
	 * Instantiates a new subscribe request.
	 * 
	 * @param service
	 *            the service
	 * @throws Exception 
	 */
	protected SubscribeRequest(ExchangeService service)
			throws Exception {
		super(service, ServiceErrorHandling.ThrowOnError);
		this.setFolderIds(new FolderIdWrapperList());
        this.setEventTypes(new ArrayList());
	}

	/**
	 * Gets the folder ids.
	 * 
	 * @return the folder ids
	 */
	public FolderIdWrapperList getFolderIds() {
		return this.folderIds;
	}

	/**
	 * Sets the folder ids.
	 */
	private void setFolderIds(FolderIdWrapperList value)
	{
		this.folderIds=value;
	}
	/**
	 * Gets the event types.
	 * 
	 * @return the event types
	 */
	public List getEventTypes() {
		return this.eventTypes;
	}
	
	/**
	 * set the EventTypes	
	 */
	private void setEventTypes(List value) {
		 this.eventTypes=value;
	}

	/**
	 * Gets the watermark.
	 * 
	 * @return the watermark
	 */
	public String getWatermark() {
		return this.watermark;
	}

	/**
	 * Sets the watermark.
	 * 
	 * @param watermark
	 *            the new watermark
	 */
	public void setWatermark(String watermark) {
		this.watermark = watermark;
	}

}