public interface

WebDBConnection

implements WebObjectInfo
com.microstrategy.web.objects.WebDBConnection

Class Overview

Object extending from WebObjectInfo to represent the first-class DB connection objects

Summary

Public Methods
abstract boolean areParameterizedQueriesEnabled()
abstract void disableExtendedFetch()
Disable Extended Fetch for ODB associated with this connection.
abstract void disableParameterizedQueries()
Disable parameterized queries.
abstract void disableTrace()
abstract void enableExtendedFetch()
Enable Extended fetch for ODB for this connection.
abstract void enableParameterizedQueries()
Enable parameterized queries.
abstract void enableTrace()
abstract Integer getCacheOption()
abstract Integer getCacheSize()
abstract Integer getCacheTimeout()
abstract int getCharEncoding()
abstract int getCharEncodingForUnix()
abstract int getConnectionLifetime()
abstract String getConnectionString()
abstract Integer getConnectionTimeout()
abstract WebDBLogin getDBLogin()
abstract Integer getDBRoleType()
Returns the type of DB role accessed.
abstract Integer getDatabaseType()
Returns the type of DB being accessed.
abstract Integer getDriverMode()
abstract Integer getExecutionMode()
abstract int getIdleTimeout()
abstract int getMaxCancelAttemptTime()
abstract int getMaxConnectionAttemptTime()
Set the maximum connection attempt time.
abstract Integer getMaxDBConnections()
abstract Integer getMaxDBCost()
abstract int getMaxQueryExeTime()
abstract Integer getMultiProcess()
abstract String getOAuthParameter()
abstract String getTablePrefix()
abstract Boolean getTraceFlag()
abstract Boolean isExtendedFetchEnabled()
abstract void setCacheOption(int option)
abstract void setCacheSize(int size)
abstract void setCacheTimeout(int cacheTimeout)
abstract void setCharEncoding(int encoding)
Set the character set encoding for Windows drivers.
abstract void setCharEncodingForUnix(int encoding)
Set the character set encoding for Unix drivers.
abstract void setConnectionLifetime(int timeout)
Set the connection lifetime.
abstract void setConnectionString(String connectionString)
abstract void setConnectionTimeout(int time)
abstract void setDBLogin(WebDBLogin newLogin, boolean embed)
Sets the login credentials to be used by this connection
abstract void setDBLogin(WebDBLogin newLogin)
abstract void setDBRoleType(int newType)
Changes the type of DBRole type associated with this database connection This method is only applicable for remote projects
abstract void setDatabaseType(int newType)
Changes the type of Database type associated with this database connection This method is only applicable for MDX database, which is DssXmlDBSAP or DssXmlDBMicrosoftAS.
abstract void setDriverMode(int newMode)
abstract void setExecutionMode(int newMode)
abstract void setIdleTimeout(int timeout)
Set the connection idle timeout.
abstract void setMaxCancelAttemptTime(int time)
Set the maximum cancel attempt time.
abstract void setMaxConnectionAttemptTime(int time)
Set the maximum connection attempt time.
abstract void setMaxDBConnections(int conns)
abstract void setMaxDBCost(int cost)
abstract void setMaxQueryExeTime(int time)
Set the maximum query execution time.
abstract void setMultiProcess(int type)
abstract void setOAuthParameter(String oa)
abstract void setTablePrefix(String prefix)
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract boolean areParameterizedQueriesEnabled ()

Returns
  • boolean whether paramatized queries are enabled
Throws
WebObjectsException

public abstract void disableExtendedFetch ()

Disable Extended Fetch for ODB associated with this connection. ExtendedFetch is a Boolean property. It specifies whether or not to use the extended fetch ODBC call to retrieve data from the connection.

public abstract void disableParameterizedQueries ()

Disable parameterized queries. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it.

Throws
WebObjectsException

public abstract void disableTrace ()

public abstract void enableExtendedFetch ()

Enable Extended fetch for ODB for this connection. ExtendedFetch is a Boolean property. It specifies whether or not to use the extended fetch ODBC call to retrieve data from the connection.

public abstract void enableParameterizedQueries ()

Enable parameterized queries. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it.

Throws
WebObjectsException

public abstract void enableTrace ()

public abstract Integer getCacheOption ()

Returns
  • integer from EnumDSSXMLDBConnectionCacheOption It specifies the degree to which the intelligence server will attempt to reuse physical connections made using the specification contained in this DBConnection object.

public abstract Integer getCacheSize ()

Returns
  • integer. It contains the maximum number of physical connections made using the specifications in this object that may be opened simultaneously. Thus it is the maximum size of the connection pool.

public abstract Integer getCacheTimeout ()

Returns
  • Integer seconds for CacheTimeout. CacheTimeOut is a numeric property. When use connection pooling, the connection is not disconnected when it is released. Instead, it is kept open until it idles for ConnectionCacheTimeOut seconds. If a connection is open and released frequently, connection pooling reduces the cost associated with creating a new connection.

public abstract int getCharEncoding ()

Returns
Throws
WebObjectsException

public abstract int getCharEncodingForUnix ()

Returns
Throws
WebObjectsException

public abstract int getConnectionLifetime ()

Returns
  • Integer seconds maximum connection lifetime
Throws
WebObjectsException

public abstract String getConnectionString ()

Returns
  • a String including connection information about this Database connection

public abstract Integer getConnectionTimeout ()

Returns
  • Integer specifying how long before requests on connection are timed out. It specifies the time in seconds to wait for a connection request comes back.

public abstract WebDBLogin getDBLogin ()

Returns
  • WebDBLogin object used to connect to ODB associated with this connection

public abstract Integer getDBRoleType ()

Returns the type of DB role accessed.

Returns

public abstract Integer getDatabaseType ()

Returns the type of DB being accessed.

Returns

public abstract Integer getDriverMode ()

Returns
  • Integer from EnumDSSXMLDBConnectionDriverMode. DriverType is an enumeration property. It specifies the connection driver type. It specifies whether the connection is made using ODBC or some native database driver.

public abstract Integer getExecutionMode ()

Returns
  • Integer from EnumDSSXMLDBConnectionExecutionMode. ExecutionMode is an enumeration property. It specifies the manner in which SQL statements will be executed on a physical connection made using this object. In particular it indicates if the statement is executed synchronously or asynchronously.

public abstract int getIdleTimeout ()

Returns
  • Integer seconds maximum connection lifetime
Throws
WebObjectsException

public abstract int getMaxCancelAttemptTime ()

Returns
  • integer seconds before cancel action times out
Throws
WebObjectsException

public abstract int getMaxConnectionAttemptTime ()

Set the maximum connection attempt time. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it

Returns
  • Integer number of seconds connection attempts to be made before timing out
Throws
WebObjectsException

public abstract Integer getMaxDBConnections ()

Returns
  • integer numeric property (Backend information)

public abstract Integer getMaxDBCost ()

Returns
  • integer numeric property (Backend information)

public abstract int getMaxQueryExeTime ()

Returns
  • Integer number of seconds that a query has to execute before being timed out
Throws
WebObjectsException

public abstract Integer getMultiProcess ()

Returns

public abstract String getOAuthParameter ()

Returns
  • a String including OAuth parameter

public abstract String getTablePrefix ()

Returns
  • String containing table prefix for this connection. TablePrefixString is a text property. The QueryEngine prefixed the names of all temporary tables that it creates during report execution with this string.

public abstract Boolean getTraceFlag ()

Returns
  • boolean specifying whether requests on this connection should be traced

public abstract Boolean isExtendedFetchEnabled ()

Returns
  • ExtendedFetch is a Boolean property. It specifies whether or not to use the extended fetch ODBC call to retrieve data from the connection.

public abstract void setCacheOption (int option)

Parameters
option integer from EnumDSSXMLDBConnectionCacheOption. It specifies the degree to which the intelligence server will attempt to reuse physical connections made using the specification contained in this DBConnection object.

public abstract void setCacheSize (int size)

Parameters
size integer. It contains the maximum number of physical connections made using the specifications in this object that may be opened simultaneously. Thus it is the maximum size of the connection pool.

public abstract void setCacheTimeout (int cacheTimeout)

Parameters
cacheTimeout Integer seconds for CacheTimeout. CacheTimeOut is a numeric property. When use connection pooling, the connection is not disconnected when it is released. Instead, it is kept open until it idles for ConnectionCacheTimeOut seconds. If a connection is open and released frequently, connection pooling reduces the cost associated with creating a new connection.

public abstract void setCharEncoding (int encoding)

Set the character set encoding for Windows drivers. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it.

Throws
WebObjectsException

public abstract void setCharEncodingForUnix (int encoding)

Set the character set encoding for Unix drivers. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it.

Throws
WebObjectsException

public abstract void setConnectionLifetime (int timeout)

Set the connection lifetime. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it.

Parameters
timeout integer seconds maximum connection lifetime
Throws
WebObjectsException

public abstract void setConnectionString (String connectionString)

Parameters
connectionString String including connection information associated with this database connection

public abstract void setConnectionTimeout (int time)

Parameters
time Integer specifying how long before requests on connection are timed out. It specifies the time in seconds to wait for a connection request comes back.

public abstract void setDBLogin (WebDBLogin newLogin, boolean embed)

Sets the login credentials to be used by this connection

Parameters
newLogin WebDBLogin object representing login credentials for this connection
embed boolean true when newLogin should be embedded in

public abstract void setDBLogin (WebDBLogin newLogin)

Parameters
newLogin WebDBLogin to be associated with this connection

public abstract void setDBRoleType (int newType)

Changes the type of DBRole type associated with this database connection This method is only applicable for remote projects

Parameters
newType integer representing the type of the new DB to be connected by this DBConnection from EnumDSSXMLDatabaseType

public abstract void setDatabaseType (int newType)

Changes the type of Database type associated with this database connection This method is only applicable for MDX database, which is DssXmlDBSAP or DssXmlDBMicrosoftAS. For other database type, we always use default database type and not allow use this method to set database type.

Parameters
newType integer representing the type of the new DB to be connected by this DBConnection from EnumDSSXMLDatabaseType

public abstract void setDriverMode (int newMode)

Parameters
newMode Integer from EnumDSSXMLDBConnectionDriverMode. It specifies the connection driver type. It specifies whether the connection is made using ODBC or some native database driver.

public abstract void setExecutionMode (int newMode)

Parameters
newMode Integer from EnumDSSXMLDBConnectionExecutionMode. It specifies the manner in SQL statements will be executed on a physical connection made using this object. In particular it indicates if the statement is executed synchronously or asynchronously.

public abstract void setIdleTimeout (int timeout)

Set the connection idle timeout. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it.

Parameters
timeout integer seconds maximum connection lifetime
Throws
WebObjectsException

public abstract void setMaxCancelAttemptTime (int time)

Set the maximum cancel attempt time. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it

Parameters
time Integer seconds maximum time to attempt to cancel a connection
Throws
WebObjectsException

public abstract void setMaxConnectionAttemptTime (int time)

Set the maximum connection attempt time. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it

Parameters
time Integer seconds maximum time to try to connect to IServer
Throws
WebObjectsException

public abstract void setMaxDBConnections (int conns)

Parameters
conns integer specifying a numeric property for this connection

public abstract void setMaxDBCost (int cost)

Parameters
cost integer specifying a numeric property for this connection

public abstract void setMaxQueryExeTime (int time)

Set the maximum query execution time. This method modifies a WebObjectInfo property. Therefore, this object must exist in the MD prior to calling it

Parameters
time Integer seconds maximum time a query can execute before being timed out
Throws
WebObjectsException

public abstract void setMultiProcess (int type)

public abstract void setOAuthParameter (String oa)

Parameters
oa String including OAuth parameter

public abstract void setTablePrefix (String prefix)

Parameters
prefix String containing table prefix for this connection
Throws
IllegalArgumentException