oracle.eclipselink.coherence

Class IntegrationProperties

java.lang.Object

oracle.eclipselink.coherence.IntegrationProperties

public abstract class IntegrationProperties
extends java.lang.Object

This abstract class contains the property names used by the EclipseLink-JPA/Coherence integration. These properties are used to configure the JPA persistence-unit and descriptors for the entities that will use Coherence.

Since:

Oracle TopLink 11g (11.1.1.0.0)

Author:

gyorke

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADDITIONAL_POF_CLASSES This persistence unit or system level property can be used to specify a list of classes that must be added to the automatic POF configuration but may not be found by TopLink Grid when scanning the JPA metadata and entity classes.
static java.lang.String	ALLOW_CLASS_TYPE_IN_MULTIPLE_GRAPHS In general multiple instances of the same entity can not be in multiple graphs when cached as an entity aggregate.
static java.lang.String	ALLOW_FETCHGROUPS_FOR_GRID_READ This property can be used when fetch groups are used to partially load data from the database but the descriptor has been configured for GridRead.
static java.lang.String	CACHE_NAME Deprecated. use "eclipselink.coherence.cache.name"
static java.lang.String	COHERENCE_CACHE_NAME This is the property name that will be used in each descriptor to store the name of the Coherence Cache.
static java.lang.String	COHERENCE_CONFIG_URI This is the property name that is used to specify the URI of the Coherence cache config that should be used.
static java.lang.String	FILTER_FACTORY_CLASS_NAME This is the property name that is used to specify a specific FilterFactory implementation to be used to translate EclipseLink queries to Coherence Filters.
static java.lang.String	INDEXED This is the property name that will be used to notify TopLink-Grid that a Coherence Index is to be created for this attribute.
static java.lang.String	IS_NOT_ECLIPSELINK This is a SYSTEM level property used to notify the TopLink-Grid serializer that the current VM is operating without EclipseLink.
static java.lang.String	POF_ID_OVERRIDES The AutoPOF framework will attempt to assign POF user type ids based on the class name.
static java.lang.String	TRANSLATION_FAILURE_POLICY This is the property name that is used to specify a specific QueryTranslationFailurePolicy implementation to be used to resolve failures to translate a Query.
static java.lang.String	USE_TOPLINK_ID_CLASSES This is the property name that is used to specify that native TopLink Primary Key information should be used in the cache instead of the JPA PK classes.

Constructor Summary

Constructors

Constructor and Description
IntegrationProperties()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_NAME

public static final java.lang.String CACHE_NAME

Deprecated. use "eclipselink.coherence.cache.name"

This is the property name that will be used in each descriptor to store the name of the Coherence Cache. If this name is not provided the integration will default to using the descriptor's alias which is the default entity name in JPA.

This property name can be used in API or using the @Property annotation.

See Also:

ClassDescriptor.setProperty(String, Object), Property, Constant Field Values

IS_NOT_ECLIPSELINK

public static final java.lang.String IS_NOT_ECLIPSELINK

This is a SYSTEM level property used to notify the TopLink-Grid serializer that the current VM is operating without EclipseLink. This would be used in an application that was directly accessing coherence for EclipseLink managed entities with relationships but did not have the JPA Persistence Unit deployed in this VM

See Also:

Constant Field Values

COHERENCE_CACHE_NAME

public static final java.lang.String COHERENCE_CACHE_NAME

This is the property name that will be used in each descriptor to store the name of the Coherence Cache. If this name is not provided the integration will default to using the descriptor's alias which is the default entity name in JPA.

This property name can be used in API or using the @Property annotation.

See Also:

ClassDescriptor.setProperty(String, Object), Property, Constant Field Values

INDEXED

public static final java.lang.String INDEXED

This is the property name that will be used to notify TopLink-Grid that a Coherence Index is to be created for this attribute. The property should be set directly on the mapping for the attribute that is to be indexed. public class Broker implements Serializable, PortableObject{ ...

See Also:

org.eclipse.persistence.mappings.DatabaseMapping#setProperty(String, Object), Property, Constant Field Values

FILTER_FACTORY_CLASS_NAME

public static final java.lang.String FILTER_FACTORY_CLASS_NAME

This is the property name that is used to specify a specific FilterFactory implementation to be used to translate EclipseLink queries to Coherence Filters. The fully qualified class name of the implementation should be used as the value.

See Also:

Constant Field Values

TRANSLATION_FAILURE_POLICY

public static final java.lang.String TRANSLATION_FAILURE_POLICY

This is the property name that is used to specify a specific QueryTranslationFailurePolicy implementation to be used to resolve failures to translate a Query. The fully qualified class name of the implementation should be used as the value.

See Also:

Constant Field Values

USE_TOPLINK_ID_CLASSES

public static final java.lang.String USE_TOPLINK_ID_CLASSES

This is the property name that is used to specify that native TopLink Primary Key information should be used in the cache instead of the JPA PK classes. This is a global setting and should be applied through the persistence.xml file. Accepted values are "TRUE" or "FALSE".

See Also:

Constant Field Values

COHERENCE_CONFIG_URI

public static final java.lang.String COHERENCE_CONFIG_URI

This is the property name that is used to specify the URI of the Coherence cache config that should be used. This may be relative to the coherence.jar.

See Also:

Constant Field Values

ALLOW_CLASS_TYPE_IN_MULTIPLE_GRAPHS

public static final java.lang.String ALLOW_CLASS_TYPE_IN_MULTIPLE_GRAPHS

In general multiple instances of the same entity can not be in multiple graphs when cached as an entity aggregate. Setting this flag will bypass the validation and allow an entity class to be present in multiple graphs. It is still not recommended that a single instance be in multiple graphs.

See Also:

Constant Field Values

ALLOW_FETCHGROUPS_FOR_GRID_READ

public static final java.lang.String ALLOW_FETCHGROUPS_FOR_GRID_READ

This property can be used when fetch groups are used to partially load data from the database but the descriptor has been configured for GridRead. In this scenario by default TopLink-Grid will force the entire entity to be loaded before placing in the Coherence cache to ensure Coherence filters will be able to find data in the cache. If this entity or application will always ensure any queried on data will be loaded in the entity then setting this property in the persistence.xml file or on an entity will not cause the entity to be loaded before being placed in the cache.

See Also:

Constant Field Values

ADDITIONAL_POF_CLASSES

public static final java.lang.String ADDITIONAL_POF_CLASSES

This persistence unit or system level property can be used to specify a list of classes that must be added to the automatic POF configuration but may not be found by TopLink Grid when scanning the JPA metadata and entity classes. Simply add the fully qualified list of classes delimited with a comma (","). Example:"org.model.CustomDateTime,org.model.PurchaseImpl"

See Also:

Constant Field Values

POF_ID_OVERRIDES

public static final java.lang.String POF_ID_OVERRIDES

The AutoPOF framework will attempt to assign POF user type ids based on the class name. In cases where there is a conflict and multiple class names generate the same id this property can be used to specify a Java properties file from the classpath that provides specific override id values for specific classes. The fully qualified class names should be entered as the keys and the POF user type as the value. This property can be provided as a persistence.xml property or a system property. In the case both are provided the persistence.xml property will be ignored.

See Also:

Properties, Constant Field Values

Constructor Detail

IntegrationProperties

public IntegrationProperties()