org.apache.cayenne.configuration.server

Class ServerRuntime

java.lang.Object

org.apache.cayenne.configuration.CayenneRuntime

org.apache.cayenne.configuration.server.ServerRuntime

public class ServerRuntime
extends CayenneRuntime

An object representing Cayenne server-stack that connects directly to the database via JDBC. This is an entry point for user applications to access Cayenne, which encapsulates the dependency injection internals. The term "server" is used as opposed to ROP "client" (see CayenneRuntime). Any application, desktop, server, etc. that has a direct JDBC connection should be using this runtime.

Since:

3.1

Field Summary

Fields inherited from class org.apache.cayenne.configuration.CayenneRuntime

injector, module, threadInjector

Constructor Summary

Constructors

Constructor and Description
ServerRuntime(String[] configurationLocations, Module... extraModules) Creates a server runtime configuring it with a standard set of services contained in ServerModule.
ServerRuntime(String configurationLocation, Module... extraModules) Creates a server runtime configuring it with a standard set of services contained in ServerModule.

Method Summary

Methods

Modifier and Type	Method and Description
DataDomain	getDataDomain() Returns the main runtime DataDomain.
DataSource	getDataSource() Returns a default DataSource for this runtime.
DataSource	getDataSource(String dataNodeName) Provides access to the JDBC DataSource assigned to a given DataNode.
<T> T	performInTransaction(TransactionalOperation<T> op) Runs provided operation wrapped in a single transaction.

Methods inherited from class org.apache.cayenne.configuration.CayenneRuntime

bindThreadInjector, getChannel, getContext, getContext, getInjector, getModule, getModules, getThreadInjector, newContext, newContext, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerRuntime

public ServerRuntime(String configurationLocation,
             Module... extraModules)

Creates a server runtime configuring it with a standard set of services contained in ServerModule. CayenneServerModule is created with provided 'configurationLocation'. An optional array of extra modules may contain service overrides and/or user services.

ServerRuntime

public ServerRuntime(String[] configurationLocations,
             Module... extraModules)

Creates a server runtime configuring it with a standard set of services contained in ServerModule. CayenneServerModule is created with one or more 'configurationLocations'. An optional array of extra modules may contain service overrides and/or user services.

Method Detail

performInTransaction

public <T> T performInTransaction(TransactionalOperation<T> op)

Runs provided operation wrapped in a single transaction. Transaction handling delegated to the internal TransactionManager. Nested calls to 'performInTransaction' are safe and attached to the same in-progress transaction. TransactionalOperation can be some arbitrary user code, which most often than not will consist of multiple Cayenne operations.

Since:

4.0

getDataDomain

public DataDomain getDataDomain()

Returns the main runtime DataDomain. Note that by default the returned DataDomain is the same as the main DataChannel returned by CayenneRuntime.getChannel(). Although users may redefine DataChannel provider in the DI registry, for instance to decorate this DataDomain with a custom wrapper.

getDataSource

public DataSource getDataSource()

Returns a default DataSource for this runtime. If no default DataSource exists, an exception is thrown.

Since:

4.0

getDataSource

public DataSource getDataSource(String dataNodeName)

Provides access to the JDBC DataSource assigned to a given DataNode. A null argument will work if there's only one DataNode configured.

Normally Cayenne applications don't need to access DataSource or any other JDBC code directly, however in some unusual conditions it may be needed, and this method provides a shortcut to raw JDBC.