Business Components

oracle.jbo.server
Class SessionImpl

java.lang.Object
  |
  +--oracle.jbo.server.SessionImpl

public class SessionImpl
extends java.lang.Object
implements Session

The default server-side implementation of the Session interface.

Applications requiring a custom implementation can extend this class. The framework loads the session implementation class defined by the SESSION_CLASS property in the file indicated by SERVER_PROPERTIES.

Since:
JDeveloper 3.0

Field Summary
static java.lang.String JBO_RT_PROPERTIES
          The pathname of the server properties file used to load various runtime properties.
static java.lang.String SESSION_CLASS
          The name of the subclass of this class to be used by the framework for managing the session.
 
Constructor Summary
protected SessionImpl()
          This constructor is called by the framework to initialize the client session
 
Method Summary
 java.lang.String[] getAllApplicationModuleDefNames()
          Gets the names of the Application Module definitions contained in all packages.
 java.lang.String[] getAllEntityAssociationDefNames()
          Gets the names of the entity association definitions defined in all packages.
 java.lang.String[] getAllEntityDefNames()
          Gets the names of the Entity Object definitions available in all packages.
 java.lang.String[] getAllViewDefNames()
          Gets the names of the View Object definitions available in all packages.
 java.lang.String[] getAllViewLinkDefNames()
          Gets the names of the View Link definitions defined in all packages.
 java.lang.String[] getApplicationModuleDefNames(java.lang.String packName)
          Gets the names of the Application Module definitions contained in a package.
 java.lang.String[] getEntityAssociationDefNames(java.lang.String packName)
          Gets the names of the entity association definitions defined in a package.
 java.lang.String[] getEntityDefNames(java.lang.String packName)
          Gets the names of the Entity Object definitions available in a package.
 java.util.Hashtable getEnvironment()
          Gets the table of packages.
 java.util.Locale getLocale()
          Gets the current Locale used for localizing error messages.
 java.lang.String[] getPackageNames()
          Gets names of the packages that make up this middle tier application.
 TransactionHandlerFactory getTransactionHandlerFactory()
           
 java.lang.String getVersion()
          Gets the middle tier's version information.
 java.lang.String[] getViewDefNames(java.lang.String packName)
          Gets the names of the View Object definitions available in a package.
 java.lang.String[] getViewLinkDefNames(java.lang.String packName)
          Gets the names of the View Link definitions defined in a package.
static SessionImpl init(java.util.Hashtable ctxEnv)
          Internal: Applications should not use this method.
 void loadPackage(java.lang.String packageName)
          Loads a package that may be browsed for defined objects.
 void setLocale(java.util.Locale l)
          Sets a new Locale for localizing error messages.
 void setProperty(java.lang.String name, java.lang.String value)
           
 void setTransactionHandlerFactory(TransactionHandlerFactory fac)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

JBO_RT_PROPERTIES

public static final java.lang.String JBO_RT_PROPERTIES
The pathname of the server properties file used to load various runtime properties.

SESSION_CLASS

public static final java.lang.String SESSION_CLASS
The name of the subclass of this class to be used by the framework for managing the session.
See Also:
Session
Constructor Detail

SessionImpl

protected SessionImpl()
This constructor is called by the framework to initialize the client session
Method Detail

init

public static SessionImpl init(java.util.Hashtable ctxEnv)
Internal: Applications should not use this method.


getEnvironment

public java.util.Hashtable getEnvironment()
Description copied from interface: Session
Gets the table of packages.
Specified by:
getEnvironment in interface Session
Tags copied from interface: Session
Returns:
a hash table of fully qualified package names.

getLocale

public java.util.Locale getLocale()
Description copied from interface: Session
Gets the current Locale used for localizing error messages.
Specified by:
getLocale in interface Session
Tags copied from interface: Session
Returns:
the current Locale.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

setLocale

public void setLocale(java.util.Locale l)
Description copied from interface: Session
Sets a new Locale for localizing error messages.
Specified by:
setLocale in interface Session
Tags copied from interface: Session
Parameters:
locale - the new Locale.

loadPackage

public void loadPackage(java.lang.String packageName)
Description copied from interface: Session
Loads a package that may be browsed for defined objects.
Specified by:
loadPackage in interface Session
Tags copied from interface: Session
Parameters:
packageName - a fully qualified package name.

getVersion

public java.lang.String getVersion()
Description copied from interface: Session
Gets the middle tier's version information.
Specified by:
getVersion in interface Session
Tags copied from interface: Session
Returns:
The version information in the form major.minor.patch.bldNum.

getApplicationModuleDefNames

public java.lang.String[] getApplicationModuleDefNames(java.lang.String packName)
Description copied from interface: Session
Gets the names of the Application Module definitions contained in a package.
Specified by:
getApplicationModuleDefNames in interface Session
Tags copied from interface: Session
Parameters:
packageName - the name of the package.
Returns:
an array of ApplicationModule definition names.

getAllApplicationModuleDefNames

public java.lang.String[] getAllApplicationModuleDefNames()
Description copied from interface: Session
Gets the names of the Application Module definitions contained in all packages.
Specified by:
getAllApplicationModuleDefNames in interface Session
Tags copied from interface: Session
Returns:
an array of ApplicationModule definition names.

getViewDefNames

public java.lang.String[] getViewDefNames(java.lang.String packName)
Description copied from interface: Session
Gets the names of the View Object definitions available in a package.
Specified by:
getViewDefNames in interface Session
Tags copied from interface: Session
Parameters:
packageName - the name of the package.
Returns:
String[] an array of ViewDef names.

getAllViewDefNames

public java.lang.String[] getAllViewDefNames()
Description copied from interface: Session
Gets the names of the View Object definitions available in all packages.
Specified by:
getAllViewDefNames in interface Session
Tags copied from interface: Session
Returns:
String[] an array of ViewDef names.

getEntityDefNames

public java.lang.String[] getEntityDefNames(java.lang.String packName)
Description copied from interface: Session
Gets the names of the Entity Object definitions available in a package.
Specified by:
getEntityDefNames in interface Session
Tags copied from interface: Session
Parameters:
packageName - the name of the package.
Returns:
String[] an array of EntityDef names.

getAllEntityDefNames

public java.lang.String[] getAllEntityDefNames()
Description copied from interface: Session
Gets the names of the Entity Object definitions available in all packages.
Specified by:
getAllEntityDefNames in interface Session
Tags copied from interface: Session
Returns:
String[] an array of EntityDef names.

getEntityAssociationDefNames

public java.lang.String[] getEntityAssociationDefNames(java.lang.String packName)
Description copied from interface: Session
Gets the names of the entity association definitions defined in a package.
Specified by:
getEntityAssociationDefNames in interface Session
Tags copied from interface: Session
Parameters:
packageName - the name of the package.
Returns:
String[] an array of EntityAssociationDef names.

getAllEntityAssociationDefNames

public java.lang.String[] getAllEntityAssociationDefNames()
Description copied from interface: Session
Gets the names of the entity association definitions defined in all packages.
Specified by:
getAllEntityAssociationDefNames in interface Session
Tags copied from interface: Session
Returns:
String[] an array of EntityAssociationDef names.

getViewLinkDefNames

public java.lang.String[] getViewLinkDefNames(java.lang.String packName)
Description copied from interface: Session
Gets the names of the View Link definitions defined in a package.
Specified by:
getViewLinkDefNames in interface Session
Tags copied from interface: Session
Parameters:
packageName - the name of the package.
Returns:
String[] an array of ViewLinkDef names.

getAllViewLinkDefNames

public java.lang.String[] getAllViewLinkDefNames()
Description copied from interface: Session
Gets the names of the View Link definitions defined in all packages.
Specified by:
getAllViewLinkDefNames in interface Session
Tags copied from interface: Session
Returns:
String[] an array of ViewLinkDef names.

getPackageNames

public java.lang.String[] getPackageNames()
Description copied from interface: Session
Gets names of the packages that make up this middle tier application.
Specified by:
getPackageNames in interface Session
Tags copied from interface: Session
Returns:
The package names.

getTransactionHandlerFactory

public TransactionHandlerFactory getTransactionHandlerFactory()

setTransactionHandlerFactory

public void setTransactionHandlerFactory(TransactionHandlerFactory fac)

Business Components