oracle.dacf.dataset
Class SessionInfo

java.lang.Object
  oracle.dacf.dataset.DacObject
      oracle.dacf.dataset.ProducerObject
          oracle.dacf.dataset.InfoObject
              oracle.dacf.dataset.SessionInfo

All Implemented Interfaces:

java.lang.Cloneable, oracle.jbo.ConnectionModeConstants, DriverTypeConstants, oracle.jbo.JboExceptionHandler, LockingModeConstants

public class SessionInfo

extends InfoObject

implements DriverTypeConstants, oracle.jbo.ConnectionModeConstants, LockingModeConstants, oracle.jbo.JboExceptionHandler

The SessionInfo represents the database transaction context on the client. It maps to a root BC4J AppModule which in turn establishes the connection to the database. The SessionInfo class instances contain metadata regarding the BC4J AppModule, connection details, and deployment platform. The SessionInfo is also the parent object in the DAC runtime object containment hierarchy; it also as a parent of all other data producers such as RowSetInfo and LOVRowSetInfo which represent database queries. The individual query columns or attributes are represented by AttributeInfo and LOVAttributeInfo objects.

To use this class, instantiate it, then identify:

• the connection details,
• where the Application Module resides,
• the deployment platform you are using,
• the RowSetInfo or LOVRowSetInfo objects (which represent the queries) that will populate the SessionInfo,

then publish the session via SessionInfo.publishSession().

The following figure illustrates the containment hierarchy for SessionInfo.

Version:

SDK

See Also:

RowSetInfo, LOVRowSetInfo, AttributeInfo, LOVAttributeInfo

Field Summary

protected java.lang.Object	_connectLock
static java.lang.String	BIND_STRING String constant to indicate use BIND connection mode.
static int	COLOCATE Integer constant to indicate client and server in the same JVM, communicating using CORBA and Visigenics ORB.
static java.lang.String	COLOCATE_STRING String constant to indicate client and server in the same JVM, communicating using CORBA and Visigenics ORB.
static java.lang.String	DEFAULT_INFOBUS_NAME
static java.lang.String	DEFAULT_MODULENAME String constant for default module name.
static int	DEFAULT_TIMEOUT Default time out value for communication with the server.
static java.lang.String	EJB_PLATFORM String constant for the EJB deployment platform.
static java.lang.String	EJB_STRING String constant for the EJB deployment platform.
static java.lang.String	ERR_PROD_CODE
static java.lang.String	IOR_STRING String constant used to specify the use of the universal Inter-ORB connection protocol.
static java.lang.String	LOCAL_PLATFORM String constant for the Local deployment platform.
static java.lang.String	LOCAL_STRING String constant for the Local deployment platform.
static java.lang.String	LOCK_NONE String constant for the locking mode "none": do not attempt to lock the row at all.
static java.lang.String	LOCK_OPTIMISTIC String constant for the locking mode "optimistic": attempt to lock the row at commit.
static java.lang.String	LOCK_PESSIMISTIC String constant for the locking mode "pessimistic": attempt to lock the row at update.
static int	MODULE Integer constant for the module type.
static java.lang.String	MODULE_STRING String constant for the module type.
static java.lang.String	O8I_PLATFORM String constant for the Oracle8i deployment platform.
static java.lang.String	O8I_STRING String constant for the Oracle8i deployment platform.
static int	OCI7 Integer constant for Oracle JDBC OCI7 driver type.
static java.lang.String	OCI7_STRING String constant for Oracle JDBC OCI7 driver type.
static int	OCI8 Integer constant for Oracle JDBC OCI8 driver type.
static java.lang.String	OCI8_STRING String constant for Oracle JDBC OCI8 driver type.
static int	PACKAGE Integer constant for the module type.
static java.lang.String	PACKAGE_STRING String constant for the module type.
static int	REMOTE Integer constant to indicate use naming service.
static java.lang.String	REMOTE_STRING String constant to indicate use naming service.
static int	THIN Integer constant for Oracle JDBC Thin driver type.
static java.lang.String	THIN_STRING String constant for Oracle JDBC Thin driver type.
static int	UNKNOWN Integer constant for an unknown driver type.
static int	USE_BIND Integer constant to indicate use BIND connection mode.
static int	USE_IOR Integer constant used to specify the use of the universal Inter-ORB connection protocol.
static java.lang.String	VISIBROKER_PLATFORM String constant for the Visibroker deployment platform.
static java.lang.String	VISIBROKER_STRING String constant for the Visibroker deployment platform.

Fields inherited from class oracle.dacf.dataset.InfoObject

_updateMode, LEVEL_APPLICATION, LEVEL_ATTRIBUTE, LEVEL_COLUMN, LEVEL_QUERY_VIEW, LEVEL_ROOT, LEVEL_ROW, LEVEL_ROWSET, LEVEL_SESSION, PROPERTIES_COLUMN_NAME, UPDATEABLE_FALSE, UPDATEABLE_MAX_VAL, UPDATEABLE_TRUE, UPDATEABLE_UNDEFINED

Fields inherited from class oracle.dacf.dataset.ProducerObject

_openLock

Fields inherited from class oracle.dacf.dataset.DacObject

EMPTY_PREFIX, INITIAL_CAPACITY, ITEMNAME_DELIMITER

Fields inherited from interface oracle.jbo.ConnectionModeConstants

LOCAL

Constructor Summary

	SessionInfo() Default constructor.
protected	SessionInfo(java.lang.String name) Constructor requiring a session bind name.
protected	SessionInfo(java.lang.String name, oracle.jbo.ApplicationModule appModule) Constructor requiring a session bind name and an Application Module.

Method Summary

void	addRowSet(ResultSetInfo resultSetInfo) Adds a ResultSetInfo to the SessionInfo.
void	cacheSingleValue(java.lang.String name, java.lang.Object s) Adds a single object and its name to the cache.
void	clearDirty() Clears the dirty state of the DataItem.
protected void	closeCheck() Internal: Applications should not use this method.
protected void	closeChildren() Internal: Applications should not use this method.
protected void	closeDataItems() Internal: Applications should not use this method.
protected void	closeProducerObject() Internal: Applications should not use this method.
protected void	connect() Internal: Applications should not use this method.
protected javax.infobus.DataItem	findDataItem(java.lang.String name) Finds the DataItem indicated by name.
void	finishedProcessingPiggyback(java.lang.Exception[] exArray)
java.applet.Applet	getAppletInstance() Gets the Applet context.
oracle.jbo.ApplicationModule	getApplicationModule() Returns the value of the Application Module property.
java.lang.String	getApplicationModuleClass() Returns the value of the ApplicationModuleClass property: this is the fully-qualified name of the class that implements the ApplicationModule object on the server.
java.lang.String	getApplicationModuleName() Deprecated. Use getName() instead.
AppModuleInfo	getAppModuleInfo() Returns the JboLocation information (Application Module and Package name).
SessInfoDescriptor	getConnection() Deprecated. Use getConnectionInfo() instead.
ConnectionInfo	getConnectionInfo() Returns the connection definition defining all elements of the connection deployment choice.
int	getConnectionMode() Returns the value of the ConnectionMode property which determines the relationship between the client and server portions of the application.
java.lang.String	getConnectionName() Deprecated. Use getConnectionInfo() instead.
java.lang.String	getConnectionURL() Deprecated. Use these methods instead: getConnectionInfo() getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection NamedConnection.getConnectionURL()
CustomConnect	getCustomConnect() Deprecated. Use ConnectionInfo.setCustomConnection(CustomConnection) instead
java.lang.String	getDatabaseURL() Returns the value of the URL connection string property, which identifies the database being used.
protected javax.infobus.DataItem	getDataItem() Returns the DbAccess DataItem that is asscociated with this SessionInfo.
javax.infobus.DbAccess	getDbAccess() Returns a javax.infobus.DbAccess interface.
java.lang.String	getDeploymentPlatform() Deprecated. Use getConnectionInfo() instead.
java.lang.String	getDriverClass() Deprecated. This method is ignored.
int	getDriverType() Deprecated. Use these methods instead: getConnectionInfo() getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection NamedConnection.getConnectionURL()
java.util.Hashtable	getEnvironment() Returns the environment hashtable used when creating the Application Module.
java.lang.String	getIIOPConnectionName() Deprecated. Use getConnectionInfo() instead.
javax.infobus.InfoBusDataProducer	getInfoBusDataProducer() Gets the InfoBusDataProducer that services the DataItem requests.
java.lang.String	getInfoBusName() Gets the name of the bus being used for publishing the DataItems created under this session.
java.lang.String	getJBOSessionClass() Deprecated. Superceded by getApplicationModuleClass().
java.util.Locale	getLocale() Returns the locale for this SessionInfo.
java.lang.String	getLockingMode() Returns the value of the LockingMode property, which identifies which lockmode is currently being used.
java.lang.String	getModulePackage() Returns the name of the Package that includes the Application Module.
java.lang.String	getName() Returns the name of the DacObject.
java.lang.String	getPassword() Deprecated. Use these methods instead: getConnectionInfo() getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection NamedConnection.getPassWord()
java.lang.String	getRemoteApplicationPath() Deprecated. Use getConnectionInfo() instead.
java.lang.String	getRemoteHost() Deprecated. Use getConnectionInfo() instead
int	getRemoteHostPort() Deprecated. Use getConnectionInfo() instead.
ResultSetInfo	getRowSet(java.lang.String name) Returns the named rowset Identifies a ResultSetInfo based upon the name (bindname) of the ResultSetInfo.
int	getRowSetCount() Return the number ResultSetInfo objects within the SessionInfo.
int	getServerTimeout() Returns the timeout threshold value for communications with the middle-tier server.
java.lang.String	getUserName() Deprecated. Use these methods instead: getConnectionInfo() getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection NamedConnection.getUserName()
void	handleException(java.lang.Exception ex, boolean lastEntryInPiggyback) Catches an exception thrown by the middle tier.
void	handleWarning(oracle.jbo.JboWarning warn) Catches a warning thrown by the middle tier.
protected void	internalValidation(int eventLevel) Internal: Applications should not use this method.
protected void	openChildren() Internal: Applications should not use this method.
protected void	openDataItems() Internal: Applications should not use this method.
protected void	openProducerObject() Internal: Applications should not use this method.
void	publishSession() Publishes the session and its child items on the InfoBus.
void	publishSession(boolean activate)
void	removeRowSet(ResultSetInfo resultSetInfo) Removes a ResultSetInfo from a SessionInfo.
void	revokeSession() Revokes the session and its child items on the InfoBus.
void	revokeSession(boolean force) Ignores all objections when revoking the session and its child items on the InfoBus.
void	setAppletInstance(java.applet.Applet appletInstance) Sets the Applet context.
protected void	setApplicationModule(oracle.jbo.ApplicationModule applicationModule) Sets the Application Module property to use in this session.
void	setApplicationModuleClass(java.lang.String nuApplicationModuleClass) Sets the ApplicationModuleClass property: the fully-qualified name of the class that implements the Application Module object on the server.
void	setApplicationModuleName(java.lang.String applicationModuleName) Deprecated. Use ProducerObject.setName(String) instead.
void	setAppModuleInfo(AppModuleInfo jboLoc) Specifies the Java Bussiness Object location and Project by using an AppModuleInfo MetaData class.
void	setBoLocationInfo(AppModuleInfo jboLoc) Deprecated. Use setAppModuleInfo(AppModuleInfo jboLoc) instead.
void	setConnection(SessInfoDescriptor sDesc) Deprecated. Use setConnectionInfo(ConnectionInfo con) instead.
void	setConnectionInfo(ConnectionInfo conn) Sets a connection defining all elements of the connection deployment choice.
void	setConnectionMode(int nuConnectionMode) Sets the ConnectionMode property which determines the relationship between the client and server portions of the application.
void	setConnectionName(java.lang.String connectionName) Deprecated. Use setConnectionInfo(ConnectionInfo) instead.
void	setConnectionURL(java.lang.String URL) Deprecated. Use these methods instead: setConnectionInfo(ConnectionInfo conn) getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection NamedConnection.setConnectionURL(String url)
void	setCustomConnect(CustomConnect customConnect) Deprecated. Use ConnectionInfo.setCustomConnection(CustomConnection) instead
void	setDatabaseURL(java.lang.String nuDatabaseURL) Deprecated. Use any of the following instead: setConnectionInfo(ConnectionInfo) getLoginConnection from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection setHostName(), setConnectionPort(), and setSID() from NamedConnection
void	setDeploymentPlatform(java.lang.String nuDeploymentPlatform) Deprecated. Use setConnectionInfo(ConnectionInfo) instead.
protected void	setDirty(boolean dirty) Determines whether this DataItem is dirty and needs to be validated.
void	setDriverClass(java.lang.String DriverClass) Deprecated. This method is ignored.
void	setDriverType(int nuDriverType) Deprecated. Use these methods instead: setConnectionInfo(ConnectionInfo) getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection
void	setIIOPConnectionName(java.lang.String connectionName) Deprecated. Use setConnectionInfo(ConnectionInfo) instead.
void	setInfoBusName(java.lang.String busName) Sets the name of the bus to be used for publishing the DataItems created under this session.
void	setJBOSessionClass(java.lang.String nuApplicationModuleClass) Deprecated. Superceded by setApplicationModuleClass(java.lang.String).
void	setLocale(java.util.Locale nuLocale) Sets the locale for this SessionInfo and all of the child objects.
void	setLockingMode(java.lang.String lockingMode) Sets the value of the LockingMode property, which identifies which lockmode is to be used.
void	setModuleInfo(ModuleDescriptor mDesc) Deprecated. Use setAppModuleInfo(AppModuleInfo jboLoc) instead.
void	setPassword(java.lang.String nuPassword) Deprecated. Use these methods instead: setConnectionInfo(ConnectionInfo) getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection NamedConnection.setPassWord(String password)
void	setRemoteApplicationPath(java.lang.String path) Deprecated. Use setConnectionInfo(ConnectionInfo) instead.
void	setRemoteHost(java.lang.String remoteHost) Deprecated. Use setConnectionInfo(ConnectionInfo) instead.
void	setRemoteHostPort(int port) Deprecated. Use setConnectionInfo(ConnectionInfo) instead.
void	setServerTimeout(int nuTimeOut) Sets the timeout threshold value for communications with the middle-tier server.
void	setUserName(java.lang.String nuUserName) Deprecated. Use these methods instead: setConnectionInfo(ConnectionInfo con) getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection NamedConnection.setUserName(String name)
void	validate() Internal: Applications should not use this method.

Methods inherited from class oracle.dacf.dataset.InfoObject

addChangeListener, addValidationListener, areParentsValid, clone, createChild, fireValidationEvent, forceValid, getChangeListeners, getUpdateMode, getValidationListeners, isActive, isDirty, isUpdateable, isValid, processValidationEvent, removeChangeListener, removeValidationListener, setActive, setUpdateable, setValid, toString, validate, validate

Methods inherited from class oracle.dacf.dataset.ProducerObject

addChild, addClonedDataItem, close, findProducerObject, findProducerObject, getClonedDataItems, getDataItemImpl, getDataProducer, getDataSourceName, getFullName, isAClonedDataItem, isOpen, open, publishDataItem, publishDataItem, removeChild, removeClonedDataItem, revokeDataItem, setClonedDataItems, setDataItem, setDataSourceName, setName, setOpen

Methods inherited from class oracle.dacf.dataset.DacObject

addChild, findDescendant, genCloneName, getChild, getChildIndex, getChildren, getNumOfChildren, getParent, getPrefix, insertChildAt, removeChild, removeChildren, setChildren, setParent, setPrefix

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN

public static final int UNKNOWN

Integer constant for an unknown driver type. Used in conjuction with setDriverType() and getDriverType().

See Also:

setDriverType(int), getDriverType(), Constant Field Values

OCI7

public static final int OCI7

Integer constant for Oracle JDBC OCI7 driver type. Used in conjuction with setDriverType() and getDriverType().

See Also:

setDriverType(int), getDriverType(), Constant Field Values

OCI8

public static final int OCI8

Integer constant for Oracle JDBC OCI8 driver type. Used in conjuction with setDriverType() and getDriverType().

See Also:

setDriverType(int), getDriverType(), Constant Field Values

THIN

public static final int THIN

Integer constant for Oracle JDBC Thin driver type. Used in conjuction with setDriverType() and getDriverType().

See Also:

setDriverType(int), getDriverType(), Constant Field Values

OCI7_STRING

public static final java.lang.String OCI7_STRING

String constant for Oracle JDBC OCI7 driver type. Used in conjuction with setDriverType() and getDriverType().

See Also:

setDriverType(int), getDriverType(), Constant Field Values

OCI8_STRING

public static final java.lang.String OCI8_STRING

String constant for Oracle JDBC OCI8 driver type. Used in conjuction with setDriverType() and getDriverType().

See Also:

setDriverType(int), getDriverType(), Constant Field Values

THIN_STRING

public static final java.lang.String THIN_STRING

String constant for Oracle JDBC Thin driver type. Used in conjuction with setDriverType() and getDriverType().

See Also:

setDriverType(int), getDriverType(), Constant Field Values

VISIBROKER_PLATFORM

public static final java.lang.String VISIBROKER_PLATFORM

String constant for the Visibroker deployment platform. Used in conjunction with setDeploymentPlatform() and getDeploymentPlatform()

See Also:

setDeploymentPlatform(String platform), getDeploymentPlatform(), Constant Field Values

LOCAL_PLATFORM

public static final java.lang.String LOCAL_PLATFORM

String constant for the Local deployment platform. Used in conjunction with setDeploymentPlatform() and getDeploymentPlatform()

See Also:

setDeploymentPlatform(String platform), getDeploymentPlatform(), Constant Field Values

EJB_PLATFORM

public static final java.lang.String EJB_PLATFORM

String constant for the EJB deployment platform. Used in conjunction with setDeploymentPlatform() and getDeploymentPlatform()

See Also:

setDeploymentPlatform(String platform), getDeploymentPlatform(), Constant Field Values

O8I_PLATFORM

public static final java.lang.String O8I_PLATFORM

String constant for the Oracle8i deployment platform. Used in conjunction with setDeploymentPlatform() and getDeploymentPlatform()

See Also:

setDeploymentPlatform(String platform), getDeploymentPlatform(), Constant Field Values

VISIBROKER_STRING

public static final java.lang.String VISIBROKER_STRING

String constant for the Visibroker deployment platform. Used in conjunction with setDeploymentPlatform() and getDeploymentPlatform()

See Also:

setDeploymentPlatform(String platform), getDeploymentPlatform(), Constant Field Values

LOCAL_STRING

public static final java.lang.String LOCAL_STRING

String constant for the Local deployment platform. Used in conjunction with setDeploymentPlatform() and getDeploymentPlatform()

See Also:

setDeploymentPlatform(String platform), getDeploymentPlatform(), Constant Field Values

EJB_STRING

public static final java.lang.String EJB_STRING

String constant for the EJB deployment platform. Used in conjunction with setDeploymentPlatform() and getDeploymentPlatform()

See Also:

setDeploymentPlatform(String platform), getDeploymentPlatform(), Constant Field Values

O8I_STRING

public static final java.lang.String O8I_STRING

String constant for the Oracle8i deployment platform. Used in conjunction with setDeploymentPlatform() and getDeploymentPlatform()

See Also:

setDeploymentPlatform(String platform), getDeploymentPlatform(), Constant Field Values

LOCK_NONE

public static final java.lang.String LOCK_NONE

String constant for the locking mode "none": do not attempt to lock the row at all. Used in conjunction with setLockingMode() and getLockingMode().

See Also:

setLockingMode(String mode), getLockingMode(), Constant Field Values

LOCK_PESSIMISTIC

public static final java.lang.String LOCK_PESSIMISTIC

String constant for the locking mode "pessimistic": attempt to lock the row at update. Used in conjunction with setLockingMode() and getLockingMode().

See Also:

setLockingMode(String mode), getLockingMode(), Constant Field Values

LOCK_OPTIMISTIC

public static final java.lang.String LOCK_OPTIMISTIC

String constant for the locking mode "optimistic": attempt to lock the row at commit. Used in conjunction with setLockingMode() and getLockingMode().

See Also:

setLockingMode(String mode), getLockingMode(), Constant Field Values

COLOCATE

public static final int COLOCATE

Integer constant to indicate client and server in the same JVM, communicating using CORBA and Visigenics ORB.

See Also:

Constant Field Values

COLOCATE_STRING

public static final java.lang.String COLOCATE_STRING

String constant to indicate client and server in the same JVM, communicating using CORBA and Visigenics ORB.

See Also:

Constant Field Values

REMOTE

public static final int REMOTE

Integer constant to indicate use naming service. Works with those CORBA ORB's that share the same object reference format.

See Also:

Constant Field Values

REMOTE_STRING

public static final java.lang.String REMOTE_STRING

String constant to indicate use naming service. Works with those CORBA ORB's that share the same object reference format.

See Also:

Constant Field Values

USE_IOR

public static final int USE_IOR

Integer constant used to specify the use of the universal Inter-ORB connection protocol.

See Also:

Constant Field Values

IOR_STRING

public static final java.lang.String IOR_STRING

String constant used to specify the use of the universal Inter-ORB connection protocol.

See Also:

Constant Field Values

USE_BIND

public static final int USE_BIND

Integer constant to indicate use BIND connection mode.

See Also:

Constant Field Values

BIND_STRING

public static final java.lang.String BIND_STRING

String constant to indicate use BIND connection mode.

See Also:

Constant Field Values

PACKAGE

public static final int PACKAGE

Integer constant for the module type.

See Also:

Constant Field Values

MODULE

public static final int MODULE

Integer constant for the module type.

See Also:

Constant Field Values

PACKAGE_STRING

public static final java.lang.String PACKAGE_STRING

String constant for the module type.

See Also:

Constant Field Values

MODULE_STRING

public static final java.lang.String MODULE_STRING

String constant for the module type.

See Also:

Constant Field Values

DEFAULT_MODULENAME

public static final java.lang.String DEFAULT_MODULENAME

String constant for default module name. Used in conjunction with setModuleName() and getModuleName()

See Also:

#setModuleName(String name), #getModuleName(), Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

Default time out value for communication with the server.

See Also:

setServerTimeout(int), getServerTimeout(), Constant Field Values

DEFAULT_INFOBUS_NAME

public static java.lang.String DEFAULT_INFOBUS_NAME

_connectLock

protected transient java.lang.Object _connectLock

ERR_PROD_CODE

public static final java.lang.String ERR_PROD_CODE

Constructor Detail

SessionInfo

public SessionInfo()

Default constructor.

SessionInfo

protected SessionInfo(java.lang.String name)

Constructor requiring a session bind name.

Parameters:

name - session bind name.

SessionInfo

protected SessionInfo(java.lang.String name,
                      oracle.jbo.ApplicationModule appModule)

Constructor requiring a session bind name and an Application Module.

Parameters:

name - session bind name.

appModule - an Application Module in the session.

Method Detail

cacheSingleValue

public void cacheSingleValue(java.lang.String name,
                             java.lang.Object s)

Adds a single object and its name to the cache.

Parameters:

name - the name of the object to cache.

s - the object to cache.

setLocale

public void setLocale(java.util.Locale nuLocale)

Sets the locale for this SessionInfo and all of the child objects.

Overrides:

setLocale in class InfoObject

Parameters:

nuLocale - the new locale to be used.

See Also:

getLocale()

getLocale

public java.util.Locale getLocale()

Returns the locale for this SessionInfo.

Overrides:

getLocale in class InfoObject

Returns:

the locale for the SessionInfo object.

See Also:

setLocale(Locale nuLocale)

setDeploymentPlatform

public void setDeploymentPlatform(java.lang.String nuDeploymentPlatform)

Deprecated. Use setConnectionInfo(ConnectionInfo) instead.

Sets the deployment platform.

The deployment platform can be one of:

• VISIBROKER_PLATFORM - Visibroker
• O8I_PLATFORM - Oracle8i
• EJB_PLATFORM - EJB platform
• LOCAL_PLATFORM - local mode

Parameters:

nuDeploymentPlatform - the deployment platform.

See Also:

getDeploymentPlatform()

getDeploymentPlatform

public java.lang.String getDeploymentPlatform()

Deprecated. Use getConnectionInfo() instead.

Returns the selected deployment platform.

The deployment platform can be one of:

• VISIBROKER_PLATFORM - Visibroker
• O8I_PLATFORM - Oracle 8i
• EJB_PLATFORM - EJB platform
• LOCAL_PLATFORM - local mode

Returns:

the deployment platform.

See Also:

setDeploymentPlatform(String nuDeploymentPlatform)

getInfoBusDataProducer

public javax.infobus.InfoBusDataProducer getInfoBusDataProducer()

Gets the InfoBusDataProducer that services the DataItem requests.

Returns:

an InfoBusDataProducer.

getInfoBusName

public java.lang.String getInfoBusName()

Gets the name of the bus being used for publishing the DataItems created under this session.

Returns:

name of the bus.

setInfoBusName

public void setInfoBusName(java.lang.String busName)

Sets the name of the bus to be used for publishing the DataItems created under this session.

Parameters:

busName - name of the bus.

setApplicationModule

protected void setApplicationModule(oracle.jbo.ApplicationModule applicationModule)

Sets the Application Module property to use in this session.

Parameters:

applicationModule - the new Java Business Objects Application Module to be used.

getApplicationModule

public oracle.jbo.ApplicationModule getApplicationModule()

Returns the value of the Application Module property.

Returns:

the Java Business Objects Application Module being used.

setApplicationModuleName

public void setApplicationModuleName(java.lang.String applicationModuleName)

Deprecated. Use ProducerObject.setName(String) instead.

Sets the name of the Session.

Parameters:

applicationModuleName - the InfoBus bind name for this session.

See Also:

ProducerObject.setName(java.lang.String)

getName

public java.lang.String getName()

Description copied from class: DacObject

Returns the name of the DacObject.

Overrides:

getName in class DacObject

Returns:

the name of the DacObject.

getApplicationModuleName

public java.lang.String getApplicationModuleName()

Deprecated. Use getName() instead.

Returns the InfoBus bind name for this session.

Returns:

the name of the session.

setRemoteHost

public void setRemoteHost(java.lang.String remoteHost)

Deprecated. Use setConnectionInfo(ConnectionInfo) instead.

Sets the RemoteHost property, which identifies the remote host machine.

Used to define which host machine will be executing the business and data access logic. This only applies when the Deployment Platform is not LOCAL.

getRemoteHost

public java.lang.String getRemoteHost()

Deprecated. Use getConnectionInfo() instead

Returns the RemoteHost property, which identifies the remote host machine.

Returns:

the name of the remote host machine.

setRemoteHostPort

public void setRemoteHostPort(int port)

Deprecated. Use setConnectionInfo(ConnectionInfo) instead.

Sets the RemoteHostPort property; identifies the connection port.

Used to define the connection port when executing remotely on an Oracle8i server.

getRemoteHostPort

public int getRemoteHostPort()

Deprecated. Use getConnectionInfo() instead.

Returns the RemoteHostPort property.

Returns:

the port number of the remote Oracle8i instance.

setRemoteApplicationPath

public void setRemoteApplicationPath(java.lang.String path)

Deprecated. Use setConnectionInfo(ConnectionInfo) instead.

Sets the RemoteApplicationPath property.

Used to define the application path when executing remotely on an Oracle8i server.

getRemoteApplicationPath

public java.lang.String getRemoteApplicationPath()

Deprecated. Use getConnectionInfo() instead.

Returns the RemoteApplicationPath property.

Returns:

the path name of the remote Oracle8i application.

setApplicationModuleClass

public void setApplicationModuleClass(java.lang.String nuApplicationModuleClass)

Sets the ApplicationModuleClass property: the fully-qualified name of the class that implements the Application Module object on the server.

Parameters:

nuApplicationModuleClass - the fully-qualified name of the Application Module's class.

getApplicationModuleClass

public java.lang.String getApplicationModuleClass()

Returns the value of the ApplicationModuleClass property: this is the fully-qualified name of the class that implements the ApplicationModule object on the server.

Returns:

the fully-qualified name of the Application Module's class.

getModulePackage

public java.lang.String getModulePackage()

Returns the name of the Package that includes the Application Module.

Returns:

the name of the package for the module.

setJBOSessionClass

public void setJBOSessionClass(java.lang.String nuApplicationModuleClass)

Deprecated. Superceded by setApplicationModuleClass(java.lang.String).

Sets the JBOSessionClass property.

Parameters:

nuApplicationModuleClass - name of the Application Module class.

getJBOSessionClass

public java.lang.String getJBOSessionClass()

Deprecated. Superceded by getApplicationModuleClass().

Returns the value of the JBOSessionClass property.

Returns:

the name of the JBOSession's class.

setConnectionMode

public void setConnectionMode(int nuConnectionMode)

Sets the ConnectionMode property which determines the relationship between the client and server portions of the application. The value of the property can be either REMOTE or COLOCATE.

Parameters:

nuConnectionMode - the connection mode to be used.

See Also:

REMOTE, COLOCATE

getConnectionMode

public int getConnectionMode()

Returns the value of the ConnectionMode property which determines the relationship between the client and server portions of the application. The value of the property can be either REMOTE or COLOCATE.

Returns:

the connection mode currently in use.

See Also:

REMOTE, COLOCATE

setUserName

public void setUserName(java.lang.String nuUserName)

Deprecated. Use these methods instead:

• setConnectionInfo(ConnectionInfo con)
• getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection
• NamedConnection.setUserName(String name)

Sets the username for this session.

The username is used to establish the "identity" of the person using the application.

Parameters:

nuUserName - the name to be used.

getUserName

public java.lang.String getUserName()

Deprecated. Use these methods instead:

• getConnectionInfo()
• getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection
• NamedConnection.getUserName()

Returns the username for this session.

The username is used to establish the "identity" of the person using the application.

Returns:

the name to be used.

setPassword

public void setPassword(java.lang.String nuPassword)

Deprecated. Use these methods instead:

• setConnectionInfo(ConnectionInfo)
• getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection
• NamedConnection.setPassWord(String password)

Sets the password for this session.

The password is used to verify the "identity" of the person using the application.

Parameters:

nuPassword - the password to be used.

getPassword

public java.lang.String getPassword()

Deprecated. Use these methods instead:

• getConnectionInfo()
• getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection
• NamedConnection.getPassWord()

Returns the password for this session.

The password is used to verify the "identity" of the person using the application.

setDatabaseURL

public void setDatabaseURL(java.lang.String nuDatabaseURL)

Deprecated. Use any of the following instead:

• setConnectionInfo(ConnectionInfo)
• getLoginConnection from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection
• setHostName(), setConnectionPort(), and setSID() from NamedConnection

Sets the URL connection string property, which identifies the database to use.

getDatabaseURL

public java.lang.String getDatabaseURL()

Returns the value of the URL connection string property, which identifies the database being used.

Returns:

the database name/connection string to be used, for example, "@localhost:1521:ORCL".

setLockingMode

public void setLockingMode(java.lang.String lockingMode)

Sets the value of the LockingMode property, which identifies which lockmode is to be used. The locking mode can be one of:

• LOCK_NONE
• LOCK_PESSIMISTIC
• LOCK_OPTIMISTIC

Parameters:

lockingMode - the lockmode type.

See Also:

LOCK_NONE, LOCK_PESSIMISTIC, LOCK_OPTIMISTIC

getLockingMode

public java.lang.String getLockingMode()

Returns the value of the LockingMode property, which identifies which lockmode is currently being used. The method can return one of:

• LOCK_NONE
• LOCK_PESSIMISTIC
• LOCK_OPTIMISTIC

Returns:

lockingMode the lockmode in use.

See Also:

LOCK_NONE, LOCK_PESSIMISTIC, LOCK_OPTIMISTIC

setDriverType

public void setDriverType(int nuDriverType)

Deprecated. Use these methods instead:

• setConnectionInfo(ConnectionInfo)
• getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection

Sets the JDBC driver to be used by the server when communicating with the database server. Setting this property sets the DriverClass to a predetermined value. The value can be one of:

• OCI7
• OCI8
• THIN

Parameters:

nuDriverType - the driver type. Can be one of OCI7, OCI8, or THIN.

See Also:

OCI7, OCI8, THIN, getDriverType(), setDatabaseURL(java.lang.String), setDriverClass(java.lang.String)

getDriverType

public int getDriverType()

Deprecated. Use these methods instead:

• getConnectionInfo()
• getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection
• NamedConnection.getConnectionURL()

Returns the JDBC driver type currently being used to communicate with the server. The method can return one of:

• OCI7
• OCI8
• THIN

See Also:

OCI7, OCI8, THIN, setDriverType(int)

setDriverClass

public void setDriverClass(java.lang.String DriverClass)

Deprecated. This method is ignored.

Sets the JDBC driver class used by Java Business Objects when communicating with the database server. Setting this property sets the DriverType to an unknown value. TBD: currently unimplemented.

Parameters:

DriverClass - the driver class, for example, "oracle.jdbc.driver.OracleDriver".

See Also:

getDriverClass()

getDriverClass

public java.lang.String getDriverClass()

Deprecated. This method is ignored.

Returns the JDBC driver class currently used by Java Business Objects to communicate with the database server.

Returns:

the driver class name.

See Also:

setDriverClass(java.lang.String)

setConnectionURL

public void setConnectionURL(java.lang.String URL)

Deprecated. Use these methods instead:

• setConnectionInfo(ConnectionInfo conn)
• getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection
• NamedConnection.setConnectionURL(String url)

Sets the JDBC URL of the database connection. The username and password are handled as separate connection properties. All other properties can be specified here.

Parameters:

URL - a connection URL, for example, "jdbc:oracle:thin@machine:1521:ORCL".

See Also:

getConnectionURL(), setUserName(java.lang.String), setPassword(java.lang.String)

getConnectionURL

public java.lang.String getConnectionURL()

Deprecated. Use these methods instead:

• getConnectionInfo()
• getLoginConnection() from any of these classes: Connection, VBConnection, Oracle8iConnection, LocalConnection
• NamedConnection.getConnectionURL()

Returns the JDBC connection URL being used to connect to the database server. The username and password must be inquired separately.

Returns:

the driver type currently used to communicate with the server.

See Also:

setConnectionURL(java.lang.String), getUserName(), getPassword()

setServerTimeout

public void setServerTimeout(int nuTimeOut)

Sets the timeout threshold value for communications with the middle-tier server. The default value is 30000 milliseconds. This value can be changed only before publishSession() is called.

Parameters:

nuTimeOut - the new time out value in milliseconds.

See Also:

publishSession()

getServerTimeout

public int getServerTimeout()

Returns the timeout threshold value for communications with the middle-tier server.

Returns:

the current timeout setting.

publishSession

public void publishSession()

Publishes the session and its child items on the InfoBus.

See Also:

setInfoBusName(java.lang.String busName), publishSession(boolean activate)

publishSession

public void publishSession(boolean activate)

revokeSession

public void revokeSession()

Revokes the session and its child items on the InfoBus.

This method causes all published DataItems to be invalid. All consumers must relinquish any held references to DataItems.

See Also:

setInfoBusName(java.lang.String busName), publishSession(boolean activate)

revokeSession

public void revokeSession(boolean force)

Ignores all objections when revoking the session and its child items on the InfoBus.

This method causes all published DataItems to be invalid. All consumers must relinquish any held references to DataItems.

Parameters:

force - if true, ignore all objections regarding pending changes.

See Also:

setInfoBusName(java.lang.String busName), publishSession(boolean activate)

validate

public void validate()
              throws ValidationException

Description copied from class: InfoObject

Internal: Applications should not use this method.

Overrides:

validate in class InfoObject

Throws:

ValidationException

internalValidation

protected void internalValidation(int eventLevel)
                           throws ValidationException

Internal: Applications should not use this method.

Overrides:

internalValidation in class InfoObject

Throws:

ValidationException

addRowSet

public void addRowSet(ResultSetInfo resultSetInfo)

Adds a ResultSetInfo to the SessionInfo.

See Also:

ResultSetInfo.setSession(SessionInfo sessInfo)

removeRowSet

public void removeRowSet(ResultSetInfo resultSetInfo)

Removes a ResultSetInfo from a SessionInfo.

Parameters:

resultSetInfo - the ResultSetInfo to be removed from the SessionInfo.

getRowSet

public ResultSetInfo getRowSet(java.lang.String name)

Returns the named rowset Identifies a ResultSetInfo based upon the name (bindname) of the ResultSetInfo.

Parameters:

name - A string identifying a rowset.

getRowSetCount

public int getRowSetCount()

Return the number ResultSetInfo objects within the SessionInfo.

Returns:

the number ResultSetInfo objects within the SessionInfo.

setConnection

public void setConnection(SessInfoDescriptor sDesc)

Deprecated. Use setConnectionInfo(ConnectionInfo con) instead.

Specifies connection information (username, password, connection URL) through a SessInfoDescriptor object. This is an alternate way to specify connection information.

Parameters:

sDesc - the connection information.

See Also:

#setConnectionInfo(Connection), SessInfoDescriptor

getConnection

public SessInfoDescriptor getConnection()

Deprecated. Use getConnectionInfo() instead.

Gets the connection information (username, password, connection URL) through a SessInfoDescriptor object. This is an alternate way to get connection information.

Returns:

the connection information.

See Also:

SessInfoDescriptor

setConnectionInfo

public void setConnectionInfo(ConnectionInfo conn)

Sets a connection defining all elements of the connection deployment choice.

Parameters:

conn - the connection definition.

See Also:

Connection

getConnectionInfo

public ConnectionInfo getConnectionInfo()

Returns the connection definition defining all elements of the connection deployment choice.

For Local platform, returns the connection name and applet instance.

For Visibroker platform, returns:

• for COLOCATE mode: connection name and applet instance.
• for USE_IOR mode: application module path, IIOP connection name, and applet instance.
• for USE_BIND mode: connection name, remote host, and applet instance.

For Oracle8i and EJB platforms, returns the application module path, IIOP connection name, and applet instance.

Returns:

the connection definition.

See Also:

Connection

setConnectionName

public void setConnectionName(java.lang.String connectionName)

Deprecated. Use setConnectionInfo(ConnectionInfo) instead.

Specifies connection information (username, password, connection URL) through a named connection. This is an alternate way to specify connection information.

Parameters:

connectionName - name of the connection.

getConnectionName

public java.lang.String getConnectionName()

Deprecated. Use getConnectionInfo() instead.

If using a connection defined by name, returns the name.

Returns:

the Connection name.

setIIOPConnectionName

public void setIIOPConnectionName(java.lang.String connectionName)

Deprecated. Use setConnectionInfo(ConnectionInfo) instead.

Specifies IIOP connection information (the IIOP connection name) through a named connection.

Parameters:

connectionName - the name of the IIOP connection.

getIIOPConnectionName

public java.lang.String getIIOPConnectionName()

Deprecated. Use getConnectionInfo() instead.

If using a IIOP connection defined by name, returns the name.

Returns:

name the IIOP Connection name.

setModuleInfo

public void setModuleInfo(ModuleDescriptor mDesc)

Deprecated. Use setAppModuleInfo(AppModuleInfo jboLoc) instead.

Specifies the ApplicationModuleClass and Project information by using a ModuleDescriptor object.

Parameters:

mDesc - the module information.

setBoLocationInfo

public void setBoLocationInfo(AppModuleInfo jboLoc)

Deprecated. Use setAppModuleInfo(AppModuleInfo jboLoc) instead.

Specifies the Java Business Object location and Project by using an AppModuleInfo MetaData class.

Parameters:

jboLoc - the JboLocation information.

setAppModuleInfo

public void setAppModuleInfo(AppModuleInfo jboLoc)

Specifies the Java Bussiness Object location and Project by using an AppModuleInfo MetaData class.

Parameters:

jboLoc - the JboLocation information.

getAppModuleInfo

public AppModuleInfo getAppModuleInfo()

Returns the JboLocation information (Application Module and Package name).

Returns:

the JboLocation information. Returns null if the Package name or the Application Module name is null.

setAppletInstance

public void setAppletInstance(java.applet.Applet appletInstance)

Sets the Applet context. This property allows the ORB to be intialized as an Applet. If null, the ORB will be intitalized as an Application.

Parameters:

appletInstance - the Applet instance.

getAppletInstance

public java.applet.Applet getAppletInstance()

Gets the Applet context.

Returns:

the Applet instance.

connect

protected void connect()

Internal: Applications should not use this method.

Used by DbAccess to connect to a data source. DbAccess is a javax.infobus interface and represents the SessionInfo object on the control side. DbAccess is closely bound to the data producer SessionInfo, which provides this method for DbAccess to use. To use this method, aquire a DbAccess interface, then do a connect through that interface.

openProducerObject

protected void openProducerObject()

Internal: Applications should not use this method.

Sets up the SessionInfo for use by creating the server-side session. This method throws an IllegalStateException exception if required properties are not set.

Specified by:

openProducerObject in class ProducerObject

Throws:

java.lang.IllegalStateException - thrown if open() is called when required properties are missing.

openChildren

protected void openChildren()

Internal: Applications should not use this method.

Opens all of the child Rowsets. This method executes the underlying query and places the current row on the first row.

Specified by:

openChildren in class ProducerObject

openDataItems

protected void openDataItems()

Internal: Applications should not use this method.

Connects the DbAccess to the server-side session.

Specified by:

openDataItems in class ProducerObject

closeCheck

protected void closeCheck()

Internal: Applications should not use this method.

Checks to see if the session can be closed. The session can be closed only when changes are saved and there are no changes pending.

Specified by:

closeCheck in class ProducerObject

Throws:

DataSourceOperationException - thrown when changes are pending and unsaved.

closeProducerObject

protected void closeProducerObject()

Internal: Applications should not use this method.

A subclass-specific method for disconnecting the client object from the appropriate server objects.

Specified by:

closeProducerObject in class ProducerObject

closeChildren

protected void closeChildren()

Internal: Applications should not use this method.

A subclass-specific method for disconnecting the child objects from their server objects counterparts.

Specified by:

closeChildren in class ProducerObject

closeDataItems

protected void closeDataItems()

Internal: Applications should not use this method.

A subclass-specific method for disconnecting and revoking DataItems.

Specified by:

closeDataItems in class ProducerObject

getDbAccess

public javax.infobus.DbAccess getDbAccess()

Returns a javax.infobus.DbAccess interface.

This interface allows the application to control the various aspects of the trasaction such as commit and rollback.

Returns:

a DbAccess interface.

getEnvironment

public java.util.Hashtable getEnvironment()

Returns the environment hashtable used when creating the Application Module.

Returns:

the environment hashtable.

handleException

public void handleException(java.lang.Exception ex,
                            boolean lastEntryInPiggyback)

Catches an exception thrown by the middle tier.

Specified by:

handleException in interface oracle.jbo.JboExceptionHandler

Parameters:

ex - an exception.

lastEntryInPiggyback - true if ex is the last of a batch of exceptions and warnings generated by a transaction.

handleWarning

public void handleWarning(oracle.jbo.JboWarning warn)

Catches a warning thrown by the middle tier.

Specified by:

handleWarning in interface oracle.jbo.JboExceptionHandler

Parameters:

warn - a warning message.

finishedProcessingPiggyback

public void finishedProcessingPiggyback(java.lang.Exception[] exArray)

Specified by:

finishedProcessingPiggyback in interface oracle.jbo.JboExceptionHandler

Parameters:

exArray -

setCustomConnect

public void setCustomConnect(CustomConnect customConnect)

Deprecated. Use ConnectionInfo.setCustomConnection(CustomConnection) instead

Specifies a custom connect object. The SessionInfo object creates the Java Business Objects Application Module and by default, performs a connect to the database.

When a "custom connect" object is specified, the SessionInfo creates the Application Module and expects the "custom connect" object to connect to the database. The "custom connect" object can do any specific processing, such as changing/deriving a new user/password.

Parameters:

customConnect - the custom connect object.

getCustomConnect

public CustomConnect getCustomConnect()

Deprecated. Use ConnectionInfo.setCustomConnection(CustomConnection) instead

Gets the "custom connect" object.

Returns:

a "custom connect" object.

findDataItem

protected javax.infobus.DataItem findDataItem(java.lang.String name)

Finds the DataItem indicated by name.

The name is generally of the form: /Session/Iterator/Column and will contain that portion that has yet to be resolved.

Overrides:

findDataItem in class ProducerObject

Parameters:

name - the name of the DataItem.

Returns:

the requested dataitem if it exists, it has been opened and it has been published.

getDataItem

protected javax.infobus.DataItem getDataItem()

Returns the DbAccess DataItem that is asscociated with this SessionInfo.

Overrides:

getDataItem in class ProducerObject

Returns:

a DbAccess DataItem.

See Also:

getDbAccess()

setDirty

protected void setDirty(boolean dirty)

Determines whether this DataItem is dirty and needs to be validated.

Overrides:

setDirty in class InfoObject

Parameters:

dirty - true if the DataItem is dirty and needs to be validated; false otherwise.

See Also:

InfoObject.isDirty()

clearDirty

public void clearDirty()

Clears the dirty state of the DataItem. This method is intended for advanced application developers only who need to plug-in a custom rollback algorithm.

Overrides:

clearDirty in class InfoObject

See Also:

InfoObject.isDirty()