microsoft.exchange.webservices.data.GetUserOofSettingsRequest 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
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="GetUserOofSettingsRequest.java" company="Microsoft"
* Copyright (c) Microsoft Corporation. All rights reserved.
*
* Defines the GetUserOofSettingsRequest class.
**************************************************************************/
package microsoft.exchange.webservices.data;
import javax.xml.stream.XMLStreamException;
/**
* Represents a GetUserOofSettings request.
*/
final class GetUserOofSettingsRequest extends SimpleServiceRequestBase {
/** The smtp address. */
private String smtpAddress;
/**
* Gets the name of the XML element.
*
* @return XML element name.
*/
@Override
protected String getXmlElementName() {
return XmlElementNames.GetUserOofSettingsRequest;
}
/**
* Validate request.
*
* @throws Exception
* the exception
*/
@Override
protected void validate() throws Exception {
super.validate();
EwsUtilities.validateParam(this.getSmtpAddress(), "SmtpAddress");
}
/**
* Validate request.
*
* @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 {
writer.writeStartElement(XmlNamespace.Types, XmlElementNames.Mailbox);
writer.writeElementValue(XmlNamespace.Types, XmlElementNames.Address,
this.getSmtpAddress());
writer.writeEndElement(); // Mailbox
}
/**
* Gets the name of the response XML element.
*
* @return XML element name
*/
@Override
protected String getResponseXmlElementName() {
return XmlElementNames.GetUserOofSettingsResponse;
}
/**
* Parses the response.
*
* @param reader
* the reader
* @return Response object
* @throws Exception
* the exception
*/
@Override
protected Object parseResponse(EwsServiceXmlReader reader)
throws Exception {
GetUserOofSettingsResponse serviceResponse =
new GetUserOofSettingsResponse();
serviceResponse.loadFromXml(reader, XmlElementNames.ResponseMessage);
if (serviceResponse.getErrorCode() == ServiceError.NoError) {
reader.readStartElement(XmlNamespace.Types,
XmlElementNames.OofSettings);
serviceResponse.setOofSettings(new OofSettings());
serviceResponse.getOofSettings().loadFromXml(reader,
reader.getLocalName());
serviceResponse.getOofSettings().setAllowExternalOof(
reader.readElementValue(OofExternalAudience.class,
XmlNamespace.Messages,
XmlElementNames.AllowExternalOof));
}
return serviceResponse;
}
/**
* Gets the request version.
*
* @return Earliest Exchange version in which this request is supported
*/
@Override
protected ExchangeVersion getMinimumRequiredServerVersion() {
return ExchangeVersion.Exchange2007_SP1;
}
/**
* Initializes a new instance of the class.
*
* @param service
* the service
* @throws Exception
*/
protected GetUserOofSettingsRequest(ExchangeService service)
throws Exception {
super(service);
}
/**
* Executes this request.
*
* @return Service response.
* @throws Exception
* the exception
*/
protected GetUserOofSettingsResponse execute() throws Exception {
GetUserOofSettingsResponse serviceResponse =
(GetUserOofSettingsResponse) this
.internalExecute();
serviceResponse.throwIfNecessary();
return serviceResponse;
}
/**
* Gets the SMTP address.
*
* @return the smtp address
*/
protected String getSmtpAddress() {
return this.smtpAddress;
}
/**
* Sets the smtp address.
*
* @param smtpAddress
* the new smtp address
*/
protected void setSmtpAddress(String smtpAddress) {
this.smtpAddress = smtpAddress;
}
}