Class CoreModule

java.lang.Object

org.apache.cayenne.CoreModule

All Implemented Interfaces:

org.apache.cayenne.di.Module

public class CoreModule
extends Object
implements org.apache.cayenne.di.Module

A DI module containing all Cayenne runtime configuration.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADAPTER_DETECTORS_LIST	A DI container key for the List<DbAdapterDetector> that contains objects that can discover the type of current database and install the correct DbAdapter in runtime.
static final String	DEFAULT_TYPES_LIST	A DI container key for the List<ExtendedType> storing default adapter-agnostic ExtendedTypes.
static final String	DOMAIN_LISTENERS_LIST	A DI container key for the List<Object> storing lifecycle events listeners.
static final String	PROJECT_LOCATIONS_LIST	A DI container key for the List<String> storing locations of the one of more project configuration files.
static final String	PROPERTIES_MAP	A DI container key for the Map<String, String> storing properties used by built-in Cayenne service.
static final String	TYPE_FACTORIES_LIST	A DI container key for the List<ExtendedTypeFactory> storing default and user-provided ExtendedTypeFactories.
static final String	USER_TYPES_LIST	A DI container key for the List<ExtendedType> storing a user-provided ExtendedTypes.

Constructor Summary

Constructors

Constructor	Description
CoreModule()	Creates a new CoreModule.

Method Summary

Modifier and Type	Method	Description
void	configure(org.apache.cayenne.di.Binder binder)
static org.apache.cayenne.di.ListBuilder<DbAdapterDetector>	contributeAdapterDetectors(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static org.apache.cayenne.di.ListBuilder<ExtendedType>	contributeDefaultTypes(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static org.apache.cayenne.di.ListBuilder<Object>	contributeDomainListeners(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static org.apache.cayenne.di.ListBuilder<DataChannelQueryFilter>	contributeDomainQueryFilters(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static org.apache.cayenne.di.ListBuilder<DataChannelSyncFilter>	contributeDomainSyncFilters(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static org.apache.cayenne.di.ListBuilder<String>	contributeProjectLocations(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static org.apache.cayenne.di.MapBuilder<String>	contributeProperties(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static org.apache.cayenne.di.ListBuilder<ExtendedTypeFactory>	contributeTypeFactories(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static org.apache.cayenne.di.ListBuilder<ExtendedType>	contributeUserTypes(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static org.apache.cayenne.di.ListBuilder<ValueObjectType>	contributeValueObjectTypes(org.apache.cayenne.di.Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static CoreModuleExtender	extend(org.apache.cayenne.di.Binder b)	Returns an extender object that allows the app to customize the CoreModule services.
static void	setSnapshotCacheSize(org.apache.cayenne.di.Binder binder, int size)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API
static void	useExternalTransactions(org.apache.cayenne.di.Binder binder, boolean useExternal)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of extend(Binder) API

Methods inherited from class Object

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

Field Details

PROPERTIES_MAP

public static final String PROPERTIES_MAP

A DI container key for the Map<String, String> storing properties used by built-in Cayenne service.

See Also:

• CoreModuleExtender.setProperty(String, Object)
• Constant Field Values

ADAPTER_DETECTORS_LIST

public static final String ADAPTER_DETECTORS_LIST

A DI container key for the List<DbAdapterDetector> that contains objects that can discover the type of current database and install the correct DbAdapter in runtime.

See Also:

• Constant Field Values

DOMAIN_LISTENERS_LIST

public static final String DOMAIN_LISTENERS_LIST

A DI container key for the List<Object> storing lifecycle events listeners.

See Also:

• CoreModuleExtender.addListener(Object)
• Constant Field Values

PROJECT_LOCATIONS_LIST

public static final String PROJECT_LOCATIONS_LIST

A DI container key for the List<String> storing locations of the one of more project configuration files.

See Also:

• Constant Field Values

DEFAULT_TYPES_LIST

public static final String DEFAULT_TYPES_LIST

A DI container key for the List<ExtendedType> storing default adapter-agnostic ExtendedTypes.

See Also:

• CoreModuleExtender.addDefaultExtendedType(ExtendedType)
• Constant Field Values

USER_TYPES_LIST

public static final String USER_TYPES_LIST

A DI container key for the List<ExtendedType> storing a user-provided ExtendedTypes.

See Also:

• CoreModuleExtender.addUserExtendedType(ExtendedType)
• Constant Field Values

TYPE_FACTORIES_LIST

public static final String TYPE_FACTORIES_LIST

A DI container key for the List<ExtendedTypeFactory> storing default and user-provided ExtendedTypeFactories.

See Also:

• CoreModuleExtender.addExtendedTypeFactory(Class)
• Constant Field Values

Constructor Details

CoreModule

public CoreModule()

Creates a new CoreModule.

Since:

4.0

Method Details

extend

public static CoreModuleExtender extend(org.apache.cayenne.di.Binder b)

Returns an extender object that allows the app to customize the CoreModule services.

Since:

5.0

useExternalTransactions

@Deprecated(since="5.0",
            forRemoval=true)
public static void useExternalTransactions(org.apache.cayenne.di.Binder binder,
 boolean useExternal)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Sets transaction management to either external or internal transactions. Default is internally-managed transactions.

Parameters:

binder - DI binder passed to the module during injector startup.

useExternal - whether external (true) or internal (false) transaction management should be used.

Since:

4.0

setSnapshotCacheSize

@Deprecated(since="5.0",
            forRemoval=true)
public static void setSnapshotCacheSize(org.apache.cayenne.di.Binder binder,
 int size)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Sets max size of snapshot cache, in pre 4.0 version this was set in the Modeler.

Parameters:

binder - DI binder passed to the module during injector startup.

size - max size of snapshot cache

Since:

4.0

contributeProjectLocations

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.ListBuilder<String> contributeProjectLocations(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Provides access to a DI collection builder for String locations that allows downstream modules to "contribute" their own Cayenne project locations.

Parameters:

binder - DI binder passed to the module during injector startup.

Returns:

ListBuilder for String locations.

contributeDomainQueryFilters

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.ListBuilder<DataChannelQueryFilter> contributeDomainQueryFilters(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Provides access to a DI collection builder for DataChannelQueryFilter's that allows downstream modules to "contribute" their own DataDomain query filters

Parameters:

binder - DI binder passed to the module during injector startup.

Returns:

ListBuilder for DataChannelQueryFilter.

Since:

4.1

contributeDomainSyncFilters

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.ListBuilder<DataChannelSyncFilter> contributeDomainSyncFilters(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Provides access to a DI collection builder for DataChannelSyncFilter's that allows downstream modules to "contribute" their own DataDomain sync filters

Parameters:

binder - DI binder passed to the module during injector startup.

Returns:

ListBuilder for DataChannelSyncFilter.

Since:

4.1

contributeDomainListeners

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.ListBuilder<Object> contributeDomainListeners(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Provides access to a DI collection builder for lifecycle events listeners.

Parameters:

binder - DI binder passed to the module during injector startup.

Returns:

ListBuilder for listener Objects.

Since:

4.0

contributeAdapterDetectors

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.ListBuilder<DbAdapterDetector> contributeAdapterDetectors(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Provides access to a DI collection builder for DbAdapterDetector's that allows downstream modules to "contribute" their own adapter detectors.

Parameters:

binder - DI binder passed to the module during injector startup.

Returns:

ListBuilder for DbAdapterDetectors.

Since:

4.0

contributeProperties

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.MapBuilder<String> contributeProperties(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Provides access to a DI map builder for runtime properties that allows downstream modules to "contribute" their own properties.

Parameters:

binder - DI binder passed to the module during injector startup.

Returns:

MapBuilder for properties.

Since:

4.0

contributeTypeFactories

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.ListBuilder<ExtendedTypeFactory> contributeTypeFactories(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Provides access to a DI collection builder for ExtendedTypeFactory's that allows downstream modules to "contribute" their own factories.

Parameters:

binder - DI binder passed to the module during injector startup.

Returns:

ListBuilder for ExtendedTypes.

Since:

4.0

contributeDefaultTypes

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.ListBuilder<ExtendedType> contributeDefaultTypes(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Provides access to a DI collection builder for default adapter-agnostic ExtendedType's that allows downstream modules to "contribute" their own types. "Default" types are loaded before adapter-provided or "user" types, so they may be overridden by those.

Parameters:

binder - DI binder passed to the module during injector startup.

Returns:

ListBuilder for ExtendedTypes.

Since:

4.0

contributeUserTypes

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.ListBuilder<ExtendedType> contributeUserTypes(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Provides access to a DI collection builder for ExtendedType's that allows downstream modules to "contribute" their own types. Unlike "default" types, "user" types are loaded after the adapter-provided types and can override those.

Parameters:

binder - DI binder passed to the module during injector startup.

Returns:

ListBuilder for ExtendedTypes.

Since:

4.0

contributeValueObjectTypes

@Deprecated(since="5.0",
            forRemoval=true)
public static org.apache.cayenne.di.ListBuilder<ValueObjectType> contributeValueObjectTypes(org.apache.cayenne.di.Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of extend(Binder) API

Parameters:

binder - DI binder passed to module during injector startup

Returns:

ListBuilder for user-contributed ValueObjectTypes

Since:

4.0

configure

public void configure(org.apache.cayenne.di.Binder binder)

Specified by:

configure in interface org.apache.cayenne.di.Module