com.github.shynixn.petblocks.bukkit.lib

Class ExtensionHikariConnectionContext

java.lang.Object

com.github.shynixn.petblocks.bukkit.lib.ExtensionHikariConnectionContext

All Implemented Interfaces:

AutoCloseable

public class ExtensionHikariConnectionContext
extends Object
implements AutoCloseable

Copyright 2017 Shynixn

Do not remove this header!

Version 1.0

MIT License

Copyright (c) 2017

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExtensionHikariConnectionContext.SQlRetriever

Field Summary

Fields

Modifier and Type	Field and Description
static String	MYSQL_DRIVER
static String	SQLITE_DRIVER

Method Summary

Modifier and Type	Method and Description
void	close() Closes the database context
boolean	execute(String sql, Connection connection, Object... parameters) Executes a preparedStatement and sets the given parameters to the statement
int	executeInsert(String sql, Connection connection, Object... parameters) Executes a preparedStatement and sets the given parameters to the statement
PreparedStatement	executeQuery(String sql, Connection connection, Object... parameters) Executes a preparedStatement and sets the given parameters to the statement
boolean	executeStored(String fileName, Connection connection, Object... parameters) Reads a sqlStatement from the given fileName, executes it and sets the given parameter
int	executeStoredInsert(String fileName, Connection connection, Object... parameters) Reads a sqlStatement from the given fileName, executes it and sets the given parameter
PreparedStatement	executeStoredQuery(String fileName, Connection connection, Object... parameters) Reads a sqlStatement from the given fileName, executes it and sets the given parameter
int	executeStoredUpdate(String fileName, Connection connection, Object... parameters) Reads a sqlStatement from the given fileName, executes it and sets the given parameter
int	executeUpdate(String sql, Connection connection, Object... parameters) Executes a preparedStatement and sets the given parameters to the statement
static ExtensionHikariConnectionContext	from(String driver, String url, ExtensionHikariConnectionContext.SQlRetriever retriever) Opens a new DatabaseContext for the given url
static ExtensionHikariConnectionContext	from(String driver, String urlPrefix, String ip, int port, String database, String userName, String password, ExtensionHikariConnectionContext.SQlRetriever retriever) Opens a new DatabaseContext for the given ip, port, database, username and password
Connection	getConnection() Provides an connection to the database which has to be closed after being used
String	getStringFromFile(String statementName) Manages caching of statements

Methods inherited from class java.lang.Object

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

Field Detail

SQLITE_DRIVER

public static final String SQLITE_DRIVER

See Also:

Constant Field Values

MYSQL_DRIVER

public static final String MYSQL_DRIVER

See Also:

Constant Field Values

Method Detail

getConnection

public Connection getConnection()
                         throws SQLException

Provides an connection to the database which has to be closed after being used

Returns:

connection

Throws:

SQLException - exception

executeStored

public boolean executeStored(String fileName,
                             Connection connection,
                             Object... parameters)
                      throws SQLException

Reads a sqlStatement from the given fileName, executes it and sets the given parameter

Parameters:

fileName - fileName

connection - connection

parameters - parameters

Returns:

success

Throws:

SQLException - exception

execute

public boolean execute(String sql,
                       Connection connection,
                       Object... parameters)
                throws SQLException

Executes a preparedStatement and sets the given parameters to the statement

Parameters:

sql - sql

connection - connection

parameters - parameters

Returns:

success

Throws:

SQLException - exception

executeStoredQuery

public PreparedStatement executeStoredQuery(String fileName,
                                            Connection connection,
                                            Object... parameters)
                                     throws SQLException

Reads a sqlStatement from the given fileName, executes it and sets the given parameter

Parameters:

fileName - fileName

connection - connection

parameters - parameters

Returns:

resultSet

Throws:

SQLException - exception

executeQuery

public PreparedStatement executeQuery(String sql,
                                      Connection connection,
                                      Object... parameters)
                               throws SQLException

Executes a preparedStatement and sets the given parameters to the statement

Parameters:

sql - sql

connection - connection

parameters - parameters

Returns:

resultSet

Throws:

SQLException - exception

executeStoredUpdate

public int executeStoredUpdate(String fileName,
                               Connection connection,
                               Object... parameters)
                        throws SQLException

Reads a sqlStatement from the given fileName, executes it and sets the given parameter

Parameters:

fileName - fileName

connection - connection

parameters - parameters

Returns:

resultCode

Throws:

SQLException - exception

executeUpdate

public int executeUpdate(String sql,
                         Connection connection,
                         Object... parameters)
                  throws SQLException

Executes a preparedStatement and sets the given parameters to the statement

Parameters:

sql - sql

connection - connection

parameters - parameters

Returns:

resultCode

Throws:

SQLException - exception

executeStoredInsert

public int executeStoredInsert(String fileName,
                               Connection connection,
                               Object... parameters)
                        throws SQLException

Reads a sqlStatement from the given fileName, executes it and sets the given parameter

Parameters:

fileName - fileName

connection - connection

parameters - parameters

Returns:

id

Throws:

SQLException - exception

executeInsert

public int executeInsert(String sql,
                         Connection connection,
                         Object... parameters)
                  throws SQLException

Executes a preparedStatement and sets the given parameters to the statement

Parameters:

sql - sql

connection - connection

parameters - parameters

Returns:

id

Throws:

SQLException - exception

close

public void close()

Closes the database context

Specified by:

close in interface AutoCloseable

getStringFromFile

public String getStringFromFile(String statementName)

Manages caching of statements

Parameters:

statementName - statementName

Returns:

sqlStatement

from

public static ExtensionHikariConnectionContext from(String driver,
                                                    String url,
                                                    ExtensionHikariConnectionContext.SQlRetriever retriever)
                                             throws IOException

Opens a new DatabaseContext for the given url

Parameters:

driver - driver

url - url

retriever - retriever

Returns:

DbConnectionContext

Throws:

IOException - exception

from

public static ExtensionHikariConnectionContext from(String driver,
                                                    String urlPrefix,
                                                    String ip,
                                                    int port,
                                                    String database,
                                                    String userName,
                                                    String password,
                                                    ExtensionHikariConnectionContext.SQlRetriever retriever)
                                             throws IOException

Opens a new DatabaseContext for the given ip, port, database, username and password

Parameters:

driver - driver

ip - ip

port - port

urlPrefix - prefix

database - database

userName - userName

password - password

retriever - retriever

Returns:

DbConnectionContext

Throws:

IOException - exception