xyz.cofe.sql.localds

Class LocalDSService

java.lang.Object

xyz.cofe.sql.localds.LocalDSService

All Implemented Interfaces:

ConnectionPoolService

public class LocalDSService
extends Object
implements ConnectionPoolService

Сервис для хранения подключений к СУБД в локальном каталоге ФС.

Осуществляет поиск в локальной файловой системе и регистрацию найденых соединений с СУБД в пуле соединений.

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

Последовательность поиска (см сис свойство ___):

1. searchForDirectories - Поиск в явно указаных каталогов (см. сис. свойство), искомый каталог должен существовать и являться каталогом.
2. searchFromCurrent - Производит рекурсивный (вверх до корня) поиск каталога .connections относительно текущего каталога.
   искомый каталог .connection можно указать сис свойством (__)
   текущий каталог можно так же указать сис свойством (__)
3. searchInHome - Производит рекурсивный (вверх до корня) поиск каталога .connections относительно домашнего каталога пользователя. сис свойством (__)
4. При предыдущий не удачных попытках, создается соот. каталог в домашней папке пользователя. С доступом только для чтения-записи владельцу (см сис свойство ___)

В найденом/созданом каталоге ищеются файлы описаний соединений. Найденые файлы регистриуются под своими именами в пуле соединений.

Пример:

 .connections/          Найденый каталог с файлами
 .connections/connections.properties Этот файл определяет поведение LocalDSService
 .connections/a1.xml    Этот файл будет зарегистриован как соединение a1
 .connections/b/a2.xml  Этот файл будет зарегистриован как соединение b/a2
 

Соединение с СУБД описывается XML файлом.

Файлы описания соединения:

 <!-- 
   type - указывает класс (возможно производный от) xyz.cofe.sql.BasicDataSource  
 -->
 <dataSource type="xyz.cofe.sql.BasicDataSource">
 <!-- 
   url - указывает с каким сервером соединяться, 
   для разных драйверов СУБД/JDBC
   MSSQL драйвер com.microsoft.sqlserver.jdbc.SQLServerDriver
     см https://docs.microsoft.com/ru-ru/sql/connect/jdbc/building-the-connection-url
     jdbc:sqlserver://[serverName[\instanceName][:portNumber]][;property=value[;property=value]]
     jdbc:sqlserver://localhost;user=MyUserName;password=*****;
     jdbc:sqlserver://localhost;databaseName=AdventureWorks;integratedSecurity=true;applicationName=MyApp;
 
   ORACLE драйвер oracle.jdbc.OracleDriver
     jdbc:oracle:thin:[<user>/<password>]@<host>[:<port>]:<SID>
     jdbc:oracle:thin:[<user>/<password>]@//<host>[:<port>]/<service>
     jdbc:oracle:thin:[<user>/<password>]@<TNSName>
 
   POSTGRESQL драйвер org.postgresql.Driver
     jdbc:postgresql://host:port/database
 -->
  <url>jdbc:sqlserver://192.168.1.10:1433;databaseName=test</url>
 
  <!-- Таймаут коннекта в секундах -->
  <loginTimeout>60</loginTimeout>
 
  <!-- __ -->
  <autoCommit>true</autoCommit>
 
  <!-- __ -->
  <schema>schema_name</schema>
 
  <!-- 
   Тип изоляции транзакций:
     Uncommitted
     Committed
     Repeatable
     Serializable
  -->
  <transactIsolation>Repeatable</transactIsolation>
 
  <networkTimeoutDaemon>true</networkTimeoutDaemon>
  <networkTimeoutStatic>true</networkTimeoutStatic>
  <networkTimeoutThreadName>DataSource network timeout</networkTimeoutThreadName>
  <networkTimeoutThreads>1</networkTimeoutThreads>
 
  <!-- Cвойства соединения передаваемые к DriverManager -->
  <properties>
 
    <!-- свойство user - указывает имя пользователя СУБД -->
    <property>
      <key>user</key>
      <value>test</value>
    </property>
 
    <!-- свойство password - указывает пароль пользователя СУБД -->
    <property>
      <key>password</key>
      <value>test</value>
    </property>
 
  </properties>
 </dataSource>

Файл connections.properties

Этот файл заданный в корне каталога соединений (.connections) содержит в себе пары ключ/значение определяющие как работать с соединениями. Файл является текстовым в формате UTF-8.

Свойство	Значение по умолчанию	Описание
registerConnections	true	true - регистрировать соединения в пуле
forceCreateLocalDS	true	true - при не возможности создать DirectoryDSS, будет использоваться реализация MemDataSource
bindMap	true	true - Осуществлять привязку соединений из пула к каталогу соединений
bindForInsert	true	true - При добавлении новых соединений в пул, соединения будут сохранены в каталоге
bindForUpdate	true	true - При обновлении соединений в пул, соединения будут сохранены в каталоге
bindForDelete	true	true - При удалении соединений из пула, соединения будут удалены из каталога

Системные свойства:

Свойство	Значение по умолчанию	Описание
xyz.cofe.sql.localds.directories		Указывает каталоги через точку с запятой в которых будет производится поиск искомого каталога
xyz.cofe.sql.localds.baseDirName	.connections	Искомый каталог с подключениями
os.name	linux	если содержит строку windows (без учета регистра) - то windows. Определяет, если os = windows - то имя мскомого каталога не зависит от регистра
xyz.cofe.sql.localds.currentDir		Указывает на тек. каталог если значение не указано, то используется: File(".")
xyz.cofe.sql.localds.userHomeDir		Переопределяет домашний каталог пользователя, по умолчанию значение береться из системной переменной user.home
xyz.cofe.sql.localds.resolveMethods	searchForDirectories;searchFromCurrent;searchInHome;createInHome;createInCurrent	Указывает в какой последовательности и как производить поиск. searchForDirectories - Искать в каталогах указанных в ствойстве xyz.cofe.sql.localds.directories Каталоги указываются через точку с запятой searchFromCurrent - произвести поиск от текущего каталога в верх до корня searchInHome - произвести поиск в домашнем каталоге пользователя createInHome - создать каталог с подключениями в домашнем каталоге пользователя createInCurrent - создать каталог с подключениями в текущем каталоге пользователя
xyz.cofe.sql.localds.mkdir.posix.perms	rwx------	Указывает POSIX доступ к создаваемому каталогу

Author:

Kamnev Georgiy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LocalDSService.EMapBinder

Field Summary

Fields

Modifier and Type	Field and Description
protected File	directory
protected Properties	properties
protected PropertyChangeSupport	psupp
protected DataSourcesStorage	storage

Constructor Summary

Constructors

Constructor and Description
LocalDSService()
LocalDSService(File dir, Properties props)
LocalDSService(String dir)
LocalDSService(String dir, Properties props)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
protected LocalDSService.EMapBinder	bind(EventMap<String,DataSource> emap, DataSourcesStorage dss)
protected void	deleteRequest(String key, DataSource ds, DataSourcesStorage dss)
void	firePropertyChange(String propertyName, Object oldValue, Object newValue)
File	getDirectory() Каталог содержащий источники данных
protected Properties	getProperties()
boolean	getProperty(String name, boolean defaultValue)
int	getProperty(String name, int defaultValue)
String	getProperty(String name, String defaultValue)
PropertyChangeListener[]	getPropertyChangeListeners()
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName)
DataSourcesStorage	getStorage()
boolean	hasListeners(String propertyName)
void	init(ConnectPool cp) Инициализация connectionPool
protected void	insertRequest(String key, DataSource ds, DataSourcesStorage dss)
boolean	isBindForDelete()
boolean	isBindForInsert()
boolean	isBindForUpdate()
boolean	isBindMap()
boolean	isForceCreateLocalDS()
boolean	isRegisterConnections()
void	reloadProperties()
protected void	removeFromStorageRequest(DataSourcesStorage dss, String key, DataSource ds)
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
File	resolveDirectory()
protected void	saveOnStorageRequest(DataSourcesStorage dss, String key, DataSource ds)
boolean	saveProperties()
void	setBindForDelete(boolean v)
void	setBindForInsert(boolean v)
void	setBindForUpdate(boolean v)
void	setBindMap(boolean v)
void	setDirectory(File directory) Каталог содержащий источники данных
void	setForceCreateLocalDS(boolean v)
void	setProperty(String name, boolean value)
void	setProperty(String name, int value)
void	setProperty(String name, String value)
void	setRegisterConnections(boolean v)
void	setStorage(DataSourcesStorage storage)
protected void	updateRequest(String key, DataSource dsOld, DataSource dsNew, DataSourcesStorage dss)

Methods inherited from class java.lang.Object

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

Field Detail

psupp

protected final transient PropertyChangeSupport psupp

properties

protected Properties properties

directory

protected File directory

storage

protected DataSourcesStorage storage

Constructor Detail

LocalDSService

public LocalDSService()

LocalDSService

public LocalDSService(String dir)

LocalDSService

public LocalDSService(String dir,
                      Properties props)

LocalDSService

public LocalDSService(File dir,
                      Properties props)

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

firePropertyChange

public void firePropertyChange(String propertyName,
                               Object oldValue,
                               Object newValue)

hasListeners

public boolean hasListeners(String propertyName)

getProperties

protected Properties getProperties()

reloadProperties

public void reloadProperties()

saveProperties

public boolean saveProperties()

getProperty

public boolean getProperty(String name,
                           boolean defaultValue)

setProperty

public void setProperty(String name,
                        boolean value)

getProperty

public int getProperty(String name,
                       int defaultValue)

setProperty

public void setProperty(String name,
                        int value)

getProperty

public String getProperty(String name,
                          String defaultValue)

setProperty

public void setProperty(String name,
                        String value)

init

public void init(ConnectPool cp)

Инициализация connectionPool

Specified by:

init in interface ConnectionPoolService

Parameters:

cp - connectionPool

isRegisterConnections

public boolean isRegisterConnections()

setRegisterConnections

public void setRegisterConnections(boolean v)

resolveDirectory

public File resolveDirectory()

getDirectory

public File getDirectory()

Каталог содержащий источники данных

Returns:

каталог с источниками данных

setDirectory

public void setDirectory(File directory)

Каталог содержащий источники данных

Parameters:

directory - каталог с источниками данных

isForceCreateLocalDS

public boolean isForceCreateLocalDS()

setForceCreateLocalDS

public void setForceCreateLocalDS(boolean v)

getStorage

public DataSourcesStorage getStorage()

setStorage

public void setStorage(DataSourcesStorage storage)

isBindMap

public boolean isBindMap()

setBindMap

public void setBindMap(boolean v)

isBindForInsert

public boolean isBindForInsert()

setBindForInsert

public void setBindForInsert(boolean v)

isBindForUpdate

public boolean isBindForUpdate()

setBindForUpdate

public void setBindForUpdate(boolean v)

isBindForDelete

public boolean isBindForDelete()

setBindForDelete

public void setBindForDelete(boolean v)

saveOnStorageRequest

protected void saveOnStorageRequest(DataSourcesStorage dss,
                                    String key,
                                    DataSource ds)

removeFromStorageRequest

protected void removeFromStorageRequest(DataSourcesStorage dss,
                                        String key,
                                        DataSource ds)

insertRequest

protected void insertRequest(String key,
                             DataSource ds,
                             DataSourcesStorage dss)

updateRequest

protected void updateRequest(String key,
                             DataSource dsOld,
                             DataSource dsNew,
                             DataSourcesStorage dss)

deleteRequest

protected void deleteRequest(String key,
                             DataSource ds,
                             DataSourcesStorage dss)

bind

protected LocalDSService.EMapBinder bind(EventMap<String,DataSource> emap,
                                         DataSourcesStorage dss)