Модуль подключения к серверу БД

Модуль db-connection предназначен для подключения приложения JaBricks к серверу БД типа Oracle, MSSQL, PostgreSQL, MySQL, Apache Derby. Параметры подключения, включающие тип провайдера, host, порт, наименование базы данных и т.д. определяются в файле инициализации приложения «jabricks.ini». Параметры учетной записи (логин, пароль) определяются в графическом интерфейсе модуля.

Примечание :
1. По сути db-connection является интерфейсной оболочкой модуля util-db для управления соединением с сервером БД.
2. При первом подключении к серверу БД модуль создает в БД таблицу jbt_users.

Описание интерфейса формы

Интерфейс формы модуля включает два обязательных для заполнения поля («Имя», «Пароль») и кнопки управления. Определенное в файле инициализации jabricks.ini значение параметра sql.login автоматически подставляется в поле «Имя». Для подключения к серверу базы данных необходимо ввести значения и нажать кнопку «Подключение». Если параметры подключения определены правильно, то db-connection с помощью модуля util-db создаст соединение с сервером БД, объект подключения Connect и закроет форму.

Примечание : при успешном подключении к SQL серверу «Имя» пользователя (логин) сохраняется в файле инициализации приложения jabricks.ini.

При повторном открытии формы компоненты «Имя» и «Пароль» будут заблокированы, а кнопка «Подключение» будет переименована в «Отключение».

Рассылка сообщений Подключения/Отключения

При успешном выполнении операций Подключения/Отключения модуль рассылает подписчикам сообщение jabricks/DBConnect. Если интерфейсные формы подписчиков (бандлов) открыты и в бандлах реализованы функции обработки события подключения, то в режиме run-time без перезагрузки модулей будут выполнены соответствующие операции — загрузка информации из сервера БД при подключении, либо очистка компонентов форм при отключении. Пример механизма подписки на сообщения локализации интерфейса представлен в модуле form-locale.

Параметры подключения к серверу БД

Необходимые параметры подключения к серверу БД определяются в файле инициализации jabricks.ini. Количество и назначения параметров для разных провайдеров БД могут отличаться. Список доступных параметров подключения к серверу БД :

Идентификатор сервиса sql.sid используется для взаимодействия с Oracle. Наименование схемы sql.schema используется для взаимодействия с MSSQL и PostgreSQL, базы данных (database) которых могут включать несколько объектов схем (schema). Необязательный параметр логин пользователя sql.login может быть не определен. При успешном подключении к серверу БД значение sql.login автоматически добавляется, либо обновляется в файле инициализации.

# Oracle
sql.provider=Oracle
sql.host=localhost
sql.port=1521
sql.sid=XE
sql.database=SCOTT
sql.login=SCOTT

# MSSQL
sql.provider=MSSQL
sql.host=localhost
# sql.host=localhost\\sqlexpress
# sql.host=depo\\sqlexpress
sql.port=1433
sql.database=mytest
sql.schema=dbo
sql.login=sa

# Postgres
sql.provider=Postgres
sql.host=localhost
sql.port=5432
sql.database=jabricks
sql.schema=public
sql.login=root

# MySQL
sql.provider=MySQL
sql.host=localhost
sql.port=3306
sql.database=jabricks
sql.login=root

# Derby
sql.provider=DerbyEmbedded
sql.host=D:/warehouse/db
sql.database=jabricks
sql.login=user

Объект описания подключения, Connect

// Описание класса
public class Connect
{
    private  Provider provider ; // Provider 
    private  String   host     ;
    private  int      port     ;
    private  String   database ;
    private  String   schema   ;
    private  String   login    ;
    private  String   password ;
    private  IDAO     dao      ; // объект взаимодействия
                                 // с сервером БД

    public Connect (String host, int port, String login, 
                    String password, Provider provider);
    public Connect (String host, int port, String login,
                    String password, IDAO dao, 
                    Provider provider);
}

Все параметры объекта Connect определяются инициализационными значениями файла jabricks.ini и учетной записью пользователя из полей формы, за исключением последнего поля IDAO, представляющющего реализацию объекта доступа к серверу БД и включающего параметр соединения с сервером java.sql.Connection с использованием JDBC и ряд методов выполнения SQL запросов. Модуль db-connection передает объект Connect в бандл util-db.

Локализация формы

Интерфейс формы локализован для трех языков : русский, английский и немецкий. Визуальные локализованные параметры интерфейса при открытии формы устанавливаются согласно текущей Locale.

Бандл "подписан" на событие изменения языка локализации jabricks/LocaleEvent. При возникновении данного события (генерируемое, например, бандлами form-locale, form-settings) и открытой форме, интерфейс формы будет переведен на новый язык локализации без "перезагрузки" формы, т.е. не требуется закрытие и повторное открытие формы.

Сообщения об ошибках

Сообщения об ошибках подключения, возвращаемые сервером БД через модуль util-db, отображаются красным курсивом в статусной строке. На следующем скриншоте (англоязычный интерфейс) демонстрируется текст ошибки.

Примечание : сообщение об ошибке подключения модуль util-db отправляет в логгер (util-logger) для отображения в консоли и для регистрации в файле при установленных соответствующих флагах в файле инициализации приложения jabricks.ini.

Зависимости модуля

Модуль db-connection использует следующие бандлы :

• бандл util-resources, от которого получает текущую Locale для локализации интерфейса формы и параметры подключения к серверу БД;
• бандл util-db для создания объекта взаимодействия с сервером IDAO и установления соединения java.sql.Connection с сервером БД.
• бандл gui-widgets, содержащий константные значения сообщений, используемые в механизме публикация/подписка.
• бандл base-jdialog, содержащий родительский класс формирования интерфейса формы.

Подключение модуля к приложению

Для подключения модуля db-connection в приложение Jabricks необходимо :

• разместить модуль в поддиректории «configuration/bundles/»;
• внести в файл инициализации бандлов «bundles.ini» запись db-connection-1.0.0.jar@start;
  
  Примечание : для открытия формы подключения при старте приложения в наименование бандла необходимо включить атрибут @start
   
• определить пункт меню или/и кнопку панели инструментов, параметрами подключения которых указать GAV значения бандла db-connection.

GAV параметры модуля db-connection имеют следующие значения :

Подробнее о включении модуля в приложение Jabricks представлено здесь.

Рассмотренный на странице модуль db-connection упакован в архивный файл db-connection-1.0.0.zip (19.0 Кб).