EWSMethod (DavMail POP/IMAP/SMTP/Caldav/Carddav/LDAP Exchange and Office 365 Gateway 6.2.2 API)

java.lang.Object
- org.apache.http.message.AbstractHttpMessage
- - org.apache.http.client.methods.AbstractExecutionAwareRequest
  - - org.apache.http.client.methods.HttpRequestBase
    - - org.apache.http.client.methods.HttpEntityEnclosingRequestBase
      - org.apache.http.client.methods.HttpPost
        
        davmail.exchange.ews.EWSMethod

All Implemented Interfaces:

Cloneable, org.apache.http.client.methods.AbortableHttpRequest, org.apache.http.client.methods.Configurable, org.apache.http.client.methods.HttpExecutionAware, org.apache.http.client.methods.HttpUriRequest, org.apache.http.client.ResponseHandler<EWSMethod>, org.apache.http.HttpEntityEnclosingRequest, org.apache.http.HttpMessage, org.apache.http.HttpRequest

Direct Known Subclasses:

ConvertIdMethod, CopyItemMethod, CreateAttachmentMethod, CreateFolderMethod, CreateItemMethod, DeleteAttachmentMethod, DeleteFolderMethod, DeleteItemMethod, ExpandDLMethod, FindFolderMethod, FindItemMethod, GetAttachmentMethod, GetFolderMethod, GetItemMethod, GetUserAvailabilityMethod, GetUserConfigurationMethod, GetUserPhotoMethod, MoveFolderMethod, MoveItemMethod, ResolveNamesMethod, UpdateFolderMethod, UpdateItemMethod
```
public abstract class EWSMethod
extends org.apache.http.client.methods.HttpPost
implements org.apache.http.client.ResponseHandler<EWSMethod>
```
EWS SOAP method.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EWSMethod.Attendee` Meeting attendee object
`static class`	`EWSMethod.Item` Item
`static class`	`EWSMethod.Occurrence` Recurring event occurrence

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<FieldURI>`	`additionalProperties`
`protected FileAttachment`	`attachment`
`protected String`	`attachmentId`
`protected long`	`backOffMilliseconds`
`protected BaseShape`	`baseShape`
`protected static int`	`CHUNK_LENGTH`
`protected static String`	`CONTENT_TYPE`
`protected Disposal`	`deleteType`
`protected String`	`errorDescription`
`protected String`	`errorDetail`
`protected String`	`errorValue`
`protected FieldOrder`	`fieldOrder`
`protected FolderId`	`folderId`
`protected boolean`	`includeMimeContent`
`protected boolean`	`includesLastItemInRange`
`protected EWSMethod.Item`	`item`
`protected ItemId`	`itemId`
`protected List<ItemId>`	`itemIds`
`protected String`	`itemType`
`protected static org.apache.log4j.Logger`	`LOGGER`
`protected int`	`maxCount`
`protected String`	`methodName`
`protected Set<AttributeOption>`	`methodOptions`
`protected int`	`offset`
`protected FolderId`	`parentFolderId`
`protected ItemId`	`parentItemId`
`protected String`	`responseCollectionName`
`protected List<EWSMethod.Item>`	`responseItems`
`protected FolderId`	`savedItemFolderId`
`protected SearchExpression`	`searchExpression`
`protected String`	`serverVersion`
`protected String`	`timezoneContext`
`protected FolderId`	`toFolderId`
`protected FolderQueryTraversal`	`traversal`
`protected ElementOption`	`unresolvedEntry`
`protected List<FieldUpdate>`	`updates`

Fields inherited from class org.apache.http.client.methods.HttpPost
METHOD_NAME

Fields inherited from class org.apache.http.message.AbstractHttpMessage
headergroup, params

Constructor Summary

Constructors
Constructor and Description
`EWSMethod(String itemType, String methodName)` Build EWS method
`EWSMethod(String itemType, String methodName, String responseCollectionName)` Build EWS method

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAdditionalProperty(FieldURI additionalProperty)`
`protected void`	`addExtendedPropertyValue(XMLStreamReader reader, EWSMethod.Item item)`
`protected void`	`addMethodOption(AttributeOption attributeOption)`
`void`	`checkSuccess()` Check method success.
`protected void`	`endChanges(Writer writer)`
`protected byte[]`	`generateSoapEnvelope()`
`protected String`	`getAttributeValue(XMLStreamReader reader, String attributeName)`
`byte[]`	`getMimeContent()` Get response mime content.
`EWSMethod.Item`	`getResponseItem()` Get single response item.
`List<EWSMethod.Item>`	`getResponseItems()` Get response items.
`String`	`getServerVersion()` Get Exchange server version, Exchange2013, Exchange2010 or Exchange2007_SP1
`int`	`getStatusCode()`
`protected String`	`getTagContent(XMLStreamReader reader)`
`protected List<FileAttachment>`	`handleAttachments(XMLStreamReader reader)`
`protected void`	`handleAttendee(XMLStreamReader reader, EWSMethod.Item item, String attendeeType)`
`protected void`	`handleAttendees(XMLStreamReader reader, EWSMethod.Item item, String attendeeType)`
`protected void`	`handleCustom(XMLStreamReader reader)`
`protected void`	`handleEmailAddresses(XMLStreamReader reader, EWSMethod.Item item)`
`protected void`	`handleErrors(XMLStreamReader reader)`
`protected FileAttachment`	`handleFileAttachment(XMLStreamReader reader)`
`protected EWSMethod.Item`	`handleItem(XMLStreamReader reader)`
`protected void`	`handleMember(XMLStreamReader reader, EWSMethod.Item responseItem)`
`protected void`	`handleMembers(XMLStreamReader reader, EWSMethod.Item responseItem)`
`protected void`	`handleMimeContent(XMLStreamReader reader, EWSMethod.Item responseItem)`
`protected void`	`handleModifiedOccurrences(XMLStreamReader reader, EWSMethod.Item item)`
`protected void`	`handleOccurrence(XMLStreamReader reader, EWSMethod.Item item)`
`EWSMethod`	`handleResponse(org.apache.http.HttpResponse response)`
`protected String`	`handleTag(XMLStreamReader reader, String localName)`
`protected void`	`processResponseStream(InputStream inputStream)`
`static String`	`responseTypeToPartstat(String responseType)` Convert response type to partstat value
`protected void`	`setFieldOrder(FieldOrder fieldOrder)`
`protected void`	`setSearchExpression(SearchExpression searchExpression)`
`void`	`setServerVersion(String serverVersion)` Set Exchange server version, Exchange2010 or Exchange2007_SP1
`void`	`setTimezoneContext(String timezoneContext)` Set Exchange timezone context
`protected void`	`startChanges(Writer writer)`
`protected void`	`writeAttachmentId(Writer writer)`
`protected void`	`writeAttachments(Writer writer)`
`protected void`	`writeFolderId(Writer writer)`
`protected void`	`writeIndexedPageView(Writer writer)`
`protected void`	`writeItem(Writer writer)`
`protected void`	`writeItemId(Writer writer)`
`protected void`	`writeParentFolderId(Writer writer)`
`protected void`	`writeParentItemId(Writer writer)`
`protected void`	`writeRestriction(Writer writer)`
`protected void`	`writeSavedItemFolderId(Writer writer)`
`protected void`	`writeShape(Writer writer)`
`protected void`	`writeSoapBody(Writer writer)`
`protected void`	`writeSortOrder(Writer writer)`
`protected void`	`writeToFolderId(Writer writer)`
`protected void`	`writeUnresolvedEntry(Writer writer)`
`protected void`	`writeUpdates(Writer writer)`

Methods inherited from class org.apache.http.client.methods.HttpPost
getMethod

Methods inherited from class org.apache.http.client.methods.HttpEntityEnclosingRequestBase
clone, expectContinue, getEntity, setEntity

Methods inherited from class org.apache.http.client.methods.HttpRequestBase
getConfig, getProtocolVersion, getRequestLine, getURI, releaseConnection, setConfig, setProtocolVersion, setURI, started, toString

Methods inherited from class org.apache.http.client.methods.AbstractExecutionAwareRequest
abort, completed, isAborted, reset, setCancellable, setConnectionRequest, setReleaseTrigger

Methods inherited from class org.apache.http.message.AbstractHttpMessage
addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.http.HttpRequest
getRequestLine

Methods inherited from interface org.apache.http.HttpMessage
addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, getProtocolVersion, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Methods inherited from interface org.apache.http.client.methods.HttpUriRequest
abort, isAborted

Field Detail

CONTENT_TYPE

protected static final String CONTENT_TYPE

LOGGER

protected static final org.apache.log4j.Logger LOGGER

CHUNK_LENGTH
```
protected static final int CHUNK_LENGTH
```
See Also:

Constant Field Values

traversal

protected FolderQueryTraversal traversal

baseShape
```
protected BaseShape baseShape
```

includeMimeContent
```
protected boolean includeMimeContent
```

folderId
```
protected FolderId folderId
```

savedItemFolderId
```
protected FolderId savedItemFolderId
```

toFolderId
```
protected FolderId toFolderId
```

parentFolderId
```
protected FolderId parentFolderId
```

itemId
```
protected ItemId itemId
```

itemIds
```
protected List<ItemId> itemIds
```

parentItemId
```
protected ItemId parentItemId
```

additionalProperties

protected Set<FieldURI> additionalProperties

deleteType
```
protected Disposal deleteType
```

methodOptions

protected Set<AttributeOption> methodOptions

unresolvedEntry

protected ElementOption unresolvedEntry

maxCount
```
protected int maxCount
```

offset
```
protected int offset
```

includesLastItemInRange

protected boolean includesLastItemInRange

updates
```
protected List<FieldUpdate> updates
```

attachment
```
protected FileAttachment attachment
```

attachmentId
```
protected String attachmentId
```

itemType
```
protected final String itemType
```

methodName
```
protected final String methodName
```

responseCollectionName

protected final String responseCollectionName

responseItems

protected List<EWSMethod.Item> responseItems

errorDetail
```
protected String errorDetail
```

errorDescription
```
protected String errorDescription
```

errorValue
```
protected String errorValue
```

backOffMilliseconds
```
protected long backOffMilliseconds
```

item
```
protected EWSMethod.Item item
```

searchExpression

protected SearchExpression searchExpression

fieldOrder
```
protected FieldOrder fieldOrder
```

serverVersion
```
protected String serverVersion
```

timezoneContext
```
protected String timezoneContext
```

Constructor Detail

EWSMethod

public EWSMethod(String itemType,
                 String methodName)

Build EWS method

Parameters:: itemType - item type; methodName - method name

EWSMethod

public EWSMethod(String itemType,
                 String methodName,
                 String responseCollectionName)

Build EWS method

Parameters:: itemType - item type; methodName - method name; responseCollectionName - item response collection name

Method Detail

addAdditionalProperty

protected void addAdditionalProperty(FieldURI additionalProperty)

addMethodOption

protected void addMethodOption(AttributeOption attributeOption)

setSearchExpression

protected void setSearchExpression(SearchExpression searchExpression)

setFieldOrder

protected void setFieldOrder(FieldOrder fieldOrder)

writeShape

protected void writeShape(Writer writer)
                   throws IOException

Throws:: IOException

writeItemId

protected void writeItemId(Writer writer)
                    throws IOException

Throws:: IOException

writeParentItemId

protected void writeParentItemId(Writer writer)
                          throws IOException

Throws:: IOException

writeFolderId

protected void writeFolderId(Writer writer)
                      throws IOException

Throws:: IOException

writeSavedItemFolderId

protected void writeSavedItemFolderId(Writer writer)
                               throws IOException

Throws:: IOException

writeToFolderId

protected void writeToFolderId(Writer writer)
                        throws IOException

Throws:: IOException

writeParentFolderId

protected void writeParentFolderId(Writer writer)
                            throws IOException

Throws:: IOException

writeItem

protected void writeItem(Writer writer)
                  throws IOException

Throws:: IOException

writeRestriction

protected void writeRestriction(Writer writer)
                         throws IOException

Throws:: IOException

writeSortOrder

protected void writeSortOrder(Writer writer)
                       throws IOException

Throws:: IOException

startChanges

protected void startChanges(Writer writer)
                     throws IOException

Throws:: IOException

writeUpdates

protected void writeUpdates(Writer writer)
                     throws IOException

Throws:: IOException

writeUnresolvedEntry

protected void writeUnresolvedEntry(Writer writer)
                             throws IOException

Throws:: IOException

endChanges

protected void endChanges(Writer writer)
                   throws IOException

Throws:: IOException

generateSoapEnvelope

protected byte[] generateSoapEnvelope()

writeSoapBody

protected void writeSoapBody(Writer writer)
                      throws IOException

Throws:: IOException

writeIndexedPageView

protected void writeIndexedPageView(Writer writer)
                             throws IOException

Throws:: IOException

writeAttachmentId

protected void writeAttachmentId(Writer writer)
                          throws IOException

Throws:: IOException

writeAttachments

protected void writeAttachments(Writer writer)
                         throws IOException

Throws:: IOException

getServerVersion
```
public String getServerVersion()
```
Get Exchange server version, Exchange2013, Exchange2010 or Exchange2007_SP1

Returns:

server version

setServerVersion
```
public void setServerVersion(String serverVersion)
```
Set Exchange server version, Exchange2010 or Exchange2007_SP1

Parameters:

serverVersion - server version

setTimezoneContext
```
public void setTimezoneContext(String timezoneContext)
```
Set Exchange timezone context

Parameters:

timezoneContext - user timezone context

checkSuccess

public void checkSuccess()
                  throws EWSException

Check method success.

Throws:: EWSException - on error

getStatusCode
```
public int getStatusCode()
```

getResponseItems

public List<EWSMethod.Item> getResponseItems()
                                      throws EWSException

Get response items.

Returns:: response items
Throws:: EWSException - on error

getResponseItem

public EWSMethod.Item getResponseItem()
                               throws EWSException

Get single response item.

Returns:: response item
Throws:: EWSException - on error

getMimeContent
```
public byte[] getMimeContent()
                      throws EWSException
```
Get response mime content.

Returns:

mime content

Throws:

EWSException - on error

handleTag

protected String handleTag(XMLStreamReader reader,
                           String localName)
                    throws XMLStreamException

Throws:: XMLStreamException

handleErrors

protected void handleErrors(XMLStreamReader reader)
                     throws XMLStreamException

Throws:: XMLStreamException

handleItem

protected EWSMethod.Item handleItem(XMLStreamReader reader)
                             throws XMLStreamException

Throws:: XMLStreamException

handleEmailAddresses

protected void handleEmailAddresses(XMLStreamReader reader,
                                    EWSMethod.Item item)
                             throws XMLStreamException

Throws:: XMLStreamException

handleAttendees

protected void handleAttendees(XMLStreamReader reader,
                               EWSMethod.Item item,
                               String attendeeType)
                        throws XMLStreamException

Throws:: XMLStreamException

handleModifiedOccurrences

protected void handleModifiedOccurrences(XMLStreamReader reader,
                                         EWSMethod.Item item)
                                  throws XMLStreamException

Throws:: XMLStreamException

handleOccurrence

protected void handleOccurrence(XMLStreamReader reader,
                                EWSMethod.Item item)
                         throws XMLStreamException

Throws:: XMLStreamException

handleMembers

protected void handleMembers(XMLStreamReader reader,
                             EWSMethod.Item responseItem)
                      throws XMLStreamException

Throws:: XMLStreamException

handleMember

protected void handleMember(XMLStreamReader reader,
                            EWSMethod.Item responseItem)
                     throws XMLStreamException

Throws:: XMLStreamException

responseTypeToPartstat
```
public static String responseTypeToPartstat(String responseType)
```
Convert response type to partstat value

Parameters:

responseType - response type

Returns:

partstat value

handleAttendee

protected void handleAttendee(XMLStreamReader reader,
                              EWSMethod.Item item,
                              String attendeeType)
                       throws XMLStreamException

Throws:: XMLStreamException

handleAttachments

protected List<FileAttachment> handleAttachments(XMLStreamReader reader)
                                          throws XMLStreamException

Throws:: XMLStreamException

handleFileAttachment

protected FileAttachment handleFileAttachment(XMLStreamReader reader)
                                       throws XMLStreamException

Throws:: XMLStreamException

handleMimeContent

protected void handleMimeContent(XMLStreamReader reader,
                                 EWSMethod.Item responseItem)
                          throws XMLStreamException

Throws:: XMLStreamException

addExtendedPropertyValue

protected void addExtendedPropertyValue(XMLStreamReader reader,
                                        EWSMethod.Item item)
                                 throws XMLStreamException

Throws:: XMLStreamException

getTagContent

protected String getTagContent(XMLStreamReader reader)
                        throws XMLStreamException

Throws:: XMLStreamException

getAttributeValue

protected String getAttributeValue(XMLStreamReader reader,
                                   String attributeName)

handleResponse
```
public EWSMethod handleResponse(org.apache.http.HttpResponse response)
```
Specified by:

handleResponse in interface org.apache.http.client.ResponseHandler<EWSMethod>

processResponseStream

protected void processResponseStream(InputStream inputStream)

handleCustom

protected void handleCustom(XMLStreamReader reader)
                     throws XMLStreamException

Throws:: XMLStreamException

Class EWSMethod

Nested Class Summary

Field Summary

Fields inherited from class org.apache.http.client.methods.HttpPost

Fields inherited from class org.apache.http.message.AbstractHttpMessage

Constructor Summary

Method Summary

Methods inherited from class org.apache.http.client.methods.HttpPost

Methods inherited from class org.apache.http.client.methods.HttpEntityEnclosingRequestBase

Methods inherited from class org.apache.http.client.methods.HttpRequestBase

Methods inherited from class org.apache.http.client.methods.AbstractExecutionAwareRequest

Methods inherited from class org.apache.http.message.AbstractHttpMessage

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.http.HttpRequest

Methods inherited from interface org.apache.http.HttpMessage

Methods inherited from interface org.apache.http.client.methods.HttpUriRequest

Field Detail

CONTENT_TYPE

LOGGER

CHUNK_LENGTH

traversal

baseShape

includeMimeContent

folderId

savedItemFolderId

toFolderId

parentFolderId

itemId

itemIds

parentItemId

additionalProperties

deleteType

methodOptions

unresolvedEntry

maxCount

offset

includesLastItemInRange

updates

attachment

attachmentId

itemType

methodName

responseCollectionName

responseItems

errorDetail

errorDescription

errorValue

backOffMilliseconds

item

searchExpression

fieldOrder

serverVersion

timezoneContext

Constructor Detail

EWSMethod

EWSMethod

Method Detail

addAdditionalProperty

addMethodOption

setSearchExpression

setFieldOrder

writeShape

writeItemId

writeParentItemId

writeFolderId

writeSavedItemFolderId

writeToFolderId

writeParentFolderId

writeItem

writeRestriction

writeSortOrder

startChanges

writeUpdates

writeUnresolvedEntry

endChanges

generateSoapEnvelope

writeSoapBody

writeIndexedPageView

writeAttachmentId

writeAttachments