Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.sql.rowset.spi
Class SyncProvider

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.sql.rowset.spi.SyncProvider

public abstract class SyncProvider
extends Object sample code for java.lang.Object definition code for java.lang.Object

The synchronization mechanism that provides reader/writer capabilities for disconnected RowSet objects. A SyncProvider implementation is a class that extends the SyncProvider abstract class.

A SyncProvider implementation is identified by a unique ID, which is its fully qualified class name. This name must be registered with the SyncFactory SPI, thus making the implementation available to all RowSet implementations. The factory mechanism in the reference implementation uses this name to instantiate the implementation, which can then provide a RowSet object with its reader (a javax.sql.RowSetReader object) and its writer (a javax.sql.RowSetWriter object).

The Jdbc RowSet Implementations specification provides two reference implementations of the SyncProvider abstract class: RIOptimisticProvider and RIXMLProvider. The RIOptimisticProvider can set any RowSet implementation with a RowSetReader object and a RowSetWriter object. However, only the RIXMLProvider implementation can set an XmlReader object and an XmlWriter object. A WebRowSet object uses the XmlReader object to read data in XML format to populate itself with that data. It uses the XmlWriter object to write itself to a stream or java.io.Writer object in XML format.

1.0 Naming Convention for Implementations

As a guide to naming SyncProvider implementations, the following should be noted:

For instance, if a vendor named Fred, Inc. offered a SyncProvider implementation, you could have the following: 

     Vendor name:  Fred, Inc.     
     Domain name of vendor:  com.fred
     Package name:  com.fred.providers
     SyncProvider implementation class name:  HighAvailabilityProvider

     Fully qualified class name of SyncProvider implementation:
                        com.fred.providers.HighAvailabilityProvider

The following line of code uses the fully qualified name to register this implementation with the SyncFactory static instance. 

     SyncFactory.registerProvider(
                          "com.fred.providers.HighAvailabilityProvider");

The default SyncProvider object provided with the reference implementation uses the following name: 

     com.sun.rowset.providers.RIOptimisticProvider

A vendor can register a SyncProvider implementation class name with Sun Microsystems, Inc. by sending email to jdbc@sun.com. Sun will maintain a database listing the available SyncProvider implementations for use with compliant RowSet implementations. This database will be similar to the one already maintained to list available JDBC drivers.

Vendors should refer to the reference implementation synchronization providers for additional guidance on how to implement a new SyncProvider implementation.

2.0 How a RowSet Object Gets Its Provider

A disconnected Rowset object may get access to a SyncProvider object in one of the following two ways:

By default, the reference implementations of the RowSet synchronization providers are always available to the Java platform. If no other pluggable synchronization providers have been correctly registered, the SyncFactory will automatically generate an instance of the default SyncProvider reference implementation. Thus, in the preceding code fragment, if no implementation named com.fred.providers.HighAvailabilitySyncProvider has been registered with the SyncFactory instance, crs will be assigned the default provider in the reference implementation, which is com.sun.rowset.providers.RIOptimisticProvider.

3.0 Violations and Synchronization Issues

If an update between a disconnected RowSet object and a data source violates the original query or the underlying data source constraints, this will result in undefined behavior for all disconnected RowSet implementations and their designated SyncProvider implementations. Not defining the behavior when such violations occur offers greater flexibility for a SyncProvider implementation to determine its own best course of action.

A SyncProvider implementation may choose to implement a specific handler to handle a subset of query violations. However if an original query violation or a more general data source constraint violation is not handled by the SyncProvider implementation, all SyncProvider objects must throw a SyncProviderException.

4.0 Updatable SQL VIEWs

It is possible for any disconnected or connected RowSet object to be populated from an SQL query that is formulated originally from an SQL VIEW. While in many cases it is possible for an update to be performed to an underlying view, such an update requires additional metadata, which may vary. The SyncProvider class provides two constants to indicate whether an implementation supports updating an SQL VIEW.

The default is for a RowSet object not to be updatable if it was populated with data from an SQL VIEW.

5.0 SyncProvider Constants

The SyncProvider class provides three sets of constants that are used as return values or parameters for SyncProvider methods. SyncProvider objects may be implemented to perform synchronization between a RowSet object and its underlying data source with varying degrees of of care. The first group of constants indicate how synchronization is handled. For example, GRADE_NONE indicates that a SyncProvider object will not take any care to see what data is valid and will simply write the RowSet data to the data source. GRADE_MODIFIED_AT_COMMIT indicates that the provider will check only modified data for validity. Other grades check all data for validity or set locks when data is modified or loaded.
  1. Constants to indicate the synchronization grade of a SyncProvider object
  2. Constants to indicate what locks are set on the data source
  3. Constants to indicate whether a SyncProvider object can perform updates to an SQL VIEW
    These constants are explained in the preceding section (4.0).

See Also:
SyncFactory sample code for javax.sql.rowset.spi.SyncFactory definition code for javax.sql.rowset.spi.SyncFactory , SyncFactoryException sample code for javax.sql.rowset.spi.SyncFactoryException definition code for javax.sql.rowset.spi.SyncFactoryException

Field Summary
static int DATASOURCE_DB_LOCK sample code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_DB_LOCK definition code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_DB_LOCK
          Indicates that a lock is placed on the entire data source that is the source of data for the RowSet object that is using this SyncProvider object.
static int DATASOURCE_NO_LOCK sample code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_NO_LOCK definition code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_NO_LOCK
          Indicates that no locks remain on the originating data source.
static int DATASOURCE_ROW_LOCK sample code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_ROW_LOCK definition code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_ROW_LOCK
          Indicates that a lock is placed on the rows that are touched by the original SQL statement used to populate the RowSet object that is using this SyncProvider object.
static int DATASOURCE_TABLE_LOCK sample code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_TABLE_LOCK definition code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_TABLE_LOCK
          Indicates that a lock is placed on all tables that are touched by the original SQL statement used to populate the RowSet object that is using this SyncProvider object.
static int GRADE_CHECK_ALL_AT_COMMIT sample code for javax.sql.rowset.spi.SyncProvider.GRADE_CHECK_ALL_AT_COMMIT definition code for javax.sql.rowset.spi.SyncProvider.GRADE_CHECK_ALL_AT_COMMIT
          Indicates a high level optimistic synchronization grade with respect to the originating data source.
static int GRADE_CHECK_MODIFIED_AT_COMMIT sample code for javax.sql.rowset.spi.SyncProvider.GRADE_CHECK_MODIFIED_AT_COMMIT definition code for javax.sql.rowset.spi.SyncProvider.GRADE_CHECK_MODIFIED_AT_COMMIT
          Indicates a low level optimistic synchronization grade with respect to the originating data source.
static int GRADE_LOCK_WHEN_LOADED sample code for javax.sql.rowset.spi.SyncProvider.GRADE_LOCK_WHEN_LOADED definition code for javax.sql.rowset.spi.SyncProvider.GRADE_LOCK_WHEN_LOADED
          Indicates the most pessimistic synchronization grade with respect to the originating data source.
static int GRADE_LOCK_WHEN_MODIFIED sample code for javax.sql.rowset.spi.SyncProvider.GRADE_LOCK_WHEN_MODIFIED definition code for javax.sql.rowset.spi.SyncProvider.GRADE_LOCK_WHEN_MODIFIED
          Indicates a pessimistic synchronization grade with respect to the originating data source.
static int GRADE_NONE sample code for javax.sql.rowset.spi.SyncProvider.GRADE_NONE definition code for javax.sql.rowset.spi.SyncProvider.GRADE_NONE
          Indicates that no synchronization with the originating data source is provided.
static int NONUPDATABLE_VIEW_SYNC sample code for javax.sql.rowset.spi.SyncProvider.NONUPDATABLE_VIEW_SYNC definition code for javax.sql.rowset.spi.SyncProvider.NONUPDATABLE_VIEW_SYNC
          Indicates that a SyncProvider implementation does not support synchronization between a RowSet object and the SQL VIEW used to populate it.
static int UPDATABLE_VIEW_SYNC sample code for javax.sql.rowset.spi.SyncProvider.UPDATABLE_VIEW_SYNC definition code for javax.sql.rowset.spi.SyncProvider.UPDATABLE_VIEW_SYNC
          Indicates that a SyncProvider implementation supports synchronization between a RowSet object and the SQL VIEW used to populate it.
 
Constructor Summary
SyncProvider sample code for javax.sql.rowset.spi.SyncProvider.SyncProvider() definition code for javax.sql.rowset.spi.SyncProvider.SyncProvider() ()
          Creates a default SyncProvider object.
 
Method Summary
abstract  int getDataSourceLock sample code for javax.sql.rowset.spi.SyncProvider.getDataSourceLock() definition code for javax.sql.rowset.spi.SyncProvider.getDataSourceLock() ()
          Returns the current data source lock severity level active in this SyncProvider implementation.
abstract  int getProviderGrade sample code for javax.sql.rowset.spi.SyncProvider.getProviderGrade() definition code for javax.sql.rowset.spi.SyncProvider.getProviderGrade() ()
          Returns a constant indicating the grade of synchronization a RowSet object can expect from this SyncProvider object.
abstract  String sample code for java.lang.String definition code for java.lang.String getProviderID sample code for javax.sql.rowset.spi.SyncProvider.getProviderID() definition code for javax.sql.rowset.spi.SyncProvider.getProviderID() ()
          Returns the unique identifier for this SyncProvider object.
abstract  RowSetReader sample code for javax.sql.RowSetReader definition code for javax.sql.RowSetReader getRowSetReader sample code for javax.sql.rowset.spi.SyncProvider.getRowSetReader() definition code for javax.sql.rowset.spi.SyncProvider.getRowSetReader() ()
          Returns a javax.sql.RowSetReader object, which can be used to populate a RowSet object with data.
abstract  RowSetWriter sample code for javax.sql.RowSetWriter definition code for javax.sql.RowSetWriter getRowSetWriter sample code for javax.sql.rowset.spi.SyncProvider.getRowSetWriter() definition code for javax.sql.rowset.spi.SyncProvider.getRowSetWriter() ()
          Returns a javax.sql.RowSetWriter object, which can be used to write a RowSet object's data back to the underlying data source.
abstract  String sample code for java.lang.String definition code for java.lang.String getVendor sample code for javax.sql.rowset.spi.SyncProvider.getVendor() definition code for javax.sql.rowset.spi.SyncProvider.getVendor() ()
          Returns the vendor name of this SyncProvider instance
abstract  String sample code for java.lang.String definition code for java.lang.String getVersion sample code for javax.sql.rowset.spi.SyncProvider.getVersion() definition code for javax.sql.rowset.spi.SyncProvider.getVersion() ()
          Returns the release version of this SyncProvider instance.
abstract  void setDataSourceLock sample code for javax.sql.rowset.spi.SyncProvider.setDataSourceLock(int) definition code for javax.sql.rowset.spi.SyncProvider.setDataSourceLock(int) (int datasource_lock)
          Sets a lock on the underlying data source at the level indicated by datasource_lock.
abstract  int supportsUpdatableView sample code for javax.sql.rowset.spi.SyncProvider.supportsUpdatableView() definition code for javax.sql.rowset.spi.SyncProvider.supportsUpdatableView() ()
          Returns whether this SyncProvider implementation can perform synchronization between a RowSet object and the SQL VIEW in the data source from which the RowSet object got its data.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

GRADE_NONE sample code for javax.sql.rowset.spi.SyncProvider.GRADE_NONE 

public static int GRADE_NONE
Indicates that no synchronization with the originating data source is provided. A SyncProvider implementation returning this grade will simply attempt to write updates in the RowSet object to the underlying data source without checking the validity of any data.

GRADE_CHECK_MODIFIED_AT_COMMIT sample code for javax.sql.rowset.spi.SyncProvider.GRADE_CHECK_MODIFIED_AT_COMMIT 

public static int GRADE_CHECK_MODIFIED_AT_COMMIT
Indicates a low level optimistic synchronization grade with respect to the originating data source. A SyncProvider implementation returning this grade will check only rows that have changed.

GRADE_CHECK_ALL_AT_COMMIT sample code for javax.sql.rowset.spi.SyncProvider.GRADE_CHECK_ALL_AT_COMMIT 

public static int GRADE_CHECK_ALL_AT_COMMIT
Indicates a high level optimistic synchronization grade with respect to the originating data source. A SyncProvider implementation returning this grade will check all rows, including rows that have not changed.

GRADE_LOCK_WHEN_MODIFIED sample code for javax.sql.rowset.spi.SyncProvider.GRADE_LOCK_WHEN_MODIFIED 

public static int GRADE_LOCK_WHEN_MODIFIED
Indicates a pessimistic synchronization grade with respect to the originating data source. A SyncProvider implementation returning this grade will lock the row in the originating data source.

GRADE_LOCK_WHEN_LOADED sample code for javax.sql.rowset.spi.SyncProvider.GRADE_LOCK_WHEN_LOADED 

public static int GRADE_LOCK_WHEN_LOADED
Indicates the most pessimistic synchronization grade with respect to the originating data source. A SyncProvider implementation returning this grade will lock the entire view and/or table affected by the original statement used to populate a RowSet object.

DATASOURCE_NO_LOCK sample code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_NO_LOCK 

public static int DATASOURCE_NO_LOCK
Indicates that no locks remain on the originating data source. This is the default lock setting for all SyncProvider implementations unless otherwise directed by a RowSet object.

DATASOURCE_ROW_LOCK sample code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_ROW_LOCK 

public static int DATASOURCE_ROW_LOCK
Indicates that a lock is placed on the rows that are touched by the original SQL statement used to populate the RowSet object that is using this SyncProvider object.

DATASOURCE_TABLE_LOCK sample code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_TABLE_LOCK 

public static int DATASOURCE_TABLE_LOCK
Indicates that a lock is placed on all tables that are touched by the original SQL statement used to populate the RowSet object that is using this SyncProvider object.

DATASOURCE_DB_LOCK sample code for javax.sql.rowset.spi.SyncProvider.DATASOURCE_DB_LOCK 

public static int DATASOURCE_DB_LOCK
Indicates that a lock is placed on the entire data source that is the source of data for the RowSet object that is using this SyncProvider object.

UPDATABLE_VIEW_SYNC sample code for javax.sql.rowset.spi.SyncProvider.UPDATABLE_VIEW_SYNC 

public static int UPDATABLE_VIEW_SYNC
Indicates that a SyncProvider implementation supports synchronization between a RowSet object and the SQL VIEW used to populate it.

NONUPDATABLE_VIEW_SYNC sample code for javax.sql.rowset.spi.SyncProvider.NONUPDATABLE_VIEW_SYNC 

public static int NONUPDATABLE_VIEW_SYNC
Indicates that a SyncProvider implementation does not support synchronization between a RowSet object and the SQL VIEW used to populate it.

Constructor Detail

SyncProvider sample code for javax.sql.rowset.spi.SyncProvider() definition code for javax.sql.rowset.spi.SyncProvider() 

public SyncProvider()
Creates a default SyncProvider object.

Method Detail

getProviderID sample code for javax.sql.rowset.spi.SyncProvider.getProviderID() definition code for javax.sql.rowset.spi.SyncProvider.getProviderID() 

public abstract String sample code for java.lang.String definition code for java.lang.String  getProviderID()
Returns the unique identifier for this SyncProvider object.

Returns:
a String object with the fully qualified class name of this SyncProvider object

getRowSetReader sample code for javax.sql.rowset.spi.SyncProvider.getRowSetReader() definition code for javax.sql.rowset.spi.SyncProvider.getRowSetReader() 

public abstract RowSetReader sample code for javax.sql.RowSetReader definition code for javax.sql.RowSetReader  getRowSetReader()
Returns a javax.sql.RowSetReader object, which can be used to populate a RowSet object with data.

Returns:
a javax.sql.RowSetReader object

getRowSetWriter sample code for javax.sql.rowset.spi.SyncProvider.getRowSetWriter() definition code for javax.sql.rowset.spi.SyncProvider.getRowSetWriter() 

public abstract RowSetWriter sample code for javax.sql.RowSetWriter definition code for javax.sql.RowSetWriter  getRowSetWriter()
Returns a javax.sql.RowSetWriter object, which can be used to write a RowSet object's data back to the underlying data source.

Returns:
a javax.sql.RowSetWriter object

getProviderGrade sample code for javax.sql.rowset.spi.SyncProvider.getProviderGrade() definition code for javax.sql.rowset.spi.SyncProvider.getProviderGrade() 

public abstract int getProviderGrade()
Returns a constant indicating the grade of synchronization a RowSet object can expect from this SyncProvider object.

Returns:
an int that is one of the following constants: SyncProvider.GRADE_NONE, SyncProvider.GRADE_CHECK_MODIFIED_AT_COMMIT, SyncProvider.GRADE_CHECK_ALL_AT_COMMIT, SyncProvider.GRADE_LOCK_WHEN_MODIFIED, SyncProvider.GRADE_LOCK_WHEN_LOADED

setDataSourceLock sample code for javax.sql.rowset.spi.SyncProvider.setDataSourceLock(int) definition code for javax.sql.rowset.spi.SyncProvider.setDataSourceLock(int) 

public abstract void setDataSourceLock(int datasource_lock)
                                throws SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException definition code for javax.sql.rowset.spi.SyncProviderException
Sets a lock on the underlying data source at the level indicated by datasource_lock. This should cause the SyncProvider to adjust its behavior by increasing or decreasing the level of optimism it provides for a successful synchronization.

Parameters:
datasource_lock - one of the following constants indicating the severity level of data source lock required: 
           SyncProvider.DATASOURCE_NO_LOCK,
           SyncProvider.DATASOURCE_ROW_LOCK,
           SyncProvider.DATASOURCE_TABLE_LOCK,
           SyncProvider.DATASOURCE_DB_LOCK,
Throws:
SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException definition code for javax.sql.rowset.spi.SyncProviderException - if an unsupported data source locking level is set.
See Also:
getDataSourceLock() sample code for javax.sql.rowset.spi.SyncProvider.getDataSourceLock() definition code for javax.sql.rowset.spi.SyncProvider.getDataSourceLock()

getDataSourceLock sample code for javax.sql.rowset.spi.SyncProvider.getDataSourceLock() definition code for javax.sql.rowset.spi.SyncProvider.getDataSourceLock() 

public abstract int getDataSourceLock()
                               throws SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException definition code for javax.sql.rowset.spi.SyncProviderException
Returns the current data source lock severity level active in this SyncProvider implementation.

Returns:
a constant indicating the current level of data source lock active in this SyncProvider object; one of the following: 
           SyncProvider.DATASOURCE_NO_LOCK,
           SyncProvider.DATASOURCE_ROW_LOCK,
           SyncProvider.DATASOURCE_TABLE_LOCK,
           SyncProvider.DATASOURCE_DB_LOCK
Throws:
SyncProviderExceptiom - if an error occurs determining the data source locking level.
SyncProviderException sample code for javax.sql.rowset.spi.SyncProviderException definition code for javax.sql.rowset.spi.SyncProviderException
See Also:
setDataSourceLock(int) sample code for javax.sql.rowset.spi.SyncProvider.setDataSourceLock(int) definition code for javax.sql.rowset.spi.SyncProvider.setDataSourceLock(int)

supportsUpdatableView sample code for javax.sql.rowset.spi.SyncProvider.supportsUpdatableView() definition code for javax.sql.rowset.spi.SyncProvider.supportsUpdatableView() 

public abstract int supportsUpdatableView()
Returns whether this SyncProvider implementation can perform synchronization between a RowSet object and the SQL VIEW in the data source from which the RowSet object got its data.

Returns:
an int saying whether this SyncProvider object supports updating an SQL VIEW; one of the following: SyncProvider.UPDATABLE_VIEW_SYNC, SyncProvider.NONUPDATABLE_VIEW_SYNC

getVersion sample code for javax.sql.rowset.spi.SyncProvider.getVersion() definition code for javax.sql.rowset.spi.SyncProvider.getVersion() 

public abstract String sample code for java.lang.String definition code for java.lang.String  getVersion()
Returns the release version of this SyncProvider instance.

Returns:
a String detailing the release version of the SyncProvider implementation

getVendor sample code for javax.sql.rowset.spi.SyncProvider.getVendor() definition code for javax.sql.rowset.spi.SyncProvider.getVendor() 

public abstract String sample code for java.lang.String definition code for java.lang.String  getVendor()
Returns the vendor name of this SyncProvider instance

Returns:
a String detailing the vendor name of this SyncProvider implementation
Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD