microsoft.exchange.webservices.data.autodiscover.configuration
Class ConfigurationSettingsBase

java.lang.Object
  extended by microsoft.exchange.webservices.data.autodiscover.configuration.ConfigurationSettingsBase
Direct Known Subclasses:
OutlookConfigurationSettings

public abstract class ConfigurationSettingsBase
extends Object

Represents the base class for configuration settings.


Constructor Summary
ConfigurationSettingsBase()
          Initializes a new instance of the ConfigurationSettingsBase class.
 
Method Summary
abstract  GetUserSettingsResponse convertSettings(String smtpAddress, List<UserSettingName> requestedSettings)
          Convert ConfigurationSettings to GetUserSettings response.
 AutodiscoverError getError()
          Gets the error.
abstract  String getNamespace()
          Gets the namespace that defines the settings.
abstract  String getRedirectTarget()
          Gets the redirect target.
abstract  AutodiscoverResponseType getResponseType()
          Gets the type of the response.
 void loadFromXml(EwsXmlReader reader)
          Loads the settings from XML.
abstract  void makeRedirectionResponse(URI redirectUrl)
          Makes this instance a redirection response.
 boolean tryReadCurrentXmlElement(EwsXmlReader reader)
          Tries to read the current XML element.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfigurationSettingsBase

public ConfigurationSettingsBase()
Initializes a new instance of the ConfigurationSettingsBase class.

Method Detail

tryReadCurrentXmlElement

public boolean tryReadCurrentXmlElement(EwsXmlReader reader)
                                 throws Exception
Tries to read the current XML element.

Parameters:
reader - the reader
Returns:
True is the current element was read, false otherwise.
Throws:
Exception - the exception

loadFromXml

public void loadFromXml(EwsXmlReader reader)
                 throws Exception
Loads the settings from XML.

Parameters:
reader - the reader
Throws:
Exception - the exception

getNamespace

public abstract String getNamespace()
Gets the namespace that defines the settings.

Returns:
The namespace that defines the settings

makeRedirectionResponse

public abstract void makeRedirectionResponse(URI redirectUrl)
Makes this instance a redirection response.

Parameters:
redirectUrl - the redirect url

getResponseType

public abstract AutodiscoverResponseType getResponseType()
Gets the type of the response.

Returns:
The type of the response.

getRedirectTarget

public abstract String getRedirectTarget()
Gets the redirect target.

Returns:
The redirect target.

convertSettings

public abstract GetUserSettingsResponse convertSettings(String smtpAddress,
                                                        List<UserSettingName> requestedSettings)
Convert ConfigurationSettings to GetUserSettings response.

Parameters:
smtpAddress - SMTP address.
requestedSettings - The requested settings.
Returns:
GetUserSettingsResponse.

getError

public AutodiscoverError getError()
Gets the error.

Returns:
The error.


Copyright © 2012–2015 Microsoft. All rights reserved.