|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmicrosoft.exchange.webservices.data.ExchangeServiceBase
microsoft.exchange.webservices.data.AutodiscoverService
public final class AutodiscoverService
Represents a binding to the Exchange Autodiscover Service.
Field Summary | |
---|---|
protected static int |
AutodiscoverMaxRedirections
The Constant AutodiscoverMaxRedirections. |
Constructor Summary | |
---|---|
|
AutodiscoverService()
Initializes a new instance of the "AutodiscoverService" class. |
protected |
AutodiscoverService(ExchangeServiceBase service)
Initializes a new instance of the "AutodiscoverService" class. |
protected |
AutodiscoverService(ExchangeServiceBase service,
ExchangeVersion requestedServerVersion)
Initializes a new instance of the AutodiscoverService class. |
|
AutodiscoverService(ExchangeVersion requestedServerVersion)
Initializes a new instance of the "AutodiscoverService" class. |
|
AutodiscoverService(java.lang.String domain)
Initializes a new instance of the "AutodiscoverService" class. |
|
AutodiscoverService(java.lang.String domain,
ExchangeVersion requestedServerVersion)
Initializes a new instance of the "AutodiscoverService" class. |
|
AutodiscoverService(java.net.URI url)
Initializes a new instance of the "AutodiscoverService" class. |
|
AutodiscoverService(java.net.URI url,
ExchangeVersion requestedServerVersion)
Initializes a new instance of the "AutodiscoverService" class. |
protected |
AutodiscoverService(java.net.URI url,
java.lang.String domain)
Initializes a new instance of the "AutodiscoverService" class. |
protected |
AutodiscoverService(java.net.URI url,
java.lang.String domain,
ExchangeVersion requestedServerVersion)
Initializes a new instance of the "AutodiscoverService" class. |
Method Summary | ||
---|---|---|
boolean |
autodiscoverRedirectionUrlValidationCallback(java.lang.String redirectionUrl)
Autodiscover redirection url validation callback. |
|
java.lang.Object |
func(java.util.List arg1,
java.util.List arg2,
ExchangeVersion arg3,
java.net.URI arg4)
Func. |
|
protected java.util.List<java.lang.String> |
getAutodiscoverServiceHosts(java.lang.String domainName,
OutParam<java.lang.Integer> outParam)
Gets the list of autodiscover service hosts. |
|
protected java.util.List<java.net.URI> |
getAutodiscoverServiceUrls(java.lang.String domainName,
OutParam<java.lang.Integer> scpHostCount)
Gets the list of autodiscover service URLs. |
|
protected java.lang.String |
getDnsServerAddress()
Gets the dns server address. |
|
java.lang.String |
getDomain()
Gets the domain this service is bound to. |
|
GetDomainSettingsResponseCollection |
getDomainSettings(java.lang.Iterable<java.lang.String> domains,
ExchangeVersion requestedVersion,
DomainSettingName... domainSettingNames)
Retrieves the specified settings for a set of domains. |
|
protected GetDomainSettingsResponseCollection |
getDomainSettings(java.util.List<java.lang.String> domains,
java.util.List<DomainSettingName> settings,
ExchangeVersion requestedVersion)
Gets the domain settings using Autodiscover SOAP service. |
|
GetDomainSettingsResponse |
getDomainSettings(java.lang.String domain,
ExchangeVersion requestedVersion,
DomainSettingName... domainSettingNames)
Retrieves the specified settings for a domain. |
|
boolean |
getEnableScpLookup()
Gets a value indicating whether the AutodiscoverService should perform SCP (ServiceConnectionPoint) record lookup when determining the Autodiscover service URL. |
|
protected
|
getLegacyUserSettings(java.lang.Class<TSettings> cls,
java.lang.String emailAddress)
Calls the legacy Autodiscover service to retrieve configuration settings. |
|
protected java.net.URI |
getRedirectionUrlFromDnsSrvRecord(java.lang.String domainName)
Get an autodiscover SRV record in DNS and construct autodiscover URL. |
|
IAutodiscoverRedirectionUrl |
getRedirectionUrlValidationCallback()
Gets the redirection url validation callback. |
|
java.net.URI |
getUrl()
Gets the url this service is bound to. |
|
protected GetUserSettingsResponseCollection |
getUserSettings(java.util.List<java.lang.String> smtpAddresses,
java.util.List<UserSettingName> settings)
Gets the user settings using Autodiscover SOAP service. |
|
GetUserSettingsResponse |
getUserSettings(java.lang.String userSmtpAddress,
UserSettingName... userSettingNames)
Retrieves the specified settings for single SMTP address. |
|
GetUserSettingsResponseCollection |
getUsersSettings(java.lang.Iterable<java.lang.String> userSmtpAddresses,
UserSettingName... userSettingNames)
Retrieves the specified settings for a set of users. |
|
protected GetUserSettingsResponse |
internalGetLegacyUserSettings(java.lang.String emailAddress,
java.util.List<UserSettingName> requestedSettings)
Gets user settings from Autodiscover legacy endpoint. |
|
protected GetUserSettingsResponse |
internalGetSoapUserSettings(java.lang.String smtpAddress,
java.util.List<UserSettingName> requestedSettings)
Calls the SOAP Autodiscover service for user settings for a single SMTP address. |
|
java.lang.Boolean |
isExternal()
|
|
protected microsoft.exchange.webservices.data.HttpWebRequest |
prepareHttpWebRequestForUrl(java.net.URI url)
Creates an HttpWebRequest instance and initializes it with the appropriate parameters, based on the configuration of this service object. |
|
protected void |
processHttpErrorResponse(microsoft.exchange.webservices.data.HttpWebRequest httpWebResponse,
java.lang.Exception webException)
Processes an HTTP error response. |
|
protected void |
setDnsServerAddress(java.lang.String value)
Sets the dns server address. |
|
void |
setDomain(java.lang.String value)
Sets the domain this service is bound to. |
|
void |
setEnableScpLookup(boolean value)
Sets the enable scp lookup. |
|
protected void |
setIsExternal(java.lang.Boolean value)
|
|
void |
setRedirectionUrlValidationCallback(IAutodiscoverRedirectionUrl value)
Sets the redirection url validation callback. |
|
void |
setUrl(java.net.URI value)
Sets the url this service is bound to. |
|
protected void |
traceResponse(microsoft.exchange.webservices.data.HttpWebRequest request,
java.io.ByteArrayOutputStream memoryStream)
Traces the response. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final int AutodiscoverMaxRedirections
Constructor Detail |
---|
public AutodiscoverService() throws ArgumentException
ArgumentException
public AutodiscoverService(ExchangeVersion requestedServerVersion) throws ArgumentException
requestedServerVersion
- The requested server version.
ArgumentException
public AutodiscoverService(java.lang.String domain) throws ArgumentException
domain
- The domain that will be used to determine the URL of the
service.
ArgumentException
public AutodiscoverService(java.lang.String domain, ExchangeVersion requestedServerVersion) throws ArgumentException
domain
- The domain that will be used to determine the URL of the
service.requestedServerVersion
- The requested server version.
ArgumentException
public AutodiscoverService(java.net.URI url) throws ArgumentException
url
- The URL of the service.
ArgumentException
public AutodiscoverService(java.net.URI url, ExchangeVersion requestedServerVersion) throws ArgumentException
url
- The URL of the service.requestedServerVersion
- The requested server version.
ArgumentException
protected AutodiscoverService(java.net.URI url, java.lang.String domain) throws ArgumentException
url
- The URL of the service.domain
- The domain that will be used to determine the URL of the
service.
ArgumentException
protected AutodiscoverService(java.net.URI url, java.lang.String domain, ExchangeVersion requestedServerVersion) throws ArgumentException
url
- The URL of the service.domain
- The domain that will be used to determine the URL of the
service.requestedServerVersion
- The requested server version.
ArgumentException
protected AutodiscoverService(ExchangeServiceBase service, ExchangeVersion requestedServerVersion)
service
- The other service.requestedServerVersion
- The requested server version.protected AutodiscoverService(ExchangeServiceBase service)
service
- The service.Method Detail |
---|
protected <TSettings extends microsoft.exchange.webservices.data.ConfigurationSettingsBase> TSettings getLegacyUserSettings(java.lang.Class<TSettings> cls, java.lang.String emailAddress) throws java.lang.Exception
TSettings
- the generic typecls
- the clsemailAddress
- The email address to retrieve configuration settings for.
java.lang.Exception
- the exceptionprotected java.net.URI getRedirectionUrlFromDnsSrvRecord(java.lang.String domainName) throws java.lang.Exception
domainName
- Name of the domain.
java.lang.Exception
- the exceptionprotected GetUserSettingsResponse internalGetLegacyUserSettings(java.lang.String emailAddress, java.util.List<UserSettingName> requestedSettings) throws java.lang.Exception
emailAddress
- The email address to use.requestedSettings
- The requested settings.
java.lang.Exception
protected GetUserSettingsResponse internalGetSoapUserSettings(java.lang.String smtpAddress, java.util.List<UserSettingName> requestedSettings) throws java.lang.Exception
smtpAddress
- SMTP address.requestedSettings
- The requested settings.
java.lang.Exception
protected GetUserSettingsResponseCollection getUserSettings(java.util.List<java.lang.String> smtpAddresses, java.util.List<UserSettingName> settings) throws java.lang.Exception
smtpAddresses
- The SMTP addresses of the users.settings
- The settings.
java.lang.Exception
- the exceptionprotected GetDomainSettingsResponseCollection getDomainSettings(java.util.List<java.lang.String> domains, java.util.List<DomainSettingName> settings, ExchangeVersion requestedVersion) throws java.lang.Exception
domains
- The domains.settings
- The settings.requestedVersion
- Requested version of the Exchange service.
java.lang.Exception
- the exceptionprotected java.util.List<java.net.URI> getAutodiscoverServiceUrls(java.lang.String domainName, OutParam<java.lang.Integer> scpHostCount) throws java.net.URISyntaxException
domainName
- Domain name.scpHostCount
- Count of hosts found via SCP lookup.
java.net.URISyntaxException
- the URI Syntax exceptionprotected java.util.List<java.lang.String> getAutodiscoverServiceHosts(java.lang.String domainName, OutParam<java.lang.Integer> outParam) throws java.net.URISyntaxException, java.lang.ClassNotFoundException
domainName
- Domain name.outParam
- the out param
java.net.URISyntaxException
- the uRI syntax exception
java.lang.ClassNotFoundException
- the class not found exceptionprotected void traceResponse(microsoft.exchange.webservices.data.HttpWebRequest request, java.io.ByteArrayOutputStream memoryStream) throws javax.xml.stream.XMLStreamException, java.io.IOException, EWSHttpException
request
- the requestmemoryStream
- the memory stream
javax.xml.stream.XMLStreamException
- the xML stream exception
java.io.IOException
- Signals that an I/O exception has occurred.
EWSHttpException
- the eWS http exceptionprotected microsoft.exchange.webservices.data.HttpWebRequest prepareHttpWebRequestForUrl(java.net.URI url) throws ServiceLocalException, java.net.URISyntaxException
url
- The URL that the HttpWebRequest should target.
ServiceLocalException
- the service local exception
java.net.URISyntaxException
- the uRI syntax exceptionprotected void processHttpErrorResponse(microsoft.exchange.webservices.data.HttpWebRequest httpWebResponse, java.lang.Exception webException) throws java.lang.Exception
processHttpErrorResponse
in class ExchangeServiceBase
httpWebResponse
- The HTTP web response.
java.lang.Exception
- the exceptionpublic boolean autodiscoverRedirectionUrlValidationCallback(java.lang.String redirectionUrl) throws AutodiscoverLocalException
IAutodiscoverRedirectionUrl
autodiscoverRedirectionUrlValidationCallback
in interface IAutodiscoverRedirectionUrl
redirectionUrl
- the redirection url
AutodiscoverLocalException
- the autodiscover local exceptionpublic GetUserSettingsResponse getUserSettings(java.lang.String userSmtpAddress, UserSettingName... userSettingNames) throws java.lang.Exception
userSmtpAddress
- The SMTP addresses of the user.userSettingNames
- The user setting names.
java.lang.Exception
- the exception
This method handles will run the entire Autodiscover "discovery"
algorithm and will follow address and URL redirections.public GetUserSettingsResponseCollection getUsersSettings(java.lang.Iterable<java.lang.String> userSmtpAddresses, UserSettingName... userSettingNames) throws java.lang.Exception
userSmtpAddresses
- the user smtp addressesuserSettingNames
- The user setting names.
java.lang.Exception
- the exceptionpublic GetDomainSettingsResponse getDomainSettings(java.lang.String domain, ExchangeVersion requestedVersion, DomainSettingName... domainSettingNames) throws java.lang.Exception
domain
- The domain.requestedVersion
- Requested version of the Exchange service.domainSettingNames
- The domain setting names.
java.lang.Exception
- the exceptionpublic GetDomainSettingsResponseCollection getDomainSettings(java.lang.Iterable<java.lang.String> domains, ExchangeVersion requestedVersion, DomainSettingName... domainSettingNames) throws java.lang.Exception
domains
- the domainsrequestedVersion
- Requested version of the Exchange service.domainSettingNames
- The domain setting names.
java.lang.Exception
- the exceptionpublic java.lang.String getDomain()
public void setDomain(java.lang.String value) throws ArgumentException
value
- the new domain
ArgumentException
public java.net.URI getUrl()
public void setUrl(java.net.URI value)
value
- the new urlpublic java.lang.Boolean isExternal()
protected void setIsExternal(java.lang.Boolean value)
public IAutodiscoverRedirectionUrl getRedirectionUrlValidationCallback()
public void setRedirectionUrlValidationCallback(IAutodiscoverRedirectionUrl value)
value
- the new redirection url validation callbackprotected java.lang.String getDnsServerAddress()
protected void setDnsServerAddress(java.lang.String value)
value
- the new dns server addresspublic boolean getEnableScpLookup()
public void setEnableScpLookup(boolean value)
value
- the new enable scp lookuppublic java.lang.Object func(java.util.List arg1, java.util.List arg2, ExchangeVersion arg3, java.net.URI arg4) throws ServiceLocalException, java.lang.Exception
arg1
- the arg1arg2
- the arg2arg3
- the arg3
ServiceLocalException
- the service local exception
javax.xml.stream.XMLStreamException
- the xML stream exception
java.io.IOException
- Signals that an I/O exception has occurred.
java.lang.Exception
- the exception
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |