T4EA  18.2 C7549 A21431
Teamcenter Gateway for Enterprise Applications API Reference
T4EA::JDBC::ORACLE Namespace Reference

Functions

 checkConnection ?User? ?Password? ?System? ?ConnectString? ?Language? args
 Implements the connection check for the custom managed connection handling for Oracle JDBC databases. More...
 
 cleanupAllJdbcConnections args
 Cleanup for all active JDBC Connections (connection close, memory cleanup...) More...
 
 cleanupJdbcConnection ?strSystem? args
 Cleanup for an active JDBC Connection (connection close, memory cleanup...) More...
 
 createJdbcMetafile strSystem args
 Create the stored procedure metafile for JDBC. More...
 
 getConnectionHandle4ActiveSystem ?blnLoadMetafile? args
 Returns the connection handle for the active EA system. More...
 
 getConnectionHandle4System strSystem ?blnLoadMetafile? args
 Returns the connection handle for the given EA system. More...
 
 initJdbcConnection strSystem ConnectString Language User Password ?blnLoadMetafile?
 Initializes a JDBC Connection. More...
 

Function Documentation

◆ checkConnection()

T4EA::JDBC::ORACLE::checkConnection   ?User? ?Password? ?System? ?ConnectString? ?Language? args  

Implements the connection check for the custom managed connection handling for Oracle JDBC databases.

If any optional parameter is missing, the procedure will use the default values from EA connection handling.

Parameters
User(optional) User name
Password(optional) Password of the user
System(optional) the EA system to use
ConnectString(optional) the database connect string
Language(optional) Language to use for session
Returns
UNKNOWN or LOGON_OK or MISSING_LOGIN_DATA or LOGON_ERROR and error message

References T4X::CORE::getSessionLogChannel(), initJdbcConnection(), and tpwrite().

◆ cleanupAllJdbcConnections()

T4EA::JDBC::ORACLE::cleanupAllJdbcConnections   args  

Cleanup for all active JDBC Connections (connection close, memory cleanup...)

Returns
OK or ERROR

References cleanupJdbcConnection(), T4X::CORE::getSessionLogChannel(), and tpwrite().

Referenced by tp_crashexit().

◆ cleanupJdbcConnection()

T4EA::JDBC::ORACLE::cleanupJdbcConnection   ?strSystem? args  

Cleanup for an active JDBC Connection (connection close, memory cleanup...)

Parameters
strSystem- EA System - (Optional - DEFAULT)
Returns
OK or ERROR

References T4X::CORE::getSessionLogChannel(), T4X::OBJECTS::tprevertto(), T4X::OBJECTS::tpwith(), and tpwrite().

Referenced by cleanupAllJdbcConnections(), and getConnectionHandle4System().

◆ createJdbcMetafile()

T4EA::JDBC::ORACLE::createJdbcMetafile   strSystem args  

Create the stored procedure metafile for JDBC.

Parameters
strSystem- EA System
Returns
OK or ERROR

References T4X::CORE::getSessionLogChannel(), and tpwrite().

◆ getConnectionHandle4ActiveSystem()

T4EA::JDBC::ORACLE::getConnectionHandle4ActiveSystem   ?blnLoadMetafile? args  

Returns the connection handle for the active EA system.

Parameters
blnLoadMetafile- If true, JDBC meta ntl file will be loaded (Optional - FALSE)
Returns
OK or ERROR

References getConnectionHandle4System(), and T4EA::CONNECTION2EA::getCurrentEAInfo().

Referenced by T4EA::CUSTOM::ORACLE::createProductInformation(), T4EA::QUERY::CUSTOM::MAPPING::executeQuery4ProductInformation(), T4EA::CUSTOM::ORACLE::getObjectInfo(), and T4EA::CUSTOM::ORACLE::updateProductInformation().

◆ getConnectionHandle4System()

T4EA::JDBC::ORACLE::getConnectionHandle4System   strSystem ?blnLoadMetafile? args  

Returns the connection handle for the given EA system.

Parameters
strSystem- EA System
blnLoadMetafile- If true, JDBC meta ntl file will be loaded (Optional - FALSE)
Returns
OK or ERROR

References cleanupJdbcConnection(), T4EA::CONNECTION2EA::getCurrentEAInfo(), T4X::CORE::getSessionLogChannel(), initJdbcConnection(), T4X::OBJECTS::tplet(), T4X::OBJECTS::tpwith(), and tpwrite().

Referenced by getConnectionHandle4ActiveSystem().

◆ initJdbcConnection()

T4EA::JDBC::ORACLE::initJdbcConnection   strSystem ConnectString Language User Password ?blnLoadMetafile?  

Initializes a JDBC Connection.

Parameters
strSystem- EA System (Optional - DEFAULT)
ConnectStringDatabase connect string
Languagelanguage to use for session
UserUser name
PasswordPassword
blnLoadMetafile- If true, JDBC meta ntl file will be loaded (Optional - FALSE)
Returns
OK or list of ERROR and message

References T4EA::getLocalizationString(), T4X::CORE::getSessionLogChannel(), T4X::OBJECTS::setInitialJavaHeapSize(), T4X::OBJECTS::setMaximumJavaHeapSize(), T4X::OBJECTS::tplet(), T4X::OBJECTS::tpmodule(), T4X::OBJECTS::tpwith(), and tpwrite().

Referenced by checkConnection(), and getConnectionHandle4System().