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

import java.net.URI;
import java.util.List;

/**
 * Represents the base class for configuration settings.
 * 
 */
@EditorBrowsable(state = EditorBrowsableState.Never)
abstract class ConfigurationSettingsBase {

	/** The error. */
	private AutodiscoverError error;

	/**
	 * Initializes a new instance of the ConfigurationSettingsBase class.
	 * 
	 */
	protected ConfigurationSettingsBase() {
	}

	/**
	 * Tries to read the current XML element.
	 * 
	 * @param reader
	 *            the reader
	 * @return True is the current element was read, false otherwise.
	 * @throws Exception
	 *             the exception
	 */
	protected boolean tryReadCurrentXmlElement(EwsXmlReader reader)
			throws Exception {
		if (reader.getLocalName().equalsIgnoreCase(XmlElementNames.Error)) {
			this.error = AutodiscoverError.parse(reader);

			return true;
		} else {
			return false;
		}
	}

	/**
	 * Loads the settings from XML.
	 * 
	 * @param reader
	 *            the reader
	 * @throws Exception
	 *             the exception
	 */
	protected void loadFromXml(EwsXmlReader reader) throws Exception {
		reader.readStartElement(XmlNamespace.NotSpecified,
				XmlElementNames.Autodiscover);
		reader.readStartElement(XmlNamespace.NotSpecified,
				XmlElementNames.Response);

		do {
			reader.read();

			if (reader.isStartElement()) {
				if (!this.tryReadCurrentXmlElement(reader)) {
					reader.skipCurrentElement();
				}
			}
		} while (!reader.isEndElement(XmlNamespace.NotSpecified,
				XmlElementNames.Response));

		reader.readEndElement(XmlNamespace.NotSpecified,
				XmlElementNames.Autodiscover);
	}

	/**
	 * Gets the namespace that defines the settings.
	 * 
	 * @return The namespace that defines the settings
	 */
	protected abstract String getNamespace();

	/**
	 * Makes this instance a redirection response.
	 * 
	 * @param redirectUrl
	 *            the redirect url
	 */
	protected abstract void makeRedirectionResponse(URI redirectUrl);

	/**
	 * Gets the type of the response.
	 * 
	 * @return The type of the response.
	 */
	protected abstract AutodiscoverResponseType getResponseType();

	/**
	 * Gets the redirect target.
	 * 
	 * @return The redirect target.
	 */
	protected abstract String getRedirectTarget();
	
	/**
	 * Convert ConfigurationSettings to GetUserSettings response.
	 * @param smtpAddress SMTP address.
	 * @param requestedSettings The requested settings.
	 * @return GetUserSettingsResponse.
	 */
	protected abstract GetUserSettingsResponse convertSettings(
			String smtpAddress, 
			List requestedSettings);
	

	/**
	 * Gets the error.
	 * 
	 * @return The error.
	 */
	protected AutodiscoverError getError() {
		return this.error;
	}
}