Java Doc for ConnectionProfile.java in  » Database-Client » iSQL-Viewer » org » isqlviewer » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This is a somewhat typical bean class, with getters/setters for the respective parameters. Each connection profile can be chained together using the ConnectionProfile.ConnectionProfile(ConnectionProfile) constructor.

The parameters of this class historically were embedded into the actually connection wrapper class. This proved to be extremely cumbersome and fragile. This implementation should proved to be more extensible and does not force to expose any internals of the connection wrapper.

This implementation also allows for changes on the fly to the profile or parent profiles without having a reference to the actual connection, and still having a live change event.
author:
   Mark A. Kobold <mkobold at isqlviewer dot com>
version:
   1.0

This method will always return false if a null resourceURL is received.

Parameters:
  location - to needs to be removed from this profile.

See Also:   java.sql.Statement.setEscapeProcessing(boolean)

See Also:   java.sql.Statement.getGeneratedKeys

See Also:   java.sql.Statement.setMaxFieldSize(int)

See Also:   java.sql.Statement.setMaxRows(int)

See Also:   java.sql.Statement.setFetchDirection(int)

See Also:   java.sql.DriverManager.setLogWriter(java.io.PrintWriter)

This will also cause the connection to for a change to this catalog if is not a null value.

By default on most RDBMS the default schema is the user-name for the connection.

If a profile setting is not available in this instance an attempt to defaults profile will be made.
Parameters:
  defaults - parent profile for settings if not available in this profile; can be null.

The listener is registered for all profile setting changes.
Parameters:
  listener - The PropertyChangeListener to be added

The listener will be invoked only when a call on firePropertyChange names that specific profile setting.
Parameters:
  propertyName - value should be one of the declared constants of this class.
Parameters:
  listener - The PropertyChangeListener to be added

This method will always return false if a null resourceURL is received. All duplicates are discarded and not added.
Parameters:
  location - resource containing runtime resources required for the connection implementation. true if the resourceURL was sucessfully added.

true if all settings from this profile are coming from the defaults.

This settings defaults to 0 number of seconds to wait before giving up on creating a connection; 0 means wait forever.

This settings defaults to 10 depth of chained exceptions to expose for SQLExceptions
See Also:   java.sql.SQLException.getNextException

This settings defaults to 0 maximum number of bytes allowed to be recieved from a single record; 0 means no limit.
See Also:   java.sql.Statement.getMaxFieldSize

This settings defaults to 0 maximum number of rows to receive from a statement; 0 means no limit.
See Also:   java.sql.Statement.getMaxRows

This settings defaults to null null if no schema is preferred; schema will be determined by connection.
See Also:   java.sql.Connection.getCatalog

This settings defaults to null null if no schema is preferred; schema will be determined by connection.

This settings defaults to 0 number of seconds to wait before giving up statement to finish; 0 means wait forever.

This settings defaults to false false if credentials for the service were not persisted.

This settings defaults to true true if credentials for the service are not in plain-text.

This settings defaults to false true stacktraces should be displayed when an exception occurs.

This settings defaults to false true if escape processing should be done by the driver on queries.
See Also:   java.sql.Statement.setEscapeProcessing(boolean)

This settings defaults to false true if the connection is recovered when disconnected upon statement execution.

This settings defaults to false true if generated keys from ResultSet objects are queried for.
See Also:   java.sql.Statement.getGeneratedKeys

This settings defaults to false true if statements should use reverse-fetching direction for results.
See Also:   java.sql.Statement.setFetchDirection(int)

This settings defaults to false trueif tracing through the java.sql.DriverManager is enabled.

This removes a PropertyChangeListener that was registered for all profile settings.
Parameters:
  listener - The PropertyChangeListener to be removed

Parameters:
  propertyName - value should be one of the declared constants of this class.
Parameters:
  listener - The PropertyChangeListener to be removed.

Parameters:
  location - to needs to be removed from this profile. true if the URL was actually removed.

collection of all added resource urls prior.

For situations of paranoia or just general security practice of not storing passwords in files this is the setting to turn on/off this behavior.

This method will fire a property change event for ConnectionProfile.STORE_CREDENTIALS .
Parameters:
  credentialsPersistent - flag to enable/disable storage of service passwords.

This method will fire a property change event for ConnectionProfile.USE_SECURE_CREDENTIALS .
Parameters:
  credentialsSecure - flag to enable/disable the encryption of service passwords.

This method will fire a property change event for ConnectionProfile.PRINT_STACKTRACES .
Parameters:
  debuggingEnabled - flag to enable/disable the display of stacktraces from exceptions.

This method will fire a property change event for ConnectionProfile.JDBC_ESCAPE_PROC .
Parameters:
  escapeProcessing - flag to enable/disable escape processing on the JDBC driver.
See Also:   java.sql.Statement.setEscapeProcessing(boolean)

This method will fire a property change event for ConnectionProfile.CONNECTION_KEEPALIVE .
Parameters:
  keepAlive - flag to enable/disable automatically recovering a broken connection.

This method will fire a property change event for ConnectionProfile.LOGIN_TIMEOUT .
Parameters:
  loginTimeout - number of seconds to wait for a connection to be made; use 0 to wait forever.

This method will fire a property change event for ConnectionProfile.MAX_EXCEPTION_CHAIN_LENGTH .
Parameters:
  maxExceptionLength - depth of chained exceptions to expose.

This method will fire a property change event for ConnectionProfile.JDBC_MAX_FIELD_SIZE .
Parameters:
  maxFieldSize - maximum number of bytes to recieve from a single record;0 means no limit.
See Also:   java.sql.Statement.setMaxFieldSize(int)

This method will fire a property change event for ConnectionProfile.JDBC_MAX_ROWS .
Parameters:
  maxRowCount - The maxRowCount to set.

If this property is a non-null value, the connection will also attempt to switch to this catalog upon connection to the server.

This method will fire a property change event for ConnectionProfile.PREFERRED_CATALOG .
Parameters:
  preferredCatalog - preferred catalog name to use; null to use default or disable.
See Also:   java.sql.Connection.getCatalog

This method will fire a property change event for ConnectionProfile.PREFERRED_SCHEMA .
Parameters:
  preferredSchema - preferred schema name to use; null to use default or disable.

This method will fire a property change event for ConnectionProfile.QUERY_TIMEOUT .
Parameters:
  queryTimeout - number of seconds to wait for a statement to execute; use 0 to wait forever.

This method will fire a property change event for ConnectionProfile.JDBC_GENERATE_KEYS .
Parameters:
  resultsetKeys - flag to enable/disable generated key acquisition
See Also:   java.sql.Statement.getGeneratedKeys

This method will fire a property change event for ConnectionProfile.JDBC_GENERATE_KEYS .
Parameters:
  reverseFetching - flag to configure fetch direction; true = reverse; false = forward.
See Also:   java.sql.Statement.setFetchDirection(int)

This method will fire a property change event for ConnectionProfile.JDBC_TRACE_ENABLED .
Parameters:
  tracingEnabled - flag to enable/disable JDBC tracing using the java.sql.DriverManager.

The parent class-loader will either be the classloader of the parent profile when this instance was created, if no parent profile was referenced then the parent classloader will be the classloader for this class. new class loader instance based on resource URLS added to this profile.

Each property can be accessed respectively by the constants defined in this class. properties object containing all profile settings.