microsoft.exchange.webservices.data.core.request.CreateAttachmentRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ews-java-api Show documentation
Show all versions of ews-java-api Show documentation
Exchange Web Services (EWS) Java API
/*
* The MIT License
* Copyright (c) 2012 Microsoft Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package microsoft.exchange.webservices.data.core.request;
import microsoft.exchange.webservices.data.core.EwsServiceXmlWriter;
import microsoft.exchange.webservices.data.core.EwsUtilities;
import microsoft.exchange.webservices.data.core.ExchangeService;
import microsoft.exchange.webservices.data.core.XmlAttributeNames;
import microsoft.exchange.webservices.data.core.XmlElementNames;
import microsoft.exchange.webservices.data.core.enumeration.service.error.ServiceErrorHandling;
import microsoft.exchange.webservices.data.core.response.CreateAttachmentResponse;
import microsoft.exchange.webservices.data.core.enumeration.misc.ExchangeVersion;
import microsoft.exchange.webservices.data.core.enumeration.misc.XmlNamespace;
import microsoft.exchange.webservices.data.core.exception.service.local.ServiceLocalException;
import microsoft.exchange.webservices.data.property.complex.Attachment;
import microsoft.exchange.webservices.data.property.complex.ItemAttachment;
import java.util.ArrayList;
import java.util.ListIterator;
/**
* Represents a CreateAttachment request.
*/
public final class CreateAttachmentRequest extends
MultiResponseServiceRequest {
/**
* The parent item id.
*/
private String parentItemId;
/**
* The attachments.
*/
private ArrayList attachments = new ArrayList();
/**
* Gets the attachments.
*
* @return attachments
*/
public ArrayList getAttachments() {
return attachments;
}
/**
* Initializes a new instance of the class.
*
* @param service the service
* @param errorHandlingMode the error handling mode
* @throws Exception
*/
public CreateAttachmentRequest(ExchangeService service, ServiceErrorHandling errorHandlingMode)
throws Exception {
super(service, errorHandlingMode);
}
/**
* Validate request..
*
* @throws Exception the exception
*/
@Override
protected void validate() throws Exception {
super.validate();
EwsUtilities.validateParam(this.parentItemId, "ParentItemId");
}
/**
* Gets the expected response message count.
*
* @return Number of expected response messages.
*/
@Override
protected int getExpectedResponseMessageCount() {
return this.attachments.size();
}
/**
* Gets the name of the XML element.
*
* @return XML element name.
*/
@Override public String getXmlElementName() {
return XmlElementNames.CreateAttachment;
}
/**
* Gets the name of the response XML element.
*
* @return XML element name.
*/
@Override
protected String getResponseXmlElementName() {
return XmlElementNames.CreateAttachmentResponse;
}
/**
* Gets the name of the response message XML element.
*
* @return XML element name.
*/
@Override
protected String getResponseMessageXmlElementName() {
return XmlElementNames.CreateAttachmentResponseMessage;
}
/**
* Gets the request version.
*
* @return Earliest Exchange version in which this request is supported.
*/
@Override
protected ExchangeVersion getMinimumRequiredServerVersion() {
return ExchangeVersion.Exchange2007_SP1;
}
/**
* Gets a value indicating whether the TimeZoneContext SOAP header should be
* emitted.
*/
protected boolean emitTimeZoneHeader() throws ServiceLocalException, Exception {
{
ListIterator items = this.getAttachments()
.listIterator();
while (items.hasNext())
{
ItemAttachment itemAttachment = (ItemAttachment) items.next();
if ((itemAttachment.getItem() != null)
&& itemAttachment
.getItem()
.getIsTimeZoneHeaderRequired(false /* isUpdateOperation */)) {
return true;
}
}
return false;
}
}
/**
* Gets the parent item id.
*
* @return parentItemId
*/
public String getParentItemId() {
return parentItemId;
}
/**
* Sets the parent item id.
*
* @param parentItemId the new parent item id
*/
public void setParentItemId(String parentItemId) {
this.parentItemId = parentItemId;
}
/**
* Writes the elements to XML.
*
* @param writer the writer
* @throws Exception the exception
*/
@Override
protected void writeElementsToXml(EwsServiceXmlWriter writer)
throws Exception {
writer.writeStartElement(XmlNamespace.Messages,
XmlElementNames.ParentItemId);
writer.writeAttributeValue(XmlAttributeNames.Id, this.parentItemId);
writer.writeEndElement();
writer.writeStartElement(XmlNamespace.Messages,
XmlElementNames.Attachments);
for (Attachment attachment : this.attachments) {
attachment.writeToXml(writer, attachment.getXmlElementName());
}
writer.writeEndElement();
}
/**
* Creates the service response.
*
* @param service the service
* @param responseIndex the response index
* @return the creates the attachment response
*/
@Override
protected CreateAttachmentResponse createServiceResponse(
ExchangeService service, int responseIndex) {
return new CreateAttachmentResponse(
this.attachments.get(responseIndex));
}
}