com.businessobjects.connectionserver.datasources.ddk
Interface PropertySet

public interface PropertySet

This interface provides the functionality for maintaining connection-specific configuration properties. A driver can set, read and modify these properties. Depending on the property, the initial value of each property is set in one of the following ways:

• Configuration files: Connection Server sets the property to the value defined in the configuration files, that is the driver's .sbo file, or cs.cfg if not defined in the driver's .sbo file.
• Specific driver method: Connection Server calls a specific driver method to initialize the property. In your driver, you code this method to set the property's initial value, for example to retrieve the initial value from the database middleware.
• Set by driver: You can include the functionality in your driver, for example to read the .sbo file or the database middleware, and assign an initial value to the parameter if you require it.

Author:

Business Objects

Field Summary

static java.lang.String	ARRAY_BIND_SIZE Integer property that specifies the recommended Array Bind Size.
static java.lang.String	ARRAY_FETCH_SIZE Integer property that specifies how many rows are retrieved from the datasource each time a fetch is performed.
static java.lang.String	AUTOCONNECT Boolean property that specifies if the Data Access layer must establish a physical connection immediately, or wait for the first SQL statement before establishing a connection.
static java.lang.String	CATALOG_SEPARATOR String property that specifies the catalog separator used to separate data items.
static java.lang.String	COLUMN_NAME_SIZE Integer property that specifies the maximum size for a column name.
static java.lang.String	CONNECTION_SHAREABLE Boolean property that specifies if it is possible to share connections to a data source.
static java.lang.String	COST_ESTIMATE_AVAILABLE Boolean property that indicates if the driver supports performing cost estimate on queries.
static java.lang.String	DBMS String property that specifies the database type used to connect to the data source.
static java.lang.String	FOREIGNKEYS_AVAILABLE Boolean property that specifies if it is possible to retrieve a list of the foreign keys available from the data source.
static java.lang.String	HINT String property that specifies a hint to the SQL optimizer.
static java.lang.String	IDENTIFIER_CASE String property that specifies the case behavior of identifiers.
static java.lang.String	IDENTIFIER_QUOTE_STRING String property that specifies the identifier quote string.
static java.lang.String	LIKE_ESCAPE_CLAUSE String property that specifies the LIKE clause escape character.
static java.lang.String	LOG_TIMEOUT Integer property that specifies the maximum number of seconds for a login request before the request fails.
static java.lang.String	MAX_ROWS Integer property that sets the maximum number of rows that can be retrieved from the data source.
static java.lang.String	NETWORKLAYER String property that specifies the network layer used to connect to the data source.
static java.lang.String	OWNER_NAME_SIZE Integer property that specifies the maximum size for the name of an owner.
static java.lang.String	OWNERS_AVAILABLE Boolean property that specifies if the data source supports owners.
static java.lang.String	PASSWORD_ENCRYPTION Boolean property that specifies if the password must be encrypted.
static java.lang.String	PERFORM_COST_ESTIMATE Boolean property that specifies if the driver must perform cost estimate on queries.
static java.lang.String	POOL_TIME Integer property that specifies the number of minutes a connection will be kept alive in the Connection Pool.
static java.lang.String	PRIMARYKEY_AVAILABLE Boolean property that specifies if it is possible to retrieve the primary key from the data source.
static java.lang.String	QUALIFIER_NAME_SIZE Integer property that specifies the maximum size for the name of a qualifier.
static java.lang.String	QUALIFIERS_AVAILABLE Boolean property that specifies if the data source supports qualifiers.
static java.lang.String	QUERY_TIMEOUT Integer property that specifies the maximum number of seconds to wait for any request on the connection to complete before returning to the application.
static java.lang.String	QUOTED_IDENTIFIER Boolean property that specifies if a datasource supports quoted identifiers.
static java.lang.String	QUOTED_IDENTIFIER_CASE String property that specifies the case behavior of quoted identifiers.
static java.lang.String	SEARCH_PATTERN_ESCAPE String property that specifies the SEARCH clause escape character.
static java.lang.String	SHARED_CONNECTION Boolean property that specifies whether or not connections to the data source are shared for this driver.
static java.lang.String	TABLE_NAME_SIZE Integer property that specifies the maximum size for a table name.
static java.lang.String	TRANSACTION_TYPE String property that specifies the transaction type.
static java.lang.String	XML_MAX_SIZE Integer property that specifies the maximum size for an XML column.

Method Summary

boolean	getBooleanProperty(java.lang.String name) Gets the value of a boolean property.
int	getIntProperty(java.lang.String name) Gets the value of an int property.
LocaleDescriptor	getLocale() Returns the locale associated with a property.
java.lang.Object	getProperty(java.lang.String name) Gets the value of a property.
short	getShortProperty(java.lang.String name) Gets the value of a short property.
java.lang.String	getStringProperty(java.lang.String name) Gets the value of a string property
boolean	isPropertyDefined(java.lang.String name) Checks if a property is defined.
void	setBooleanProperty(java.lang.String name, boolean value) Sets a boolean property's value.
void	setIntProperty(java.lang.String name, int value) Sets an int property's value
void	setProperty(java.lang.String name, java.lang.Object value) Sets a property's value.
void	setShortProperty(java.lang.String name, short value) Sets a short property's value.
void	setStringProperty(java.lang.String name, java.lang.String value) Sets a string property's value.

Field Detail

NETWORKLAYER

static final java.lang.String NETWORKLAYER

String property that specifies the network layer used to connect to the data source.

DBMS

static final java.lang.String DBMS

String property that specifies the database type used to connect to the data source.

CONNECTION_SHAREABLE

static final java.lang.String CONNECTION_SHAREABLE

Boolean property that specifies if it is possible to share connections to a data source.

Initial setting:

Configuration files: Connection Shareable parameter

SHARED_CONNECTION

static final java.lang.String SHARED_CONNECTION

Boolean property that specifies whether or not connections to the data source are shared for this driver.

Initial setting:

Configuration files: Shared Connection parameter

TRANSACTION_TYPE

static final java.lang.String TRANSACTION_TYPE

String property that specifies the transaction type.

Initial setting:

Configuration files: Depends on the .sbo file's Transactional Available and the Transaction Mode setting:

• If Transactional Available is set to False, then this property is set to None.


• If Transactional Available is set to True (the default setting), then this property is set to value of the Transaction Mode value in the .sbo file.

Possible values are:

• None
• AutoCommit
• Transactional

CATALOG_SEPARATOR

static final java.lang.String CATALOG_SEPARATOR

String property that specifies the catalog separator used to separate data items.

Initial setting:

Set by driver: Catalog Separator parameter or database middleware

IDENTIFIER_QUOTE_STRING

static final java.lang.String IDENTIFIER_QUOTE_STRING

String property that specifies the identifier quote string.

Initial setting:

Set by driver: Identifier Quote String parameter or database middleware

SEARCH_PATTERN_ESCAPE

static final java.lang.String SEARCH_PATTERN_ESCAPE

String property that specifies the SEARCH clause escape character.

Initial setting:

Set by driver: Escape Character parameter or database middleware

LIKE_ESCAPE_CLAUSE

static final java.lang.String LIKE_ESCAPE_CLAUSE

String property that specifies the LIKE clause escape character.

Initial setting:

Set by driver: LIKE Escape Clause parameter or database middleware

IDENTIFIER_CASE

static final java.lang.String IDENTIFIER_CASE

String property that specifies the case behavior of identifiers.

Initial setting:

Set by driver: Identifier Case parameter or database middleware

QUOTED_IDENTIFIER_CASE

static final java.lang.String QUOTED_IDENTIFIER_CASE

String property that specifies the case behavior of quoted identifiers.

Initial setting:

Configuration files: Quoted Identifier Case parameter.

AUTOCONNECT

static final java.lang.String AUTOCONNECT

Boolean property that specifies if the Data Access layer must establish a physical connection immediately, or wait for the first SQL statement before establishing a connection.

Initial setting:

False

ARRAY_FETCH_SIZE

static final java.lang.String ARRAY_FETCH_SIZE

Integer property that specifies how many rows are retrieved from the datasource each time a fetch is performed.

Initial setting:

Configuration files: Array fetch Size parameter

MAX_ROWS

static final java.lang.String MAX_ROWS

Integer property that sets the maximum number of rows that can be retrieved from the data source.

Initial setting:

0

XML_MAX_SIZE

static final java.lang.String XML_MAX_SIZE

Integer property that specifies the maximum size for an XML column.

Initial setting:

Configuration files: XML Max Size parameter

LOG_TIMEOUT

static final java.lang.String LOG_TIMEOUT

Integer property that specifies the maximum number of seconds for a login request before the request fails.

Initial setting:

600 seconds

QUERY_TIMEOUT

static final java.lang.String QUERY_TIMEOUT

Integer property that specifies the maximum number of seconds to wait for any request on the connection to complete before returning to the application.

Initial setting:

600 seconds

POOL_TIME

static final java.lang.String POOL_TIME

Integer property that specifies the number of minutes a connection will be kept alive in the Connection Pool.

Initial setting:

Configuration files: Pool Time parameter

QUOTED_IDENTIFIER

static final java.lang.String QUOTED_IDENTIFIER

Boolean property that specifies if a datasource supports quoted identifiers.

Initial setting:

Configuration files: Quoted Identifier parameter

PASSWORD_ENCRYPTION

static final java.lang.String PASSWORD_ENCRYPTION

Boolean property that specifies if the password must be encrypted.

Initial setting:

Configuration files Password Encryption parameter

ARRAY_BIND_SIZE

static final java.lang.String ARRAY_BIND_SIZE

Integer property that specifies the recommended Array Bind Size.

Initial setting:

Configuration files: Array Bind Size parameter

COST_ESTIMATE_AVAILABLE

static final java.lang.String COST_ESTIMATE_AVAILABLE

Boolean property that indicates if the driver supports performing cost estimate on queries.

Initial setting:

Configuration files: Cost Estimate Available parameter

PERFORM_COST_ESTIMATE

static final java.lang.String PERFORM_COST_ESTIMATE

Boolean property that specifies if the driver must perform cost estimate on queries.

Initial setting:

False

HINT

static final java.lang.String HINT

String property that specifies a hint to the SQL optimizer.

Initial setting:

Empty string

QUALIFIERS_AVAILABLE

static final java.lang.String QUALIFIERS_AVAILABLE

Boolean property that specifies if the data source supports qualifiers. Connection Server initializes this property by calling the qualifiersAvailable() method in the DBDriver interface. The driver's qualifiersAvailable() method must check if the Qualifiers Available SBO parameter is defined.

Initial setting:

Configuration files: Qualifiers Available parameter

OWNERS_AVAILABLE

static final java.lang.String OWNERS_AVAILABLE

Boolean property that specifies if the data source supports owners.

Initial setting:

Specific driver method: ownersAvailable() method

PRIMARYKEY_AVAILABLE

static final java.lang.String PRIMARYKEY_AVAILABLE

Boolean property that specifies if it is possible to retrieve the primary key from the data source. Connection Server initializes this property by calling the primaryKeyAvailable() method in the DBDriver interface. The driver's primaryKeyAvailable() method must check if the PrimaryKey Available SBO parameter is defined.

Initial setting:

Configuration files: PrimaryKey Available parameter

FOREIGNKEYS_AVAILABLE

static final java.lang.String FOREIGNKEYS_AVAILABLE

Boolean property that specifies if it is possible to retrieve a list of the foreign keys available from the data source. Connection Server initializes this property by calling the foreignKeysAvailable() method in the DBDriver interface. The driver's foreignKeysAvailable() method must check if the ForeignKeys Available SBO parameter is defined.

Initial setting:

Configuration files: ForeignKeys Available parameter

QUALIFIER_NAME_SIZE

static final java.lang.String QUALIFIER_NAME_SIZE

Integer property that specifies the maximum size for the name of a qualifier.

Initial setting:

Configuration files: Catalog Name Max Size parameter

OWNER_NAME_SIZE

static final java.lang.String OWNER_NAME_SIZE

Integer property that specifies the maximum size for the name of an owner.

Initial setting:

Configuration files: Schema Name Max Size parameter

TABLE_NAME_SIZE

static final java.lang.String TABLE_NAME_SIZE

Integer property that specifies the maximum size for a table name.

Initial setting:

Configuration files: Table Name Max Size parameter

COLUMN_NAME_SIZE

static final java.lang.String COLUMN_NAME_SIZE

Integer property that specifies the maximum size for a column name.

Initial setting:

Configuration files: Column Name Max Size parameter

Method Detail

isPropertyDefined

boolean isPropertyDefined(java.lang.String name)

Checks if a property is defined.

Parameters:

name - The name of the property

Returns:

• True: the property is defined.
• False: the property is not defined.

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value)
                 throws CSException

Sets a property's value.

Parameters:

name - The name of the property.

value - The value to set for the property.

Throws:

CSException - The property does not exist, or the value is not the correct type for the property.

setBooleanProperty

void setBooleanProperty(java.lang.String name,
                        boolean value)
                        throws CSException

Sets a boolean property's value.

Parameters:

name - The name of the property.

value - The value to set for the property.

Throws:

CSException - The property does not exist, or the value is not the correct type for the property.

setShortProperty

void setShortProperty(java.lang.String name,
                      short value)
                      throws CSException

Sets a short property's value.

Parameters:

name - The name of the property.

value - The value to set for the property.

Throws:

CSException - The property does not exist, or the value is not the correct type for the property.

setIntProperty

void setIntProperty(java.lang.String name,
                    int value)
                    throws CSException

Sets an int property's value

Parameters:

name - The name of the property.

value - The value to set for the property.

Throws:

CSException - The property does not exist, or the value is not the correct type for the property.

setStringProperty

void setStringProperty(java.lang.String name,
                       java.lang.String value)
                       throws CSException

Sets a string property's value.

Parameters:

name - The name of the property.

value - The value to set for the property.

Throws:

CSException - The property does not exist, or the value is not the correct type for the property.

getProperty

java.lang.Object getProperty(java.lang.String name)
                             throws CSException

Gets the value of a property.

Parameters:

name - The name of the property.

Returns:

The value of the property

Throws:

CSException - The property does not exist, or the property type is not a string

getBooleanProperty

boolean getBooleanProperty(java.lang.String name)
                           throws CSException

Gets the value of a boolean property.

Parameters:

name - The name of the property.

Returns:

The value of the property

Throws:

CSException - The property does not exist, or the property type is not a boolean

getShortProperty

short getShortProperty(java.lang.String name)
                       throws CSException

Gets the value of a short property.

Parameters:

name - The name of the property.

Returns:

The value of the property.

Throws:

CSException - The property does not exist, or the property type is not a short.

getIntProperty

int getIntProperty(java.lang.String name)
                   throws CSException

Gets the value of an int property.

Parameters:

name - The name of the property.

Returns:

The value of the property.

Throws:

CSException - The property does not exist, or the property type is not an int.

getStringProperty

java.lang.String getStringProperty(java.lang.String name)
                                   throws CSException

Gets the value of a string property

Parameters:

name - The name of the property.

Returns:

The value of the property.

Throws:

CSException - The property does not exist, or the property type is not a string

getLocale

LocaleDescriptor getLocale()

Returns the locale associated with a property.

Returns:

The property locale.