Package org.pmw.tinylog.writers

Class JdbcWriter

java.lang.Object

org.pmw.tinylog.writers.JdbcWriter

All Implemented Interfaces:

Writer

public final class JdbcWriter
extends Object
implements Writer

Writes log entries to a SQL database.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JdbcWriter.Value	Values to insert into database.

Constructor Summary

Constructors

Constructor	Description
JdbcWriter(String url, String table, List<String> columns, List<JdbcWriter.Value> values)
JdbcWriter(String url, String table, List<String> columns, List<JdbcWriter.Value> values, boolean batch)
JdbcWriter(String url, String table, List<String> columns, List<JdbcWriter.Value> values, boolean batch, int reconnect)
JdbcWriter(String url, String table, List<String> columns, List<JdbcWriter.Value> values, boolean batch, String username, String password)
JdbcWriter(String url, String table, List<String> columns, List<JdbcWriter.Value> values, boolean batch, String username, String password, int reconnect)
JdbcWriter(String url, String table, List<String> columns, List<JdbcWriter.Value> values, String username, String password)
JdbcWriter(String url, String table, List<JdbcWriter.Value> values)
JdbcWriter(String url, String table, List<JdbcWriter.Value> values, boolean batch)
JdbcWriter(String url, String table, List<JdbcWriter.Value> values, boolean batch, int reconnect)
JdbcWriter(String url, String table, List<JdbcWriter.Value> values, boolean batch, String username, String password)
JdbcWriter(String url, String table, List<JdbcWriter.Value> values, boolean batch, String username, String password, int reconnect)
JdbcWriter(String url, String table, List<JdbcWriter.Value> values, String username, String password)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the writer and release all resources.
void	flush()	Flush this writer and force any buffered data to output.
List<String>	getColumns()	Get the columns of the table, which are used for the insert statement.
String	getPassword()	Get the password for database log in.
long	getReconnetInterval()	Get the minimum time span in milliseconds between two reconnecting tries to database if connecting is broken.
Set<LogEntryValue>	getRequiredLogEntryValues()	Get all log entry values that are required by this writer.
String	getTable()	Get the name of the database table.
String	getUrl()	Get the JDBC connection URL to database.
String	getUsername()	Get the user name for database log in.
List<JdbcWriter.Value>	getValues()	Get all values to insert.
void	init(Configuration configuration)	Initialize the writer (open a file for example).
boolean	isBatchMode()	Determine whether batch mode is enabled.
void	write(LogEntry logEntry)	Write a log entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<JdbcWriter.Value> values)

Parameters:

url - JDBC connection URL

table - Name of table

values - Values to insert

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<JdbcWriter.Value> values,
                  boolean batch)

Parameters:

url - JDBC connection URL

table - Name of table

values - Values to insert

batch - true for collecting SQL statements and execute them in a batch process, false to execute SQL statements immediately (default)

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<JdbcWriter.Value> values,
                  boolean batch,
                  int reconnect)

Parameters:

url - JDBC connection URL

table - Name of table

values - Values to insert

batch - true for collecting SQL statements and execute them in a batch process, false to execute SQL statements immediately (default)

reconnect - Seconds between two reconnecting tries to database if connecting is broken (-1 disables reconnecting)

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<JdbcWriter.Value> values,
                  String username,
                  String password)

Parameters:

url - JDBC connection URL

table - Name of table

values - Values to insert

username - User name for database log in

password - Password for database log in

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<JdbcWriter.Value> values,
                  boolean batch,
                  String username,
                  String password)

Parameters:

url - JDBC connection URL

table - Name of table

values - Values to insert

batch - true for collecting SQL statements and execute them in a batch process, false to execute SQL statements immediately (default)

username - User name for database log in

password - Password for database log in

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<JdbcWriter.Value> values,
                  boolean batch,
                  String username,
                  String password,
                  int reconnect)

Parameters:

url - JDBC connection URL

table - Name of table

values - Values to insert

batch - true for collecting SQL statements and execute them in a batch process, false to execute SQL statements immediately (default)

username - User name for database log in

password - Password for database log in

reconnect - Seconds between two reconnecting tries to database if connecting is broken (-1 disables reconnecting)

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<String> columns,
                  List<JdbcWriter.Value> values)

Parameters:

url - JDBC connection URL

table - Name of table

columns - Columns of table to use for insert

values - Values to insert

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<String> columns,
                  List<JdbcWriter.Value> values,
                  boolean batch)

Parameters:

url - JDBC connection URL

table - Name of table

columns - Columns of table to use for insert

values - Values to insert

batch - true for collecting SQL statements and execute them in a batch process, false to execute SQL statements immediately (default)

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<String> columns,
                  List<JdbcWriter.Value> values,
                  boolean batch,
                  int reconnect)

Parameters:

url - JDBC connection URL

table - Name of table

columns - Columns of table to use for insert

values - Values to insert

batch - true for collecting SQL statements and execute them in a batch process, false to execute SQL statements immediately (default)

reconnect - Seconds two between reconnecting tries to database if connecting is broken (-1 disables reconnecting)

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<String> columns,
                  List<JdbcWriter.Value> values,
                  String username,
                  String password)

Parameters:

url - JDBC connection URL

table - Name of table

columns - Columns of table to use for insert

values - Values to insert

username - User name for database log in

password - Password for database log in

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<String> columns,
                  List<JdbcWriter.Value> values,
                  boolean batch,
                  String username,
                  String password)

Parameters:

url - JDBC connection URL

table - Name of table

columns - Columns of table to use for insert

values - Values to insert

batch - true for collecting SQL statements and execute them in a batch process, false to execute SQL statements immediately (default)

username - User name for database log in

password - Password for database log in

JdbcWriter

public JdbcWriter(String url,
                  String table,
                  List<String> columns,
                  List<JdbcWriter.Value> values,
                  boolean batch,
                  String username,
                  String password,
                  int reconnect)

Parameters:

url - JDBC connection URL

table - Name of table

columns - Columns of table to use for insert

values - Values to insert

batch - true for collecting SQL statements and execute them in a batch process, false to execute SQL statements immediately (default)

username - User name for database log in

password - Password for database log in

reconnect - Seconds between two reconnecting tries to database if connecting is broken (-1 disables reconnecting)

Method Detail

getUrl

public String getUrl()

Get the JDBC connection URL to database.

Returns:

JDBC connection URL

getTable

public String getTable()

Get the name of the database table.

Returns:

Name of the database table

getColumns

public List<String> getColumns()

Get the columns of the table, which are used for the insert statement.

Returns:

Columns of the table, which are used for the insert statement

getValues

public List<JdbcWriter.Value> getValues()

Get all values to insert.

Returns:

Values to insert

isBatchMode

public boolean isBatchMode()

Determine whether batch mode is enabled.

Returns:

true if batch mode is enabled, false if not

getUsername

public String getUsername()

Get the user name for database log in.

Returns:

User name for log in

getPassword

public String getPassword()

Get the password for database log in.

Returns:

Password for log in

getReconnetInterval

public long getReconnetInterval()

Get the minimum time span in milliseconds between two reconnecting tries to database if connecting is broken. Negative numbers mean that automatically reconnecting is disabled.

Returns:

Milliseconds between two reconnecting tries to database if connecting is broken

getRequiredLogEntryValues

public Set<LogEntryValue> getRequiredLogEntryValues()

Description copied from interface: Writer

Get all log entry values that are required by this writer.

Specified by:

getRequiredLogEntryValues in interface Writer

Returns:

Required values for log entry

init

public void init(Configuration configuration)
          throws SQLException,
                 NamingException

Description copied from interface: Writer

Initialize the writer (open a file for example).

Specified by:

init in interface Writer

Parameters:

configuration - Configuration of logger

Throws:

SQLException

NamingException

write

public void write(LogEntry logEntry)
           throws SQLException

Description copied from interface: Writer

Write a log entry.

Specified by:

write in interface Writer

Parameters:

logEntry - Log entry to output

Throws:

SQLException

flush

public void flush()
           throws SQLException

Description copied from interface: Writer

Flush this writer and force any buffered data to output.

Specified by:

flush in interface Writer

Throws:

SQLException

close

public void close()
           throws SQLException

Description copied from interface: Writer

Close the writer and release all resources. If a writer required a close() call, it should be registered in the init() method at VMShutdownHook for automatically shutdown when VM will be shutdown.

Specified by:

close in interface Writer

Throws:

SQLException