Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)

E17503-02

oracle.adfnmc.sync
Class SyncUtils

java.lang.Object
  extended by oracle.adfnmc.sync.SyncUtils

public class SyncUtils
extends java.lang.Object


Field Summary
static java.lang.Class CLASS_INSTANCE
           
static java.lang.String DEFAULT_FROM_OUTCOME_NAME
           
static java.lang.String DEFAULT_RETURN_FAILURE_NAME
           
static java.lang.String DEFAULT_RETURN_SUCCESS_NAME
           
static java.lang.String DEFAULT_TO_ACTIVITY_NAME
           
static java.lang.String OLITE_ROOT
           
static java.lang.String SYNC_AUTOSYNC_EL
           
static ValueExpression SYNC_AUTOSYNC_EXPR
           
static java.lang.String SYNC_CONTEXT_NAME
           
static java.lang.String SYNC_CURRENTPROGRESS_EL
           
static ValueExpression SYNC_CURRENTPROGRESS_EXPR
           
static java.lang.String SYNC_ERROR_EL
           
static ValueExpression SYNC_ERROR_EXPR
           
static java.lang.String SYNC_INPROGRESS_EL
           
static ValueExpression SYNC_INPROGRESS_EXPR
           
static java.lang.String SYNC_MANUALSYNC_EL
           
static ValueExpression SYNC_MANUALSYNC_EXPR
           
static java.lang.String SYNC_PASSWORD_EL
           
static ValueExpression SYNC_PASSWORD_EXPR
           
static java.lang.String SYNC_SAVEPASSWORD_EL
           
static ValueExpression SYNC_SAVEPASSWORD_EXPR
           
static java.lang.String SYNC_STATUSMSG_EL
           
static ValueExpression SYNC_STATUSMSG_EXPR
           
static java.lang.String SYNC_URL_EL
           
static ValueExpression SYNC_URL_EXPR
           
static java.lang.String SYNC_USE_SAVED_SETTINGS_EL
           
static ValueExpression SYNC_USE_SAVED_SETTINGS_EXPR
           
static java.lang.String SYNC_USERNAME_EL
           
static ValueExpression SYNC_USERNAME_EXPR
           
 
Constructor Summary
SyncUtils()
           
 
Method Summary
static boolean allRequiredSyncParametersWereProvided()
          Determine if all the parameters necessary to sync were provided via EL expressions
static boolean allSyncParametersWereSaved()
          Determine if all the parameters necessary to sync were previously saved by OpenSync
static void displayMobileSyncTaskFlow()
           
static java.lang.String formDatabasePath(java.lang.String databaseID, java.lang.String username)
          Forms a fully-qualified path for a database that is managed by OpenSync SQLite databases managed by OpenSync are named like this: SQLite.DATA_DIRECTORY/sqlite_db/syncUsername/applicationName.db
static java.lang.String getDatabaseFilename(java.lang.String databaseID)
          Get the fully-qualified filename of the database specified in the URL
static boolean getExitApplicationOnSyncFailureInTestMode()
           
static java.lang.String getLastSyncURL(java.lang.String username)
          Get the URL of the sync server that this user is accessing to synchronize data
static java.lang.String getLastSyncUser()
          Returns the last user who ran OpenSync
static SyncSession getOrCreateSyncSession()
           
static java.lang.String getPasswordHash(java.lang.String username)
          Get the password hash that is associated with the provided username.
static int getSyncCredentialsMode()
          Get the value that indicates how sync credentials are to be provided, e.g.
static java.lang.String getUserSettingsFilename(java.lang.String username)
          User-specific settings are stored in file called "userN.xml", where N is >= 0.
static void initiateSync()
           
static void initiateSync(boolean useSavedSettings, java.lang.String[] dbIDs, Connection[] connectionsToShare)
          Start a sync operation via OpenSync to update databases stored on the device
static void initiateSyncWithSavedSettings()
           
static boolean isSavedPasswordChecked()
           
static void performNavigationActionAsync(java.lang.String navigationAction)
           
static void performNavigationActionSync(java.lang.String navigationAction)
           
static void setExitApplicationOnSyncFailureInTestMode(boolean value)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_INSTANCE

public static final java.lang.Class CLASS_INSTANCE

SYNC_CONTEXT_NAME

public static final java.lang.String SYNC_CONTEXT_NAME
See Also:
Constant Field Values

SYNC_USERNAME_EL

public static final java.lang.String SYNC_USERNAME_EL

SYNC_PASSWORD_EL

public static final java.lang.String SYNC_PASSWORD_EL

SYNC_SAVEPASSWORD_EL

public static final java.lang.String SYNC_SAVEPASSWORD_EL

SYNC_URL_EL

public static final java.lang.String SYNC_URL_EL

SYNC_STATUSMSG_EL

public static final java.lang.String SYNC_STATUSMSG_EL

SYNC_CURRENTPROGRESS_EL

public static final java.lang.String SYNC_CURRENTPROGRESS_EL

SYNC_ERROR_EL

public static final java.lang.String SYNC_ERROR_EL
See Also:
Constant Field Values

SYNC_INPROGRESS_EL

public static final java.lang.String SYNC_INPROGRESS_EL
See Also:
Constant Field Values

SYNC_AUTOSYNC_EL

public static final java.lang.String SYNC_AUTOSYNC_EL
See Also:
Constant Field Values

SYNC_MANUALSYNC_EL

public static final java.lang.String SYNC_MANUALSYNC_EL
See Also:
Constant Field Values

SYNC_USE_SAVED_SETTINGS_EL

public static final java.lang.String SYNC_USE_SAVED_SETTINGS_EL

SYNC_USERNAME_EXPR

public static final ValueExpression SYNC_USERNAME_EXPR

SYNC_PASSWORD_EXPR

public static final ValueExpression SYNC_PASSWORD_EXPR

SYNC_SAVEPASSWORD_EXPR

public static final ValueExpression SYNC_SAVEPASSWORD_EXPR

SYNC_URL_EXPR

public static final ValueExpression SYNC_URL_EXPR

SYNC_STATUSMSG_EXPR

public static final ValueExpression SYNC_STATUSMSG_EXPR

SYNC_CURRENTPROGRESS_EXPR

public static final ValueExpression SYNC_CURRENTPROGRESS_EXPR

SYNC_ERROR_EXPR

public static final ValueExpression SYNC_ERROR_EXPR

SYNC_INPROGRESS_EXPR

public static final ValueExpression SYNC_INPROGRESS_EXPR

SYNC_AUTOSYNC_EXPR

public static final ValueExpression SYNC_AUTOSYNC_EXPR

SYNC_USE_SAVED_SETTINGS_EXPR

public static final ValueExpression SYNC_USE_SAVED_SETTINGS_EXPR

SYNC_MANUALSYNC_EXPR

public static final ValueExpression SYNC_MANUALSYNC_EXPR

DEFAULT_FROM_OUTCOME_NAME

public static final java.lang.String DEFAULT_FROM_OUTCOME_NAME
See Also:
Constant Field Values

DEFAULT_TO_ACTIVITY_NAME

public static final java.lang.String DEFAULT_TO_ACTIVITY_NAME
See Also:
Constant Field Values

DEFAULT_RETURN_SUCCESS_NAME

public static final java.lang.String DEFAULT_RETURN_SUCCESS_NAME
See Also:
Constant Field Values

DEFAULT_RETURN_FAILURE_NAME

public static final java.lang.String DEFAULT_RETURN_FAILURE_NAME
See Also:
Constant Field Values

OLITE_ROOT

public static final java.lang.String OLITE_ROOT
See Also:
Constant Field Values
Constructor Detail

SyncUtils

public SyncUtils()
Method Detail

getDatabaseFilename

public static final java.lang.String getDatabaseFilename(java.lang.String databaseID)
Get the fully-qualified filename of the database specified in the URL

Parameters:
databaseID -
Returns:

formDatabasePath

public static java.lang.String formDatabasePath(java.lang.String databaseID,
                                                java.lang.String username)
Forms a fully-qualified path for a database that is managed by OpenSync SQLite databases managed by OpenSync are named like this: SQLite.DATA_DIRECTORY/sqlite_db/syncUsername/applicationName.db

Parameters:
databaseID -
username -
Returns:

getSyncCredentialsMode

public static final int getSyncCredentialsMode()
Get the value that indicates how sync credentials are to be provided, e.g. prompt or use the last user's credentials.

Returns:

getLastSyncUser

public static final java.lang.String getLastSyncUser()
Returns the last user who ran OpenSync

Returns:

getUserSettingsFilename

public static final java.lang.String getUserSettingsFilename(java.lang.String username)
User-specific settings are stored in file called "userN.xml", where N is >= 0. This returns the fully-qualified name of that file

Parameters:
username -
Returns:

getPasswordHash

public static java.lang.String getPasswordHash(java.lang.String username)
Get the password hash that is associated with the provided username. If the username is invalid, or the user elected not to save their password, then this will return null.

Parameters:
username -
Returns:

isSavedPasswordChecked

public static boolean isSavedPasswordChecked()

getLastSyncURL

public static java.lang.String getLastSyncURL(java.lang.String username)
Get the URL of the sync server that this user is accessing to synchronize data

Parameters:
username -
Returns:

getOrCreateSyncSession

public static SyncSession getOrCreateSyncSession()

initiateSync

public static void initiateSync()

initiateSyncWithSavedSettings

public static void initiateSyncWithSavedSettings()

initiateSync

public static void initiateSync(boolean useSavedSettings,
                                java.lang.String[] dbIDs,
                                Connection[] connectionsToShare)
Start a sync operation via OpenSync to update databases stored on the device

Parameters:
useSavedSettings - - attempt to use previously-saved sync settings
dbIDs - - array of database IDs (NOT fully-qualified database paths), each of which is associated with the corresponding Connection in the connectionsToShare array
connectionsToShare - - array of JDBC Connection objects, each of which will be shared with OpenSync

performNavigationActionAsync

public static void performNavigationActionAsync(java.lang.String navigationAction)

performNavigationActionSync

public static void performNavigationActionSync(java.lang.String navigationAction)

allSyncParametersWereSaved

public static boolean allSyncParametersWereSaved()
Determine if all the parameters necessary to sync were previously saved by OpenSync

Returns:

allRequiredSyncParametersWereProvided

public static boolean allRequiredSyncParametersWereProvided()
Determine if all the parameters necessary to sync were provided via EL expressions

Returns:

displayMobileSyncTaskFlow

public static void displayMobileSyncTaskFlow()

setExitApplicationOnSyncFailureInTestMode

public static void setExitApplicationOnSyncFailureInTestMode(boolean value)

getExitApplicationOnSyncFailureInTestMode

public static boolean getExitApplicationOnSyncFailureInTestMode()

Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)

E17503-02

Copyright © 2011, Oracle and/or its affiliates. All rights reserved.