# CommonDataSource

Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Methods](https://developer.android.com/reference/javax/sql/CommonDataSource#pubmethods)  

# CommonDataSource

`
public


interface
CommonDataSource
`  
`


`

|----------------------------|
| javax.sql.CommonDataSource |

|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Known indirect subclasses [ConnectionPoolDataSource](https://developer.android.com/reference/javax/sql/ConnectionPoolDataSource),[DataSource](https://developer.android.com/reference/javax/sql/DataSource) |--------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| | [ConnectionPoolDataSource](https://developer.android.com/reference/javax/sql/ConnectionPoolDataSource) | A factory for`PooledConnection`objects.                                                       | | [DataSource](https://developer.android.com/reference/javax/sql/DataSource)                             | A factory for connections to the physical data source that this`DataSource`object represents. | |

<br />

*** ** * ** ***

Interface that defines the methods which are common between`DataSource`,`XADataSource`and`ConnectionPoolDataSource`.

<br />

## Summary

|                                                                                                                                                                                         ### Public methods                                                                                                                                                                                          ||
|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` abstract `[PrintWriter](https://developer.android.com/reference/java/io/PrintWriter) | ` `[getLogWriter](https://developer.android.com/reference/javax/sql/CommonDataSource#getLogWriter())`() ` <br /> Retrieves the log writer for this`DataSource`object.                                                                                                                                       |
| ` abstract int`                                                                        | ` `[getLoginTimeout](https://developer.android.com/reference/javax/sql/CommonDataSource#getLoginTimeout())`() ` Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.                                                                                  |
| ` abstract `[Logger](https://developer.android.com/reference/java/util/logging/Logger) | ` `[getParentLogger](https://developer.android.com/reference/javax/sql/CommonDataSource#getParentLogger())`() ` Return the parent Logger of all the Loggers used by this data source.                                                                                                                       |
| ` abstract void`                                                                       | ` `[setLogWriter](https://developer.android.com/reference/javax/sql/CommonDataSource#setLogWriter(java.io.PrintWriter))`(`[PrintWriter](https://developer.android.com/reference/java/io/PrintWriter)` out) ` <br /> Sets the log writer for this`DataSource`object to the given`java.io.PrintWriter`object. |
| ` abstract void`                                                                       | ` `[setLoginTimeout](https://developer.android.com/reference/javax/sql/CommonDataSource#setLoginTimeout(int))`(int seconds) ` <br /> Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.                                                            |

## Public methods

### getLogWriter

Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract PrintWriter getLogWriter ()
```

<br />

Retrieves the log writer for this`DataSource`object.

The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the`java.sql.DriverManager`class. When a`DataSource`object is created, the log writer is initially null; in other words, the default is for logging to be disabled.

<br />

|                                                                        Returns                                                                        ||
|----------------------------------------------------------------------------|---------------------------------------------------------------------------|
| [PrintWriter](https://developer.android.com/reference/java/io/PrintWriter) | the log writer for this data source or null if logging is disabled <br /> |

|                                                      Throws                                                      ||
|-------------------------------------------------------------------------------|-----------------------------------|
| [SQLException](https://developer.android.com/reference/java/sql/SQLException) | if a database access error occurs |

**See also:**

- [setLogWriter(PrintWriter)](https://developer.android.com/reference/javax/sql/CommonDataSource#setLogWriter(java.io.PrintWriter))  

### getLoginTimeout

Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract int getLoginTimeout ()
```

Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a`DataSource`object is created, the login timeout is initially zero.

<br />

|                    Returns                     ||
|-------|-----------------------------------------|
| `int` | the data source login time limit <br /> |

|                                                      Throws                                                       ||
|-------------------------------------------------------------------------------|------------------------------------|
| [SQLException](https://developer.android.com/reference/java/sql/SQLException) | if a database access error occurs. |

**See also:**

- [setLoginTimeout(int)](https://developer.android.com/reference/javax/sql/CommonDataSource#setLoginTimeout(int))  

### getParentLogger

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract Logger getParentLogger ()
```

Return the parent Logger of all the Loggers used by this data source. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source. Configuring this Logger will affect all of the log messages generated by the data source. In the worst case, this may be the root Logger.

<br />

|                                                          Returns                                                          ||
|----------------------------------------------------------------------------|-----------------------------------------------|
| [Logger](https://developer.android.com/reference/java/util/logging/Logger) | the parent Logger for this data source <br /> |

|                                                                                   Throws                                                                                   ||
|---------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| [SQLFeatureNotSupportedException](https://developer.android.com/reference/java/sql/SQLFeatureNotSupportedException) | if the data source does not use`java.util.logging``.` |

### setLogWriter

Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract void setLogWriter (PrintWriter out)
```

<br />

Sets the log writer for this`DataSource`object to the given`java.io.PrintWriter`object.

The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the`java.sql.DriverManager`class. When a`DataSource`object is created the log writer is initially null; in other words, the default is for logging to be disabled.

<br />

|                                    Parameters                                    ||
|-------|---------------------------------------------------------------------------|
| `out` | `PrintWriter`: the new log writer; to disable logging, set to null <br /> |

|                                                      Throws                                                      ||
|-------------------------------------------------------------------------------|-----------------------------------|
| [SQLException](https://developer.android.com/reference/java/sql/SQLException) | if a database access error occurs |

**See also:**

- [getLogWriter()](https://developer.android.com/reference/javax/sql/CommonDataSource#getLogWriter())  

### setLoginTimeout

Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract void setLoginTimeout (int seconds)
```

<br />

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a`DataSource`object is created, the login timeout is initially zero.

<br />

|                        Parameters                         ||
|-----------|------------------------------------------------|
| `seconds` | `int`: the data source login time limit <br /> |

|                                                      Throws                                                       ||
|-------------------------------------------------------------------------------|------------------------------------|
| [SQLException](https://developer.android.com/reference/java/sql/SQLException) | if a database access error occurs. |

**See also:**

- [getLoginTimeout()](https://developer.android.com/reference/javax/sql/CommonDataSource#getLoginTimeout())