no.g9.jgrape

Class SessionManager

java.lang.Object

no.g9.jgrape.SessionManager

Direct Known Subclasses:

JGrapeLocal, TxSessionManager

public abstract class SessionManager
extends Object

Common Session management methods used by the JGrapeService implementors.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_CONTROL Client context parameter for log control

Constructor Summary

Constructors

Constructor and Description
SessionManager()

Method Summary

Modifier and Type	Method and Description
protected boolean	doLog()
static String	getDatabaseContextName(ClientContext ctx, String appName) Returns the proper database context name according to the given client context.
static String	getDatabaseMappingName(ObjectSelection objectSelection) Returns the proper database mapping name according to the given objectSelection
static String	getLogfileDateFormat()
static Session	getSession(ClientContext ctx, String dbMapping) Convenience method, returns a session for the given client context and database mapping.
static Session	getSession(ObjectSelection objectSelection, ClientContext ctx) Convenience method, returns a session for the given object selection and client context.
static SessionFactory	getSessionFactory()
protected void	logControl(boolean on) Turn service logging on or off.
protected void	logParams(JGrapeParamWrapper logObject) Log the JGrapeService parameters.
static void	setLogfileDateFormat(String logfileDateFormat) Set the format currently used for timestamping log files.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_CONTROL

public static final String LOG_CONTROL

Client context parameter for log control

See Also:

Constant Field Values

Constructor Detail

SessionManager

public SessionManager()

Method Detail

getSessionFactory

public static SessionFactory getSessionFactory()

Returns:

the session factory (singleton).

getSession

public static Session getSession(ObjectSelection objectSelection,
                                 ClientContext ctx)

Convenience method, returns a session for the given object selection and client context. The session will be shared within the current thread.

Parameters:

objectSelection - - the object selection.

ctx - - the client context.

Returns:

session.

getSession

public static Session getSession(ClientContext ctx,
                                 String dbMapping)

Convenience method, returns a session for the given client context and database mapping. The session will be shared within the current thread. NB! This method will not use the default client context from g9.config.properties, as the application name is unknown.

Parameters:

ctx - - the client context.

dbMapping - - the database mapping.

Returns:

session.

getDatabaseContextName

public static String getDatabaseContextName(ClientContext ctx,
                                            String appName)

Returns the proper database context name according to the given client context. Will try to load the default database context from g9.config.properties if none is given in the client context.

Parameters:

ctx - - the client context

appName - - the name of the service application

Returns:

the database context name, null if no database context is found.

getDatabaseMappingName

public static String getDatabaseMappingName(ObjectSelection objectSelection)

Returns the proper database mapping name according to the given objectSelection

Parameters:

objectSelection - - the object selection in question.

Returns:

the database mapping name.

logParams

protected void logParams(JGrapeParamWrapper logObject)

Log the JGrapeService parameters. The log file to use is derived from the user id in the supplied client context. Which log file to use is calculated from the hashCode of the user id. If there is no client context, or the user id is not set, the first log file is used.

Parameters:

logObject - - the JGrapeService parameters to be logged.

logControl

protected void logControl(boolean on)

Turn service logging on or off. When turned on, the log files are opened. When turned off, the log files are closed.

Parameters:

on - - true=on, false=off

doLog

protected boolean doLog()

Returns:

true if service logging is on, false if off.

getLogfileDateFormat

public static String getLogfileDateFormat()

Returns:

the format currently used for timestamping log files.

setLogfileDateFormat

public static void setLogfileDateFormat(String logfileDateFormat)

Set the format currently used for timestamping log files.

Parameters:

logfileDateFormat - - the new format to use.