davmail.exchange.ews
Class EWSMethod

java.lang.Object
  org.apache.commons.httpclient.HttpMethodBase
      org.apache.commons.httpclient.methods.ExpectContinueMethod
          org.apache.commons.httpclient.methods.EntityEnclosingMethod
              org.apache.commons.httpclient.methods.PostMethod
                  davmail.exchange.ews.EWSMethod

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod

Direct Known Subclasses:

CopyItemMethod, CreateAttachmentMethod, CreateFolderMethod, CreateItemMethod, DeleteAttachmentMethod, DeleteFolderMethod, DeleteItemMethod, FindFolderMethod, FindItemMethod, GetAttachmentMethod, GetFolderMethod, GetItemMethod, GetUserAvailabilityMethod, GetUserConfigurationMethod, MoveFolderMethod, MoveItemMethod, ResolveNamesMethod, UpdateFolderMethod, UpdateItemMethod

public abstract class EWSMethod
extends org.apache.commons.httpclient.methods.PostMethod

EWS SOAP method.

Nested Class Summary

static class	EWSMethod.Attendee Meeting attendee object
static class	EWSMethod.Item Item
static class	EWSMethod.Occurrence Recurring event occurrence

Field Summary

protected Set<FieldURI>	additionalProperties
protected FileAttachment	attachment
protected String	attachmentId
protected BaseShape	baseShape
protected Disposal	deleteType
protected String	errorDescription
protected String	errorDetail
protected FieldOrder	fieldOrder
protected FolderId	folderId
protected boolean	includeMimeContent
protected boolean	includesLastItemInRange
protected EWSMethod.Item	item
protected ItemId	itemId
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.commons.httpclient.methods.PostMethod

FORM_URL_ENCODED_CONTENT_TYPE

Fields inherited from class org.apache.commons.httpclient.methods.EntityEnclosingMethod

CONTENT_LENGTH_AUTO, CONTENT_LENGTH_CHUNKED

Fields inherited from class org.apache.commons.httpclient.HttpMethodBase

effectiveVersion, statusLine

Constructor Summary

EWSMethod(String itemType, String methodName)
Build EWS method

EWSMethod(String itemType, String methodName, String responseCollectionName)
Build EWS method

Method Summary

protected void	addAdditionalProperty(FieldURI additionalProperty)
protected void	addExtendedPropertyValue(javax.xml.stream.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(javax.xml.stream.XMLStreamReader reader, String attributeName)
byte[]	getMimeContent() Get response mime content.
String	getName()
EWSMethod.Item	getResponseItem() Get single response item.
List<EWSMethod.Item>	getResponseItems() Get response items.
String	getServerVersion() Get Exchange server version, Exchange2010 or Exchange2007_SP1
int	getStatusCode()
protected String	getTagContent(javax.xml.stream.XMLStreamReader reader)
protected List<FileAttachment>	handleAttachments(javax.xml.stream.XMLStreamReader reader)
protected void	handleAttendee(javax.xml.stream.XMLStreamReader reader, EWSMethod.Item item, String attendeeType)
protected void	handleAttendees(javax.xml.stream.XMLStreamReader reader, EWSMethod.Item item, String attendeeType)
protected void	handleCustom(javax.xml.stream.XMLStreamReader reader)
protected void	handleEmailAddresses(javax.xml.stream.XMLStreamReader reader, EWSMethod.Item item)
protected void	handleErrors(javax.xml.stream.XMLStreamReader reader)
protected FileAttachment	handleFileAttachment(javax.xml.stream.XMLStreamReader reader)
protected EWSMethod.Item	handleItem(javax.xml.stream.XMLStreamReader reader)
protected void	handleMimeContent(javax.xml.stream.XMLStreamReader reader, EWSMethod.Item responseItem)
protected void	handleModifiedOccurrences(javax.xml.stream.XMLStreamReader reader, EWSMethod.Item item)
protected void	handleOccurrence(javax.xml.stream.XMLStreamReader reader, EWSMethod.Item item)
protected String	handleTag(javax.xml.stream.XMLStreamReader reader, String localName)
protected void	processResponseBody(org.apache.commons.httpclient.HttpState httpState, org.apache.commons.httpclient.HttpConnection httpConnection)
protected void	processResponseStream(InputStream inputStream)
static String	responseTypeToPartstat(String responseType)
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	writeIndexedPageItemView(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.commons.httpclient.methods.PostMethod

addParameter, addParameter, addParameters, clearRequestBody, generateRequestEntity, getParameter, getParameters, hasRequestContent, removeParameter, removeParameter, setParameter, setRequestBody

Methods inherited from class org.apache.commons.httpclient.methods.EntityEnclosingMethod

addContentLengthRequestHeader, addRequestHeaders, generateRequestBody, getFollowRedirects, getRequestCharSet, getRequestContentLength, getRequestEntity, recycle, setContentChunked, setFollowRedirects, setRequestBody, setRequestBody, setRequestContentLength, setRequestContentLength, setRequestEntity, writeRequestBody

Methods inherited from class org.apache.commons.httpclient.methods.ExpectContinueMethod

getUseExpectHeader, setUseExpectHeader

Methods inherited from class org.apache.commons.httpclient.HttpMethodBase

abort, addCookieRequestHeader, addHostRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, execute, generateRequestLine, getAuthenticationRealm, getContentCharSet, getDoAuthentication, getEffectiveVersion, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getParams, getPath, getProxyAuthenticationRealm, getProxyAuthState, getQueryString, getRecoverableExceptionCount, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isConnectionCloseForced, isHttp11, isRequestSent, isStrictMode, processCookieHeaders, processResponseHeaders, processStatusLine, readResponse, readResponseBody, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setResponseStream, setStrictMode, setURI, shouldCloseConnection, validate, writeRequest, writeRequestHeaders, writeRequestLine

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.apache.log4j.Logger LOGGER

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

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

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

getName

public String getName()

Specified by:

getName in interface org.apache.commons.httpclient.HttpMethod

Overrides:

getName in class org.apache.commons.httpclient.methods.PostMethod

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

writeIndexedPageItemView

protected void writeIndexedPageItemView(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, 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()

Specified by:

getStatusCode in interface org.apache.commons.httpclient.HttpMethod

Overrides:

getStatusCode in class org.apache.commons.httpclient.HttpMethodBase

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(javax.xml.stream.XMLStreamReader reader,
                           String localName)
                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

handleErrors

protected void handleErrors(javax.xml.stream.XMLStreamReader reader)
                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

handleItem

protected EWSMethod.Item handleItem(javax.xml.stream.XMLStreamReader reader)
                             throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

handleEmailAddresses

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

Throws:

javax.xml.stream.XMLStreamException

handleAttendees

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

Throws:

javax.xml.stream.XMLStreamException

handleModifiedOccurrences

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

Throws:

javax.xml.stream.XMLStreamException

handleOccurrence

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

Throws:

javax.xml.stream.XMLStreamException

responseTypeToPartstat

public static String responseTypeToPartstat(String responseType)

handleAttendee

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

Throws:

javax.xml.stream.XMLStreamException

handleAttachments

protected List<FileAttachment> handleAttachments(javax.xml.stream.XMLStreamReader reader)
                                          throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

handleFileAttachment

protected FileAttachment handleFileAttachment(javax.xml.stream.XMLStreamReader reader)
                                       throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

handleMimeContent

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

Throws:

javax.xml.stream.XMLStreamException

addExtendedPropertyValue

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

Throws:

javax.xml.stream.XMLStreamException

getTagContent

protected String getTagContent(javax.xml.stream.XMLStreamReader reader)
                        throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getAttributeValue

protected String getAttributeValue(javax.xml.stream.XMLStreamReader reader,
                                   String attributeName)

processResponseBody

protected void processResponseBody(org.apache.commons.httpclient.HttpState httpState,
                                   org.apache.commons.httpclient.HttpConnection httpConnection)

Overrides:

processResponseBody in class org.apache.commons.httpclient.HttpMethodBase

processResponseStream

protected void processResponseStream(InputStream inputStream)

handleCustom

protected void handleCustom(javax.xml.stream.XMLStreamReader reader)
                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException