oracle.lite.mSync

Class SyncOption

java.lang.Object

oracle.lite.mSync.SyncOption

public class SyncOption
extends java.lang.Object

The SyncOption class is used to define the parameters for the sync process. It can either be constructed manually or can save or load data from the user profile.

Code snippet below:

        SyncOption op = new SyncOption(user, passwd, "noNewPubs","HTTP",server.toString());
  

Another example:

          String SyncUserName = "test" 
          String SyncPassword = "test" 
          String SyncServer = "test.us.oracle.com";
          String TransportType="HTTP"; 
          String TransportParam="Server="+SyncServer+";"; 
          SyncOption syncOpt = new SyncOption();
          syncOpt.setUser(SyncUserName); 
          syncOpt.setPassword(SyncPassword); 
          syncOpt.setTransportParam(TransportParam); 
          syncOpt.setTransportType(TransportType);
          syncOpt.save();
   

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHID_PREF
static java.lang.String	AUTHID_PROP
static java.lang.String	CHANGE_DB_PASS_PROP
static java.lang.String	CREATE_DB_USER_PROP
static java.lang.String	DEVTAG_PREF
static java.lang.String	DEVTAG_PROP
static java.lang.String	DM_RUN_UPDATE_PROP
static java.lang.String	HTTP_PASS_PROP
static java.lang.String	HTTP_USER_PROP
static java.lang.String	MAC_PROP
static java.lang.String	RECEIVE_FILE_PROP
static java.lang.String	SEND_FILE_PROP
static java.lang.String	URL_PROP
static java.lang.String	USER_NAME_PROP
static java.lang.String	USER_PASS_PROP

Constructor Summary

Constructors

Constructor and Description
SyncOption()
SyncOption(java.lang.String mu)
SyncOption(java.lang.String user, java.lang.String pwd, java.lang.String param, java.lang.String trType, java.lang.String trParam) Construct a sync option object by using the provided information
SyncOption(java.lang.String user, java.lang.String pwd, java.lang.String param, java.lang.String trType, java.lang.String trParam, java.lang.String mu)

Method Summary

Methods

Modifier and Type	Method and Description
void	addProgressListener(SyncProgressListener p)
void	clearSyncParam()
void	clearTransportParam()
void	close()
void	finalize()
java.lang.String	getPassword()
java.lang.String	getPublication(java.lang.String appName)
java.lang.String	getSyncOptions(java.lang.String opt) Get option strings
java.lang.String	getSyncParam()
java.lang.String	getSyncProperty(java.lang.String propName)
java.lang.String	getTransportDriver() Deprecated API.
java.lang.String	getTransportType() Get the transport driver(type)
java.lang.String	getUser() Get the user name
void	load()
void	save() Save the settings to the user profile
void	setPassword(java.lang.String pwd) Set password
void	setSyncFlag(java.lang.String pubName, java.lang.String tblName, short flag) For selective sync
void	setSyncOptions(java.lang.String opt) Set a string with sync options e.g.
void	setSyncParam(java.lang.String param) Set synchronization parameter
void	setSyncProperty(java.lang.String propName, java.lang.String propValue)
void	setTransport(SyncOpenTransport ot)
void	setTransportDriver(java.lang.String driverName) Deprecated API.
void	setTransportParam(java.lang.String trParam)
void	setTransportType(java.lang.String trType)
void	setUser(java.lang.String user) Set user name
void	setUser(java.lang.String user, java.lang.String pwd)

Methods inherited from class java.lang.Object

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

Field Detail

AUTHID_PREF

public static final java.lang.String AUTHID_PREF

See Also:

Constant Field Values

AUTHID_PROP

public static final java.lang.String AUTHID_PROP

See Also:

Constant Field Values

CHANGE_DB_PASS_PROP

public static final java.lang.String CHANGE_DB_PASS_PROP

See Also:

Constant Field Values

CREATE_DB_USER_PROP

public static final java.lang.String CREATE_DB_USER_PROP

See Also:

Constant Field Values

DEVTAG_PREF

public static final java.lang.String DEVTAG_PREF

See Also:

Constant Field Values

DEVTAG_PROP

public static final java.lang.String DEVTAG_PROP

See Also:

Constant Field Values

DM_RUN_UPDATE_PROP

public static final java.lang.String DM_RUN_UPDATE_PROP

See Also:

Constant Field Values

HTTP_PASS_PROP

public static final java.lang.String HTTP_PASS_PROP

See Also:

Constant Field Values

HTTP_USER_PROP

public static final java.lang.String HTTP_USER_PROP

See Also:

Constant Field Values

MAC_PROP

public static final java.lang.String MAC_PROP

See Also:

Constant Field Values

RECEIVE_FILE_PROP

public static final java.lang.String RECEIVE_FILE_PROP

See Also:

Constant Field Values

SEND_FILE_PROP

public static final java.lang.String SEND_FILE_PROP

See Also:

Constant Field Values

URL_PROP

public static final java.lang.String URL_PROP

See Also:

Constant Field Values

USER_NAME_PROP

public static final java.lang.String USER_NAME_PROP

See Also:

Constant Field Values

USER_PASS_PROP

public static final java.lang.String USER_PASS_PROP

See Also:

Constant Field Values

Constructor Detail

SyncOption

public SyncOption()
           throws SyncException

Throws:

SyncException

SyncOption

public SyncOption(java.lang.String mu)
           throws SyncException

Throws:

SyncException

SyncOption

public SyncOption(java.lang.String user,
          java.lang.String pwd,
          java.lang.String param,
          java.lang.String trType,
          java.lang.String trParam)
           throws SyncException

Construct a sync option object by using the provided information

Parameters:

user - - the username to sync

pwd - - the password to sync

param - - A string with a set of name-and-value pairs: "name=values;name2=values2;..."
Currently supported name-and value pairs are:

NAME	VALUE	DESCRIPTION
reset	N/A	Clear all entries in the environment before applying the rest of the settings
security	[SSL][CAST5][AES]	To turn on SSL encryption; To use CAST5 stream encryption; To use AES encryption
pushonly	N/A	Push changes on the client to the server only, do not pick up changes from the server. Useful for data collection application that wants to only drop of data collected
highPriority	N/A	To use high priority sync
noapps	N/A	If this flag is present, the sync will not pick up any new or updated applications. This is usually set when syncing on top of slow network like wireless or slow dial-up
syncDirection	[SendOnly][ReceiveOnly]	Note: An implementation of your own transport is required to set these two parameters.
noNewPubs	N/A	If this flag is present, the server will not send any new publications created since the last sync and only sync data in current publications
fullrefresh	N/A	Force a full refresh

trType - - Name of the transportType to use.
Currently, the only driver supported is "HTTP".
Note: transportDriver is deprecated. Use transportType instead.

trParam - - A string that contains all the parameters needed for the specified driver to operate.
format: server=server1;proxy=proxy1;proxyPort=portNo;

Throws:

SyncException

SyncOption

public SyncOption(java.lang.String user,
          java.lang.String pwd,
          java.lang.String param,
          java.lang.String trType,
          java.lang.String trParam,
          java.lang.String mu)
           throws SyncException

Throws:

SyncException

Method Detail

addProgressListener

public void addProgressListener(SyncProgressListener p)

clearSyncParam

public void clearSyncParam()

clearTransportParam

public void clearTransportParam()

close

public void close()

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

getPassword

public java.lang.String getPassword()

getPublication

public java.lang.String getPublication(java.lang.String appName)
                                throws SyncException

Throws:

SyncException

getSyncOptions

public java.lang.String getSyncOptions(java.lang.String opt)
                                throws SyncException

Get option strings

Throws:

SyncException

getSyncParam

public java.lang.String getSyncParam()

getSyncProperty

public java.lang.String getSyncProperty(java.lang.String propName)
                                 throws SyncException

Throws:

SyncException

getTransportDriver

public java.lang.String getTransportDriver()

Deprecated API. Get the transport driver

getTransportType

public java.lang.String getTransportType()

Get the transport driver(type)

getUser

public java.lang.String getUser()

Get the user name

load

public void load()
          throws SyncException

Throws:

SyncException

save

public void save()
          throws SyncException

Save the settings to the user profile

Throws:

SyncException

setPassword

public void setPassword(java.lang.String pwd)
                 throws SyncException

Set password

Parameters:

pwd - - password to set

Throws:

SyncException

setSyncFlag

public void setSyncFlag(java.lang.String pubName,
               java.lang.String tblName,
               short flag)
                 throws SyncException

For selective sync

Parameters:

pubName - - the publication name

tblName - - the table name

flag - - set to 1 if turn on sync flag , otherwise set to 0.
For example, the following code snippet will enable sync flag for every table except OrdersODB.TEST.

                 SyncOption op = new SyncOption(user, passwd, "noNewPubs","HTTP",server.toString());
                 op.setSyncFlag("","",(short)1);             //turn on sync flag for all the tables
                 op.setSyncFlag("","OrdersODB.TEST",(short)0); //turn off sync flag for OrdersODB.TEST
         

Throws:

SyncException

setSyncOptions

public void setSyncOptions(java.lang.String opt)
                    throws SyncException

Set a string with sync options e.g. DEVTAG=WIN32;AUTHID=123

Throws:

SyncException

setSyncParam

public void setSyncParam(java.lang.String param)

Set synchronization parameter

Parameters:

param - - synchronization parameter to set

See Also:

param values

setSyncProperty

public void setSyncProperty(java.lang.String propName,
                   java.lang.String propValue)
                     throws SyncException

Throws:

SyncException

setTransport

public void setTransport(SyncOpenTransport ot)

setTransportDriver

public void setTransportDriver(java.lang.String driverName)

Deprecated API. Set transport driver(type)

Parameters:

driverName - - driver name to set

setTransportParam

public void setTransportParam(java.lang.String trParam)
                       throws SyncException

Throws:

SyncException

setTransportType

public void setTransportType(java.lang.String trType)

setUser

public void setUser(java.lang.String user)

Set user name

Parameters:

user - - user name to set

setUser

public void setUser(java.lang.String user,
           java.lang.String pwd)
             throws SyncException

Throws:

SyncException