com.pivotal.gemfirexd.internal.impl.tools.ij

Class util

java.lang.Object

com.pivotal.gemfirexd.internal.impl.tools.ij.util

All Implemented Interfaces:

PrivilegedAction

public final class util
extends Object
implements PrivilegedAction

Methods used to control setup for apps as well as display some internal ij structures.

See Also:

JDBCDisplayUtil

Method Summary

Methods

Modifier and Type	Method and Description
static void	DisplayMulti(com.pivotal.gemfirexd.internal.iapi.tools.i18n.LocalizedOutput out, PreparedStatement ps, ResultSet rs, Connection conn, scala.tools.jline.console.ConsoleReader reader, com.pivotal.gemfirexd.internal.shared.common.StopWatch timer) Display a statement that takes parameters by stuffing it with rows from the result set and displaying each result each time through.
static void	DisplayVector(com.pivotal.gemfirexd.internal.iapi.tools.i18n.LocalizedOutput out, Vector v) Display a vector of strings to the out stream.
static String	getArg(String param, String[] args) Find the argument that follows the specified parameter.
static Properties	getConnAttributeArg(String[] args) ij is started with "-ca[r] file OtherArgs"; the file contains connection attibute properties to pass to getConnection
static Connection	getDataSourceConnection(String dsName, String user, String password, String dbName, boolean firstTime) Returns a connection obtained using the DataSource.
static String	getFileArg(String[] args) Return the name of the ij command file or null if none is specified.
static String	getInputResourceNameArg(String[] args) Return the name of a resource containing input commands or null iff none has been specified.
static boolean	getPropertyArg(String[] args) ij is started with "-p[r] file OtherArgs"; the file contains properties to control the driver and database used to run ij, and can provide additional system properties.
static InputStream	getResourceAsStream(String resourceName) Convenience routine to get a resource as a BufferedInputStream.
static String	getSelectedSchema(Connection theConnection) Selects the current schema from the given connection.
static boolean	invalidArgs(String[] args) Verify the ij line arguments command arguments.
static void	loadDriver(String driverClass) Load a driver given a class name.
static void	loadDriverIfKnown(String jdbcProtocol) Find the appropriate driver and load it, given a JDBC URL.
Object	run()
static void	setupDataSource(Object ds, String dbName, boolean firstTime) Sets up a data source with values specified in ij.dataSource.* properties or passed as parameters of this method
static Connection	startJBMS() Utility interface that defaults driver and database to null.
static Connection	startJBMS(String defaultDriver, String defaultURL) Utility interface that defaults connInfo to null
static Connection	startJBMS(String defaultDriver, String defaultURL, Properties connInfo) This will look for the System properties "ij.driver" and "ij.database" and return a java.sql.Connection if it successfully connects.
static Properties	updateConnInfo(String user, String password, Properties connInfo)

Methods inherited from class java.lang.Object

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

Method Detail

getArg

public static String getArg(String param,
            String[] args)

Find the argument that follows the specified parameter.

Parameters:

param - the parameter (e.g. "-p")

args - the argument list to consider.

Returns:

the argument that follows the parameter, or null if not found

getPropertyArg

public static boolean getPropertyArg(String[] args)
                              throws IOException

ij is started with "-p[r] file OtherArgs"; the file contains properties to control the driver and database used to run ij, and can provide additional system properties.

getPropertyArg will look at the args and take out a "-p " pair, reading the file into the system properties.

If there was a -p without a following , no action is taken.

Parameters:

args - the argument list to consider.

Returns:

true if a property item was found and loaded.

Throws:

IOException - thrown if file not found

getConnAttributeArg

public static Properties getConnAttributeArg(String[] args)
                                      throws IOException

ij is started with "-ca[r] file OtherArgs"; the file contains connection attibute properties to pass to getConnection

getConnAttributeArg will look at the args and take out a "-ca[r] " pair and returning the Properties

Parameters:

args - the argument list to consider.

Returns:

properties in the file

Throws:

IOException - thrown if file not found

getResourceAsStream

public static InputStream getResourceAsStream(String resourceName)

Convenience routine to get a resource as a BufferedInputStream. If the resourceName is not absolute (does not begin with a "/") this qualifies the name with the "ij.defaultResourcePackage" name.

Parameters:

resourceName - the name of the resource

Returns:

a buffered stream for the resource if it exists and null otherwise.

getFileArg

public static String getFileArg(String[] args)
                         throws IOException

Return the name of the ij command file or null if none is specified. The command file may be proceeded with -f flag on the command line. Alternatively, the command file may be specified without a -f flag. In this case we assume the first unknown argument is the command file.

This should only be called after calling invalidArgs.

If there is no such argument, a null is returned.

Parameters:

args - the argument list to consider.

Returns:

the name of the first argument not preceded by "-p", null if none found.

Throws:

IOException - thrown if file not found

getInputResourceNameArg

public static String getInputResourceNameArg(String[] args)

Return the name of a resource containing input commands or null iff none has been specified.

invalidArgs

public static boolean invalidArgs(String[] args)

Verify the ij line arguments command arguments. Also used to detect --help.

Returns:

true if the args are invalid

• Only legal argument provided.
• Only specify a quantity once.

setupDataSource

public static void setupDataSource(Object ds,
                   String dbName,
                   boolean firstTime)
                            throws Exception

Sets up a data source with values specified in ij.dataSource.* properties or passed as parameters of this method

Parameters:

ds - DataSource object

dbName - Database Name

firstTime - If firstTime is false, ij.dataSource.createDatabase and ij.dataSource.databaseName properties will not be used. The value in parameter dbName will be used instead of ij.dataSource.databaseName.

Throws:

Exception

getDataSourceConnection

public static Connection getDataSourceConnection(String dsName,
                                 String user,
                                 String password,
                                 String dbName,
                                 boolean firstTime)
                                          throws SQLException

Returns a connection obtained using the DataSource. This method will be called when ij.dataSource property is set. It uses ij.dataSource.* properties to get details for the connection.

Parameters:

dsName - Data Source name

user - User name

password - Password

dbName - Database Name

firstTime - Indicates if the method is called first time. This is passed to setupDataSource method.

Throws:

SQLException

startJBMS

public static Connection startJBMS(String defaultDriver,
                   String defaultURL,
                   Properties connInfo)
                            throws SQLException,
                                   ClassNotFoundException,
                                   InstantiationException,
                                   IllegalAccessException

This will look for the System properties "ij.driver" and "ij.database" and return a java.sql.Connection if it successfully connects. The deprecated driver and database properties are examined first.

If no connection was possible, it will return a null.

Failure to load the driver class is quietly ignored.

Parameters:

defaultDriver - the driver to use if no property value found

defaultURL - the database URL to use if no property value found

connInfo - Connection attributes to pass to getConnection

Returns:

a connection to the defaultURL if possible; null if not.

Throws:

SQLException - on failure to connect.

ClassNotFoundException - on failure to load driver.

InstantiationException - on failure to load driver.

IllegalAccessException - on failure to load driver.

updateConnInfo

public static Properties updateConnInfo(String user,
                        String password,
                        Properties connInfo)

startJBMS

public static Connection startJBMS()
                            throws SQLException,
                                   ClassNotFoundException,
                                   InstantiationException,
                                   IllegalAccessException

Utility interface that defaults driver and database to null.

Returns:

a connection to the defaultURL if possible; null if not.

Throws:

SQLException - on failure to connect.

ClassNotFoundException - on failure to load driver.

InstantiationException - on failure to load driver.

IllegalAccessException - on failure to load driver.

startJBMS

public static Connection startJBMS(String defaultDriver,
                   String defaultURL)
                            throws SQLException,
                                   ClassNotFoundException,
                                   InstantiationException,
                                   IllegalAccessException

Utility interface that defaults connInfo to null

Parameters:

defaultDriver - the driver to use if no property value found

defaultURL - the database URL to use if no property value found

Returns:

a connection to the defaultURL if possible; null if not.

Throws:

SQLException - on failure to connect.

ClassNotFoundException - on failure to load driver.

InstantiationException - on failure to load driver.

IllegalAccessException - on failure to load driver.

DisplayVector

public static void DisplayVector(com.pivotal.gemfirexd.internal.iapi.tools.i18n.LocalizedOutput out,
                 Vector v)

Display a vector of strings to the out stream.

DisplayMulti

public static void DisplayMulti(com.pivotal.gemfirexd.internal.iapi.tools.i18n.LocalizedOutput out,
                PreparedStatement ps,
                ResultSet rs,
                Connection conn,
                scala.tools.jline.console.ConsoleReader reader,
                com.pivotal.gemfirexd.internal.shared.common.StopWatch timer)
                         throws SQLException,
                                ijException

Display a statement that takes parameters by stuffing it with rows from the result set and displaying each result each time through. Deal with autocommit behavior along the way.

Throws:

SQLException - thrown on db error

ijException - thrown on ij error

run

public final Object run()

Specified by:

run in interface PrivilegedAction

loadDriverIfKnown

public static void loadDriverIfKnown(String jdbcProtocol)
                              throws ClassNotFoundException,
                                     InstantiationException,
                                     IllegalAccessException

Find the appropriate driver and load it, given a JDBC URL. No action if no driver known for a given URL.

Parameters:

jdbcProtocol - the protocol to try.

Throws:

ClassNotFoundException - if unable to locate class for driver.

InstantiationException - if unable to create an instance.

IllegalAccessException - if driver class constructor not visible.

loadDriver

public static void loadDriver(String driverClass)
                       throws ClassNotFoundException,
                              InstantiationException,
                              IllegalAccessException

Load a driver given a class name.

Throws:

ClassNotFoundException - if unable to locate class for driver.

InstantiationException - if unable to create an instance.

IllegalAccessException - if driver class constructor not visible.

getSelectedSchema

public static String getSelectedSchema(Connection theConnection)
                                throws SQLException

Selects the current schema from the given connection. As there are no way of getting current schema supported by all major DBMS-es, this method may return null.

Parameters:

theConnection - Connection to get current schema for

Returns:

the current schema of the connection, or null if error.

Throws:

SQLException