microsoft.exchange.webservices.data.autodiscover.request
Class GetUserSettingsRequest

java.lang.Object
  microsoft.exchange.webservices.data.autodiscover.request.AutodiscoverRequest
      microsoft.exchange.webservices.data.autodiscover.request.GetUserSettingsRequest

public class GetUserSettingsRequest
extends AutodiscoverRequest

Represents a GetUserSettings request.

Constructor Summary

GetUserSettingsRequest(AutodiscoverService service, URI url)
Initializes a new instance of the GetUserSettingsRequest class.

GetUserSettingsRequest(AutodiscoverService service, URI url, boolean expectPartnerToken)
Initializes a new instance of the GetUserSettingsRequest class.

Method Summary

protected AutodiscoverResponse	createServiceResponse() Creates the service response.
GetUserSettingsResponseCollection	execute() Executes this instance.
protected String	getPartnerToken() Gets the partner token.
protected String	getPartnerTokenReference() Gets the partner token reference.
protected String	getRequestXmlElementName() Gets the name of the request XML element.
protected String	getResponseXmlElementName() Gets the name of the response XML element.
protected List<UserSettingName>	getSettings() Gets the settings.
protected List<String>	getSmtpAddresses() Gets the SMTP addresses.
protected String	getWsAddressingActionName() Gets the WS-Addressing action name.
protected void	readSoapHeader(EwsXmlReader reader) Read the partner token soap header.
void	setSettings(List<UserSettingName> value) Sets the settings.
void	setSmtpAddresses(List<String> value) Sets the smtp addresses.
protected void	validate() Validates the request.
protected void	writeAttributesToXml(EwsServiceXmlWriter writer) Writes the attribute to XML.
protected void	writeElementsToXml(EwsServiceXmlWriter writer) Writes request to XML.
void	writeExtraCustomSoapHeadersToXml(EwsServiceXmlWriter writer) Write extra headers.

Methods inherited from class microsoft.exchange.webservices.data.autodiscover.request.AutodiscoverRequest

getResponseStream, getService, getUrl, internalExecute, isRedirectionResponse, loadFromXml, readSoapBody, readSoapHeaders, writeBodyToXml, writeSoapRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetUserSettingsRequest

public GetUserSettingsRequest(AutodiscoverService service,
                              URI url)
                       throws ServiceValidationException

Initializes a new instance of the GetUserSettingsRequest class.

Parameters:

service - the service

url - the url

Throws:

ServiceValidationException - on validation error

GetUserSettingsRequest

public GetUserSettingsRequest(AutodiscoverService service,
                              URI url,
                              boolean expectPartnerToken)
                       throws ServiceValidationException

Initializes a new instance of the GetUserSettingsRequest class.

Parameters:

service - autodiscover service associated with this request

url - URL of Autodiscover service

expectPartnerToken - expect partner token or not

Throws:

ServiceValidationException - on validation error

Method Detail

validate

protected void validate()
                 throws Exception

Validates the request.

Overrides:

validate in class AutodiscoverRequest

Throws:

Exception - the exception

execute

public GetUserSettingsResponseCollection execute()
                                          throws Exception

Executes this instance.

Returns:

the gets the user settings response collection

Throws:

Exception - the exception

getRequestXmlElementName

protected String getRequestXmlElementName()

Gets the name of the request XML element.

Specified by:

getRequestXmlElementName in class AutodiscoverRequest

Returns:

Request XML element name.

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class AutodiscoverRequest

Returns:

Response XML element name.

getWsAddressingActionName

protected String getWsAddressingActionName()

Gets the WS-Addressing action name.

Specified by:

getWsAddressingActionName in class AutodiscoverRequest

Returns:

WS-Addressing action name.

createServiceResponse

protected AutodiscoverResponse createServiceResponse()

Creates the service response.

Specified by:

createServiceResponse in class AutodiscoverRequest

Returns:

AutodiscoverResponse

writeAttributesToXml

protected void writeAttributesToXml(EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

Writes the attribute to XML.

Specified by:

writeAttributesToXml in class AutodiscoverRequest

Parameters:

writer - The writer.

Throws:

ServiceXmlSerializationException - the service xml serialization exception

writeExtraCustomSoapHeadersToXml

public void writeExtraCustomSoapHeadersToXml(EwsServiceXmlWriter writer)
                                      throws XMLStreamException,
                                             ServiceXmlSerializationException

Description copied from class: AutodiscoverRequest

Write extra headers.

Overrides:

writeExtraCustomSoapHeadersToXml in class AutodiscoverRequest

Parameters:

writer - XML writer

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws XMLStreamException,
                                  ServiceXmlSerializationException

Writes request to XML.

Specified by:

writeElementsToXml in class AutodiscoverRequest

Parameters:

writer - the writer

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

readSoapHeader

protected void readSoapHeader(EwsXmlReader reader)
                       throws Exception

Read the partner token soap header.

Overrides:

readSoapHeader in class AutodiscoverRequest

Parameters:

reader - EWS XML reader

Throws:

Exception - on error

getSmtpAddresses

protected List<String> getSmtpAddresses()

Gets the SMTP addresses.

Returns:

the SMTP addresses

setSmtpAddresses

public void setSmtpAddresses(List<String> value)

Sets the smtp addresses.

Parameters:

value - the new smtp addresses

getSettings

protected List<UserSettingName> getSettings()

Gets the settings.

Returns:

the settings

setSettings

public void setSettings(List<UserSettingName> value)

Sets the settings.

Parameters:

value - the new settings

getPartnerToken

protected String getPartnerToken()

Gets the partner token.

Returns:

partner token

getPartnerTokenReference

protected String getPartnerTokenReference()

Gets the partner token reference.

Returns:

partner token reference