public interface SyncBackend
Modifier and Type | Interface and Description |
---|---|
static interface |
SyncBackend.RequestContext |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DOMAIN_SEPARATOR |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createOrUpdateDataItem(SyncBackend.RequestContext requestContext,
java.lang.String profileName,
SyncCollection collection,
java.lang.String itemId,
IData data) |
java.lang.String |
createOrUpdateFolder(SyncBackend.RequestContext requestContext,
SyncFolder folder) |
void |
deleteDataItem(SyncBackend.RequestContext requestContext,
java.lang.String profileName,
SyncCollection collection,
java.lang.String itemId) |
java.lang.String |
deleteFolder(SyncBackend.RequestContext requestContext,
java.lang.String folderId) |
SyncDataItem |
fetchDataItem(SyncBackend.RequestContext requestContext,
java.lang.String profileName,
SyncCollection collection,
java.lang.String itemId) |
boolean |
folderIsValid(SyncBackend.RequestContext requestContext,
java.lang.String profileName,
SyncCollection collection)
Validates whether folder specified by folderId and collectionType is valid.
|
AttachmentDataT |
getAttachementData(SyncBackend.RequestContext requestContext,
java.lang.String attachmentId) |
GetChangedDataItemsResult |
getChangedDataItems(SyncBackend.RequestContext requestContext,
java.lang.String profileName,
SyncCollection collection,
boolean noData,
int maxItems,
SyncDataItem.State state,
java.util.Set<java.lang.String> excludes) |
java.util.List<SyncFolder> |
getChangedFolders(SyncBackend.RequestContext requestContext,
java.lang.String profileName,
java.lang.String syncKey) |
ClientProfile |
getClientProfile(SyncBackend.RequestContext requestContext,
java.lang.String profileName) |
java.io.File |
getContextTempDir(SyncBackend.RequestContext requestContext,
java.io.File tempDir) |
java.util.List<java.lang.String> |
getDeletedDataItems(SyncBackend.RequestContext requestContext,
java.lang.String profileName,
SyncCollection collection,
java.lang.String syncKeyTo)
Return deleted data items starting from collection.getSyncKey() up to syncKeyTo
|
java.util.List<SyncFolder> |
getDeletedFolders(SyncBackend.RequestContext requestContext,
java.lang.String profileName,
java.lang.String syncKey) |
java.lang.String |
getNextSyncKey(SyncBackend.RequestContext requestContext,
java.lang.String syncKey) |
java.lang.String |
moveDataItem(SyncBackend.RequestContext requestContext,
java.lang.String profileName,
java.lang.String srcFolderId,
java.lang.String dstFolderId,
java.lang.String itemId) |
SyncBackend.RequestContext |
newRequestContext(java.lang.String userId,
java.lang.Object context) |
void |
sendMail(SyncBackend.RequestContext requestContext,
java.io.InputStream mimeMessage) |
void |
setDataItemReadFlag(SyncBackend.RequestContext requestContext,
java.lang.String folderId,
java.lang.String itemId,
boolean read) |
void |
updateClientProfile(SyncBackend.RequestContext requestContext,
ClientProfile clientProfile,
java.util.Set<java.lang.String> folderIds,
boolean noSyncKeys,
boolean noMappings)
Updates the client profile.
|
static final java.lang.String DOMAIN_SEPARATOR
SyncBackend.RequestContext newRequestContext(java.lang.String userId, java.lang.Object context)
java.lang.String getNextSyncKey(SyncBackend.RequestContext requestContext, java.lang.String syncKey) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
SyncDataItem fetchDataItem(SyncBackend.RequestContext requestContext, java.lang.String profileName, SyncCollection collection, java.lang.String itemId) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
java.lang.String moveDataItem(SyncBackend.RequestContext requestContext, java.lang.String profileName, java.lang.String srcFolderId, java.lang.String dstFolderId, java.lang.String itemId) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
AttachmentDataT getAttachementData(SyncBackend.RequestContext requestContext, java.lang.String attachmentId) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
java.lang.String createOrUpdateDataItem(SyncBackend.RequestContext requestContext, java.lang.String profileName, SyncCollection collection, java.lang.String itemId, IData data) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
void deleteDataItem(SyncBackend.RequestContext requestContext, java.lang.String profileName, SyncCollection collection, java.lang.String itemId) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
void setDataItemReadFlag(SyncBackend.RequestContext requestContext, java.lang.String folderId, java.lang.String itemId, boolean read) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
GetChangedDataItemsResult getChangedDataItems(SyncBackend.RequestContext requestContext, java.lang.String profileName, SyncCollection collection, boolean noData, int maxItems, SyncDataItem.State state, java.util.Set<java.lang.String> excludes) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
java.util.List<java.lang.String> getDeletedDataItems(SyncBackend.RequestContext requestContext, java.lang.String profileName, SyncCollection collection, java.lang.String syncKeyTo) throws org.openmdx.base.exception.ServiceException
requestContext
- profileName
- collection
- currentSyncKey
- org.openmdx.base.exception.ServiceException
java.util.List<SyncFolder> getChangedFolders(SyncBackend.RequestContext requestContext, java.lang.String profileName, java.lang.String syncKey) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
java.util.List<SyncFolder> getDeletedFolders(SyncBackend.RequestContext requestContext, java.lang.String profileName, java.lang.String syncKey) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
java.lang.String createOrUpdateFolder(SyncBackend.RequestContext requestContext, SyncFolder folder) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
java.lang.String deleteFolder(SyncBackend.RequestContext requestContext, java.lang.String folderId) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
boolean folderIsValid(SyncBackend.RequestContext requestContext, java.lang.String profileName, SyncCollection collection) throws org.openmdx.base.exception.ServiceException
userId
- folderId
- org.openmdx.base.exception.ServiceException
void sendMail(SyncBackend.RequestContext requestContext, java.io.InputStream mimeMessage) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
java.io.File getContextTempDir(SyncBackend.RequestContext requestContext, java.io.File tempDir) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
ClientProfile getClientProfile(SyncBackend.RequestContext requestContext, java.lang.String profileName) throws org.openmdx.base.exception.ServiceException
org.openmdx.base.exception.ServiceException
void updateClientProfile(SyncBackend.RequestContext requestContext, ClientProfile clientProfile, java.util.Set<java.lang.String> folderIds, boolean noSyncKeys, boolean noMappings) throws org.openmdx.base.exception.ServiceException
requestContext
- request context.clientProfile
- profile.folderIds
- list of folders to be updated. If null all folders are updated.noSyncKeys
- sync keys are not updated if true.noMappings
- mappings are not updated if true.org.openmdx.base.exception.ServiceException
This software is published under the BSD license. Copyright © 2003-${build.year}, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.