|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sap.ip.me.api.sync.SyncManager
Handles synchronization tasks with backend including outbound and inbound processing
Field Summary | |
static java.lang.String |
CONNECTION_TYPE_DISC
Value for Configuration property SYNCSETTINGS_CONNECTION_TYPE. |
static java.lang.String |
CONNECTION_TYPE_HTTP
Value for Configuration property SYNCSETTINGS_CONNECTION_TYPE. |
protected static java.lang.String |
SYNC_PROTOCOL_VERSION
The property tells the framework which internal transport protocol is used. |
Constructor Summary | |
SyncManager()
|
Method Summary | |
static SyncManager |
getInstance()
Gets the only one instance of the SyncManager class |
static int |
getSyncProtocolVersion()
Get version number of used synchronization protocol. |
abstract boolean |
isConnectionTerminatable()
Checks whether the connection to the Mobile Infrastructure Middleware system can be terminated or not. |
boolean |
isFilterOnTimedSync()
Gets the parameter for the Filter on Timed Sync. |
abstract boolean |
isSAPLogonTicketSupportEnabled()
Checks whether the framework is configured for SAP logon ticket support. |
boolean |
isSuppressDownload()
Gets the parameter for the suppress download feature. |
abstract boolean |
isSyncCredentialAvailable()
Checks whether the required synchronization credentials (user ID/synchronization password or SAP logon ticket) are available. |
abstract boolean |
isSyncRunning()
Checks whether a synchronization process (except background synchronizations) is running or not. |
void |
setFilterOnTimedSync(boolean filtered)
Set the 'Filter on Timed Sync' flag. |
void |
setSuppressDownload(boolean activateSuppressDownload)
Sets the parameter for suppress download. |
abstract void |
setSyncPasswordOfCurrentUser(java.lang.String password)
Sets the synchronization password of the current user. |
void |
synchronizeWithBackend()
Handles the complete synchronization for the current user. |
abstract void |
synchronizeWithBackend(VisibilityType visibility)
Handles the complete synchronization for current user or for all other users. |
abstract boolean |
terminateConnection()
Terminates the connection to the Mobile Infrastructure Middleware system. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static java.lang.String SYNC_PROTOCOL_VERSION
251300
that means binary transport protocol is
used.
public static final java.lang.String CONNECTION_TYPE_HTTP
SyncManager
exchanges
the outbound and inbound queue via http If Connection type is set up to
http the SYNCSETTINGS_GATEWAY
in the Configuration must be
set up to a gateway url.
public static final java.lang.String CONNECTION_TYPE_DISC
SyncManager
exchanges the
outbound and inbound queue via file system. If Connection type is set to
disc the SYNCSETTINGS_GATEWAY
in the Configuration must be
set up to a file directory.
Constructor Detail |
public SyncManager()
Method Detail |
public static SyncManager getInstance()
public void synchronizeWithBackend()
public abstract void synchronizeWithBackend(VisibilityType visibility)
visibility
- Determines if the synchronization happens only for
containers which are created for the current user and as shared
containers or for all outbound containers on the device user
independentVisibilityType
public final void setFilterOnTimedSync(boolean filtered)
public final boolean isFilterOnTimedSync()
true
if the 'Filter on Timed sync' feature is activated
false
if the 'Filter on Timed sync' feature is deactivatedpublic final void setSuppressDownload(boolean activateSuppressDownload)
public final boolean isSuppressDownload()
true
if the suppress download feature is activated
false
if the suppress download feature is deactivatedpublic abstract void setSyncPasswordOfCurrentUser(java.lang.String password) throws SyncPasswordException
SyncPasswordException
with an appropriate message ID (containing the resaon) will be thrown.
password
- The synchronization password
SyncPasswordException
- Contains the reason why the setting of
the synchronization password failed if it fails.SyncPasswordException
public abstract boolean isSyncCredentialAvailable()
True
if the synchronization credentials are
available, false
otherwise.public abstract boolean isSyncRunning()
true
if an UI triggered synchronization is running,
false
if no synchronization is running or if background
synchronization is running.public abstract boolean isSAPLogonTicketSupportEnabled()
True if the framework is enabled for SAP logon ticket
support, false
otherwise.
public static int getSyncProtocolVersion()
public abstract boolean terminateConnection()
true
if connection was terminated successfully
false
otherwise.isConnectionTerminatable
public abstract boolean isConnectionTerminatable()
true
if connection can be terminated
false
otherwise.terminateConnection
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |