microsoft.exchange.webservices.data
Class UpdateDelegateRequest

java.lang.Object
  microsoft.exchange.webservices.data.UpdateDelegateRequest

public class UpdateDelegateRequest
extends Object

Represents an UpdateDelegate request.

Constructor Summary

protected

UpdateDelegateRequest(ExchangeService service) Initializes a new instance of the class.

Method Summary

protected microsoft.exchange.webservices.data.DelegateManagementResponse	createResponse() Creates the response.
protected microsoft.exchange.webservices.data.HttpWebRequest	emit(OutParam<microsoft.exchange.webservices.data.HttpWebRequest> request) * Send request and get response.
protected TResponse	execute() Executes this request.
List<DelegateUser>	getDelegateUsers() Gets the delegate users.
Mailbox	getMailbox() Gets the mailbox.
MeetingRequestsDeliveryScope	getMeetingRequestsDeliveryScope() Gets the meeting requests delivery scope.
protected ExchangeVersion	getMinimumRequiredServerVersion() Gets the request version.
protected static InputStream	getResponseStream(microsoft.exchange.webservices.data.HttpWebRequest request) * Gets the response stream (may be wrapped with GZip/Deflate stream to decompress content).
protected String	getResponseXmlElementName() Gets the name of the response XML element.
protected ExchangeService	getService() Gets the service.
protected String	getXmlElementName() Gets the name of the XML element.
protected Object	internalExecute() Execute this request.
protected Object	parseResponse(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) Parses the response.
protected void	readPreamble(microsoft.exchange.webservices.data.EwsServiceXmlReader ewsXmlReader) * Reads any preamble data not part of the core response.
protected Object	readResponse(microsoft.exchange.webservices.data.EwsServiceXmlReader ewsXmlReader) * Reads the response.
protected microsoft.exchange.webservices.data.SoapFaultDetails	readSoapFault(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) Reads the SOAP fault.
void	setMailbox(Mailbox mailbox) Sets the mailbox.
void	setMeetingRequestsDeliveryScope(MeetingRequestsDeliveryScope value) Sets the meeting requests delivery scope.
protected void	throwIfNotSupportedByRequestedServerVersion() * Throw exception if request is not supported in requested server version.
protected void	traceResponse(microsoft.exchange.webservices.data.HttpWebRequest request, ByteArrayOutputStream memoryStream) * Traces the response.
protected void	validate() Validate request..
protected microsoft.exchange.webservices.data.HttpWebRequest	validateAndEmitRequest(OutParam<microsoft.exchange.webservices.data.HttpWebRequest> request) * Validates request parameters, and emits the request to the server.
protected void	writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) * Writes XML attributes.
protected void	writeBodyToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) * Writes XML body.
protected void	writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) Writes XML elements.
protected void	writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) * Writes XML.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateDelegateRequest

protected UpdateDelegateRequest(ExchangeService service)
                         throws Exception

Initializes a new instance of the class.

Parameters:

service - the service

Throws:

Exception

Method Detail

validate

protected void validate()
                 throws Exception

Validate request..

Throws:

Exception - the exception

writeElementsToXml

protected void writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                           throws Exception

Writes XML elements.

Parameters:

writer - the writer

Throws:

Exception - the exception

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Returns:

XML element name.

createResponse

protected microsoft.exchange.webservices.data.DelegateManagementResponse createResponse()

Creates the response.

Returns:

Response object.

getXmlElementName

protected String getXmlElementName()

Gets the name of the XML element.

Returns:

Xml element name.

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Returns:

Earliest Exchange version in which this request is supported.

getMeetingRequestsDeliveryScope

public MeetingRequestsDeliveryScope getMeetingRequestsDeliveryScope()

Gets the meeting requests delivery scope. The meeting requests delivery scope.

Returns:

the meeting requests delivery scope

setMeetingRequestsDeliveryScope

public void setMeetingRequestsDeliveryScope(MeetingRequestsDeliveryScope value)

Sets the meeting requests delivery scope.

Parameters:

value - the new meeting requests delivery scope

getDelegateUsers

public List<DelegateUser> getDelegateUsers()

Gets the delegate users. The delegate users.

Returns:

the delegate users

parseResponse

protected Object parseResponse(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                        throws Exception

Parses the response.

Parameters:

reader - the reader

Returns:

Response object.

Throws:

Exception - the exception

execute

protected TResponse execute()
                                                                                            throws Exception

Executes this request.

Returns:

Response object.

Throws:

Exception - the exception

getMailbox

public Mailbox getMailbox()

Gets the mailbox. The mailbox.

Returns:

the mailbox

setMailbox

public void setMailbox(Mailbox mailbox)

Sets the mailbox.

Parameters:

mailbox - the new mailbox

internalExecute

protected Object internalExecute()
                          throws ServiceLocalException,
                                 Exception

Execute this request.

Throws:

Exception

ServiceLocalException

writeBodyToXml

protected void writeBodyToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                       throws Exception

* Writes XML body.

Parameters:

writer - The writer.

Throws:

Exception - the exception

writeAttributesToXml

protected void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

* Writes XML attributes. Subclass will override if it has XML attributes.

Parameters:

writer - The writer.

Throws:

ServiceXmlSerializationException - the service xml serialization exception

getService

protected ExchangeService getService()

Gets the service.

Returns:

The service.

throwIfNotSupportedByRequestedServerVersion

protected void throwIfNotSupportedByRequestedServerVersion()
                                                    throws ServiceVersionException

* Throw exception if request is not supported in requested server version.

Throws:

ServiceVersionException - the service version exception

writeToXml

protected void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                   throws Exception

* Writes XML.

Parameters:

writer - The writer.

Throws:

Exception - the exception

emit

protected microsoft.exchange.webservices.data.HttpWebRequest emit(OutParam<microsoft.exchange.webservices.data.HttpWebRequest> request)
                                                           throws Exception

* Send request and get response.

Returns:

HttpWebRequest object from which response stream can be read.

Throws:

Exception - the exception

getResponseStream

protected static InputStream getResponseStream(microsoft.exchange.webservices.data.HttpWebRequest request)
                                        throws IOException,
                                               EWSHttpException

* Gets the response stream (may be wrapped with GZip/Deflate stream to decompress content).

Parameters:

request - HttpWebRequest object from which response stream can be read.

Returns:

ResponseStream

Throws:

IOException - Signals that an I/O exception has occurred.

EWSHttpException - the eWS http exception

traceResponse

protected void traceResponse(microsoft.exchange.webservices.data.HttpWebRequest request,
                             ByteArrayOutputStream memoryStream)
                      throws XMLStreamException,
                             IOException,
                             EWSHttpException

* Traces the response.

Parameters:

request - The response.

memoryStream - The response content in a MemoryStream.

Throws:

XMLStreamException - the xML stream exception

IOException - Signals that an I/O exception has occurred.

EWSHttpException - the eWS http exception

readResponse

protected Object readResponse(microsoft.exchange.webservices.data.EwsServiceXmlReader ewsXmlReader)
                       throws Exception

* Reads the response.

Parameters:

ewsXmlReader - The XML reader.

Returns:

Service response.

Throws:

Exception - the exception

readPreamble

protected void readPreamble(microsoft.exchange.webservices.data.EwsServiceXmlReader ewsXmlReader)
                     throws Exception

* Reads any preamble data not part of the core response.

Parameters:

ewsXmlReader - The EwsServiceXmlReader.

Throws:

Exception

readSoapFault

protected microsoft.exchange.webservices.data.SoapFaultDetails readSoapFault(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)

Reads the SOAP fault.

Parameters:

reader - The reader.

Returns:

SOAP fault details.

validateAndEmitRequest

protected microsoft.exchange.webservices.data.HttpWebRequest validateAndEmitRequest(OutParam<microsoft.exchange.webservices.data.HttpWebRequest> request)
                                                                             throws ServiceLocalException,
                                                                                    Exception

* Validates request parameters, and emits the request to the server.

Parameters:

request - The request.

Returns:

The response returned by the server.

Throws:

ServiceLocalException

Exception