oracle.lite.mSync

Class SyncOption

java.lang.Object

oracle.lite.mSync.SyncOption

Deprecated.

As of DMS 12.1.0.0.0, package oracle.lite.mSync was replaced by oracle.opensync.ose and oracle.opensync.syncagent. Instead of SyncOption, sync options should be set through OSESession.setXXX() methods. This class may be removed from future release.

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 Deprecated.
static java.lang.String	AUTHID_PROP Deprecated.
static java.lang.String	CHANGE_DB_PASS_PROP Deprecated.
static java.lang.String	CREATE_DB_USER_PROP Deprecated.
static java.lang.String	DEVTAG_PREF Deprecated.
static java.lang.String	DEVTAG_PROP Deprecated.
static java.lang.String	DM_RUN_UPDATE_PROP Deprecated.
static java.lang.String	HTTP_PASS_PROP Deprecated.
static java.lang.String	HTTP_USER_PROP Deprecated.
static java.lang.String	MAC_PROP Deprecated.
static java.lang.String	RECEIVE_FILE_PROP Deprecated.
static java.lang.String	SEND_FILE_PROP Deprecated.
static java.lang.String	URL_PROP Deprecated.
static java.lang.String	USER_NAME_PROP Deprecated.
static java.lang.String	USER_PASS_PROP Deprecated.

Constructor Summary

Constructors

Constructor and Description
SyncOption() Deprecated.
SyncOption(java.lang.String mu) Deprecated.
SyncOption(java.lang.String user, java.lang.String pwd) Deprecated. Construct a sync option object by using the provided parameters
SyncOption(java.lang.String user, java.lang.String pwd, java.lang.String param, java.lang.String trType, java.lang.String trParam) Deprecated. 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) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addProgressListener(SyncProgressListener p) Deprecated.
void	clearSyncParam() Deprecated.
void	clearTransportParam() Deprecated.
void	close() Deprecated.
void	finalize() Deprecated.
java.lang.String	getPassword() Deprecated.
java.lang.String	getPublication(java.lang.String appName) Deprecated.
java.lang.String	getSyncOptions(java.lang.String opt) Deprecated. Get option strings
java.lang.String	getSyncParam() Deprecated.
java.lang.String	getSyncProperty(java.lang.String propName) Deprecated.
java.lang.String	getTransportDriver() Deprecated. Deprecated API.
java.lang.String	getTransportType() Deprecated. Get the transport driver(type)
java.lang.String	getUser() Deprecated. Get the user name
void	load() Deprecated.
void	save() Deprecated. Save the settings to the user profile
void	selectPub(java.lang.String pubName) Deprecated. For selective sync, specify what publication will be selected to do the sync.
void	setPassword(java.lang.String pwd) Deprecated. Set password
void	setSyncFlag(java.lang.String pubName, java.lang.String tblName, short flag) Deprecated. As of DMS 12.1.0.0.0, selective sync based on table name is not supported. Use oracle.opensync.ose.OSESession.selectPub(String) instead. This method may be removed in future release.
void	setSyncOptions(java.lang.String opt) Deprecated. Set a string with sync options e.g.
void	setSyncParam(java.lang.String param) Deprecated. Set synchronization parameter
void	setSyncProperty(java.lang.String propName, java.lang.String propValue) Deprecated.
void	setTransport(SyncOpenTransport ot) Deprecated.
void	setTransportDriver(java.lang.String driverName) Deprecated. Deprecated API.
void	setTransportParam(java.lang.String trParam) Deprecated.
void	setTransportType(java.lang.String trType) Deprecated.
void	setUser(java.lang.String user) Deprecated. Set user name
void	setUser(java.lang.String user, java.lang.String pwd) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

DEVTAG_PREF

public static final java.lang.String DEVTAG_PREF

Deprecated.

See Also:

Constant Field Values

AUTHID_PREF

public static final java.lang.String AUTHID_PREF

Deprecated.

See Also:

Constant Field Values

DEVTAG_PROP

public static final java.lang.String DEVTAG_PROP

Deprecated.

See Also:

Constant Field Values

AUTHID_PROP

public static final java.lang.String AUTHID_PROP

Deprecated.

See Also:

Constant Field Values

HTTP_USER_PROP

public static final java.lang.String HTTP_USER_PROP

Deprecated.

See Also:

Constant Field Values

HTTP_PASS_PROP

public static final java.lang.String HTTP_PASS_PROP

Deprecated.

See Also:

Constant Field Values

DM_RUN_UPDATE_PROP

public static final java.lang.String DM_RUN_UPDATE_PROP

Deprecated.

See Also:

Constant Field Values

URL_PROP

public static final java.lang.String URL_PROP

Deprecated.

See Also:

Constant Field Values

USER_NAME_PROP

public static final java.lang.String USER_NAME_PROP

Deprecated.

See Also:

Constant Field Values

USER_PASS_PROP

public static final java.lang.String USER_PASS_PROP

Deprecated.

See Also:

Constant Field Values

SEND_FILE_PROP

public static final java.lang.String SEND_FILE_PROP

Deprecated.

See Also:

Constant Field Values

RECEIVE_FILE_PROP

public static final java.lang.String RECEIVE_FILE_PROP

Deprecated.

See Also:

Constant Field Values

CREATE_DB_USER_PROP

public static final java.lang.String CREATE_DB_USER_PROP

Deprecated.

See Also:

Constant Field Values

CHANGE_DB_PASS_PROP

public static final java.lang.String CHANGE_DB_PASS_PROP

Deprecated.

See Also:

Constant Field Values

MAC_PROP

public static final java.lang.String MAC_PROP

Deprecated.

See Also:

Constant Field Values

Constructor Detail

SyncOption

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

Deprecated.

Throws:

SyncException

SyncOption

public SyncOption()
           throws SyncException

Deprecated.

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

Deprecated.

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

Deprecated.

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)
           throws SyncException

Deprecated.

Construct a sync option object by using the provided parameters

Parameters:

user - - the username to sync

pwd - - the password to sync

Throws:

SyncException

Method Detail

close

public void close()

Deprecated.

finalize

public void finalize()

Deprecated.

Overrides:

finalize in class java.lang.Object

load

public void load()
          throws SyncException

Deprecated.

Throws:

SyncException

setUser

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

Deprecated.

Throws:

SyncException

setUser

public void setUser(java.lang.String user)

Deprecated.

Set user name

Parameters:

user - - user name to set

getUser

public java.lang.String getUser()

Deprecated.

Get the user name

setPassword

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

Deprecated.

Set password

Parameters:

pwd - - password to set

Throws:

SyncException

getPassword

public java.lang.String getPassword()

Deprecated.

setSyncFlag

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

Deprecated. As of DMS 12.1.0.0.0, selective sync based on table name is not supported. Use oracle.opensync.ose.OSESession.selectPub(String) instead. This method may be removed in future release.

For selective sync. 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
         

Parameters:

pubName - - the publication name

tblName - - the table name

flag - - set to 1 if turn on sync flag , otherwise set to 0.

Throws:

SyncException

selectPub

public void selectPub(java.lang.String pubName)
               throws SyncException

Deprecated.

For selective sync, specify what publication will be selected to do the sync.

Parameters:

pubName - - name of the publication For example, the following code snippet will select publication 'myPub' for selective synchronization.

                 SyncOption op = new SyncOption(user, passwd, "noNewPubs", "HTTP", server.toString());
                 op.selectPub("myPub");             //turn on sync flag for all the tables
         

Throws:

SyncException

setSyncOptions

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

Deprecated.

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

Throws:

SyncException

getSyncOptions

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

Deprecated.

Get option strings

Throws:

SyncException

setSyncParam

public void setSyncParam(java.lang.String param)

Deprecated.

Set synchronization parameter

Parameters:

param - - synchronization parameter to set

See Also:

param values

clearSyncParam

public void clearSyncParam()

Deprecated.

getSyncParam

public java.lang.String getSyncParam()

Deprecated.

setTransportType

public void setTransportType(java.lang.String trType)

Deprecated.

getTransportType

public java.lang.String getTransportType()

Deprecated.

Get the transport driver(type)

getTransportDriver

public java.lang.String getTransportDriver()

Deprecated.

Deprecated API. Get the transport driver

setTransportDriver

public void setTransportDriver(java.lang.String driverName)

Deprecated.

Deprecated API. Set transport driver(type)

Parameters:

driverName - - driver name to set

setTransportParam

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

Deprecated.

Throws:

SyncException

clearTransportParam

public void clearTransportParam()

Deprecated.

save

public void save()
          throws SyncException

Deprecated.

Save the settings to the user profile

Throws:

SyncException

getPublication

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

Deprecated.

Throws:

SyncException

addProgressListener

public void addProgressListener(SyncProgressListener p)

Deprecated.

setTransport

public void setTransport(SyncOpenTransport ot)

Deprecated.

setSyncProperty

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

Deprecated.

Throws:

SyncException

getSyncProperty

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

Deprecated.

Throws:

SyncException