|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.cayenne.configuration.CayenneRuntime
public abstract class CayenneRuntime
A superclass of various Cayenne runtime stacks. A Runtime is the main access
point to Cayenne for a user application. It provides a default Cayenne
configuration as well as a way to customize this configuration via a built-in
dependency injection (DI) container. In fact implementation-wise, Runtime
object is just a convenience thin wrapper around a DI Injector
.
Field Summary | |
---|---|
protected Injector |
injector
|
protected Module[] |
modules
|
protected static ThreadLocal<Injector> |
threadInjector
A holder of an Injector bound to the current thread. |
Constructor Summary | |
---|---|
CayenneRuntime(Collection<Module> modules)
Creates a CayenneRuntime with configuration based on the supplied collection of DI modules. |
|
CayenneRuntime(Module... modules)
Creates a CayenneRuntime with configuration based on the supplied array of DI modules. |
Method Summary | |
---|---|
static void |
bindThreadInjector(Injector injector)
Binds a DI Injector bound to the current thread. |
DataChannel |
getChannel()
Returns the runtime DataChannel . |
ObjectContext |
getContext()
Deprecated. since 3.1 use better named newContext() instead. |
ObjectContext |
getContext(DataChannel parentChannel)
Deprecated. since 3.1 use better named newContext(DataChannel)
instead. |
Injector |
getInjector()
Returns DI injector used by this runtime. |
Module[] |
getModules()
Returns an array of modules used to initialize this runtime. |
static Injector |
getThreadInjector()
Returns the Injector bound to the current thread. |
protected static Module[] |
mergeModules(Module mainModule,
Collection<Module> extraModules)
Internal helper method to add special extra modules in subclass constructors. |
protected static Module[] |
mergeModules(Module mainModule,
Module... extraModules)
Internal helper method to add special extra modules in subclass constructors. |
ObjectContext |
newContext()
Returns a new ObjectContext instance based on the runtime's main DataChannel. |
ObjectContext |
newContext(DataChannel parentChannel)
Returns a new ObjectContext which is a child of the specified DataChannel. |
void |
shutdown()
Shuts down the DI injector of this runtime, giving all services that need to release some resources a chance to do that. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final ThreadLocal<Injector> threadInjector
protected Injector injector
protected Module[] modules
Constructor Detail |
---|
public CayenneRuntime(Module... modules)
public CayenneRuntime(Collection<Module> modules)
Method Detail |
---|
public static void bindThreadInjector(Injector injector)
Injector
bound to the current thread. It is primarily
intended for deserialization of ObjectContexts.
CayenneFilter
will automatically bind the right injector to each
request thread. If you are not using CayenneFilter, your application is
responsible for calling this method at appropriate points of the
lifecycle.
public static Injector getThreadInjector()
Injector
bound to the current thread. Will return
null if none is bound.
protected static Module[] mergeModules(Module mainModule, Module... extraModules)
protected static Module[] mergeModules(Module mainModule, Collection<Module> extraModules)
public Module[] getModules()
public Injector getInjector()
@BeforeScopeEnd public void shutdown()
public DataChannel getChannel()
DataChannel
.
public ObjectContext newContext()
public ObjectContext newContext(DataChannel parentChannel)
@Deprecated public ObjectContext getContext()
newContext()
instead.
@Deprecated public ObjectContext getContext(DataChannel parentChannel)
newContext(DataChannel)
instead.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |