oracle.jbo.server
Class SessionImpl

java.lang.Object
  oracle.jbo.server.SessionImpl

All Implemented Interfaces:

Session

public class SessionImpl
extends java.lang.Object
implements Session

Field Summary

static java.lang.Class

CLASS_INSTANCE

Fields inherited from interface oracle.jbo.Session

JBO_SESSION_COOKIE, JBO_SESSION_LOCALE

Constructor Summary

SessionImpl()

Method Summary

ApplicationModule	findSharedApplicationModule(java.lang.String appModuleName) INTERNAL: Applications should not use.
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 packageName) Gets the names of the Application Module definitions contained in a package.
java.lang.String[]	getEntityAssociationDefNames(java.lang.String packageName) Gets the names of the entity association definitions defined in a package.
java.lang.String[]	getEntityDefNames(java.lang.String packageName) Gets the names of the Entity Object definitions available in a package.
java.util.Hashtable	getEnvironment() Returns the BC4J context for the session.
Locale	getLocale() Gets the current Locale used for localizing error messages.
LocaleContext	getLocaleContext() * retrieves the locale context for the session
java.lang.String[]	getPackageNames() Gets names of the packages that make up this middle tier application.
TransactionHandlerFactory	getTransactionHandlerFactory() Get the session's transaction handler factory.
java.util.Hashtable	getUserData() Returns application context for the session.
java.lang.String	getUserPrincipalName()
java.lang.String[]	getUserRoles() Returns the Roles/Groups for current user principal.
java.lang.String	getVersion() Gets the middle tier's version information.
java.lang.String[]	getViewDefNames(java.lang.String packageName) Gets the names of the View Object definitions available in a package.
java.lang.String[]	getViewLinkDefNames(java.lang.String packageName) Gets the names of the View Link definitions defined in a package.
void	invalidateSession() INTERNAL: Applications should not use.
boolean	isClient() Returns whether this session is running as a client in 3 tier or not.
boolean	isUserInRole(java.lang.String role)
void	loadPackage(java.lang.String packageName) Loads a package that may be browsed for defined objects.
void	setLocale(Locale locale) Sets a new Locale for localizing error messages.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_INSTANCE

public static final java.lang.Class CLASS_INSTANCE

Constructor Detail

SessionImpl

public SessionImpl()

Method Detail

findSharedApplicationModule

public ApplicationModule findSharedApplicationModule(java.lang.String appModuleName)

Description copied from interface: Session

INTERNAL: Applications should not use.

Specified by:

findSharedApplicationModule in interface Session

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

Returns:

an array of ApplicationModule definition 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

Returns:

String[] an array of EntityAssociationDef 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

Returns:

String[] an array of EntityDef 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

Returns:

String[] an array of ViewDef 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

Returns:

String[] an array of ViewLinkDef names.

getApplicationModuleDefNames

public java.lang.String[] getApplicationModuleDefNames(java.lang.String packageName)

Description copied from interface: Session

Gets the names of the Application Module definitions contained in a package.

Specified by:

getApplicationModuleDefNames in interface Session

Parameters:

packageName - the name of the package.

Returns:

an array of ApplicationModule definition names.

getEntityAssociationDefNames

public java.lang.String[] getEntityAssociationDefNames(java.lang.String packageName)

Description copied from interface: Session

Gets the names of the entity association definitions defined in a package.

Specified by:

getEntityAssociationDefNames in interface Session

Parameters:

packageName - the name of the package.

Returns:

String[] an array of EntityAssociationDef names.

getEntityDefNames

public java.lang.String[] getEntityDefNames(java.lang.String packageName)

Description copied from interface: Session

Gets the names of the Entity Object definitions available in a package.

Specified by:

getEntityDefNames in interface Session

Parameters:

packageName - the name of the package.

Returns:

String[] an array of EntityDef names.

getEnvironment

public java.util.Hashtable getEnvironment()

Description copied from interface: Session

Returns the BC4J context for the session. Examples of BC4J context include the values for the BC4J properties defined in PropertyMetadata. Applications should store custom session context in the Session userdata.

Specified by:

getEnvironment in interface Session

Returns:

a hashtable of BC4J session properties

See Also:

Session.getUserData()

getLocale

public Locale getLocale()

Description copied from interface: Session

Gets the current Locale used for localizing error messages.

Specified by:

getLocale in interface Session

Returns:

the current Locale.

getLocaleContext

public LocaleContext getLocaleContext()

Description copied from interface: Session

* retrieves the locale context for the session

Specified by:

getLocaleContext in interface Session

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

Returns:

The package names.

getUserData

public java.util.Hashtable getUserData()

Description copied from interface: Session

Returns application context for the session. Applications may store any custom session data in this Hashtable. This hashtable will be reset by oracle.jbo.server.ApplicationModuleImpl#prepareSession(Session).

Specified by:

getUserData in interface Session

getUserRoles

public java.lang.String[] getUserRoles()

Description copied from interface: Session

Returns the Roles/Groups for current user principal.

Specified by:

getUserRoles in interface Session

Returns:

list of role names.

getVersion

public java.lang.String getVersion()

Description copied from interface: Session

Gets the middle tier's version information.

Specified by:

getVersion in interface Session

Returns:

The version information in the form major.minor.patch.bldNum.

getViewDefNames

public java.lang.String[] getViewDefNames(java.lang.String packageName)

Description copied from interface: Session

Gets the names of the View Object definitions available in a package.

Specified by:

getViewDefNames in interface Session

Parameters:

packageName - the name of the package.

Returns:

String[] an array of ViewDef names.

getViewLinkDefNames

public java.lang.String[] getViewLinkDefNames(java.lang.String packageName)

Description copied from interface: Session

Gets the names of the View Link definitions defined in a package.

Specified by:

getViewLinkDefNames in interface Session

Parameters:

packageName - the name of the package.

Returns:

String[] an array of ViewLinkDef names.

invalidateSession

public void invalidateSession()

Description copied from interface: Session

INTERNAL: Applications should not use.

Specified by:

invalidateSession in interface Session

isClient

public boolean isClient()

Description copied from interface: Session

Returns whether this session is running as a client in 3 tier or not.

Specified by:

isClient in interface Session

Returns:

true if the session is in 3 tier. false if in 2 tier.

isUserInRole

public boolean isUserInRole(java.lang.String role)

Specified by:

isUserInRole in interface Session

Parameters:

role - the name of the role.

Returns:

true if the user is in role; false otherwise.

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

Parameters:

packageName - a fully qualified package name.

setLocale

public void setLocale(Locale locale)

Description copied from interface: Session

Sets a new Locale for localizing error messages.

Specified by:

setLocale in interface Session

Parameters:

locale - the new Locale.

getTransactionHandlerFactory

public TransactionHandlerFactory getTransactionHandlerFactory()

Get the session's transaction handler factory. This method may be overriden by a custom Session implementation to return a custom implementation of the TransactionHandlerFactory interface.

See Also:

TransactionHandler, TransactionHandlerFactory

getUserPrincipalName

public java.lang.String getUserPrincipalName()