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

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

/**
 * Represents the response to a GetUsersSettings call for an individual user.
 * 
 */
public final class GetUserSettingsResponse extends AutodiscoverResponse {

	/** The smtp address. */
	private String smtpAddress;

	/** The redirect target. */
	private String redirectTarget;

	/** The settings. */
	private Map settings;

	/** The user setting errors. */
	private Collection userSettingErrors;

	/**
	 * Initializes a new instance of the 
	 * class.
	 */
	public GetUserSettingsResponse() {
		super();
		this.setSmtpAddress(null);
		this.setSettings(new HashMap());
		this.setUserSettingErrors(new ArrayList());
	}

	/**
	 * Tries the get the user setting value.
	 * @param cls Type of user setting.
	 * @param setting The setting.
	 * @param value The setting value.
	 * @return True if setting was available.
	 */
	public  boolean  tryGetSettingValue(Class cls,
			UserSettingName setting, OutParam  value) {
		Object objValue;
		if (this.getSettings().containsKey(setting)) {
			objValue = this.getSettings().get(setting);
			value.setParam((T) objValue);
			return true;
		}				
		else {			
			value.setParam(null);
			return false;
		}
	}

	/**
	 * Gets the SMTP address this response applies to.
	 * 
	 * @return the smtp address
	 */
	public String getSmtpAddress() {
		return this.smtpAddress;
	}

	/**
	 * Sets the smtp address.
	 * 
	 * @param value
	 *            the new smtp address
	 */
	protected void setSmtpAddress(String value) {
		this.smtpAddress = value;
	}

	/**
	 * Gets the redirectionTarget (URL or email address).
	 * 
	 * @return the redirect target
	 */
	public String getRedirectTarget() {
		return this.redirectTarget;
	}

	/**
	 * Sets the redirectionTarget (URL or email address).
	 */
	protected void  setRedirectTarget(String value) {
		this.redirectTarget = value;
	}
	
	/**
	 * Gets the requested settings for the user.
	 * 
	 * @return the settings
	 */
	public Map getSettings() {
		return this.settings;
	}

	/**
	 * sets the requested settings for the user.	 
	 */
	public void setSettings(Map settings) {
		this.settings = settings;
	}

	/**
	 * Gets error information for settings that could not be returned.
	 * 
	 * @return the user setting errors
	 */
	public Collection getUserSettingErrors() {
		return this.userSettingErrors;
	}

	/**
	 * sets the requested settings for the user.	 
	 */
	protected void setUserSettingErrors(Collection value) {
		this.userSettingErrors = value;
	}
	
	/**
	 * Loads response from XML.
	 * 
	 * @param reader
	 *            The reader.
	 * @param endElementName
	 *            End element name.
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected void loadFromXml(EwsXmlReader reader, String endElementName)
	throws Exception {
		do {
			reader.read();

			if (reader.getNodeType().getNodeType() == XMLNodeType.START_ELEMENT) {
				if (reader.getLocalName()
						.equals(XmlElementNames.RedirectTarget)) {

					this.setRedirectTarget(reader.readElementValue());
				} else if (reader.getLocalName().equals(
						XmlElementNames.UserSettingErrors)) {
					this.loadUserSettingErrorsFromXml(reader);
				} else if (reader.getLocalName().equals(
						XmlElementNames.UserSettings)) {
					this.loadUserSettingsFromXml(reader);
				} else {
					super.loadFromXml(reader, endElementName);
				}
			}
		} while (!reader
				.isEndElement(XmlNamespace.Autodiscover, endElementName));
	}

	/**
	 * Loads from XML.
	 * 
	 * @param reader
	 *            The reader.
	 * @throws Exception
	 *             the exception
	 */
	protected void loadUserSettingsFromXml(EwsXmlReader reader)
	throws Exception {
		if (!reader.isEmptyElement()) {
			do {
				reader.read();

				if ((reader.getNodeType().getNodeType() == XMLNodeType.START_ELEMENT) &&
						(reader.getLocalName()
								.equals(XmlElementNames.UserSetting))) {
					String settingClass = reader.readAttributeValue(
							XmlNamespace.XmlSchemaInstance,
							XmlAttributeNames.Type);

					if (settingClass.equals(XmlElementNames.StringSetting)) {
						this.readSettingFromXml(reader);
					} else if (settingClass.equals(XmlElementNames.WebClientUrlCollectionSetting)) {
						this.readSettingFromXml(reader);
					} else if (settingClass.equals(XmlElementNames.AlternateMailboxCollectionSetting)) {
						this.readSettingFromXml(reader);
					} else if (settingClass.equals(XmlElementNames.ProtocolConnectionCollectionSetting)) {
						this.readSettingFromXml(reader);
					} else {
						EwsUtilities.EwsAssert(false,
								"GetUserSettingsResponse." +
								"LoadUserSettingsFromXml",
								String.format("%s,%s",
										"Invalid setting class '%s' returned",
										settingClass));
						break;
					}
				}
			} while (!reader.isEndElement(XmlNamespace.Autodiscover,
					XmlElementNames.UserSettings));
		} else {
			reader.read();
		}
	}

	/**
	 * Reads user setting from XML.
	 * 
	 * @param reader
	 *            The reader.
	 * @throws Exception
	 *             the exception
	 */
	private void readSettingFromXml(EwsXmlReader reader) throws Exception {
		UserSettingName name = null;
		Object value = null;

		do {
			reader.read();

			if (reader.getNodeType().getNodeType() == XMLNodeType.START_ELEMENT) {
				if (reader.getLocalName().equals(XmlElementNames.Name)) {
					name = reader.readElementValue(UserSettingName.class);
				} else if (reader.getLocalName().equals(XmlElementNames.Value)) {
					value = reader.readElementValue();
				} else if (reader.getLocalName().equals(
						XmlElementNames.WebClientUrls)) {

					value = WebClientUrlCollection.loadFromXml(reader);
				} else if (reader.getLocalName().equals(
						XmlElementNames.ProtocolConnections)) {
					value = ProtocolConnectionCollection.LoadFromXml(reader);
				} else if (reader.getLocalName().equals(
						XmlElementNames.AlternateMailboxes)) {
					value = AlternateMailboxCollection.loadFromXml(reader);
				}
			}
		} while (!reader.isEndElement(XmlNamespace.Autodiscover,
				XmlElementNames.UserSetting));

		EwsUtilities.EwsAssert(name != null,
				"GetUserSettingsResponse.ReadSettingFromXml",
		"Missing name element in user setting");

		this.getSettings().put(name, value);
	}

	/**
	 * Loads the user setting errors.
	 * 
	 * @param reader
	 *            The reader.
	 * @throws Exception
	 *             the exception
	 */
	private void loadUserSettingErrorsFromXml(EwsXmlReader reader)
	throws Exception {
		if (!reader.isEmptyElement()) {
			do {
				reader.read();

				if ((reader.getNodeType().getNodeType() == XMLNodeType.START_ELEMENT) &&
						(reader.getLocalName()
								.equals(XmlElementNames.UserSettingError))) {
					UserSettingError error = new UserSettingError();
					error.loadFromXml(reader);
					this.getUserSettingErrors().add(error);
				}
			} while (!reader.isEndElement(XmlNamespace.Autodiscover,
					XmlElementNames.UserSettingErrors));
		} else {
			reader.read();
		}
	}
}