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

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

/***
 * Represents a file attachment.
 */
public final class FileAttachment extends Attachment {

	/** The file name. */
	private String fileName;

	/** The content stream. */
	private InputStream contentStream;

	/** The content. */
	private byte[] content;

	/** The load to stream. */
	private OutputStream loadToStream;

	/** The is contact photo. */
	private boolean isContactPhoto;

	/**
	 * * Initializes a new instance.
	 * 
	 * @param owner
	 *            the owner
	 */
	protected FileAttachment(Item owner) {
		super(owner);
	}

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

	/**
	 * * Validates this instance.
	 * 
	 * @param attachmentIndex
	 *            the attachment index
	 * @throws ServiceValidationException
	 *             the service validation exception
	 * @Index of this attachment
	 */
	void validate(int attachmentIndex) throws ServiceValidationException {
		try {
			if ((this.fileName == null || this.fileName.isEmpty())
					&& (this.content == null) && (this.contentStream == null)) {
				throw new ServiceValidationException(String.format(
						Strings.FileAttachmentContentIsNotSet, 
						attachmentIndex));
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	/**
	 * * Tries to read element from XML.
	 * 
	 * @param reader
	 *            the reader
	 * @return True if element was read.
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected boolean tryReadElementFromXml(EwsServiceXmlReader reader)
			throws Exception {
		boolean result = super.tryReadElementFromXml(reader);

		if (!result) {
			if (reader.getLocalName().equals(XmlElementNames.IsContactPhoto)) {
				this.isContactPhoto = reader.readElementValue(Boolean.class);
			} else if (reader.getLocalName().equals(XmlElementNames.Content)) {
				if (this.loadToStream != null) {
					reader.readBase64ElementValue(this.loadToStream);
				} else {
					// If there's a file attachment content handler, use it.
					// Otherwise
					// load the content into a byte array.
					// TODO: Should we mark the attachment to indicate that
					// content is stored elsewhere?
					if (reader.getService().getFileAttachmentContentHandler() != null) {
						OutputStream outputStream = reader.getService()
								.getFileAttachmentContentHandler()
								.getOutputStream(getId());
						if (outputStream != null) {
							reader.readBase64ElementValue(outputStream);
						} else {
							this.content = reader.readBase64ElementValue();
						}
					} else {
						this.content = reader.readBase64ElementValue();
					}
				}

				result = true;
			}
		}

		return result;
	}

	/**
	 * * Writes elements and content to XML.
	 * 
	 * @param writer
	 *            the writer
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected void writeElementsToXml(EwsServiceXmlWriter writer)
			throws Exception {
		super.writeElementsToXml(writer);
		// ExchangeVersion ev=writer.getService().getRequestedServerVersion();
		if (writer.getService().getRequestedServerVersion().ordinal() > 
		ExchangeVersion.Exchange2007_SP1
				.ordinal()) {
			writer.writeElementValue(XmlNamespace.Types,
					XmlElementNames.IsContactPhoto, this.isContactPhoto);
		}

		writer.writeStartElement(XmlNamespace.Types, XmlElementNames.Content);

		if (!(this.fileName == null || this.fileName.isEmpty())) {
			File fileStream = new File(this.fileName);
			FileInputStream fis = null;
			try {
				fis = new FileInputStream(fileStream);
				writer.writeBase64ElementValue(fis);				
			} finally{
				if(fis != null){
					fis.close();
				}
			}			
			
		} else if (this.contentStream != null) {
			writer.writeBase64ElementValue(this.contentStream);
		} else if (this.content != null) {
			writer.writeBase64ElementValue(this.content);
		} else {
			EwsUtilities.EwsAssert(false, "FileAttachment.WriteElementsToXml",
					"The attachment's content is not set.");
		}

		writer.writeEndElement();
	}

	/**
	 * * Loads the content of the file attachment into the specified stream.
	 * Calling this method results in a call to EWS.
	 * 
	 * @param stream
	 *            the stream
	 * @throws Exception
	 *             the exception
	 */
	public void load(OutputStream stream) throws Exception {
		this.loadToStream = stream;

		try {
			this.load();
		} finally {
			this.loadToStream = null;
		}
	}

	/**
	 * * Loads the content of the file attachment into the specified file.
	 * Calling this method results in a call to EWS.
	 * 
	 * @param fileName
	 *            the file name
	 * @throws Exception
	 *             the exception
	 */
	public void load(String fileName) throws Exception {
		File fileStream = new File(fileName);
		FileOutputStream fos = new FileOutputStream(fileStream);
		this.loadToStream = fos;
		try {
			this.load();
		} finally {
			this.loadToStream.flush();
			this.loadToStream = null;
		}

		this.fileName = fileName;
		this.content = null;
		this.contentStream = null;
	}

	/**
	 * * Gets the name of the file the attachment is linked to.
	 * 
	 * @return the file name
	 */
	public String getFileName() {
		return this.fileName;
	}

	/**
	 * Sets the file name.
	 * 
	 * @param fileName
	 *            the new file name
	 */
	protected void setFileName(String fileName) {
		this.throwIfThisIsNotNew();

		this.fileName = fileName;
		this.content = null;
		this.contentStream = null;
	}

	/***
	 * Gets  the content stream.Gets the name of the file the attachment
	 * is linked to.
	 * 
	 * @return The content stream
	 */
	protected InputStream getContentStream() {
		return this.contentStream;
	}

	/**
	 * Sets the content stream.
	 * 
	 * @param contentStream
	 *            the new content stream
	 */
	protected void setContentStream(InputStream contentStream) {
		this.throwIfThisIsNotNew();

		this.contentStream = contentStream;
		this.content = null;
		this.fileName = null;
	}

	/**
	 * * Gets the content of the attachment into memory. Content is set only
	 * when Load() is called.
	 * 
	 * @return the content
	 */
	public byte[] getContent() {
		return this.content;
	}

	/**
	 * Sets the content.
	 * 
	 * @param content
	 *            the new content
	 */
	protected void setContent(byte[] content) {
		this.throwIfThisIsNotNew();

		this.content = content;
		this.fileName = null;
		this.contentStream = null;
	}

	/**
	 * Gets  a value indicating whether this attachment is a contact
	 * photo.
	 *
	 * @return true, if is contact photo
	 * @throws ServiceVersionException the service version exception
	 */
	public boolean isContactPhoto() throws ServiceVersionException {
		EwsUtilities.validatePropertyVersion(this.getOwner().getService(),
				ExchangeVersion.Exchange2010, "IsContactPhoto");
		return this.isContactPhoto;
	}

	/**
	 * Sets the checks if is contact photo.
	 *
	 * @param isContactPhoto the new checks if is contact photo
	 * @throws ServiceVersionException the service version exception
	 */
	public void setIsContactPhoto(boolean isContactPhoto) 
	throws ServiceVersionException {
		EwsUtilities.validatePropertyVersion(this.getOwner().getService(),
				ExchangeVersion.Exchange2010, "IsContactPhoto");
		this.throwIfThisIsNotNew();
		this.isContactPhoto = isContactPhoto;
	}

}