Overview | Package | Class | Tree | Deprecated | Index | Help

2.01.05
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## interbase.interclient
Class ConnectionProperties

    java.lang.Object
      |
      +--java.util.Dictionary
            |
            +--java.util.Hashtable
                  |
                  +--java.util.Properties
                        |
                        +--interbase.interclient.ConnectionProperties

All Implemented Interfaces:
  Cloneable, Map, Serializable

Deprecated. deprecated since InterClient 2.0, replaced by `DataSource` API.

public final class ConnectionProperties
extends Properties

Properties used to tailor an InterBase connection.

This class is used to tailor connection properties before attaching to an InterBase database. Using this class is an alternative to configuring a java.util.Properties object directly. For example,

     java.util.Properties properties = new java.util.Properties ();
     properties.put ("charSet", "SJIS")

is identical to

     ConnectionProperties properties = new ConnectionProperties ();
     properties.setCharacterEncoding (CharacterEncodings.SJIS)

Also see Connection Properties in the InterClient Help documentation for a list of valid properties.

Note: These are transient properties of a connection. Methods for setting persistent database properties may be found in the `ServerManager` class.

See the InterBase Extension API for a complete list of available InterBase extensions to JDBC.

Since:
  Extension, since InterClient 1.0
See Also:
  `Driver.connect(java.lang.String,java.util.Properties)`, `Driver.getPropertyInfo(String, java.util.Properties)`, Serialized Form

Inner classes inherited from class java.util.Map
`Map.Entry`

Fields inherited from class java.util.Properties
`defaults`

Constructor Summary
`ConnectionProperties()` Deprecated. To be deprecated in InterClient 2, replaced by `DataSource` API.

Method Summary
`void` | `setCharacterEncoding(String encoding)` Deprecated. To be deprecated in InterClient 2, replaced by `DataSource` API.
`void` | `setUser(String user, String password)` Deprecated. To be deprecated in InterClient 2, replaced by `DataSource` API.

Methods inherited from class java.util.Properties
`getProperty, getProperty, list, list, load, propertyNames, save, setProperty, store`

Methods inherited from class java.util.Hashtable
`clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

### ConnectionProperties

    public ConnectionProperties()

  Deprecated. To be deprecated in InterClient 2, replaced by `DataSource` API.

  Construct a default InterBase connection properties object.
  Since:
    Extension, since InterClient 1.0

Method Detail

### setCharacterEncoding

    public void setCharacterEncoding(String encoding)

  Deprecated. To be deprecated in InterClient 2, replaced by `DataSource` API.

  Sets the character encoding for the pending connection. All SQL and data will be presented to the database using the specified character encoding.

  The connection property key is "charSet". The default value is `CharacterEncodings.NONE`.

  Property values must match one of the supported IANA character encoding names specified in the `CharacterEncodings` class.

  Since:
    Extension, since InterClient 1.50

### setUser

    public void setUser(String user,
                        String password)

  Deprecated. To be deprecated in InterClient 2, replaced by `DataSource` API.

  Sets the user and password for the pending connection.

  The corresponding connection property keys are "user" and "password".

  Since:
    Extension, since InterClient 1.0

Overview | Package | Class | Tree | Deprecated | Index | Help

2.01.05
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Send comments or suggestions to interclient@borland.com