to.etc.webapp.query

Class QContextManager

java.lang.Object

to.etc.webapp.query.QContextManager

public final class QContextManager
extends Object

Fugly singleton helper class to globally access database stuff.

Author:

Frits Jalvingh Created on Jul 15, 2009

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT

Method Summary

Modifier and Type	Method and Description
static void	closeSharedContext(String key, QContextContainer cc) If the specified container contains a shared context close it.
static void	closeSharedContexts(IQContextContainer cc)
static QDataContext	createUnmanagedContext() Return the DEFAULT unmanaged (manually closed) context factory.
static QDataContext	createUnmanagedContext(String key) Return the unmanaged (manually closed) context factory.
static QDataContext	getContext(String key, IQContextContainer cc)
static QDataContext	getContext(String key, QContextContainer cc) Gets a shared QDataContext from the container.
static QDataContextFactory	getDataContextFactory() Return the DEFAULT QDataContextFactory.
static QDataContextFactory	getDataContextFactory(String key) Return the named QDataContextFactory.
static QDataContextFactory	getDataContextFactory(String key, IQContextContainer container)
static QDataContextFactory	getDataContextFactory(String key, QContextContainer cc) Get/create a shared context factory.
static IQContextFactorySquared	instance(String key) Returns the instance of the manager used to satisfy all calls.
static void	setImplementation(String key, IQContextFactorySquared cm) Override the default implementation of QContextManager with your own.
static void	setImplementation(String key, QDataContextFactory factory)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final String DEFAULT

See Also:

Constant Field Values

Method Detail

setImplementation

public static void setImplementation(@Nonnull
                                     String key,
                                     @Nonnull
                                     IQContextFactorySquared cm)

Override the default implementation of QContextManager with your own. This must be called before QContextManager is ever used.

Parameters:

cm -

setImplementation

public static void setImplementation(@Nonnull
                                     String key,
                                     @Nonnull
                                     QDataContextFactory factory)

instance

@Nonnull
public static IQContextFactorySquared instance(@Nonnull
                                                        String key)

Returns the instance of the manager used to satisfy all calls. If no instance is set this will create the default handler instance.

Returns:

getDataContextFactory

@Nonnull
public static QDataContextFactory getDataContextFactory(@Nonnull
                                                                 String key)

Return the named QDataContextFactory. This is the root of *all* default connections allocated through DomUI. This either returns the single factory, or it asks the delegate to get a factory, allowing the delegate to return a user-specific factory.

Returns:

getDataContextFactory

@Nonnull
public static QDataContextFactory getDataContextFactory()

Return the DEFAULT QDataContextFactory. This is the root of *all* default connections allocated through DomUI. This either returns the single factory, or it asks the delegate to get a factory, allowing the delegate to return a user-specific factory.

Returns:

createUnmanagedContext

@Nonnull
public static QDataContext createUnmanagedContext(@Nonnull
                                                           String key)
                                                    throws Exception

Return the unmanaged (manually closed) context factory.

Returns:

Throws:

Exception

createUnmanagedContext

@Nonnull
public static QDataContext createUnmanagedContext()
                                                    throws Exception

Return the DEFAULT unmanaged (manually closed) context factory.

Parameters:

key -

Returns:

Throws:

Exception

getDataContextFactory

@Nonnull
public static QDataContextFactory getDataContextFactory(@Nonnull
                                                                 String key,
                                                                 @Nonnull
                                                                 QContextContainer cc)

Get/create a shared context factory. The context factory gets attached to the container it is shared in, and will always try to re-use any QDataContext already present in the container. In addition, all data contexts allocated thru this mechanism have a disabled close() method, preventing them from closing the shared connection.

Parameters:

cc -

Returns:

getContext

@Nonnull
public static QDataContext getContext(@Nonnull
                                               String key,
                                               @Nonnull
                                               QContextContainer cc)
                                        throws Exception

Gets a shared QDataContext from the container. If it is not already present it will be allocated, stored in the container for later reuse and returned. The context is special in that it cannot be closed() using it's close() call - it is silently ignored.

Throws:

Exception

getContext

@Nonnull
public static QDataContext getContext(@Nonnull
                                               String key,
                                               @Nonnull
                                               IQContextContainer cc)
                                        throws Exception

Throws:

Exception

closeSharedContext

public static void closeSharedContext(@Nonnull
                                      String key,
                                      @Nonnull
                                      QContextContainer cc)

If the specified container contains a shared context close it.

Parameters:

cc -

closeSharedContexts

public static void closeSharedContexts(@Nonnull
                                       IQContextContainer cc)

getDataContextFactory

@Nonnull
public static QDataContextFactory getDataContextFactory(@Nonnull
                                                                 String key,
                                                                 @Nonnull
                                                                 IQContextContainer container)