BasicDataSource (root 0.2-SNAPSHOT API)

java.lang.Object
- xyz.cofe.sql.SimpleDataSource
- - xyz.cofe.sql.BasicDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource, ConnectOptions
```
public class BasicDataSource
extends SimpleDataSource
implements ConnectOptions
```
Описание соединения с СУБД.

Author:

Kamnev Georgiy

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BasicDataSource.XmlVisitor

Nested Classes
Modifier and Type	Class and Description
`static class`	`BasicDataSource.XmlVisitor`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`autoCommit`
`protected AtomicLong`	`changed`
`static Charset`	`defaultFileCharset`
`protected Integer`	`networkTimeout`
`protected Boolean`	`networkTimeoutDaemon`
`protected static ExecutorService`	`networkTimeoutService`
`protected Boolean`	`networkTimeoutStatic`
`protected String`	`networkTimeoutThreadName`
`protected Integer`	`networkTimeoutThreads`
`protected String`	`schema`
`protected AtomicLong`	`scn`
`protected TransactIsolation`	`transactIsolation` Режим изоляции транзакций
`static String`	`XMLROOT` Имя корневого тега (dataSource)

Fields inherited from class xyz.cofe.sql.SimpleDataSource
loginTimeout, logWriter, properties, psupport, url

Constructor Summary

Constructors
Constructor and Description
`BasicDataSource()`
`BasicDataSource(BasicDataSource sample)`
`BasicDataSource(String url)`
`BasicDataSource(String url, Properties props)`
`BasicDataSource(String url, String username, String password)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assign(SimpleDataSource ds)`
`BasicDataSource`	`clone()`
`protected void`	`configureConnection(Connection conn)`
`Boolean`	`getAutoCommit()` Указывает автоматическое подтверждение транзакций
`long`	`getChanged()` Время (мс от 1970) последнего изменения.
`Connection`	`getConnection()`
`Connection`	`getConnection(String username, String password)`
`ConnectOptionsProperties`	`getConnectOptions()`
`long`	`getIdleTimeout()` Указывает время (мс) простоя соединения, после которого соединение будет закрыто.
`Integer`	`getNetworkTimeout()` Устанавливает максимальный период, когда соединение или объекты, созданные из Connection, будут ждать, пока база данных ответит на любой запрос.
`Boolean`	`getNetworkTimeoutDaemon()` Указывает как запускать сервис network timeout.
`static ExecutorService`	`getNetworkTimeoutService()`
`Boolean`	`getNetworkTimeoutStatic()` Использовать сервис проверки network timeout как статичный (синглетон) демон Это поведение по умолчанию
`String`	`getNetworkTimeoutThreadName()`
`Integer`	`getNetworkTimeoutThreads()` Указывает кол-во потоков/тредов для сервиса network-timeout
`String`	`getSchema()` Указывают текущую схему при установке соединения
`long`	`getSCN()` Последовательный номер изменения
`long`	`getStatementIdleTimeout()` Указывает время (мс) простоя запроса, после которого запрос будет закрыт.
`TransactIsolation`	`getTransactIsolation()` Указывает режим изоляции транзакций
`protected void`	`initScnIncrementor()`
`boolean`	`isCollectActivityStat()` Собирать статистику активности
`boolean`	`isProxyConnection()` Создавать прокси соединение
`void`	`loadXml(Node xml)`
`static BasicDataSource`	`read(XMLStreamReader reader)`
`static BasicDataSource`	`readXml(File reader)`
`static BasicDataSource`	`readXml(File reader)`
`static BasicDataSource`	`readXml(File reader, Charset cs)`
`static BasicDataSource`	`readXml(File reader, Charset cs)`
`static BasicDataSource`	`readXml(InputStream reader)`
`static BasicDataSource`	`readXml(InputStream reader, Charset cs)`
`static BasicDataSource`	`readXml(Path reader)`
`static BasicDataSource`	`readXml(Path reader, Charset cs)`
`static BasicDataSource`	`readXml(Reader reader)`
`static BasicDataSource`	`readXml(URL reader)`
`static BasicDataSource`	`readXml(URL reader, Charset cs)`
`void`	`setAutoCommit(Boolean autoCommit)` Указывает автоматическое подтверждение транзакций
`void`	`setCollectActivityStat(boolean v)` Собирать статистику активности
`void`	`setIdleTimeout(long ms)` Указывает время (мс) простоя соединения, после которого соединение будет закрыто.
`void`	`setNetworkTimeout(Integer networkTimeout)` Указывает таймут сети.
`void`	`setNetworkTimeoutDaemon(Boolean networkTimeoutDaemon)` Указывает как запускать сервис network timeout.
`void`	`setNetworkTimeoutStatic(Boolean networkTimeoutStatic)` Использовать сервис проверки network timeout как статичный (синглетон) демон
`void`	`setNetworkTimeoutThreadName(String networkTimeoutThreadName)`
`void`	`setNetworkTimeoutThreads(Integer networkTimeoutThreads)` Указывает кол-во потоков/тредов для сервиса network-timeout
`void`	`setProxyConnection(boolean v)` Создавать прокси соединение
`void`	`setSchema(String schema)` Указывают текущую схему при установке соединения
`void`	`setStatementIdleTimeout(long ms)` Указывает время (мс) простоя запроса, после которого запрос будет закрыт.
`void`	`setTransactIsolation(TransactIsolation transactIsolation)` Указывает режим изоляции транзакций
`void`	`write(Element el)`
`void`	`write(FormatXMLWriter xwr)`
`void`	`write(XMLStreamWriter xwr)`
`void`	`writeXml(File writer)`
`void`	`writeXml(File writer)`
`void`	`writeXml(File writer, Charset cs)`
`void`	`writeXml(File writer, Charset cs)`
`void`	`writeXml(OutputStream writer)`
`void`	`writeXml(OutputStream writer, Charset cs)`
`void`	`writeXml(Path writer)`
`void`	`writeXml(Path writer, Charset cs)`
`void`	`writeXml(Writer writer)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - scn
```
protected final AtomicLong scn
```
  - changed
```
protected final AtomicLong changed
```
  - autoCommit
```
protected Boolean autoCommit
```
  - transactIsolation
```
protected TransactIsolation transactIsolation
```
    Режим изоляции транзакций
  - schema
```
protected String schema
```
  - networkTimeout
```
protected Integer networkTimeout
```
  - networkTimeoutThreads
```
protected Integer networkTimeoutThreads
```
  - networkTimeoutDaemon
```
protected Boolean networkTimeoutDaemon
```
  - networkTimeoutThreadName
```
protected String networkTimeoutThreadName
```
  - networkTimeoutService
```
protected static transient volatile ExecutorService networkTimeoutService
```
  - networkTimeoutStatic
```
protected Boolean networkTimeoutStatic
```
  - XMLROOT
```
public static final String XMLROOT
```
    Имя корневого тега (dataSource)
    
    See Also:
    
    Constant Field Values
  - defaultFileCharset
```
public static final Charset defaultFileCharset
```
- Constructor Detail
  - BasicDataSource
```
public BasicDataSource()
```
  - BasicDataSource
```
public BasicDataSource(String url)
```
  - BasicDataSource
```
public BasicDataSource(String url,
                       String username,
                       String password)
```
  - BasicDataSource
```
public BasicDataSource(String url,
                       Properties props)
```
  - BasicDataSource
```
public BasicDataSource(BasicDataSource sample)
```
- Method Detail
  - clone
```
public BasicDataSource clone()
```
    Overrides:
    
    clone in class SimpleDataSource
  - assign
```
public void assign(SimpleDataSource ds)
```
    Overrides:
    
    assign in class SimpleDataSource
  - initScnIncrementor
```
protected void initScnIncrementor()
```
  - getConnectOptions
```
public ConnectOptionsProperties getConnectOptions()
```
  - getChanged
```
public long getChanged()
```
    Время (мс от 1970) последнего изменения.
    
    Returns:
    
    время последнего изменения
  - getSCN
```
public long getSCN()
```
    Последовательный номер изменения
    
    Returns:
    
    счетчик изменения
  - isProxyConnection
```
public boolean isProxyConnection()
```
    Создавать прокси соединение
    
    Specified by:
    
    isProxyConnection in interface ConnectOptions
    
    Returns:
    
    true - создавать прокси
  - setProxyConnection
```
public void setProxyConnection(boolean v)
```
    Создавать прокси соединение
    
    Parameters:
    
    v - true - создавать прокси
  - isCollectActivityStat
```
public boolean isCollectActivityStat()
```
    Собирать статистику активности
    
    Specified by:
    
    isCollectActivityStat in interface ConnectOptions
    
    Returns:
    
    собирать статистику активности
  - setCollectActivityStat
```
public void setCollectActivityStat(boolean v)
```
    Собирать статистику активности
    
    Parameters:
    
    v - true - собирать статистику активности
  - getIdleTimeout
```
public long getIdleTimeout()
```
    Указывает время (мс) простоя соединения, после которого соединение будет закрыто.
    значение -1 и меньше - не закрывать по истечению таймаута
    
    Specified by:
    
    getIdleTimeout in interface ConnectOptions
    
    Returns:
    
    Время простоя
  - setIdleTimeout
```
public void setIdleTimeout(long ms)
```
    Указывает время (мс) простоя соединения, после которого соединение будет закрыто.
    значение -1 и меньше - не закрывать по истечению таймаута
    
    Parameters:
    
    ms - время (мс) простоя соединения
  - getStatementIdleTimeout
```
public long getStatementIdleTimeout()
```
    Указывает время (мс) простоя запроса, после которого запрос будет закрыт.
    значение -1 и меньше - не закрывать по истечению таймаута
    
    Specified by:
    
    getStatementIdleTimeout in interface ConnectOptions
    
    Returns:
    
    Время (мс) простоя
  - setStatementIdleTimeout
```
public void setStatementIdleTimeout(long ms)
```
    Указывает время (мс) простоя запроса, после которого запрос будет закрыт.
    значение -1 и меньше - не закрывать по истечению таймаута
    
    Parameters:
    
    ms - Время (мс) простоя
  - getConnection
```
public Connection getConnection(String username,
                                String password)
                         throws SQLException
```
    Specified by:
    
    getConnection in interface DataSource
    
    Overrides:
    
    getConnection in class SimpleDataSource
    
    Throws:
    
    SQLException
  - getConnection
```
public Connection getConnection()
                         throws SQLException
```
    Specified by:
    
    getConnection in interface DataSource
    
    Overrides:
    
    getConnection in class SimpleDataSource
    
    Throws:
    
    SQLException
  - getAutoCommit
```
public Boolean getAutoCommit()
```
    Указывает автоматическое подтверждение транзакций
    
    Returns:
    
    true - автоматическое подтверждение транзакций
  - setAutoCommit
```
public void setAutoCommit(Boolean autoCommit)
```
    Указывает автоматическое подтверждение транзакций
    
    Parameters:
    
    autoCommit - true - автоматическое подтверждение транзакций
  - getTransactIsolation
```
public TransactIsolation getTransactIsolation()
```
    Указывает режим изоляции транзакций
    
    Returns:
    
    режим изоляции транзакций
  - setTransactIsolation
```
public void setTransactIsolation(TransactIsolation transactIsolation)
```
    Указывает режим изоляции транзакций
    
    Parameters:
    
    transactIsolation - режим изоляции транзакций
  - getSchema
```
public String getSchema()
```
    Указывают текущую схему при установке соединения
    
    Returns:
    
    имя схемы
  - setSchema
```
public void setSchema(String schema)
```
    Указывают текущую схему при установке соединения
    
    Parameters:
    
    schema - имя схемы
  - getNetworkTimeout
```
public Integer getNetworkTimeout()
```
    Устанавливает максимальный период, когда соединение или объекты, созданные из Connection, будут ждать, пока база данных ответит на любой запрос.
    Если какой-либо запрос остается без ответа, метод ожидания вернется с помощью SQLException, а Connection или объекты, созданные из Connection, будут отмечены как закрытые. Любое последующее использование объектов, за исключением методов close, isClosed или Connection.isValid, приведет к SQLException.
    Примечание. Этот метод предназначен для решения редкого, но серьезного состояния, при котором сетевые разделы могут вызывать потоки, выдающие вызовы JDBC, для непрерывного зависания в сокетах, до OS TCP-TIMEOUT (обычно 10 минут). Этот метод связан с методом abort (), который предоставляет потоку администратора средство для освобождения таких потоков в случаях, когда соединение JDBC доступно для потока администратора. Метод setNetworkTimeout будет охватывать случаи, когда нет потока администратора или он не имеет доступа к соединению. Этот метод является серьезным в его эффектах и должен иметь достаточно высокое значение, поэтому он никогда не запускается до каких-либо более обычных тайм-аутов, таких как таймауты транзакций.
    Реализации драйвера JDBC также могут поддерживать метод setNetworkTimeout, чтобы наложить ограничение на время отклика базы данных в средах, где нет сети.
    Драйверы могут внутренне реализовывать некоторые или все свои вызовы API с несколькими внутренними передачами драйверов-баз данных, и для реализации этого варианта остается только, будет ли предел применяться всегда к ответу на вызов API или любому отдельному запросу во время вызова API.
    Этот метод можно вызвать несколько раз, например, установить ограничение для области кода JDBC и сбросить значение по умолчанию при выходе из этой области. Вызов этого метода не влияет на уже выдающиеся запросы.
    Значение тайм-аута Statement.setQueryTimeout () не зависит от значения таймаута, указанного в setNetworkTimeout. Если тайм-аут запроса истекает до истечения сетевого тайм-аута, выполнение заявки будет отменено.
    Если сеть все еще активна, результатом будет то, что и оператор, и соединение все еще могут использоваться.
    Однако, если истечение таймаута сети истекает до таймаута запроса или если тайм-аут инструкции выходит из строя из-за сетевых проблем, соединение будет отмечено как закрытое, любые ресурсы, удерживаемые соединением, будут освобождены, и соединение и инструкция будут непригодными.
    Когда драйвер определяет, что значение тайм-аута setNetworkTimeout истекло, драйвер JDBC отмечает соединение закрытым и освобождает любые ресурсы, удерживаемые соединением.
    Этот метод проверяет, есть ли объект SQLPermission, прежде чем позволить этому методу продолжить работу. Если существует SecurityManager и его метод checkPermission отклоняет вызов setNetworkTimeout, этот метод генерирует исключение java.lang.SecurityException.
    
    Returns:
    
    таймут сети
  - setNetworkTimeout
```
public void setNetworkTimeout(Integer networkTimeout)
```
    Указывает таймут сети.
    
    Parameters:
    
    networkTimeout - таймаут
    
    See Also:
    
    getNetworkTimeout()
  - getNetworkTimeoutThreads
```
public Integer getNetworkTimeoutThreads()
```
    Указывает кол-во потоков/тредов для сервиса network-timeout
    
    Returns:
    
    кол-во тредов, по умолч 1
  - setNetworkTimeoutThreads
```
public void setNetworkTimeoutThreads(Integer networkTimeoutThreads)
```
    Указывает кол-во потоков/тредов для сервиса network-timeout
    
    Parameters:
    
    networkTimeoutThreads - кол-во тредов, по умолч 1
  - getNetworkTimeoutDaemon
```
public Boolean getNetworkTimeoutDaemon()
```
    Указывает как запускать сервис network timeout.
    true (по умолчанию) - Сервис network timeout будет запущен как фоновый поток(потоки)
    false - Сервис network timeout будет запущен как обычный поток (тред)
    
    Returns:
    
    true - сервис network timeout в фоновом режиме
  - setNetworkTimeoutDaemon
```
public void setNetworkTimeoutDaemon(Boolean networkTimeoutDaemon)
```
    Указывает как запускать сервис network timeout.
    
    Parameters:
    
    networkTimeoutDaemon - true (по умолчанию) - Сервис network timeout будет запущен как фоновый поток(потоки)
    false - Сервис network timeout будет запущен как обычный поток (тред)
  - getNetworkTimeoutThreadName
```
public String getNetworkTimeoutThreadName()
```
  - setNetworkTimeoutThreadName
```
public void setNetworkTimeoutThreadName(String networkTimeoutThreadName)
```
  - getNetworkTimeoutService
```
public static ExecutorService getNetworkTimeoutService()
```
  - getNetworkTimeoutStatic
```
public Boolean getNetworkTimeoutStatic()
```
    Использовать сервис проверки network timeout как статичный (синглетон) демон
    Это поведение по умолчанию
    
    Returns:
    
    true - использовать статичный (синглетон) демон network timeout
  - setNetworkTimeoutStatic
```
public void setNetworkTimeoutStatic(Boolean networkTimeoutStatic)
```
    Использовать сервис проверки network timeout как статичный (синглетон) демон
    
    Parameters:
    
    networkTimeoutStatic - true - использовать статичный (синглетон) демон network timeout
  - configureConnection
```
protected void configureConnection(Connection conn)
```
  - write
```
public void write(XMLStreamWriter xwr)
```
  - write
```
public void write(FormatXMLWriter xwr)
```
  - write
```
public void write(Element el)
```
  - writeXml
```
public void writeXml(Writer writer)
```
  - writeXml
```
public void writeXml(OutputStream writer)
```
  - writeXml
```
public void writeXml(OutputStream writer,
                     Charset cs)
```
  - writeXml
```
public void writeXml(File writer,
                     Charset cs)
```
  - writeXml
```
public void writeXml(File writer)
```
  - writeXml
```
public void writeXml(Path writer,
                     Charset cs)
```
  - writeXml
```
public void writeXml(Path writer)
```
  - writeXml
```
public void writeXml(File writer,
                     Charset cs)
```
  - writeXml
```
public void writeXml(File writer)
```
  - read
```
public static BasicDataSource read(XMLStreamReader reader)
```
  - readXml
```
public static BasicDataSource readXml(Reader reader)
```
  - readXml
```
public static BasicDataSource readXml(URL reader)
```
  - readXml
```
public static BasicDataSource readXml(URL reader,
                                      Charset cs)
```
  - readXml
```
public static BasicDataSource readXml(InputStream reader,
                                      Charset cs)
```
  - readXml
```
public static BasicDataSource readXml(InputStream reader)
```
  - readXml
```
public static BasicDataSource readXml(File reader)
```
  - readXml
```
public static BasicDataSource readXml(File reader,
                                      Charset cs)
```
  - readXml
```
public static BasicDataSource readXml(Path reader)
```
  - readXml
```
public static BasicDataSource readXml(Path reader,
                                      Charset cs)
```
  - readXml
```
public static BasicDataSource readXml(File reader)
```
  - readXml
```
public static BasicDataSource readXml(File reader,
                                      Charset cs)
```
  - loadXml
```
public void loadXml(Node xml)
```

Class BasicDataSource

Nested Class Summary

Field Summary

Fields inherited from class xyz.cofe.sql.SimpleDataSource

Constructor Summary

Method Summary

Methods inherited from class xyz.cofe.sql.SimpleDataSource

Methods inherited from class java.lang.Object

Field Detail

scn

changed

autoCommit

transactIsolation

schema

networkTimeout

networkTimeoutThreads

networkTimeoutDaemon

networkTimeoutThreadName

networkTimeoutService

networkTimeoutStatic

XMLROOT

defaultFileCharset

Constructor Detail

BasicDataSource

BasicDataSource

BasicDataSource

BasicDataSource

BasicDataSource

Method Detail

clone

assign

initScnIncrementor

getConnectOptions

getChanged

getSCN

isProxyConnection

setProxyConnection

isCollectActivityStat

setCollectActivityStat

getIdleTimeout

setIdleTimeout

getStatementIdleTimeout

setStatementIdleTimeout

getConnection

getConnection

getAutoCommit

setAutoCommit

getTransactIsolation

setTransactIsolation

getSchema

setSchema

getNetworkTimeout

setNetworkTimeout

getNetworkTimeoutThreads

setNetworkTimeoutThreads

getNetworkTimeoutDaemon

setNetworkTimeoutDaemon

getNetworkTimeoutThreadName

setNetworkTimeoutThreadName

getNetworkTimeoutService

getNetworkTimeoutStatic

setNetworkTimeoutStatic

configureConnection

write

write

write

writeXml

writeXml

writeXml

writeXml

writeXml

writeXml

writeXml

writeXml

writeXml

read

readXml

readXml

readXml

readXml