Spec-Zone.ru › OpenJDK 24

Класс SyncProvider

java.lang.Object
javax.sql.rowset.spi.SyncProvider
public abstract class SyncProvider extends Object
Механизм синхронизации, обеспечивающий возможности чтения/записи для отключенных RowSet объектов. Реализация SyncProvider — это класс, расширяющий абстрактный класс SyncProvider.

Реализация SyncProvider идентифицируется уникальным идентификатором, который представляет собой полное имя класса. Это имя должно быть зарегистрировано в SyncFactory SPI, сделав реализацию доступной для всех реализаций RowSet. Механизм фабрики в эталонной реализации использует это имя для создания реализации, которая затем может предоставить объект RowSet с его объектом чтения (объект javax.sql.RowSetReader) и объектом записи (объект javax.sql.RowSetWriter).

Спецификация Jdbc RowSet Реализации предоставляет две эталонные реализации абстрактного класса SyncProvider: RIOptimisticProvider и RIXMLProvider. RIOptimisticProvider может установить любую реализацию RowSet с объектом RowSetReader и объектом RowSetWriter. Однако только реализация RIXMLProvider может установить объект XmlReader и объект XmlWriter. Объект WebRowSet использует объект XmlReader для чтения данных в формате XML, чтобы заполнить себя этими данными. Он использует объект XmlWriter для записи самого себя в поток или объект java.io.Writer в формате XML.

1.0 Конвенция именования для реализаций

В качестве руководства по именованию реализаций SyncProvider следует отметить следующее:
  • Имя реализации SyncProvider — это полное имя ее класса.
  • Рекомендуется, чтобы поставщики предоставляли реализацию SyncProvider в пакете с именем providers.

Например, если поставщик Fred, Inc. предложил реализацию SyncProvider, у вас может быть следующее:

     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
 

Следующая строка кода использует полное имя для регистрации этой реализации в статическом экземпляре SyncFactory.

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

Объект по умолчанию SyncProvider, предоставляемый эталонной реализацией, использует следующее имя:

     com.sun.rowset.providers.RIOptimisticProvider
 

Поставщики должны обратиться к эталонным поставщикам синхронизации для получения дополнительной информации о том, как реализовать новую реализацию SyncProvider.

2.0 Как объект RowSet получает своего поставщика

Отключенный объект Rowset может получить доступ к объекту SyncProvider одним из следующих двух способов:
  • Используя конструктор
           CachedRowSet crs = new CachedRowSet(
                      "com.fred.providers.HighAvailabilitySyncProvider");
          
  • Используя метод setSyncProvider
           CachedRowSet crs = new CachedRowSet();
           crs.setSyncProvider("com.fred.providers.HighAvailabilitySyncProvider");
          

По умолчанию эталонные реализации поставщиков синхронизации RowSet всегда доступны платформе Java. Если никакие другие подключаемые поставщики синхронизации не были корректно зарегистрированы, SyncFactory автоматически сгенерирует экземпляр по умолчанию эталонной реализации SyncProvider. Таким образом, в предыдущем фрагменте кода, если никакая реализация с именем com.fred.providers.HighAvailabilitySyncProvider не была зарегистрирована в экземпляре SyncFactory, crs будет назначен поставщику по умолчанию в эталонной реализации, а именно com.sun.rowset.providers.RIOptimisticProvider.

3.0 Нарушения и проблемы синхронизации

Если обновление между отключенным объектом RowSet и источником данных нарушает исходный запрос или ограничения основного источника данных, это приведет к неопределенному поведению для всех реализаций отключенных объектов RowSet и их назначенных реализаций SyncProvider. Отсутствие определения поведения при таких нарушениях обеспечивает большую гибкость для реализации SyncProvider, чтобы определить свой собственный наилучший курс действий.

Реализация SyncProvider может выбрать реализацию определенного обработчика для обработки подмножества нарушений запроса. Однако если нарушение исходного запроса или нарушение ограничения источника данных в более общем случае не обрабатывается реализацией SyncProvider, все объекты SyncProvider должны сгенерировать исключение SyncProviderException.

4.0 Обновляемые SQL-представления

Любой отключенный или подключенный объект RowSet может быть заполнен из SQL-запроса, изначально сформулированного из SQL-представления VIEW. Хотя во многих случаях возможно выполнить обновление базового представления, такое обновление требует дополнительной метаданных, которые могут различаться. Класс SyncProvider предоставляет две константы для указания, поддерживает ли реализация обновление SQL-представления VIEW.
  • NONUPDATABLE_VIEW_SYNC — указывает, что реализация SyncProvider не поддерживает синхронизацию с SQL-представлением VIEW как основным источником данных для объекта RowSet.
  • UPDATABLE_VIEW_SYNC — указывает, что реализация SyncProvider поддерживает синхронизацию с SQL-представлением VIEW как основным источником данных.

По умолчанию объект RowSet не может быть обновлен, если он был заполнен данными из SQL-представления VIEW.

5.0 Константы SyncProvider

Класс SyncProvider предоставляет три набора констант, которые используются в качестве возвращаемых значений или параметров для методов SyncProvider. Объекты SyncProvider могут быть реализованы для выполнения синхронизации между объектом RowSet и его основным источником данных с разной степенью тщательности. Первая группа констант указывает, как обрабатывается синхронизация. Например, GRADE_NONE указывает, что объект SyncProvider не будет обращать внимание на то, какие данные допустимы, и просто запишет данные RowSet в источник данных. GRADE_MODIFIED_AT_COMMIT указывает, что поставщик будет проверять только измененные данные на валидность. Другие классы проверяют все данные на валидность или устанавливают блокировки при изменении или загрузке данных.
  1. Константы для указания степени синхронизации объекта SyncProvider
    • SyncProvider.GRADE_NONE
    • SyncProvider.GRADE_MODIFIED_AT_COMMIT
    • SyncProvider.GRADE_CHECK_ALL_AT_COMMIT
    • SyncProvider.GRADE_LOCK_WHEN_MODIFIED
    • SyncProvider.GRADE_LOCK_WHEN_LOADED
  2. Константы для указания устанавливаемых блокировок на источнике данных
    • SyncProvider.DATASOURCE_NO_LOCK
    • SyncProvider.DATASOURCE_ROW_LOCK
    • SyncProvider.DATASOURCE_TABLE_LOCK
    • SyncProvider.DATASOURCE_DB_LOCK
  3. Константы для указания возможности объекта SyncProvider выполнять обновления SQL-представления VIEW
    Эти константы объяснены в предыдущем разделе (4.0).
    • SyncProvider.UPDATABLE_VIEW_SYNC
    • SyncProvider.NONUPDATABLE_VIEW_SYNC
Since:
1.5
См. также:
  • SyncFactory
  • SyncFactoryException

Краткое описание полей

Модификатор и тип Поле Описание
static final int DATASOURCE_DB_LOCK
Указывает, что блокировка применена ко всему источнику данных, являющемуся источником данных для объекта RowSet, использующего этот объект SyncProvider.
static final int DATASOURCE_NO_LOCK
Указывает, что блокировки исходного источника данных больше нет.
static final int DATASOURCE_ROW_LOCK
Указывает, что блокировка применена к строкам, затронутым исходным SQL-запросом, используемым для заполнения объекта RowSet, использующего этот объект SyncProvider.
static final int DATASOURCE_TABLE_LOCK
Указывает, что блокировка применена ко всем таблицам, затронутым исходным SQL-запросом, используемым для заполнения объекта RowSet, использующего этот объект SyncProvider.
static final int GRADE_CHECK_ALL_AT_COMMIT
Указывает высокий уровень оптимистической синхронизации по отношению к исходному источнику данных.
static final int GRADE_CHECK_MODIFIED_AT_COMMIT
Указывает низкий уровень оптимистической синхронизации по отношению к исходному источнику данных.
static final int GRADE_LOCK_WHEN_LOADED
Указывает наиболее пессимистический уровень синхронизации по отношению к исходному источнику данных.
static final int GRADE_LOCK_WHEN_MODIFIED
Указывает пессимистический уровень синхронизации по отношению к исходному источнику данных.
static final int GRADE_NONE
Указывает, что синхронизация с исходным источником данных не предоставляется.
static final int NONUPDATABLE_VIEW_SYNC
Указывает, что реализация SyncProvider не поддерживает синхронизацию между объектом RowSet и SQL-запросом VIEW, используемым для его заполнения.
static final int UPDATABLE_VIEW_SYNC
Указывает, что реализация SyncProvider поддерживает синхронизацию между объектом RowSet и SQL-запросом VIEW, используемым для его заполнения.

Краткое описание конструкторов

Конструктор Описание
SyncProvider()
Создаёт объект SyncProvider по умолчанию.

Краткое описание методов

Модификатор и тип Метод Описание
abstract int getDataSourceLock()
Возвращает текущий уровень строгости блокировки источника данных, активный в данной реализации SyncProvider.
abstract int getProviderGrade()
Возвращает константу, указывающую уровень синхронизации, который может ожидать объект RowSet от объекта SyncProvider.
abstract String getProviderID()
Возвращает уникальный идентификатор этого объекта SyncProvider.
abstract RowSetReader getRowSetReader()
Возвращает объект javax.sql.RowSetReader, который можно использовать для заполнения объекта RowSet данными.
abstract RowSetWriter getRowSetWriter()
Возвращает объект javax.sql.RowSetWriter, который можно использовать для записи данных объекта RowSet обратно в базовый источник данных.
abstract String getVendor()
Возвращает имя поставщика этой инстанции SyncProvider
abstract String getVersion()
Возвращает версию данной инстанции SyncProvider.
abstract void setDataSourceLock(int datasource_lock)
Устанавливает блокировку базового источника данных на уровне, указанном в datasource_lock.
abstract int supportsUpdatableView()
Возвращает, может ли данная реализация SyncProvider выполнить синхронизацию между объектом RowSet и SQL-запросом VIEW в источнике данных, из которого объект RowSet получил свои данные.

Методы, объявленные в классе java.lang.Object

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

Подробное описание полей

GRADE_NONE

public static final int GRADE_NONE
Указывает, что синхронизация с исходным источником данных не предоставляется. Реализация SyncProvider, возвращающая этот класс, просто попытается записать обновления в объект RowSet в исходный источник данных без проверки достоверности данных.
См. также:
  • Значения постоянных полей

GRADE_CHECK_MODIFIED_AT_COMMIT

public static final int GRADE_CHECK_MODIFIED_AT_COMMIT
Указывает оптимистический уровень синхронизации низкого уровня по отношению к исходному источнику данных. Реализация SyncProvider, возвращающая этот класс, будет проверять только измененные строки.
См. также:
  • Значения постоянных полей

GRADE_CHECK_ALL_AT_COMMIT

public static final int GRADE_CHECK_ALL_AT_COMMIT
Указывает оптимистический уровень синхронизации высокого уровня по отношению к исходному источнику данных. Реализация SyncProvider, возвращающая этот класс, будет проверять все строки, включая не изменённые.
См. также:
  • Значения постоянных полей

GRADE_LOCK_WHEN_MODIFIED

public static final int GRADE_LOCK_WHEN_MODIFIED
Указывает пессимистический уровень синхронизации по отношению к исходному источнику данных. Реализация SyncProvider, возвращающая этот класс, заблокирует строку в исходном источнике данных.
См. также:
  • Значения постоянных полей

GRADE_LOCK_WHEN_LOADED

public static final int GRADE_LOCK_WHEN_LOADED
Указывает наиболее пессимистический уровень синхронизации по отношению к исходному источнику данных. Реализация SyncProvider, возвращающая этот класс, заблокирует весь вид и/или таблицу, затронутые исходным оператором, использованным для заполнения объекта RowSet.
См. также:
  • Значения постоянных полей

DATASOURCE_NO_LOCK

public static final int DATASOURCE_NO_LOCK
Указывает, что блокировки в исходном источнике данных отсутствуют. Это значение по умолчанию для всех реализаций SyncProvider, если не указано иное объектом RowSet.
См. также:
  • Значения постоянных полей

DATASOURCE_ROW_LOCK

public static final int DATASOURCE_ROW_LOCK
Указывает, что блокировка применена к строкам, затронутым исходным SQL-запросом для заполнения объекта RowSet, использующего данный объект SyncProvider.
См. также:
  • Значения постоянных полей

DATASOURCE_TABLE_LOCK

public static final int DATASOURCE_TABLE_LOCK
Указывает, что блокировка применена ко всем таблицам, затронутым исходным SQL-запросом для заполнения объекта RowSet, использующего данный объект SyncProvider.
См. также:
  • Значения постоянных полей

DATASOURCE_DB_LOCK

public static final int DATASOURCE_DB_LOCK
Указывает, что блокировка применена ко всему источнику данных, являющемуся источником данных для объекта RowSet, использующего данный объект SyncProvider.
См. также:
  • Значения постоянных полей

UPDATABLE_VIEW_SYNC

public static final int UPDATABLE_VIEW_SYNC
Указывает, что реализация SyncProvider поддерживает синхронизацию между объектом RowSet и SQL-запросом VIEW, используемым для его заполнения.
См. также:
  • Значения постоянных полей

NONUPDATABLE_VIEW_SYNC

public static final int NONUPDATABLE_VIEW_SYNC
Указывает, что реализация SyncProvider не поддерживает синхронизацию между объектом RowSet и SQL-запросом VIEW, используемым для его заполнения.
См. также:
  • Значения постоянных полей

Подробное описание конструкторов

SyncProvider

public SyncProvider()
Создаёт объект SyncProvider по умолчанию.

Подробное описание методов

getProviderID

public abstract String getProviderID()
Возвращает уникальный идентификатор для этого объекта SyncProvider.
Возвращает:
объект String с полным квалифицированным именем класса этого объекта SyncProvider

getRowSetReader

public abstract RowSetReader getRowSetReader()
Возвращает объект javax.sql.RowSetReader, который может быть использован для заполнения объекта RowSet данными.
Возвращает:
объект javax.sql.RowSetReader

getRowSetWriter

public abstract RowSetWriter getRowSetWriter()
Возвращает объект javax.sql.RowSetWriter, который может быть использован для записи данных объекта RowSet обратно в исходный источник данных.
Возвращает:
объект javax.sql.RowSetWriter

getProviderGrade

public abstract int getProviderGrade()
Возвращает константу, указывающую уровень синхронизации, который объект RowSet может ожидать от этого объекта SyncProvider.
Возвращает:
целое число, являющееся одной из следующих констант: 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

public abstract void setDataSourceLock(int datasource_lock) throws SyncProviderException
Устанавливает блокировку на исходном источнике данных на уровне, указанном в datasource_lock. Это должно привести к тому, что SyncProvider скорректирует своё поведение, увеличив или уменьшив уровень оптимизма, предоставляемый для успешной синхронизации.
Параметры:
datasource_lock - одна из следующих констант, указывающих уровень блокировки источника данных:
           SyncProvider.DATASOURCE_NO_LOCK,
           SyncProvider.DATASOURCE_ROW_LOCK,
           SyncProvider.DATASOURCE_TABLE_LOCK,
           SyncProvider.DATASOURCE_DB_LOCK,
 
Исключения:
SyncProviderException - если установлен неподдерживаемый уровень блокировки источника данных.
См. также:
  • getDataSourceLock()

getDataSourceLock

public abstract int getDataSourceLock() throws SyncProviderException
Возвращает текущий уровень блокировки источника данных, активный в этой реализации SyncProvider.
Возвращает:
константа, указывающая текущий уровень блокировки источника данных, активный в этом объекте SyncProvider; одна из следующих:
           SyncProvider.DATASOURCE_NO_LOCK,
           SyncProvider.DATASOURCE_ROW_LOCK,
           SyncProvider.DATASOURCE_TABLE_LOCK,
           SyncProvider.DATASOURCE_DB_LOCK
 
Исключения:
SyncProviderException - если произошла ошибка при определении уровня блокировки источника данных.
См. также:
  • setDataSourceLock(int)

supportsUpdatableView

public abstract int supportsUpdatableView()
Возвращает, может ли эта реализация SyncProvider выполнить синхронизацию между объектом RowSet и SQL VIEW в источнике данных, из которого объект RowSet получил свои данные.
Возвращает:
int, указывающее, поддерживает ли этот объект SyncProvider обновление SQL VIEW; одно из следующих значений: SyncProvider.UPDATABLE_VIEW_SYNC, SyncProvider.NONUPDATABLE_VIEW_SYNC

getVersion

public abstract String getVersion()
Возвращает версию релиза этого экземпляра SyncProvider.
Возвращает:
String, описывающий версию релиза реализации SyncProvider

getVendor

public abstract String getVendor()
Возвращает имя поставщика этого экземпляра SyncProvider.
Возвращает:
String, описывающий имя поставщика реализации SyncProvider

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.sql.rowset/javax/sql/rowset/spi/SyncProvider.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API