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

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

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

import javax.xml.stream.XMLStreamException;

/**
 * Represents a GetAttachment request.
 * 
 */
final class GetAttachmentRequest extends
		MultiResponseServiceRequest {

	/** The attachments. */
	private List attachments = new ArrayList();

	/** The additional properties. */
	private List additionalProperties = 
		new ArrayList();

	/** The body type. */
	private BodyType bodyType;

	/**
	 * Initializes a new instance of the GetAttachmentRequest class.
	 * 
	 * @param service
	 *            The service.
	 * @param errorHandlingMode
	 *            Indicates how errors should be handled.
	 * @throws Exception 
	 */
	GetAttachmentRequest(ExchangeService service,
			ServiceErrorHandling errorHandlingMode)
			throws Exception {
		super(service, errorHandlingMode);
	}

	/**
	 * Validate request.
	 * 
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected void validate() throws Exception {
		super.validate();
		EwsUtilities.validateParamCollection(this.getAttachments().iterator(),
				"Attachments");
		for (int i = 0; i < this.getAdditionalProperties().size(); i++) {
			EwsUtilities.validateParam(this.getAdditionalProperties().get(i),
					String.format("AdditionalProperties[%d]", i));
		}
	}

	/**
	 * Creates the service response.
	 * 
	 * @param service
	 *            The service.
	 * @param responseIndex
	 *            Index of the response.
	 * @return Service response.
	 */
	@Override
	protected GetAttachmentResponse createServiceResponse(
			ExchangeService service, int responseIndex) {
		return new GetAttachmentResponse(this.getAttachments().get(
				responseIndex));
	}

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

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

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

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

	/**
	 * Writes XML elements.
	 * 
	 * @param writer
	 *            The writer
	 * @throws XMLStreamException
	 *             the xML stream exception
	 * @throws ServiceXmlSerializationException
	 *             the service xml serialization exception
	 */
	@Override
	protected void writeElementsToXml(EwsServiceXmlWriter writer)
			throws XMLStreamException, ServiceXmlSerializationException {
		if ((this.getBodyType() != null)
				|| this.getAdditionalProperties().size() > 0) {
			writer.writeStartElement(XmlNamespace.Messages,
					XmlElementNames.AttachmentShape);

			if (this.getBodyType() != null) {
				writer.writeElementValue(XmlNamespace.Types,
						XmlElementNames.BodyType, this.getBodyType());
			}

			if (this.getAdditionalProperties().size() > 0) {
				PropertySet.writeAdditionalPropertiesToXml(writer, this
						.getAdditionalProperties().iterator());
			}

			writer.writeEndElement(); // AttachmentShape
		}

		writer.writeStartElement(XmlNamespace.Messages,
				XmlElementNames.AttachmentIds);

		for (Attachment attachment : this.getAttachments()) {
			writer.writeStartElement(XmlNamespace.Types,
					XmlElementNames.AttachmentId);
			writer
					.writeAttributeValue(XmlAttributeNames.Id, attachment
							.getId());
			writer.writeEndElement();
		}

		writer.writeEndElement();
	}

	/**
	 * Gets the request version.
	 * 
	 * @return Earliest Exchange version in which this request is supported.
	 */
	@Override
	protected ExchangeVersion getMinimumRequiredServerVersion() {
		return ExchangeVersion.Exchange2007_SP1;
	}

	/**
	 * Gets the attachments.
	 * 
	 * @return the attachments
	 */
	public List getAttachments() {
		return this.attachments;
	}

	/**
	 * Gets the additional properties.
	 * 
	 * @return the additional properties
	 */
	public List getAdditionalProperties() {
		return this.additionalProperties;
	}

	/**
	 * Gets  the type of the body.
	 * 
	 * @return the body type
	 */
	public BodyType getBodyType() {

		return this.bodyType;

	}

	/**
	 * Sets the body type.
	 * 
	 * @param bodyType
	 *            the new body type
	 */
	public void setBodyType(BodyType bodyType) {
		this.bodyType = bodyType;
	}

}