com.screenscraper.datamanager.sql

Class SshDataSource

java.lang.Object

org.apache.commons.dbcp.BasicDataSource

com.screenscraper.datamanager.sql.SshDataSource

All Implemented Interfaces:

java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource

Deprecated.

@Deprecated
public class SshDataSource
extends org.apache.commons.dbcp.BasicDataSource

Class used to connect to a database through an SSH tunnel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSSQL Deprecated.
static java.lang.String	MYSQL Deprecated.
static java.lang.String	ORACLE Deprecated.
static java.lang.String	POSTGRESQL Deprecated.
java.lang.String	remoteUrl Deprecated.

Fields inherited from class org.apache.commons.dbcp.BasicDataSource

connectionPool, connectionProperties, dataSource, defaultAutoCommit, defaultCatalog, defaultReadOnly, defaultTransactionIsolation, driverClassName, initialSize, logWriter, maxActive, maxIdle, maxOpenPreparedStatements, maxWait, minEvictableIdleTimeMillis, minIdle, numTestsPerEvictionRun, password, poolPreparedStatements, testOnBorrow, testOnReturn, testWhileIdle, timeBetweenEvictionRunsMillis, url, username, validationQuery

Constructor Summary

Constructors

Constructor and Description
SshDataSource(java.lang.String sshUser, java.io.File key) Deprecated. Default using ssh port 22
SshDataSource(java.lang.String sshUser, int sshPort, java.io.File key) Deprecated. Creates a BasicDataSource that uses an ssh tunnel to connect to the database
SshDataSource(java.lang.String sshUser, int sshPort, java.lang.String password) Deprecated. Creates a BasicDataSource that uses an ssh tunnel to connect to the database
SshDataSource(java.lang.String sshUser, java.lang.String password) Deprecated. Default using ssh port 22

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
static int	getFreePort() Deprecated. Returns a free port on the machine
java.util.logging.Logger	getParentLogger() Deprecated.
boolean	isWrapperFor(java.lang.Class<?> iface) Deprecated.
void	setRemoteUrl(java.lang.String url) Deprecated. Sets the remote url you wish to connect to
void	setUrl(java.lang.String url) Deprecated.
void	setUrl(java.lang.String sqlDatabaseType, int sqlServerPort, java.lang.String databaseName) Deprecated. Use this instead of setUrl(String url).
<T> T	unwrap(java.lang.Class<T> iface) Deprecated.

Methods inherited from class org.apache.commons.dbcp.BasicDataSource

addConnectionProperty, createDataSource, getConnection, getConnection, getDefaultAutoCommit, getDefaultCatalog, getDefaultReadOnly, getDefaultTransactionIsolation, getDriverClassName, getInitialSize, getLogAbandoned, getLoginTimeout, getLogWriter, getMaxActive, getMaxIdle, getMaxOpenPreparedStatements, getMaxWait, getMinEvictableIdleTimeMillis, getMinIdle, getNumActive, getNumIdle, getNumTestsPerEvictionRun, getPassword, getRemoveAbandoned, getRemoveAbandonedTimeout, getTestOnBorrow, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, getUrl, getUsername, getValidationQuery, isAccessToUnderlyingConnectionAllowed, isPoolPreparedStatements, removeConnectionProperty, setAccessToUnderlyingConnectionAllowed, setDefaultAutoCommit, setDefaultCatalog, setDefaultReadOnly, setDefaultTransactionIsolation, setDriverClassName, setInitialSize, setLogAbandoned, setLoginTimeout, setLogWriter, setMaxActive, setMaxIdle, setMaxOpenPreparedStatements, setMaxWait, setMinEvictableIdleTimeMillis, setMinIdle, setNumTestsPerEvictionRun, setPassword, setPoolPreparedStatements, setRemoveAbandoned, setRemoveAbandonedTimeout, setTestOnBorrow, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis, setUsername, setValidationQuery

Methods inherited from class java.lang.Object

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

Field Detail

MYSQL

public static final java.lang.String MYSQL

Deprecated.

See Also:

Constant Field Values

MSSQL

public static final java.lang.String MSSQL

Deprecated.

See Also:

Constant Field Values

ORACLE

public static final java.lang.String ORACLE

Deprecated.

See Also:

Constant Field Values

POSTGRESQL

public static final java.lang.String POSTGRESQL

Deprecated.

See Also:

Constant Field Values

remoteUrl

public java.lang.String remoteUrl

Deprecated.

Constructor Detail

SshDataSource

public SshDataSource(@NotNull
                     java.lang.String sshUser,
                     @NotNull
                     java.lang.String password)

Deprecated.

Default using ssh port 22

Parameters:

sshUser - Ex: user@remotehost.com

password - The password

SshDataSource

public SshDataSource(@NotNull
                     java.lang.String sshUser,
                     int sshPort,
                     @NotNull
                     java.lang.String password)

Deprecated.

Creates a BasicDataSource that uses an ssh tunnel to connect to the database

Parameters:

sshUser - The username

sshPort - The port

password - The password

SshDataSource

public SshDataSource(@NotNull
                     java.lang.String sshUser,
                     @NotNull
                     java.io.File key)
              throws java.io.FileNotFoundException

Deprecated.

Default using ssh port 22

Parameters:

sshUser - Ex: user@remotehost.com

key - The key file for access

Throws:

java.io.FileNotFoundException - If the key file isn't found

SshDataSource

public SshDataSource(@NotNull
                     java.lang.String sshUser,
                     int sshPort,
                     @NotNull
                     java.io.File key)
              throws java.io.FileNotFoundException

Deprecated.

Creates a BasicDataSource that uses an ssh tunnel to connect to the database

Parameters:

sshUser - The username

sshPort - The port

key - The key file for access

Throws:

java.io.FileNotFoundException - If the key file isn't found

Method Detail

close

public void close()
           throws java.sql.SQLException

Deprecated.

Overrides:

close in class org.apache.commons.dbcp.BasicDataSource

Throws:

java.sql.SQLException

setUrl

public void setUrl(@NotNull
                   java.lang.String sqlDatabaseType,
                   int sqlServerPort,
                   @Nullable
                   java.lang.String databaseName)

Deprecated.

Use this instead of setUrl(String url). Makes an sql connection that is forwarded through the ssh connection to the remote sql server

Parameters:

sqlDatabaseType - SshDataSource.MYSQL, SshDataSource.MSSQL, SshDataSource.ORACLE, or SshDataSource.POSTRESQL

sqlServerPort - listening port of remote sql server

databaseName - name of the database you want to connect to or null

setRemoteUrl

public void setRemoteUrl(java.lang.String url)

Deprecated.

Sets the remote url you wish to connect to

Parameters:

url - default localhost

setUrl

public void setUrl(java.lang.String url)

Deprecated.

Overrides:

setUrl in class org.apache.commons.dbcp.BasicDataSource

getFreePort

public static int getFreePort()

Deprecated.

Returns a free port on the machine

Returns:

The port number that is available

unwrap

@NotNull
public <T> T unwrap(java.lang.Class<T> iface)
                       throws java.sql.SQLException

Deprecated.

Throws:

java.sql.SQLException

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException

Deprecated.

Throws:

java.sql.SQLException

getParentLogger

@NotNull
public java.util.logging.Logger getParentLogger()
                                                   throws java.sql.SQLFeatureNotSupportedException

Deprecated.

Throws:

java.sql.SQLFeatureNotSupportedException