Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.datanucleus.ExecutionContextImpl Maven / Gradle / Ivy
DataNucleus Core provides the primary components of a heterogenous Java persistence solution.
It supports persistence API's being layered on top of the core functionality.
/**********************************************************************
Copyright (c) 2006 Andy Jefferson and others. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Contributors:
2007 Xuan Baldauf - added the use of srm.findObject() to cater for different object lifecycle management policies (in RDBMS and DB4O databases)
2007 Xuan Baldauf - changes to allow the disabling of clearing of fields when transitioning from PERSISTENT_NEW to TRANSIENT.
2008 Marco Schulze - added reference counting functionality for get/acquireThreadContextInfo()
...
**********************************************************************/
package org.datanucleus;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.BitSet;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.datanucleus.api.ApiAdapter;
import org.datanucleus.cache.CacheUniqueKey;
import org.datanucleus.cache.CachedPC;
import org.datanucleus.cache.L2CachePopulateFieldManager;
import org.datanucleus.cache.Level1Cache;
import org.datanucleus.cache.Level2Cache;
import org.datanucleus.cache.SoftRefCache;
import org.datanucleus.cache.StrongRefCache;
import org.datanucleus.cache.WeakRefCache;
import org.datanucleus.enhancement.Persistable;
import org.datanucleus.enhancer.ImplementationCreator;
import org.datanucleus.exceptions.ClassNotDetachableException;
import org.datanucleus.exceptions.ClassNotPersistableException;
import org.datanucleus.exceptions.ClassNotResolvedException;
import org.datanucleus.exceptions.CommitStateTransitionException;
import org.datanucleus.exceptions.NoPersistenceInformationException;
import org.datanucleus.exceptions.NucleusException;
import org.datanucleus.exceptions.NucleusFatalUserException;
import org.datanucleus.exceptions.NucleusObjectNotFoundException;
import org.datanucleus.exceptions.NucleusOptimisticException;
import org.datanucleus.exceptions.NucleusUserException;
import org.datanucleus.exceptions.ObjectDetachedException;
import org.datanucleus.exceptions.RollbackStateTransitionException;
import org.datanucleus.exceptions.TransactionActiveOnCloseException;
import org.datanucleus.exceptions.TransactionNotActiveException;
import org.datanucleus.flush.FlushMode;
import org.datanucleus.flush.FlushProcess;
import org.datanucleus.flush.Operation;
import org.datanucleus.flush.OperationQueue;
import org.datanucleus.identity.DatastoreUniqueLongId;
import org.datanucleus.identity.IdentityKeyTranslator;
import org.datanucleus.identity.IdentityReference;
import org.datanucleus.identity.IdentityStringTranslator;
import org.datanucleus.identity.IdentityUtils;
import org.datanucleus.identity.DatastoreId;
import org.datanucleus.identity.SCOID;
import org.datanucleus.management.ManagerStatistics;
import org.datanucleus.metadata.AbstractClassMetaData;
import org.datanucleus.metadata.AbstractMemberMetaData;
import org.datanucleus.metadata.IdentityType;
import org.datanucleus.metadata.TransactionType;
import org.datanucleus.metadata.UniqueMetaData;
import org.datanucleus.metadata.VersionMetaData;
import org.datanucleus.properties.BasePropertyStore;
import org.datanucleus.state.CallbackHandler;
import org.datanucleus.state.LockManager;
import org.datanucleus.state.LockManagerImpl;
import org.datanucleus.state.LockMode;
import org.datanucleus.state.DNStateManager;
import org.datanucleus.state.RelationshipManager;
import org.datanucleus.store.FieldValues;
import org.datanucleus.store.StorePersistenceHandler.PersistenceBatchType;
import org.datanucleus.store.query.Extent;
import org.datanucleus.store.types.converters.TypeConversionHelper;
import org.datanucleus.store.types.scostore.Store;
import org.datanucleus.transaction.Transaction;
import org.datanucleus.transaction.TransactionEventListener;
import org.datanucleus.transaction.TransactionImpl;
import org.datanucleus.transaction.jta.JTAJCATransactionImpl;
import org.datanucleus.transaction.jta.JTATransactionImpl;
import org.datanucleus.util.ClassUtils;
import org.datanucleus.util.ConcurrentReferenceHashMap;
import org.datanucleus.util.ConcurrentReferenceHashMap.ReferenceType;
import org.datanucleus.util.Localiser;
import org.datanucleus.util.NucleusLogger;
import org.datanucleus.util.StringUtils;
/**
* Manager for persistence/retrieval of objects within an execution context, equating to the work required by JDO PersistenceManager and JPA EntityManager.
* Caching
*
* An ExecutionContext has its own Level 1 cache. This stores objects against their identity.
* The Level 1 cache is typically a weak referenced map and so cached objects can be garbage collected.
* Objects are placed in the Level 1 cache during the transaction.
* The NucleusContext also has a Level 2 cache. This is used to allow cross-communication between ExecutionContexts.
* Objects are placed in the Level 2 cache during commit() of a transaction. If an object is deleted during a transaction then it will be removed
* from the Level 2 cache at commit(). If an object is no longer enlisted in the transaction at commit then it will be removed from the Level 2 cache
* (so we remove the chance of handing out old data).
*
* Transactions
*
* An ExecutionContext has a single transaction (the "current" transaction). The transaction can be "active" (if begin() has been called on it) or "inactive".
*
* Persisted Objects
*
* When an object involved in the current transaction it is enlisted (calling enlistInTransaction()).
* Its identity is saved (in "txEnlistedIds") for use later in any "persistenceByReachability" process run at commit.
* Any object that is passed via makePersistent() will be stored (as an identity) in "txKnownPersistedIds" and objects
* persisted due to reachability from these objects will also have their identity stored (in "txFlushedNewIds").
* All of this information is used in the "persistence-by-reachability-at-commit" process which detects if some objects
* originally persisted are no longer reachable and hence should not be persistent after all.
*
* StateManager-based storage
*
* You may note that we have various fields here storing StateManager-related information such as which StateManager is embedded into which StateManager etc,
* or the managed relations for a StateManager. These are stored here to avoid adding a reference to the storage of each and every StateManager, since
* we could potentially have a very large number of StateManagers (and they may not use that field in the majority, but it still needs the reference).
* The same should be followed as a general rule when considering storing something in StateManager.
*
*
* This class is NOT thread-safe. Use ExecutionContextThreadedImpl if you want to *attempt* to have multithreaded PM/EMs.
*
*/
public class ExecutionContextImpl implements ExecutionContext, TransactionEventListener
{
/** Context for the persistence process. */
PersistenceNucleusContext nucCtx;
/** The owning PersistenceManager/EntityManager object. */
private Object owner;
private boolean closing = false;
/** State variable for whether the context is closed. */
private boolean closed;
/** Current FetchPlan for the context. */
private FetchPlan fetchPlan;
/** The ClassLoader resolver to use for class loading issues. */
private ClassLoaderResolver clr = null;
/** Callback handler for this context. */
private CallbackHandler callbackHandler;
/** Level 1 Cache, essentially a Map of StateManager keyed by the id. */
protected Level1Cache cache;
/** Properties controlling runtime behaviour (detach on commit, multithreaded, etc). */
private final BasePropertyStore properties = new BasePropertyStore();
/** Current transaction */
private Transaction tx;
/** The current flush mode, if it is defined. */
private FlushMode flushMode = null;
/** Cache of StateManagers enlisted in the current transaction, keyed by the object id. */
private final Map enlistedSMCache = new ConcurrentReferenceHashMap<>(1, ReferenceType.STRONG, ReferenceType.WEAK);
/** List of StateManagers for all current dirty objects managed by this context. */
private final Collection dirtySMs = new LinkedHashSet<>();
/** List of StateManagers for all current dirty objects made dirty by reachability. */
private final Collection indirectDirtySMs = new LinkedHashSet<>();
private OperationQueue operationQueue = null;
private Set nontxProcessedSMs = null;
private boolean l2CacheEnabled = false;
/** Map of fields of object to update in L2 cache (when attached), keyed by the id. */
private Map l2CacheTxFieldsToUpdateById = null;
/** Set of ids to be Level2 cached at commit (if using L2 cache). */
private Set l2CacheTxIds = null;
/** Objects that were updated in L2 cache before commit, which should be evicted if rollback happens */
private List l2CacheObjectsToEvictUponRollback = null;
/** State variable for whether the context is currently flushing its operations. */
private int flushing = 0;
/** Manager for dynamic fetch groups. */
private FetchGroupManager fetchGrpMgr;
/** Lock manager for object-based locking. */
private LockManager lockMgr = null;
/** Lookup map of attached-detached objects when attaching/detaching. */
private Map smAttachDetachObjectReferenceMap = null;
/** Map of embedded StateManager relations, keyed by owner StateManager. */
private Map> smEmbeddedInfoByOwner = null;
/** Map of embedded StateManager relations, keyed by embedded StateManager. */
private Map smEmbeddedInfoByEmbedded = null;
/**
* Map of associated values per StateManager. This can contain anything really and is down to the StoreManager to define.
* For example RDBMS datastores typically put external FK info in here keyed by the mapping of the field to which it pertains.
*/
protected Map> stateManagerAssociatedValuesMap = null;
/** Handler for "managed relations" at flush/commit. */
private ManagedRelationsHandler managedRelationsHandler = null;
/** Handler for "persistence-by-reachability" at commit. */
private ReachabilityAtCommitHandler pbrAtCommitHandler = null;
/** State variable for whether we are currently running detachAllOnCommit/detachAllOnRollback. */
private boolean runningDetachAllOnTxnEnd = false;
/**
* Temporary array of StateManagers to detach at commit (to prevent garbage collection).
* Set up in preCommit() and used in postCommit().
*/
private DNStateManager[] detachAllOnTxnEndSMs = null;
/** Statistics gatherer for this context. */
private ManagerStatistics statistics = null;
/** Set of listeners who need to know when this ExecutionContext is closing, so they can clean up. */
private Set ecListeners = null;
/**
* Thread-specific state information (instances of {@link ThreadContextInfo}) used where we don't want
* to pass information down through a large number of method calls.
*/
private ThreadLocal contextInfoThreadLocal;
/**
* Constructor.
* TODO userName/password aren't currently used and we always use the PMF/EMF userName/password.
* @param ctx NucleusContext
* @param owner Owning object (for bytecode enhancement contract, PersistenceManager)
* @param options Any options affecting startup
* @throws NucleusUserException if an error occurs allocating the necessary requested components
*/
public ExecutionContextImpl(PersistenceNucleusContext ctx, Object owner, Map options)
{
this.nucCtx = ctx;
initialise(owner, options);
// Set up the Level 1 Cache, allowing reuse by subsequent uses of the ExecutionContext
initialiseLevel1Cache();
}
public void initialise(Object owner, Map options)
{
// TODO Make use of the username+password (for JDO). How? need new StoreManager maybe?
/*String userName = (String)options.get(ExecutionContext.OPTION_USERNAME);
String password = (String)options.get(ExecutionContext.OPTION_PASSWORD);*/
this.owner = owner;
this.closed = false;
// Set up class loading
ClassLoader contextLoader = Thread.currentThread().getContextClassLoader();
clr = nucCtx.getClassLoaderResolver(contextLoader);
try
{
ImplementationCreator ic = nucCtx.getImplementationCreator();
if (ic != null)
{
clr.setRuntimeClassLoader(ic.getClassLoader());
}
}
catch (Exception ex)
{
// do nothing
}
Configuration conf = nucCtx.getConfiguration();
// copy default configuration from factory for overrideable properties
for (Map.Entry entry : conf.getManagerOverrideableProperties().entrySet())
{
properties.setProperty(entry.getKey(), entry.getValue());
}
properties.getFrequentProperties().setDefaults(conf.getFrequentProperties());
// Set up FetchPlan
fetchPlan = new FetchPlan(this, clr).setMaxFetchDepth(properties.getIntProperty(PropertyNames.PROPERTY_MAX_FETCH_DEPTH));
// Set up the transaction based on the environment
if (TransactionType.JTA.toString().equalsIgnoreCase(conf.getStringProperty(PropertyNames.PROPERTY_TRANSACTION_TYPE)))
{
if (getNucleusContext().isJcaMode())
{
// JTA transaction under JCA
tx = new JTAJCATransactionImpl(this, properties);
}
else
{
// JTA transaction
boolean autoJoin = true;
if (options != null && options.containsKey(OPTION_JTA_AUTOJOIN))
{
autoJoin = Boolean.valueOf((String)options.get(OPTION_JTA_AUTOJOIN));
}
tx = new JTATransactionImpl(this, autoJoin, properties);
}
}
else
{
// Local transaction
tx = new TransactionImpl(this, properties);
}
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010000", this, nucCtx.getStoreManager(), tx));
}
if (nucCtx.statisticsEnabled())
{
statistics = new ManagerStatistics(nucCtx.getJMXManager(), nucCtx.getStatistics());
}
contextInfoThreadLocal = new ThreadLocal()
{
protected Object initialValue()
{
return new ThreadContextInfo();
}
};
if (properties.getFrequentProperties().getManageRelationships())
{
managedRelationsHandler = new ManagedRelationsHandler(properties.getBooleanProperty(PropertyNames.PROPERTY_MANAGE_RELATIONSHIPS_CHECKS));
}
if (properties.getFrequentProperties().getReachabilityAtCommit())
{
pbrAtCommitHandler = new ReachabilityAtCommitHandler(this);
}
lockMgr = new LockManagerImpl(this);
l2CacheObjectsToEvictUponRollback = null;
setLevel2Cache(true);
}
/**
* Method to close the context.
*/
public void close()
{
if (closed)
{
throw new NucleusUserException(Localiser.msg("010002"));
}
if (tx.getIsActive())
{
String closeActionTxAction = nucCtx.getConfiguration().getStringProperty(PropertyNames.PROPERTY_EXECUTION_CONTEXT_CLOSE_ACTIVE_TX_ACTION);
if (closeActionTxAction != null)
{
closeActionTxAction = closeActionTxAction.toLowerCase();
if (closeActionTxAction.equals("exception"))
{
throw new TransactionActiveOnCloseException(this);
}
else if (closeActionTxAction.equals("rollback"))
{
NucleusLogger.GENERAL.warn("ExecutionContext closed with active transaction, so rolling back the active transaction");
tx.rollback();
}
}
}
// Commit any outstanding non-tx updates
if (!dirtySMs.isEmpty() && tx.getNontransactionalWrite())
{
if (isNonTxAtomic())
{
// TODO Remove this when all mutator operations handle it atomically
// Process as nontransactional update
processNontransactionalUpdate();
}
else
{
// Process within a transaction
try
{
tx.begin();
tx.commit();
}
finally
{
if (tx.isActive())
{
tx.rollback();
}
}
}
}
if (properties.getFrequentProperties().getDetachOnClose() && cache != null && !cache.isEmpty())
{
// "Detach-on-Close", detaching all currently cached objects
// TODO This will remove objects from the L1 cache one-by-one. Is there a possibility for optimisation? See also AttachDetachTest.testDetachOnClose
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010011"));
Collection toDetach = new LinkedHashSet<>(cache.values());
try
{
if (!tx.getNontransactionalRead())
{
tx.begin();
}
for (DNStateManager sm : toDetach)
{
if (sm != null && sm.getObject() != null && !sm.getExecutionContext().getApiAdapter().isDeleted(sm.getObject()) && sm.getExternalObjectId() != null)
{
// If the object is deleted then no point detaching. An object can be in L1 cache if transient and passed in to a query as a param for example
try
{
sm.detach(new DetachState(getApiAdapter()));
}
catch (NucleusObjectNotFoundException onfe)
{
// Catch exceptions for any objects that are deleted in other managers whilst having this open
}
}
}
if (!tx.getNontransactionalRead())
{
tx.commit();
}
}
finally
{
if (!tx.getNontransactionalRead())
{
if (tx.isActive())
{
tx.rollback();
}
}
}
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010012"));
}
// Call all listeners to do their clean up TODO Why is this here and not after "disconnect remaining resources" or before "detachOnClose"?
ExecutionContext.LifecycleListener[] listener = nucCtx.getExecutionContextListeners();
for (int i=0; i cachedSMsClone = new HashSet<>(cache.values());
for (DNStateManager sm : cachedSMsClone)
{
if (sm != null)
{
// Remove it from any transaction
sm.disconnect();
}
}
cache.clear();
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("003011"));
}
}
else
{
// TODO If there is no cache we need a way for StateManagers to be disconnected; have StateManager as listener for EC close? (ecListeners below)
}
// Clear out lifecycle listeners that were registered
closeCallbackHandler();
if (ecListeners != null)
{
// Inform all interested parties that we are about to close
Set listeners = new HashSet<>(ecListeners);
for (ExecutionContextListener lstr : listeners)
{
lstr.executionContextClosing(this);
}
ecListeners.clear();
ecListeners = null;
}
// Reset the Fetch Plan to its DFG setting
fetchPlan.clearGroups().addGroup(FetchPlan.DEFAULT);
if (statistics != null)
{
statistics.close();
statistics = null;
}
enlistedSMCache.clear();
dirtySMs.clear();
indirectDirtySMs.clear();
if (nontxProcessedSMs != null)
{
nontxProcessedSMs.clear();
nontxProcessedSMs = null;
}
if (managedRelationsHandler != null)
{
managedRelationsHandler.clear();
}
if (l2CacheTxIds != null)
{
l2CacheTxIds.clear();
}
if (l2CacheTxFieldsToUpdateById != null)
{
l2CacheTxFieldsToUpdateById.clear();
}
if (pbrAtCommitHandler != null)
{
pbrAtCommitHandler.clear();
}
if (smEmbeddedInfoByOwner != null)
{
smEmbeddedInfoByOwner.clear();
smEmbeddedInfoByOwner = null;
}
if (smEmbeddedInfoByEmbedded != null)
{
smEmbeddedInfoByEmbedded.clear();
smEmbeddedInfoByEmbedded = null;
}
if (stateManagerAssociatedValuesMap != null)
{
stateManagerAssociatedValuesMap.clear();
stateManagerAssociatedValuesMap = null;
}
l2CacheObjectsToEvictUponRollback = null;
closing = false;
closed = true;
tx.close(); // Close the transaction
tx = null;
owner = null;
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010001", this));
}
// Hand back to the pool for reuse
nucCtx.getExecutionContextPool().checkIn(this);
}
/* (non-Javadoc)
* @see org.datanucleus.ExecutionContext#registerExecutionContextListener(org.datanucleus.ExecutionContextListener)
*/
@Override
public void registerExecutionContextListener(ExecutionContextListener listener)
{
if (ecListeners == null)
{
ecListeners = new HashSet<>();
}
ecListeners.add(listener);
}
/* (non-Javadoc)
* @see org.datanucleus.ExecutionContext#deregisterExecutionContextListener(org.datanucleus.ExecutionContextListener)
*/
@Override
public void deregisterExecutionContextListener(ExecutionContextListener listener)
{
if (ecListeners != null)
{
ecListeners.remove(listener);
// if (ecListeners.isEmpty())
// {
// ecListeners = null;
// }
}
}
/**
* Method to set whether we are supporting the Level2 Cache with this ExecutionContext
* Note that if the NucleusContext has no Level2 Cache enabled then you cannot turn it on here.
* @param flag Whether to enable/disable it
*/
protected void setLevel2Cache(boolean flag)
{
if (flag && nucCtx.hasLevel2Cache() && !l2CacheEnabled)
{
// Create temporary storage to handle objects needing L2 caching after txn
l2CacheTxIds = new HashSet();
l2CacheTxFieldsToUpdateById = new HashMap<>();
l2CacheEnabled = true;
}
else if (!flag && l2CacheEnabled)
{
// Remove temporary storage for L2 caching
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug("Disabling L2 caching for " + this);
}
l2CacheTxIds.clear();
l2CacheTxIds = null;
l2CacheTxFieldsToUpdateById.clear();
l2CacheTxFieldsToUpdateById = null;
l2CacheEnabled = false;
}
}
/**
* Accessor for whether this context is closed.
* @return Whether this manager is closed.
*/
public boolean isClosed()
{
return closed;
}
/**
* Context info for a particular thread. Can be used for storing state information for the current
* thread where we don't want to pass it through large numbers of method calls (e.g persistence by
* reachability) where such argument passing would damage the structure of DataNucleus.
*/
static class ThreadContextInfo
{
int referenceCounter = 0;
/** Map of the owner of an attached object, keyed by the object. Present when performing attachment. */
Map attachedOwnerByObject = null;
/** Map of attached PC object keyed by the id. Present when performing a attachment. */
Map attachedPCById = null;
boolean merging = false;
boolean nontxPersistDelete = false;
}
/**
* Accessor for the thread context information, for the current thread.
* If the current thread is not present, will add an info context for it.
*
* You must call {@link #releaseThreadContextInfo()} when you don't need it anymore,
* since we use reference counting. Use a try...finally-block for this purpose.
*
*
* @return The thread context information
* @see #getThreadContextInfo()
*/
protected ThreadContextInfo acquireThreadContextInfo()
{
ThreadContextInfo threadInfo = (ThreadContextInfo) contextInfoThreadLocal.get();
++threadInfo.referenceCounter;
return threadInfo;
}
/**
* Get the current ThreadContextInfo assigned to the current thread without changing the
* reference counter.
* @return the thread context information
* @see #acquireThreadContextInfo()
*/
protected ThreadContextInfo getThreadContextInfo()
{
return (ThreadContextInfo) contextInfoThreadLocal.get();
}
/**
* Method to remove the current thread context info for the current thread, after
* the reference counter reached 0. This method decrements a reference counter (per thread), that
* is incremented by {@link #acquireThreadContextInfo()}.
*
* @see #acquireThreadContextInfo()
*/
protected void releaseThreadContextInfo()
{
ThreadContextInfo threadInfo = (ThreadContextInfo) contextInfoThreadLocal.get();
if (--threadInfo.referenceCounter <= 0) // might be -1, if acquireThreadContextInfo was not called. shall we throw an exception in this case?
{
threadInfo.referenceCounter = 0; // just to be 100% sure, we never have a negative reference counter.
if (threadInfo.attachedOwnerByObject != null)
threadInfo.attachedOwnerByObject.clear();
threadInfo.attachedOwnerByObject = null;
if (threadInfo.attachedPCById != null)
threadInfo.attachedPCById.clear();
threadInfo.attachedPCById = null;
contextInfoThreadLocal.remove();
}
}
public void transactionStarted()
{
getStoreManager().transactionStarted(this);
postBegin();
}
public void transactionPreFlush() {}
public void transactionFlushed() {}
public void transactionPreCommit()
{
preCommit();
}
public void transactionCommitted()
{
getStoreManager().transactionCommitted(this);
postCommit();
}
public void transactionPreRollBack()
{
preRollback();
}
public void transactionRolledBack()
{
getStoreManager().transactionRolledBack(this);
postRollback();
}
public void transactionEnded() {}
public void transactionSetSavepoint(String name) {}
public void transactionReleaseSavepoint(String name) {}
public void transactionRollbackToSavepoint(String name) {}
@Override
public ManagerStatistics getStatistics()
{
return statistics;
}
/**
* Method to initialise the L1 cache.
* @throws NucleusUserException if an error occurs setting up the L1 cache
*/
protected void initialiseLevel1Cache()
{
String level1Type = getStringProperty(PropertyNames.PROPERTY_CACHE_L1_TYPE); // TODO This is not listed as overrideable on the manager
if (level1Type == null)
{
level1Type = nucCtx.getConfiguration().getStringProperty(PropertyNames.PROPERTY_CACHE_L1_TYPE);
}
if (Level1Cache.NONE_NAME.equalsIgnoreCase(level1Type))
{
cache = null;
}
else if (SoftRefCache.NAME.equalsIgnoreCase(level1Type))
{
cache = new SoftRefCache();
}
else if (WeakRefCache.NAME.equalsIgnoreCase(level1Type))
{
cache = new WeakRefCache();
}
else if (StrongRefCache.NAME.equalsIgnoreCase(level1Type))
{
cache = new StrongRefCache();
}
else
{
try
{
// Create an instance of the L1 Cache
cache = (Level1Cache)getNucleusContext().getPluginManager().createExecutableExtension(
"org.datanucleus.cache_level1", "name", level1Type, "class-name", null, null);
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("003003", level1Type));
}
}
catch (Exception e)
{
// Exception on creation, so check the L1 cache class name from its plugin name
String level1ClassName = getNucleusContext().getPluginManager().getAttributeValueForExtension("org.datanucleus.cache_level1", "name", level1Type, "class-name");
if (level1ClassName == null)
{
// Plugin of this name not found
throw new NucleusUserException(Localiser.msg("003001", level1Type)).setFatal();
}
// Class name for this L1 cache plugin is not found!
throw new NucleusUserException(Localiser.msg("003002", level1Type, level1ClassName),e).setFatal();
}
}
}
@Override
public Level1Cache getLevel1Cache()
{
return cache;
}
@Override
public ClassLoaderResolver getClassLoaderResolver()
{
return clr;
}
@Override
public LockManager getLockManager()
{
return lockMgr;
}
@Override
public FetchPlan getFetchPlan()
{
assertIsOpen();
return fetchPlan;
}
@Override
public PersistenceNucleusContext getNucleusContext()
{
return nucCtx;
}
/**
* Accessor for the owner of this ExecutionContext. This will typically be PersistenceManager (JDO) or EntityManager (JPA).
* @return The owner
*/
public Object getOwner()
{
return owner;
}
@Override
public void setProperties(Map props)
{
if (props == null)
{
return;
}
for (Map.Entry entry : props.entrySet())
{
setProperty(entry.getKey(), entry.getValue());
}
}
@Override
public void setProperty(String name, Object value)
{
/*if (tx.isActive())
{
// Don't allow change of options during a transaction
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug("Attempt to set property " + name + " during a transaction. Ignored");
}
return;
}*/
if (name.equalsIgnoreCase(PropertyNames.PROPERTY_MANAGE_RELATIONSHIPS))
{
if ("false".equalsIgnoreCase((String)value))
{
// Turn off managed relations if enabled
managedRelationsHandler = null;
}
else if ("true".equalsIgnoreCase((String)value))
{
managedRelationsHandler = new ManagedRelationsHandler(properties.getBooleanProperty(PropertyNames.PROPERTY_MANAGE_RELATIONSHIPS_CHECKS));
}
}
else if (name.equalsIgnoreCase(PropertyNames.PROPERTY_MANAGE_RELATIONSHIPS_CHECKS))
{
if (managedRelationsHandler != null)
{
Boolean checks = Boolean.valueOf((String)value);
if (checks == Boolean.TRUE)
{
managedRelationsHandler.setPerformChecks(true);
}
else if (checks == Boolean.FALSE)
{
managedRelationsHandler.setPerformChecks(false);
}
}
}
else if (name.equalsIgnoreCase(PropertyNames.PROPERTY_PERSISTENCE_BY_REACHABILITY_AT_COMMIT))
{
if (pbrAtCommitHandler != null)
{
if ("false".equalsIgnoreCase((String)value))
{
// Turn off PBR at commit if enabled
pbrAtCommitHandler = null;
}
else if ("true".equalsIgnoreCase((String)value))
{
pbrAtCommitHandler = new ReachabilityAtCommitHandler(this);
}
}
}
else if (name.equalsIgnoreCase(PropertyNames.PROPERTY_FLUSH_MODE))
{
flushMode = FlushMode.getFlushModeForString((String) value);
return;
}
else if (name.equalsIgnoreCase(PropertyNames.PROPERTY_CACHE_L2_TYPE))
{
// Allow the user to turn off L2 caching with this ExecutionContext
if ("none".equalsIgnoreCase((String)value))
{
// Turn off L2 cache
setLevel2Cache(false);
}
else
{
NucleusLogger.PERSISTENCE.warn("Only support disabling L2 cache via property on PM/EM. Ignored");
}
return;
}
else if (name.equalsIgnoreCase(PropertyNames.PROPERTY_CACHE_L1_TYPE))
{
// Allow the user to turn off L1 caching with this ExecutionContext
if ("none".equalsIgnoreCase((String)value))
{
if (cache != null)
{
if (!cache.isEmpty())
{
NucleusLogger.PERSISTENCE.warn("Can only disable L1 cache when it is empty. Ignored");
return;
}
cache = null;
}
}
else
{
NucleusLogger.PERSISTENCE.warn("Only support disabling L1 cache via property on PM/EM. Ignored");
}
return;
}
if (properties.hasProperty(name.toLowerCase()))
{
String intName = getNucleusContext().getConfiguration().getInternalNameForProperty(name);
getNucleusContext().getConfiguration().validatePropertyValue(intName, value);
properties.setProperty(intName.toLowerCase(), value);
}
else
{
String intName = getNucleusContext().getConfiguration().getInternalNameForProperty(name);
if (intName != null && !intName.equalsIgnoreCase(name))
{
getNucleusContext().getConfiguration().validatePropertyValue(intName, value);
properties.setProperty(intName.toLowerCase(), value);
}
else
{
NucleusLogger.PERSISTENCE.warn("Attempt to set property \"" + name + "\" on PM/EM yet this is not supported. Ignored");
}
}
if (name.equalsIgnoreCase(PropertyNames.PROPERTY_SERIALIZE_READ))
{
// Apply value to transaction
tx.setSerializeRead(getBooleanProperty(PropertyNames.PROPERTY_SERIALIZE_READ));
}
}
@Override
public Map getProperties()
{
Map props = new HashMap<>();
for (Map.Entry entry : properties.getProperties().entrySet())
{
props.put(nucCtx.getConfiguration().getCaseSensitiveNameForPropertyName(entry.getKey()), entry.getValue());
}
return props;
}
@Override
public Boolean getBooleanProperty(String name)
{
if (properties.hasProperty(name))
{
return properties.getBooleanProperty(name);
}
return null;
}
@Override
public Integer getIntProperty(String name)
{
if (properties.hasProperty(name))
{
return properties.getIntProperty(name);
}
return null;
}
@Override
public String getStringProperty(String name)
{
if (properties.hasProperty(name))
{
return properties.getStringProperty(name);
}
return null;
}
@Override
public Object getProperty(String name)
{
if (properties.hasProperty(name))
{
return properties.getProperty(name);
}
return null;
}
@Override
public Set getSupportedProperties()
{
return nucCtx.getConfiguration().getManagedOverrideablePropertyNames();
}
@Override
public boolean getMultithreaded()
{
return false;
}
@Override
public FlushMode getFlushMode()
{
return flushMode;
}
@Override
public boolean isDelayDatastoreOperationsEnabled()
{
if (!tx.isActive())
{
// Non-transactional usage
if (isFlushing())
{
return false;
}
return !isNonTxAtomic();
}
// Transactional usage
if (isFlushing() || tx.isCommitting())
{
// Already sending to the datastore so return false to not confuse things
return false;
}
if (flushMode == FlushMode.AUTO)
{
return false;
}
else if (flushMode == FlushMode.MANUAL || flushMode == FlushMode.QUERY)
{
return true;
}
// Default behaviour - delay ops with optimistic, and don't (currently) with datastore txns
return tx.getOptimistic();
}
@Override
public String getTenantId()
{
return nucCtx.getTenantId(this);
}
@Override
public String getCurrentUser()
{
return nucCtx.getCurrentUser(this);
}
@Override
public boolean isInserting(Object pc)
{
DNStateManager sm = findStateManager(pc);
if (sm == null)
{
return false;
}
return sm.isInserting();
}
@Override
public Transaction getTransaction()
{
assertIsOpen();
return tx;
}
@Override
public void enlistInTransaction(DNStateManager sm)
{
assertActiveTransaction();
if (pbrAtCommitHandler != null && tx.isActive())
{
if (getApiAdapter().isNew(sm.getObject()))
{
// Add this object to the list of new objects in this transaction
pbrAtCommitHandler.addFlushedNewObject(sm.getInternalObjectId());
}
else if (getApiAdapter().isPersistent(sm.getObject()) && !getApiAdapter().isDeleted(sm.getObject()))
{
// Add this object to the list of known valid persisted objects (unless it is a known new object)
if (!pbrAtCommitHandler.isObjectFlushedNew(sm.getInternalObjectId()))
{
pbrAtCommitHandler.addPersistedObject(sm.getInternalObjectId());
}
}
// Add the object to those enlisted
if (!pbrAtCommitHandler.isExecuting())
{
// Keep a note of the id for use by persistence-by-reachability-at-commit
pbrAtCommitHandler.addEnlistedObject(sm.getInternalObjectId());
}
}
if (NucleusLogger.TRANSACTION.isDebugEnabled())
{
NucleusLogger.TRANSACTION.debug(Localiser.msg("015017", IdentityUtils.getPersistableIdentityForId(sm.getInternalObjectId())));
}
enlistedSMCache.put(sm.getInternalObjectId(), sm);
}
@Override
public void evictFromTransaction(DNStateManager sm)
{
if (enlistedSMCache.remove(sm.getInternalObjectId()) != null)
{
if (NucleusLogger.TRANSACTION.isDebugEnabled())
{
NucleusLogger.TRANSACTION.debug(Localiser.msg("015019", IdentityUtils.getPersistableIdentityForId(sm.getInternalObjectId())));
}
}
}
/**
* Method to return if an object is enlisted in the current transaction.
* This is only of use when running "persistence-by-reachability" at commit.
* @param id Identity for the object
* @return Whether it is enlisted in the current transaction
*/
public boolean isEnlistedInTransaction(Object id)
{
if (pbrAtCommitHandler == null || !tx.isActive())
{
return false;
}
if (id == null)
{
return false;
}
return pbrAtCommitHandler.isObjectEnlisted(id);
}
/**
* Method to add the object managed by the specified StateManager to the (L1) cache.
* @param sm StateManager
*/
public void addStateManagerToCache(DNStateManager sm)
{
// Add to the Level 1 Cache
putObjectIntoLevel1Cache(sm);
}
/**
* Method to remove the object managed by the specified StateManager from the cache.
* @param sm StateManager
*/
public void removeStateManagerFromCache(DNStateManager sm)
{
if (closing)
{
// All state variables will be reset in bulk in close()
return;
}
// Remove from the Level 1 Cache
removeObjectFromLevel1Cache(sm.getInternalObjectId());
// Remove it from any transaction
enlistedSMCache.remove(sm.getInternalObjectId());
if (smEmbeddedInfoByEmbedded != null)
{
// Remove any owner-embedded relations for this
EmbeddedOwnerRelation embRel = smEmbeddedInfoByEmbedded.get(sm);
if (embRel != null)
{
if (smEmbeddedInfoByOwner != null)
{
// Remove from owner lookup too
smEmbeddedInfoByOwner.remove(embRel.getOwnerSM());
}
smEmbeddedInfoByEmbedded.remove(sm);
}
}
if (smEmbeddedInfoByOwner != null)
{
// Remove any owner-embedded relations for this
List embRels = smEmbeddedInfoByOwner.get(sm);
if (embRels != null)
{
if (smEmbeddedInfoByEmbedded != null)
{
for (EmbeddedOwnerRelation rel : embRels)
{
// Remove from embedded lookup too
smEmbeddedInfoByEmbedded.remove(rel.getEmbeddedSM());
}
}
smEmbeddedInfoByOwner.remove(sm);
}
}
if (stateManagerAssociatedValuesMap != null)
{
stateManagerAssociatedValuesMap.remove(sm);
}
setAttachDetachReferencedObject(sm, null);
}
/**
* Method to return StateManager for an object (if managed).
* @param pc The object we are checking
* @return StateManager, null if not found.
* @throws NucleusUserException if the persistable object is managed by a different ExecutionContext
*/
public DNStateManager findStateManager(Object pc)
{
DNStateManager sm = (DNStateManager) getApiAdapter().getStateManager(pc);
if (sm != null)
{
ExecutionContext ec = sm.getExecutionContext();
if (ec != null && this != ec)
{
throw new NucleusUserException(Localiser.msg("010007", getApiAdapter().getIdForObject(pc)));
}
}
return sm;
}
/**
* Find StateManager for the specified object, persisting it if required and assigning a StateManager if doing so
* @param pc The persistable object
* @param persist persists the object if not yet persisted
* @return StateManager
*/
public DNStateManager findStateManager(Object pc, boolean persist)
{
DNStateManager sm = findStateManager(pc);
if (sm == null && persist)
{
return findStateManager(persistObjectInternal(pc, null, PersistableObjectType.PC));
}
return sm;
}
@Override
public DNStateManager findStateManagerForEmbedded(Object value, DNStateManager ownerSM, AbstractMemberMetaData mmd, PersistableObjectType objectType)
{
// This caters for the calling code using a MMD from an definition, going back to the class itself
AbstractMemberMetaData ownerMmd = ownerSM.getClassMetaData().getMetaDataForMember(mmd.getName());
// TODO If we limit each object to one embedded owner then need to check for different owner here and create copy if necessary
DNStateManager embeddedSM = findStateManager(value);
if (embeddedSM == null)
{
// Assign a StateManager to manage our embedded object (and register it)
embeddedSM = nucCtx.getStateManagerFactory().newForEmbedded(this, value, false, ownerSM, ownerMmd.getAbsoluteFieldNumber(), objectType);
}
else
{
if (!embeddedSM.isEmbedded())
{
// TODO This object is already registered as not embedded so need to create clone of object and manage it as embedded!
NucleusLogger.PERSISTENCE.warn("Object " + StringUtils.toJVMIDString(value) + " is already registered with " + embeddedSM +
" as NOT EMBEDDED but needs to be embedded into " + ownerSM + ". Please correct this. An object can be either embedded or not but not both");
}
}
return embeddedSM;
}
public DNStateManager findStateManagerOfOwnerForAttachingObject(Object pc)
{
ThreadContextInfo threadInfo = acquireThreadContextInfo();
try
{
if (threadInfo.attachedOwnerByObject == null)
{
return null;
}
return threadInfo.attachedOwnerByObject.get(pc);
}
finally
{
releaseThreadContextInfo();
}
}
/**
* Convenience method for whether any non-tx operations are considered "atomic" (i.e auto-commit).
* @return Whether atomic non-tx behaviour
*/
private boolean isNonTxAtomic()
{
return properties.getBooleanProperty(PropertyNames.PROPERTY_TRANSACTION_NONTX_ATOMIC);
}
/**
* Method called when a non-tx update has been performed (via setter call on the persistable object, or via
* use of mutator methods of a field). Only hands the update across to be "committed" if not part of an owning
* persist/delete call.
*/
public void processNontransactionalUpdate()
{
if (tx.isActive() || !tx.getNontransactionalWrite() || !tx.getNontransactionalWriteAutoCommit())
{
return;
}
ThreadContextInfo threadInfo = acquireThreadContextInfo();
try
{
if (threadInfo.nontxPersistDelete)
{
// Invoked from persist/delete so ignore as we are handling it
return;
}
processNontransactionalAtomicChanges();
}
finally
{
releaseThreadContextInfo();
}
}
/**
* Handler for all outstanding changes to be "committed" atomically.
* If a transaction is active, non-tx writes are disabled, or atomic updates not enabled then will do nothing.
* Otherwise will flush any updates that are outstanding (updates to an object), will perform detachAllOnCommit
* if enabled (so user always has detached objects), update objects in any L2 cache, and migrates any
* objects through lifecycle changes.
* Is similar in content to "flush"+"preCommit"+"postCommit"
* Note that this handling for updates is not part of standard JDO which expects non-tx updates to migrate an
* object to P_NONTRANS_DIRTY rather than committing it directly.
* TODO If any update fails we should throw the appropriate exception for the API
*/
protected void processNontransactionalAtomicChanges()
{
if (tx.isActive() || !tx.getNontransactionalWrite() || !tx.getNontransactionalWriteAutoCommit())
{
return;
}
if (!dirtySMs.isEmpty())
{
// Make sure all non-tx dirty objects are enlisted so they get lifecycle changes
for (DNStateManager sm : dirtySMs)
{
if (NucleusLogger.TRANSACTION.isDebugEnabled())
{
NucleusLogger.TRANSACTION.debug(Localiser.msg("015017", IdentityUtils.getPersistableIdentityForId(sm.getInternalObjectId())));
}
enlistedSMCache.put(sm.getInternalObjectId(), sm);
}
// Flush any outstanding changes to the datastore
flushInternal(true);
if (l2CacheEnabled)
{
// L2 caching of enlisted objects
performLevel2CacheUpdateAtCommit();
}
if (properties.getFrequentProperties().getDetachAllOnCommit())
{
// "detach-on-commit"
performDetachAllOnTxnEndPreparation();
performDetachAllOnTxnEnd();
}
// Make sure lifecycle changes take place to all "enlisted" objects
List failures = null;
try
{
// "commit" all enlisted StateManagers
ApiAdapter api = getApiAdapter();
DNStateManager[] sms = enlistedSMCache.values().toArray(new DNStateManager[enlistedSMCache.size()]);
for (int i = 0; i < sms.length; ++i)
{
try
{
// Run through "postCommit" to migrate the lifecycle state
if (sms[i] != null && sms[i].getObject() != null && api.isPersistent(sms[i].getObject()) && api.isDirty(sms[i].getObject()))
{
sms[i].postCommit(getTransaction());
}
else
{
NucleusLogger.PERSISTENCE.debug(">> Atomic nontransactional processing : Not performing postCommit on " + sms[i]);
}
}
catch (RuntimeException e)
{
if (failures == null)
{
failures = new ArrayList();
}
failures.add(e);
}
}
}
finally
{
resetTransactionalVariables();
}
if (failures != null && !failures.isEmpty())
{
throw new CommitStateTransitionException((Exception[]) failures.toArray(new Exception[failures.size()]));
}
}
if (nontxProcessedSMs != null && !nontxProcessedSMs.isEmpty())
{
for (DNStateManager sm : nontxProcessedSMs)
{
if (sm != null && sm.getLifecycleState() != null && sm.getLifecycleState().isDeleted())
{
removeObjectFromLevel1Cache(sm.getInternalObjectId());
removeObjectFromLevel2Cache(sm.getInternalObjectId());
}
}
nontxProcessedSMs.clear();
}
}
// ----------------------------- Lifecycle Methods ------------------------------------
/**
* Internal method to evict an object from L1 cache.
* @param obj The object
* @throws NucleusException if an error occurs evicting the object
*/
public void evictObject(Object obj)
{
if (obj == null)
{
return;
}
try
{
clr.setPrimary(obj.getClass().getClassLoader());
assertClassPersistable(obj.getClass());
assertNotDetached(obj);
// We do not directly remove from cache level 1 here.
// The cache level 1 will be evicted automatically on garbage collection, if the object can be evicted.
// It means not all JDO states allows the object to be evicted.
DNStateManager sm = findStateManager(obj);
if (sm == null)
{
throw new NucleusUserException(Localiser.msg("010048", StringUtils.toJVMIDString(obj), getApiAdapter().getIdForObject(obj), "evict"));
}
sm.evict();
}
finally
{
clr.unsetPrimary();
}
}
/**
* Method to evict all objects of the specified type (and optionally its subclasses) that are present in the L1 cache.
* @param cls Type of persistable object
* @param subclasses Whether to include subclasses
*/
public void evictObjects(Class cls, boolean subclasses)
{
if (cache != null && !cache.isEmpty())
{
Set smsToEvict = new HashSet<>(cache.values());
for (DNStateManager sm : smsToEvict)
{
Object pc = sm.getObject();
boolean evict = false;
if (!subclasses && pc.getClass() == cls)
{
evict = true;
}
else if (subclasses && cls.isAssignableFrom(pc.getClass()))
{
evict = true;
}
if (evict)
{
sm.evict();
removeObjectFromLevel1Cache(getApiAdapter().getIdForObject(pc));
}
}
}
}
/**
* Method to evict all current objects from L1 cache.
*/
public void evictAllObjects()
{
if (cache != null && !cache.isEmpty())
{
// TODO All persistent non-transactional instances should be evicted here, but not yet supported
// Evict StateManagers and remove objects from cache. Performed in separate loop to avoid ConcurrentModificationException
Set smsToEvict = new HashSet(cache.values());
for (DNStateManager sm : smsToEvict)
{
if (sm != null)
{
sm.evict();
}
}
cache.clear();
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("003011"));
}
}
}
@Override
public void refreshObject(Object obj)
{
if (obj == null)
{
return;
}
try
{
clr.setPrimary(obj.getClass().getClassLoader());
assertClassPersistable(obj.getClass());
assertNotDetached(obj);
DNStateManager sm = findStateManager(obj);
if (sm == null)
{
throw new NucleusUserException(Localiser.msg("010048", StringUtils.toJVMIDString(obj), getApiAdapter().getIdForObject(obj), "refresh"));
}
if (getApiAdapter().isPersistent(obj) && sm.isWaitingToBeFlushedToDatastore())
{
// Persistent but not yet flushed so nothing to "refresh" from!
return;
}
sm.refresh();
}
finally
{
clr.unsetPrimary();
}
}
@Override
public void refreshAllObjects()
{
Set toRefresh = new HashSet<>();
toRefresh.addAll(enlistedSMCache.values());
toRefresh.addAll(dirtySMs);
toRefresh.addAll(indirectDirtySMs);
if (!tx.isActive() && cache != null && !cache.isEmpty())
{
toRefresh.addAll(cache.values());
}
List failures = null;
for (DNStateManager sm : toRefresh)
{
try
{
sm.refresh();
}
catch (RuntimeException e)
{
if (failures == null)
{
failures = new ArrayList();
}
failures.add(e);
}
}
if (failures != null && !failures.isEmpty())
{
throw new NucleusUserException(Localiser.msg("010037"), (Exception[]) failures.toArray(new Exception[failures.size()]));
}
}
@Override
public void retrieveObjects(boolean useFetchPlan, Object... pcs)
{
if (pcs == null || pcs.length == 0)
{
return;
}
// TODO Consider doing these in bulk where possible if several objects of the same type
List failures = null;
for (Object pc : pcs)
{
if (pc == null)
{
continue;
}
try
{
clr.setPrimary(pc.getClass().getClassLoader());
assertClassPersistable(pc.getClass());
assertNotDetached(pc);
DNStateManager sm = findStateManager(pc);
if (sm == null)
{
throw new NucleusUserException(Localiser.msg("010048", StringUtils.toJVMIDString(pc), getApiAdapter().getIdForObject(pc), "retrieve"));
}
sm.retrieve(useFetchPlan);
}
catch (RuntimeException e)
{
if (failures == null)
{
failures = new ArrayList();
}
failures.add(e);
}
finally
{
clr.unsetPrimary();
}
}
if (failures != null && !failures.isEmpty())
{
throw new NucleusUserException(Localiser.msg("010037"), (Exception[]) failures.toArray(new Exception[failures.size()]));
}
}
@Override
public Object persistObject(Object obj, boolean merging)
{
if (obj == null)
{
return null;
}
// Allocate thread-local persistence info
ThreadContextInfo threadInfo = acquireThreadContextInfo();
try
{
boolean allowMergeOfTransient = getBooleanProperty(PropertyNames.PROPERTY_ALLOW_ATTACH_OF_TRANSIENT);
if (merging && allowMergeOfTransient)
{
threadInfo.merging = true;
}
if (threadInfo.attachedOwnerByObject == null)
{
threadInfo.attachedOwnerByObject = new HashMap();
}
if (threadInfo.attachedPCById == null)
{
threadInfo.attachedPCById = new HashMap();
}
if (tx.isActive())
{
return persistObjectWork(obj);
}
threadInfo.nontxPersistDelete = true;
boolean success = true;
Set cachedIds = (cache != null && !cache.isEmpty()) ? new HashSet(cache.keySet()) : null;
try
{
return persistObjectWork(obj);
}
catch (RuntimeException re)
{
success = false;
if (cache != null)
{
// Make sure we evict any objects that have been put in the L1 cache during this step
// TODO Also ought to disconnect any state manager
Iterator cacheIter = cache.keySet().iterator();
while (cacheIter.hasNext())
{
Object id = cacheIter.next();
if (cachedIds == null || !cachedIds.contains(id))
{
// Remove from L1 cache
cacheIter.remove();
}
}
}
throw re;
}
finally
{
threadInfo.nontxPersistDelete = false;
if (success)
{
// Commit any non-tx changes
processNontransactionalAtomicChanges();
}
}
}
finally
{
// Deallocate thread-local persistence info
releaseThreadContextInfo();
}
}
@Override
public Object[] persistObjects(Object... objs)
{
if (objs == null)
{
return null;
}
Object[] persistedObjs = new Object[objs.length];
// Allocate thread-local persistence info
ThreadContextInfo threadInfo = acquireThreadContextInfo();
try
{
if (threadInfo.attachedOwnerByObject == null)
{
threadInfo.attachedOwnerByObject = new HashMap();
}
if (threadInfo.attachedPCById == null)
{
threadInfo.attachedPCById = new HashMap();
}
if (!tx.isActive())
{
threadInfo.nontxPersistDelete = true;
}
try
{
getStoreManager().getPersistenceHandler().batchStart(this, PersistenceBatchType.PERSIST);
List failures = null;
for (int i=0;i T persistObjectInternal(T obj, FieldValues preInsertChanges, PersistableObjectType objectType, DNStateManager ownerSM, int ownerFieldNum)
{
if (obj == null)
{
return null;
}
// TODO Support embeddedOwner/objectType, so we can add StateManager for embedded objects here
ApiAdapter api = getApiAdapter();
Object id = null; // Id of the object that was persisted during this process (if any)
try
{
clr.setPrimary(obj.getClass().getClassLoader());
assertClassPersistable(obj.getClass());
ExecutionContext ec = api.getExecutionContext(obj);
if (ec != null && ec != this)
{
// Object managed by a different manager
throw new NucleusUserException(Localiser.msg("010007", obj));
}
// This block of code was present up to 6.0.0-m4. No comment present as to why so commented out seemingly to no ill effect
// if (ownerSM != null)
// {
// ownerSM = findStateManager(ownerSM.getObject());
// }
boolean cacheable = false;
T persistedPc = obj; // Persisted object is the passed in pc (unless being attached as a copy)
if (api.isDetached(obj))
{
// Detached : attach it
assertDetachable(obj);
if (getBooleanProperty(PropertyNames.PROPERTY_COPY_ON_ATTACH))
{
// Attach a copy and return the copy
persistedPc = attachObjectCopy(ownerSM, obj, api.getIdForObject(obj) == null);
}
else
{
// Attach the object
attachObject(ownerSM, obj, api.getIdForObject(obj) == null);
}
}
else if (api.isTransactional(obj) && !api.isPersistent(obj))
{
// TransientTransactional : persist it
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010015", StringUtils.toJVMIDString(obj)));
}
DNStateManager sm = findStateManager(obj);
if (sm == null)
{
throw new NucleusUserException(Localiser.msg("010007", getApiAdapter().getIdForObject(obj)));
}
sm.makePersistentTransactionalTransient();
}
else if (!api.isPersistent(obj))
{
// Transient : persist it
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010015", StringUtils.toJVMIDString(obj)));
}
boolean merged = false;
ThreadContextInfo threadInfo = acquireThreadContextInfo();
try
{
if (threadInfo.merging)
{
// Attach of transient is permitted, so attach it
AbstractClassMetaData cmd = getMetaDataManager().getMetaDataForClass(obj.getClass(), clr);
if (cmd.getIdentityType() == IdentityType.APPLICATION)
{
Object transientId = nucCtx.getIdentityManager().getApplicationId(obj, cmd);
if (transientId != null)
{
// User has set id field(s) so find the datastore object (if exists)
T existingObj = (T)findObject(transientId, true, true, cmd.getFullClassName());
findStateManager(existingObj).attach(obj);
id = transientId;
merged = true;
persistedPc = existingObj;
cacheable = nucCtx.isClassCacheable(cmd);
}
}
}
}
catch (NucleusObjectNotFoundException onfe)
{
// Object with this id doesn't exist, so just persist the transient (below)
}
finally
{
releaseThreadContextInfo();
}
if (!merged)
{
DNStateManager sm = findStateManager(obj);
if (sm == null)
{
if ((objectType == PersistableObjectType.EMBEDDED_COLLECTION_ELEMENT_PC ||
objectType == PersistableObjectType.EMBEDDED_MAP_KEY_PC ||
objectType == PersistableObjectType.EMBEDDED_MAP_VALUE_PC ||
objectType == PersistableObjectType.EMBEDDED_PC) && ownerSM != null)
{
// Embedded/serialised (SCO) object
sm = nucCtx.getStateManagerFactory().newForEmbedded(this, obj, false, ownerSM, ownerFieldNum, objectType);
sm.makePersistent();
id = sm.getInternalObjectId();
}
else
{
// FCO object
sm = nucCtx.getStateManagerFactory().newForPersistentNew(this, obj, preInsertChanges);
sm.makePersistent();
id = sm.getInternalObjectId();
}
}
else
{
if (sm.getReferencedPC() == null)
{
// Not attaching, so persist it
sm.makePersistent();
id = sm.getInternalObjectId();
}
else
{
// Being attached, so use the attached object
persistedPc = sm.getReferencedPC();
}
}
if (sm != null)
{
cacheable = nucCtx.isClassCacheable(sm.getClassMetaData());
}
}
}
else if (api.isPersistent(obj) && api.getIdForObject(obj) == null)
{
// Embedded/Serialised : have StateManager but no identity, allow persist in own right
// Should we be making a copy of the object here ?
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010015", StringUtils.toJVMIDString(obj)));
}
DNStateManager sm = findStateManager(obj);
sm.makePersistent();
id = sm.getInternalObjectId();
cacheable = nucCtx.isClassCacheable(sm.getClassMetaData());
}
else if (api.isDeleted(obj))
{
// Deleted : (re)-persist it (permitted in JPA, but not JDO - see StateManager)
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010015", StringUtils.toJVMIDString(obj)));
}
DNStateManager sm = findStateManager(obj);
sm.makePersistent();
id = sm.getInternalObjectId();
cacheable = nucCtx.isClassCacheable(sm.getClassMetaData());
}
else
{
if (api.isPersistent(obj) && api.isTransactional(obj) && api.isDirty(obj) && isDelayDatastoreOperationsEnabled())
{
// Object provisionally persistent (but not in datastore) so re-run reachability maybe
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010015", StringUtils.toJVMIDString(obj)));
}
DNStateManager sm = findStateManager(obj);
sm.makePersistent();
id = sm.getInternalObjectId();
cacheable = nucCtx.isClassCacheable(sm.getClassMetaData());
}
}
if (id != null && l2CacheTxIds != null && cacheable)
{
l2CacheTxIds.add(id);
}
return persistedPc;
}
finally
{
clr.unsetPrimary();
}
}
@Override
public void deleteObjects(Object... objs)
{
if (objs == null)
{
return;
}
ThreadContextInfo threadInfo = acquireThreadContextInfo();
try
{
if (!tx.isActive())
{
threadInfo.nontxPersistDelete = true;
}
getStoreManager().getPersistenceHandler().batchStart(this, PersistenceBatchType.DELETE);
List failures = null;
for (int i=0;i attachedOwnerByObject = getThreadContextInfo().attachedOwnerByObject; // For the current thread
if (attachedOwnerByObject != null)
{
attachedOwnerByObject.put((Persistable) pc, ownerSM);
}
ApiAdapter api = getApiAdapter();
Object id = api.getIdForObject(pc);
if (id != null && isInserting(pc))
{
// Object is being inserted in this transaction so just return
return;
}
else if (id == null && !sco)
{
// Transient object so needs persisting
persistObjectInternal(pc, null, PersistableObjectType.PC);
return;
}
if (api.isDetached(pc))
{
// Detached, so migrate to attached
DNStateManager l1CachedSM = (cache != null) ? cache.get(id) : null;
if (l1CachedSM != null && l1CachedSM.getObject() != pc)
{
// attached object with the same id already present in the L1 cache so cannot attach in-situ
throw new NucleusUserException(Localiser.msg("010017", IdentityUtils.getPersistableIdentityForId(id)));
}
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010016", IdentityUtils.getPersistableIdentityForId(id)));
}
nucCtx.getStateManagerFactory().newForDetached(this, pc, id, api.getVersionForObject(pc)).attach(sco);
}
else
{
// Not detached so can't attach it. Just return
return;
}
}
@Override
public T attachObjectCopy(DNStateManager ownerSM, T pc, boolean sco)
{
assertClassPersistable(pc.getClass());
assertDetachable(pc);
// Store the owner for this persistable object being attached
Map attachedOwnerByObject = getThreadContextInfo().attachedOwnerByObject; // For the current thread
if (attachedOwnerByObject != null)
{
attachedOwnerByObject.put((Persistable) pc, ownerSM);
}
ApiAdapter api = getApiAdapter();
Object id = api.getIdForObject(pc);
if (id != null && isInserting(pc))
{
// Object is being inserted in this transaction
return pc;
}
else if (id == null && !sco)
{
// Object was not persisted before so persist it
return persistObjectInternal(pc, null, PersistableObjectType.PC);
}
else if (api.isPersistent(pc))
{
// Already persistent hence can't be attached
return pc;
}
// Object should exist in this datastore now
T pcTarget = null;
if (sco)
{
// SCO PC (embedded/serialised)
boolean detached = getApiAdapter().isDetached(pc);
DNStateManager targetSM = nucCtx.getStateManagerFactory().newForEmbedded(this, pc, true, null, -1, PersistableObjectType.EMBEDDED_PC);
pcTarget = targetSM.getObject();
if (detached)
{
// If the object is detached, re-attach it
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010018", StringUtils.toJVMIDString(pc), StringUtils.toJVMIDString(pcTarget)));
}
targetSM.attachCopy(pc, sco);
}
}
else
{
// FCO PC
boolean detached = getApiAdapter().isDetached(pc);
pcTarget = (T)findObject(id, false, false, pc.getClass().getName());
if (detached)
{
T obj = null;
Map attachedPCById = getThreadContextInfo().attachedPCById; // For the current thread
if (attachedPCById != null) // Only used by persistObject process
{
obj = (T) attachedPCById.get(getApiAdapter().getIdForObject(pc));
}
if (obj != null)
{
pcTarget = obj;
}
else
{
// If the object is detached, re-attach it
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010018", StringUtils.toJVMIDString(pc), StringUtils.toJVMIDString(pcTarget)));
}
pcTarget = (T) findStateManager(pcTarget).attachCopy(pc, sco);
// Save the detached-attached PCs for later reference
if (attachedPCById != null) // Only used by persistObject process
{
attachedPCById.put(getApiAdapter().getIdForObject(pc), (Persistable) pcTarget);
}
}
}
}
return pcTarget;
}
@Override
public Object getAttachedObjectForId(Object id)
{
DNStateManager sm = enlistedSMCache.get(id);
if (sm == null && cache != null)
{
sm = cache.get(id);
}
return (sm != null) ? sm.getObject() : null;
}
@Override
public void detachObject(FetchPlanState state, Object obj)
{
if (getApiAdapter().isDetached(obj))
{
// Already detached
return;
}
if (!getApiAdapter().isPersistent(obj))
{
if (runningDetachAllOnTxnEnd && !getMetaDataManager().getMetaDataForClass(obj.getClass(), clr).isDetachable())
{
// Object is not detachable, and is now transient (and after commit) so just return
return;
}
// Transient object passed so persist it before thinking about detaching
if (tx.isActive())
{
persistObjectInternal(obj, null, PersistableObjectType.PC);
}
}
DNStateManager sm = findStateManager(obj);
if (sm == null)
{
throw new NucleusUserException(Localiser.msg("010007", getApiAdapter().getIdForObject(obj)));
}
sm.detach(state);
// Clear any changes from this since it is now detached
if (dirtySMs.contains(sm) || indirectDirtySMs.contains(sm))
{
NucleusLogger.GENERAL.info(Localiser.msg("010047", StringUtils.toJVMIDString(obj)));
clearDirty(sm);
}
}
@Override
public void detachObjects(FetchPlanState state, Object... pcs)
{
if (pcs == null || pcs.length == 0)
{
return;
}
Collection smsToDetach = new HashSet<>();
for (Object pc : pcs)
{
if (getApiAdapter().isDetached(pc))
{
// Already detached
continue;
}
else if (!getApiAdapter().isPersistent(pc))
{
if (runningDetachAllOnTxnEnd && !getMetaDataManager().getMetaDataForClass(pc.getClass(), clr).isDetachable())
{
// Object is not detachable, and is now transient (and after commit) so just return
continue;
}
// Transient object passed so persist it before thinking about detaching
if (tx.isActive())
{
persistObjectInternal(pc, null, PersistableObjectType.PC);
}
}
DNStateManager sm = findStateManager(pc);
if (sm != null)
{
smsToDetach.add(sm);
}
}
for (DNStateManager sm : smsToDetach)
{
sm.detach(state);
// Clear any changes from this since it is now detached
if (dirtySMs.contains(sm) || indirectDirtySMs.contains(sm))
{
NucleusLogger.GENERAL.info(Localiser.msg("010047", StringUtils.toJVMIDString(sm.getObject())));
clearDirty(sm);
}
}
}
@Override
public T detachObjectCopy(FetchPlanState state, T pc)
{
T thePC = pc;
try
{
clr.setPrimary(pc.getClass().getClassLoader());
if (!getApiAdapter().isPersistent(pc) && !getApiAdapter().isDetached(pc))
{
// Transient object passed so persist it before thinking about detaching
if (tx.isActive())
{
thePC = persistObjectInternal(pc, null, PersistableObjectType.PC);
}
else
{
// JDO [12.6.8] "If a detachCopy method is called outside an active transaction, the reachability
// algorithm will not be run; if any transient instances are reachable via persistent fields, a
// XXXUserException is thrown for each persistent instance containing such fields.
throw new NucleusUserException(Localiser.msg("010014"));
}
}
if (getApiAdapter().isDetached(thePC))
{
// Passing in a detached (dirty or clean) instance, so get a persistent copy to detach
thePC = (T)findObject(getApiAdapter().getIdForObject(thePC), false, true, null);
}
DNStateManager sm = findStateManager(thePC);
if (sm == null)
{
throw new NucleusUserException(Localiser.msg("010007", getApiAdapter().getIdForObject(thePC)));
}
return sm.detachCopy(state);
}
finally
{
clr.unsetPrimary();
}
}
@Override
public void detachAll()
{
Collection smsToDetach = new HashSet<>(this.enlistedSMCache.values());
if (cache != null && !cache.isEmpty())
{
smsToDetach.addAll(cache.values());
}
FetchPlanState fps = new FetchPlanState();
for (DNStateManager sm : smsToDetach)
{
sm.detach(fps);
}
}
@Override
public Object getAttachDetachReferencedObject(DNStateManager sm)
{
if (smAttachDetachObjectReferenceMap == null)
{
return null;
}
return smAttachDetachObjectReferenceMap.get(sm);
}
@Override
public void setAttachDetachReferencedObject(DNStateManager sm, Object obj)
{
if (obj != null)
{
if (smAttachDetachObjectReferenceMap == null)
{
smAttachDetachObjectReferenceMap = new HashMap();
}
smAttachDetachObjectReferenceMap.put(sm, obj);
}
else
{
if (smAttachDetachObjectReferenceMap != null)
{
smAttachDetachObjectReferenceMap.remove(sm);
}
}
}
// ----------------------------- New Instances ----------------------------------
/**
* Method to generate an instance of an interface, abstract class, or concrete PC class.
* @param cls The class of the interface or abstract class, or concrete class defined in MetaData
* @return The instance of this type
* @throws NucleusUserException if an ImplementationCreator instance does not exist and one is needed (i.e not a concrete class passed in)
*/
public T newInstance(Class cls)
{
if (getApiAdapter().isPersistable(cls) && !Modifier.isAbstract(cls.getModifiers()))
{
// Concrete PC class so instantiate here
try
{
return cls.getDeclaredConstructor().newInstance();
}
catch (IllegalAccessException|InstantiationException|InvocationTargetException|NoSuchMethodException e)
{
throw new NucleusUserException(e.toString(), e);
}
}
// Use ImplementationCreator
if (getNucleusContext().getImplementationCreator() == null)
{
throw new NucleusUserException(Localiser.msg("010035"));
}
return getNucleusContext().getImplementationCreator().newInstance(cls, clr);
}
// ----------------------------- Object Retrieval by Id ----------------------------------
/**
* Method to return if the specified object exists in the datastore.
* @param obj The (persistable) object
* @return Whether it exists
*/
public boolean exists(Object obj)
{
if (obj == null)
{
return false;
}
Object id = getApiAdapter().getIdForObject(obj);
if (id == null)
{
return false;
}
try
{
findObject(id, true, false, obj.getClass().getName());
}
catch (NucleusObjectNotFoundException onfe)
{
return false;
}
return true;
}
/**
* Accessor for the currently managed objects for the current transaction.
* If the transaction is not active this returns null.
* @return Collection of managed objects enlisted in the current transaction
*/
public Set getManagedObjects()
{
if (!tx.isActive())
{
return null;
}
Set objs = new HashSet();
for (DNStateManager sm : enlistedSMCache.values())
{
objs.add(sm.getObject());
}
return objs;
}
/**
* Accessor for the currently managed objects for the current transaction.
* If the transaction is not active this returns null.
* @param classes Classes that we want the enlisted objects for
* @return Collection of managed objects enlisted in the current transaction
*/
public Set getManagedObjects(Class[] classes)
{
if (!tx.isActive())
{
return null;
}
Set objs = new HashSet();
for (DNStateManager sm : enlistedSMCache.values())
{
for (int i=0;i T findObject(Class cls, Object key)
{
if (cls == null || key == null)
{
throw new NucleusUserException(Localiser.msg("010051", cls, key));
}
AbstractClassMetaData cmd = getMetaDataManager().getMetaDataForClass(cls, clr);
if (cmd == null)
{
throw new NucleusUserException(Localiser.msg("010052", cls.getName()));
}
// Get the identity
Object id = key;
if (cmd.getIdentityType() == IdentityType.DATASTORE)
{
if (!IdentityUtils.isDatastoreIdentity(key))
{
// Create an OID
id = nucCtx.getIdentityManager().getDatastoreId(cmd.getFullClassName(), key);
}
}
else if (!cmd.getObjectidClass().equals(key.getClass().getName()))
{
// primaryKey is just the key (when using single-field identity), so create a PK object
try
{
id = newObjectId(cls, key);
}
catch (NucleusException ne)
{
throw new IllegalArgumentException(ne);
}
}
return (T) findObject(id, true, true, null);
}
@Override
public List findObjects(Class cls, List keys)
{
if (cls == null || keys == null)
{
throw new NucleusUserException(Localiser.msg("010051", cls, keys));
}
AbstractClassMetaData cmd = getMetaDataManager().getMetaDataForClass(cls, clr);
if (cmd == null)
{
throw new NucleusUserException(Localiser.msg("010052", cls.getName()));
}
// Get the identities TODO Batch this process
List objs = new ArrayList<>();
for (Object key : keys)
{
Object id = key;
if (cmd.getIdentityType() == IdentityType.DATASTORE)
{
if (!IdentityUtils.isDatastoreIdentity(key))
{
// Create an OID
id = nucCtx.getIdentityManager().getDatastoreId(cmd.getFullClassName(), key);
}
}
else if (!cmd.getObjectidClass().equals(key.getClass().getName()))
{
// primaryKey is just the key (when using single-field identity), so create a PK object
try
{
id = newObjectId(cls, key);
}
catch (NucleusException ne)
{
throw new IllegalArgumentException(ne);
}
}
objs.add((T) findObject(id, true, true, null));
}
return objs;
}
@Override
public T findObjectByUnique(Class cls, String[] memberNames, Object[] memberValues)
{
if (cls == null || memberNames == null || memberNames.length == 0 || memberValues == null || memberValues.length == 0)
{
throw new NucleusUserException(Localiser.msg("010053", cls, StringUtils.objectArrayToString(memberNames), StringUtils.objectArrayToString(memberValues)));
}
// Check class and member existence
AbstractClassMetaData cmd = getMetaDataManager().getMetaDataForClass(cls, clr);
if (cmd == null)
{
throw new NucleusUserException(Localiser.msg("010052", cls.getName()));
}
for (String memberName : memberNames)
{
AbstractMemberMetaData mmd = cmd.getMetaDataForMember(memberName);
if (mmd == null)
{
throw new NucleusUserException("Attempt to find object using unique key of class " + cmd.getFullClassName() + " but field " + memberName + " doesnt exist!");
}
}
// Check whether this is cached against the unique key
CacheUniqueKey uniKey = new CacheUniqueKey(cls.getName(), memberNames, memberValues);
DNStateManager sm = (cache != null) ? cache.getUnique(uniKey) : null;
if (sm == null && l2CacheEnabled)
{
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("003007", uniKey));
}
// Try L2 cache
Object pc = getObjectFromLevel2CacheForUnique(uniKey);
if (pc != null)
{
sm = findStateManager(pc);
}
}
if (sm != null)
{
return (T) sm.getObject();
}
return (T) getStoreManager().getPersistenceHandler().findObjectForUnique(this, cmd, memberNames, memberValues);
}
public Persistable findObject(Object id, boolean validate)
{
return findObject(id, validate, validate, null);
}
@Override
public Persistable findObject(Object id, FieldValues fv, Class cls, boolean ignoreCache, boolean checkInheritance)
{
assertIsOpen();
Persistable pc = null;
DNStateManager sm = null;
if (!ignoreCache)
{
// Check if an object exists in the L1/L2 caches for this id
pc = getObjectFromCache(id);
}
if (pc == null)
{
// Find direct from the datastore if supported
pc = (Persistable) getStoreManager().getPersistenceHandler().findObject(this, id);
}
boolean createdHollow = false;
if (pc == null)
{
// Determine the class details for this "id" if not provided, including checking of inheritance level
String className = cls != null ? cls.getName() : null;
if (!(id instanceof SCOID))
{
ClassDetailsForId details = getClassDetailsForId(id, className, checkInheritance);
if (details.className != null && cls != null && !cls.getName().equals(details.className))
{
cls = clr.classForName(details.className);
}
className = details.className;
id = details.id;
if (details.pc != null)
{
// Found following inheritance check via the cache
pc = details.pc;
sm = findStateManager(pc);
}
}
if (pc == null)
{
// Still not found so create a Hollow instance with the supplied field values
if (cls == null)
{
try
{
cls = clr.classForName(className, id.getClass().getClassLoader());
}
catch (ClassNotResolvedException e)
{
String msg = Localiser.msg("010027", IdentityUtils.getPersistableIdentityForId(id));
NucleusLogger.PERSISTENCE.warn(msg);
throw new NucleusUserException(msg, e);
}
}
createdHollow = true;
sm = nucCtx.getStateManagerFactory().newForHollow(this, cls, id, fv); // Will put object in L1 cache
pc = (Persistable) sm.getObject();
putObjectIntoLevel2Cache(sm, false);
}
}
if (pc != null && fv != null && !createdHollow)
{
// Object found in the cache so load the requested fields
if (sm == null)
{
sm = findStateManager(pc);
}
if (sm != null)
{
// Load the requested fields
fv.fetchNonLoadedFields(sm);
}
}
return pc;
}
@Override
public Persistable[] findObjectsById(Object[] identities, boolean validate)
{
if (identities == null)
{
return null;
}
else if (identities.length == 1)
{
return new Persistable[] {findObject(identities[0], validate, validate, null)};
}
for (int i=0;i pcById = new HashMap(identities.length);
List idsToFind = new ArrayList();
ApiAdapter api = getApiAdapter();
// Check the L1 cache
for (int i=0;i pcsById = getObjectsFromLevel2Cache(idsToFind);
if (!pcsById.isEmpty())
{
// Found some so add to the values, and remove from the "toFind" list
Iterator> entryIter = pcsById.entrySet().iterator();
while (entryIter.hasNext())
{
Map.Entry entry = entryIter.next();
pcById.put(entry.getKey(), entry.getValue());
idsToFind.remove(entry.getKey());
}
}
}
boolean performValidationWhenCached = getBooleanProperty(PropertyNames.PROPERTY_FIND_OBJECT_VALIDATE_WHEN_CACHED);
List smsToValidate = new ArrayList<>();
if (validate)
{
if (performValidationWhenCached)
{
// Mark all StateManagers for validation (performed at end)
Collection pcValues = pcById.values();
for (Object pc : pcValues)
{
if (api.isTransactional(pc))
{
// This object is transactional, so no need to validate
continue;
}
// Mark this object for validation
smsToValidate.add(findStateManager(pc));
}
}
}
Object[] foundPcs = null;
if (!idsToFind.isEmpty())
{
// Try to find unresolved objects direct from the datastore if supported by the datastore (e.g ODBMS)
foundPcs = getStoreManager().getPersistenceHandler().findObjects(this, idsToFind.toArray());
}
int foundPcIdx = 0;
for (Object id : idsToFind)
{
Object idOrig = id; // Id target class could change due to inheritance level
Persistable pc = foundPcs != null ? (Persistable)foundPcs[foundPcIdx++] : null;
DNStateManager sm = null;
if (pc != null)
{
// Object created by store plugin
sm = findStateManager(pc);
putObjectIntoLevel1Cache(sm);
}
else
{
// Object not found yet, so maybe class name is not correct inheritance level
ClassDetailsForId details = getClassDetailsForId(id, null, validate);
String className = details.className;
id = details.id;
if (details.pc != null)
{
// Found in cache from updated id
pc = details.pc;
sm = findStateManager(pc);
if (performValidationWhenCached && validate)
{
if (!api.isTransactional(pc))
{
// Mark this object for validation
smsToValidate.add(sm);
}
}
}
else
{
// Still not found so create a Hollow instance with the supplied field values
try
{
Class pcClass = clr.classForName(className, (id instanceof DatastoreId) ? null : id.getClass().getClassLoader());
if (Modifier.isAbstract(pcClass.getModifiers()))
{
// This class is abstract so impossible to have an instance of this type
throw new NucleusObjectNotFoundException(Localiser.msg("010027", IdentityUtils.getPersistableIdentityForId(id), className));
}
sm = nucCtx.getStateManagerFactory().newForHollow(this, pcClass, id);
pc = (Persistable) sm.getObject();
if (!validate)
{
// Mark StateManager as needing to validate this object before loading fields
sm.markForInheritanceValidation();
}
putObjectIntoLevel1Cache(sm); // Cache it in case we have bidir relations
}
catch (ClassNotResolvedException e)
{
NucleusLogger.PERSISTENCE.warn(Localiser.msg("010027", IdentityUtils.getPersistableIdentityForId(id)));
throw new NucleusUserException(Localiser.msg("010027", IdentityUtils.getPersistableIdentityForId(id)), e);
}
if (validate)
{
// Mark this object for validation
smsToValidate.add(sm);
}
}
}
// Put in map under input id, so we find it later
pcById.put(idOrig, pc);
}
if (!smsToValidate.isEmpty())
{
// Validate the objects that need it
try
{
getStoreManager().getPersistenceHandler().locateObjects(smsToValidate.toArray(new DNStateManager[smsToValidate.size()]));
}
catch (NucleusObjectNotFoundException nonfe)
{
NucleusObjectNotFoundException[] nonfes = (NucleusObjectNotFoundException[]) nonfe.getNestedExceptions();
if (nonfes != null)
{
for (int i=0;i cmds = getMetaDataManager().getClassMetaDataWithApplicationId(id.getClass().getName());
if (cmds != null && cmds.size() == 1)
{
// Only 1 possible class using this id type, so return it
return cmds.iterator().next().getFullClassName();
}
}
if (className != null)
{
String[] subclasses = getMetaDataManager().getConcreteSubclassesForClass(className);
int numConcrete = 0;
String concreteClassName = null;
if (subclasses != null && subclasses.length > 0)
{
numConcrete = subclasses.length;
concreteClassName = subclasses[0];
}
Class rootCls = clr.classForName(className);
if (!Modifier.isAbstract(rootCls.getModifiers()))
{
concreteClassName = className;
numConcrete++;
}
if (numConcrete == 1)
{
// Single possible concrete class, so return it
return concreteClassName;
}
}
// If we have multiple possible classes then refer to the datastore to resolve it
return getStoreManager().getClassNameForObjectID(id, clr, this);
}
/**
* This method returns an object id instance corresponding to the pcClass and key arguments.
* Operates in 2 modes :-
*
* The class uses SingleFieldIdentity and the key is the value of the key field
* In all other cases the key is the String form of the object id instance
*
* @param pcClass Class of the persistable object to create the identity for
* @param key Value of the key for SingleFieldIdentity (or the toString value)
* @return The new object-id instance
*/
public Object newObjectId(Class pcClass, Object key)
{
if (pcClass == null)
{
throw new NucleusUserException(Localiser.msg("010028"));
}
assertClassPersistable(pcClass);
AbstractClassMetaData cmd = getMetaDataManager().getMetaDataForClass(pcClass, clr);
if (cmd == null)
{
throw new NoPersistenceInformationException(pcClass.getName());
}
// If the class is not yet managed, manage it
if (!getStoreManager().managesClass(cmd.getFullClassName()))
{
getStoreManager().manageClasses(clr, cmd.getFullClassName());
}
IdentityKeyTranslator translator = getNucleusContext().getIdentityManager().getIdentityKeyTranslator();
if (translator != null)
{
// Use the provided translator to convert it
key = translator.getKey(this, pcClass, key);
}
Object id = null;
if (cmd.usesSingleFieldIdentityClass())
{
// Single Field Identity
if (getBooleanProperty(PropertyNames.PROPERTY_FIND_OBJECT_TYPE_CONVERSION) && translator == null && !key.getClass().getName().equals(cmd.getObjectidClass()))
{
// key provided is intended to be the type of the PK member, so provide convenience type conversion to the actual type required
AbstractMemberMetaData mmd = cmd.getMetaDataForMember(cmd.getPrimaryKeyMemberNames()[0]);
if (!mmd.getType().isAssignableFrom(key.getClass()))
{
Object convKey = TypeConversionHelper.convertTo(key, mmd.getType());
if (convKey != null)
{
key = convKey;
}
}
}
id = nucCtx.getIdentityManager().getSingleFieldId(clr.classForName(cmd.getObjectidClass()), pcClass, key);
}
else if (key instanceof java.lang.String)
{
// String-based PK (datastore identity or application identity)
if (cmd.getIdentityType() == IdentityType.APPLICATION)
{
if (Modifier.isAbstract(pcClass.getModifiers()) && cmd.getObjectidClass() != null)
{
try
{
id = ClassUtils.newInstance(clr.classForName(cmd.getObjectidClass()), new Class[] {java.lang.String.class}, new Object[] {(String)key});
}
catch(Exception e)
{
String msg = Localiser.msg("010030", cmd.getObjectidClass(), cmd.getFullClassName());
NucleusLogger.PERSISTENCE.error(msg, e);
throw new NucleusUserException(msg);
}
}
else
{
clr.classForName(pcClass.getName(), true);
id = nucCtx.getIdentityManager().getApplicationId(pcClass, key);
}
}
else
{
id = nucCtx.getIdentityManager().getDatastoreId((String)key);
}
}
else if (cmd.getIdentityType() == IdentityType.DATASTORE && (key instanceof Number))
{
// Assume that the user called newObjectId passing in a numeric surrogate field value
id = nucCtx.getIdentityManager().getDatastoreId(pcClass.getName(), key);
}
else
{
// Key is not a string, and is not SingleFieldIdentity
throw new NucleusUserException(Localiser.msg("010029", pcClass.getName(), key.getClass().getName()));
}
return id;
}
/**
* This method returns an object id instance corresponding to the class name, and the passed
* object (when using app identity).
* @param className Name of the class of the object.
* @param pc The persistable object. Used for application-identity
* @return A new object ID.
*/
public Object newObjectId(String className, Object pc)
{
AbstractClassMetaData cmd = getMetaDataManager().getMetaDataForClass(className, clr);
if (cmd.getIdentityType() == IdentityType.DATASTORE)
{
// Populate any strategy value for the "datastore-identity" element
return nucCtx.getIdentityManager().getDatastoreId(cmd.getFullClassName(), getStoreManager().getValueGenerationStrategyValue(this, cmd, null));
}
else if (cmd.getIdentityType() == IdentityType.APPLICATION)
{
return nucCtx.getIdentityManager().getApplicationId(pc, cmd); // All values will have been populated before arriving here
}
else
{
// All "nondurable" cases (e.g views) will come through here
return new SCOID(className);
}
}
/**
* Method to clear an object from the list of dirty objects.
* @param sm StateManager
*/
public void clearDirty(DNStateManager sm)
{
dirtySMs.remove(sm);
indirectDirtySMs.remove(sm);
}
/**
* Method to clear all objects marked as dirty (whether directly or indirectly).
*/
public void clearDirty()
{
dirtySMs.clear();
indirectDirtySMs.clear();
}
/**
* Method to mark an object (StateManager) as dirty.
* @param sm StateManager
* @param directUpdate Whether the object has had a direct update made on it (if known)
*/
public void markDirty(DNStateManager sm, boolean directUpdate)
{
if (sm.isEmbedded())
{
// We don't monitor embedded StateManagers for flushing, they are handled via their owner
return;
}
if (tx.isCommitting() && !tx.isActive())
{
//post commit cannot change objects (sanity check - avoid changing avoids on detach)
throw new NucleusException("Cannot change objects when transaction is no longer active.");
}
boolean isInDirty = dirtySMs.contains(sm);
boolean isInIndirectDirty = indirectDirtySMs.contains(sm);
if (!isDelayDatastoreOperationsEnabled() && !isInDirty && !isInIndirectDirty &&
dirtySMs.size() >= getNucleusContext().getConfiguration().getIntProperty(PropertyNames.PROPERTY_FLUSH_AUTO_OBJECT_LIMIT))
{
// Reached flush limit so flush
flushInternal(false);
}
if (directUpdate)
{
if (isInIndirectDirty)
{
indirectDirtySMs.remove(sm);
dirtySMs.add(sm);
}
else if (!isInDirty)
{
dirtySMs.add(sm);
if (l2CacheTxIds != null && nucCtx.isClassCacheable(sm.getClassMetaData()))
{
l2CacheTxIds.add(sm.getInternalObjectId());
}
}
}
else
{
if (!isInDirty && !isInIndirectDirty)
{
// Register as an indirect dirty
indirectDirtySMs.add(sm);
if (l2CacheTxIds != null && nucCtx.isClassCacheable(sm.getClassMetaData()))
{
l2CacheTxIds.add(sm.getInternalObjectId());
}
}
}
}
/**
* Accessor for whether to manage relationships at flush/commit.
* @return Whether to manage relationships at flush/commit.
*/
public boolean getManageRelations()
{
return managedRelationsHandler != null;
}
/**
* Method to return the RelationshipManager for StateManager.
* If we are currently managing relations and StateManager has no RelationshipManager allocated then one is created.
* @param sm StateManager
* @return The RelationshipManager
*/
public RelationshipManager getRelationshipManager(DNStateManager sm)
{
return managedRelationsHandler != null ? managedRelationsHandler.getRelationshipManagerForStateManager(sm) : null;
}
/**
* Returns whether this context is currently performing the manage relationships task.
* @return Whether in the process of managing relations
*/
public boolean isManagingRelations()
{
return (managedRelationsHandler != null) ? managedRelationsHandler.isExecuting() : false;
}
/**
* Convenience method to inspect the list of objects with outstanding changes to flush.
* @return StateManagers for the objects to be flushed.
*/
public List getObjectsToBeFlushed()
{
List sms = new ArrayList<>();
sms.addAll(dirtySMs);
sms.addAll(indirectDirtySMs);
return sms;
}
/**
* Returns whether the context is in the process of flushing.
* @return true if the context is flushing
*/
public boolean isFlushing()
{
return flushing > 0;
}
/**
* Method callable from external APIs for user-management of flushing.
* Called by JDO PM.flush, or JPA EM.flush().
* Performs management of relations, prior to performing internal flush of all dirty/new/deleted instances to the datastore.
*/
public void flush()
{
if (tx.isActive())
{
// Managed Relationships
if (managedRelationsHandler != null)
{
managedRelationsHandler.execute();
}
// Perform internal flush
flushInternal(true);
if (!dirtySMs.isEmpty() || !indirectDirtySMs.isEmpty())
{
// If the flush caused the attach of an object it can get registered as dirty, so do second pass
NucleusLogger.PERSISTENCE.debug("Flush pass 1 resulted in " + (dirtySMs.size() + indirectDirtySMs.size()) + " additional objects being made dirty. Performing flush pass 2");
flushInternal(true);
}
if (operationQueue != null && !operationQueue.getOperations().isEmpty())
{
NucleusLogger.PERSISTENCE.warn("Queue of operations after flush() is not empty! Generate a testcase and report this. See below (debug) for full details of unflushed ops");
operationQueue.log();
}
}
}
/**
* This method flushes all dirty, new, and deleted instances to the datastore.
* @param flushToDatastore Whether to ensure any changes reach the datastore
* Otherwise they will be flushed to the datastore manager and leave it to
* decide the opportune moment to actually flush them to the datastore
* @throws NucleusOptimisticException when optimistic locking error(s) occur
*/
public void flushInternal(boolean flushToDatastore)
{
if (!flushToDatastore && dirtySMs.isEmpty() && indirectDirtySMs.isEmpty())
{
// Nothing to flush so abort now
return;
}
if (!tx.isActive())
{
// Non transactional flush, so store the ids for later
if (nontxProcessedSMs == null)
{
nontxProcessedSMs = new HashSet<>();
}
nontxProcessedSMs.addAll(dirtySMs);
nontxProcessedSMs.addAll(indirectDirtySMs);
}
flushing++;
try
{
if (flushToDatastore)
{
// Make sure flushes its changes to the datastore
tx.preFlush();
}
// Retrieve the appropriate flush process, and execute it
FlushProcess flusher = getStoreManager().getFlushProcess();
List optimisticFailures = flusher.execute(this, dirtySMs, indirectDirtySMs, operationQueue);
if (flushToDatastore)
{
// Make sure flushes its changes to the datastore
tx.flush();
}
if (optimisticFailures != null)
{
// Throw a single NucleusOptimisticException containing all optimistic failures
throw new NucleusOptimisticException(Localiser.msg("010031"), optimisticFailures.toArray(new Throwable[optimisticFailures.size()]));
}
}
finally
{
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
NucleusLogger.PERSISTENCE.debug(Localiser.msg("010004"));
}
flushing--;
}
}
/* (non-Javadoc)
* @see org.datanucleus.ExecutionContext#getOperationQueue()
*/
public OperationQueue getOperationQueue()
{
return operationQueue;
}
/* (non-Javadoc)
* @see org.datanucleus.ExecutionContext#addOperationToQueue(org.datanucleus.flush.Operation)
*/
public void addOperationToQueue(Operation oper)
{
if (operationQueue == null)
{
operationQueue = new OperationQueue();
}
operationQueue.enqueue(oper);
}
/* (non-Javadoc)
* @see org.datanucleus.ExecutionContext#flushSCOOperationsForBackingStore(org.datanucleus.store.scostore.Store, org.datanucleus.state.DNStateManager)
*/
public void flushOperationsForBackingStore(Store backingStore, DNStateManager sm)
{
if (operationQueue != null)
{
// TODO Remove this when core-50 is implemented, and process operationQueue in flush()
operationQueue.performAll(backingStore, sm);
}
}
/* (non-Javadoc)
* @see org.datanucleus.ExecutionContext#operationQueueIsActive()
*/
@Override
public boolean operationQueueIsActive()
{
return isDelayDatastoreOperationsEnabled() && !isFlushing() && getTransaction().isActive();
}
/**
* Method to perform any post-begin checks.
*/
public void postBegin()
{
DNStateManager[] sms = dirtySMs.toArray(new DNStateManager[dirtySMs.size()]);
for (int i=0; i cachedSMs = new HashSet<>(cache.values());
for (DNStateManager cachedSM : cachedSMs)
{
LockMode lockMode = getLockManager().getLockMode(cachedSM);
if (cachedSM != null && cachedSM.isFlushedToDatastore() && cachedSM.getClassMetaData().isVersioned() &&
(lockMode == LockMode.LOCK_OPTIMISTIC_WRITE || lockMode == LockMode.LOCK_PESSIMISTIC_WRITE))
{
// Not dirty, but locking requires a version update, so force it
VersionMetaData vermd = cachedSM.getClassMetaData().getVersionMetaDataForClass();
if (vermd != null)
{
if (vermd.getMemberName() != null)
{
cachedSM.makeDirty((Persistable) cachedSM.getObject(), vermd.getMemberName());
dirtySMs.add(cachedSM);
}
else
{
// TODO Cater for surrogate version
NucleusLogger.PERSISTENCE.warn("We do not support forced version update with surrogate version columns : " + cachedSM);
}
}
}
}
}
// Make sure all is flushed before we start
flush();
if (pbrAtCommitHandler != null)
{
// Persistence-by-reachability at commit
try
{
pbrAtCommitHandler.execute();
}
catch (Throwable t)
{
NucleusLogger.PERSISTENCE.error(t);
if (t instanceof NucleusException)
{
throw (NucleusException) t;
}
throw new NucleusException("Unexpected error during precommit",t);
}
}
if (l2CacheEnabled)
{
// L2 caching of enlisted objects
performLevel2CacheUpdateAtCommit();
}
if (properties.getFrequentProperties().getDetachAllOnCommit())
{
// "detach-on-commit"
performDetachAllOnTxnEndPreparation();
}
}
/**
* Accessor for whether the object with this identity is modified in the current transaction.
* Only returns true when using the L2 cache and the object has been modified during the txn.
* @param id The identity
* @return Whether it is modified/new/deleted in this transaction
*/
public boolean isObjectModifiedInTransaction(Object id)
{
if (l2CacheTxIds != null)
{
return l2CacheTxIds.contains(id);
}
return false;
}
/* (non-Javadoc)
* @see org.datanucleus.ExecutionContext#markFieldsForUpdateInLevel2Cache(java.lang.Object, boolean[])
*/
public void markFieldsForUpdateInLevel2Cache(Object id, boolean[] fields)
{
if (l2CacheTxFieldsToUpdateById == null)
{
return;
}
BitSet bits = l2CacheTxFieldsToUpdateById.get(id);
if (bits == null)
{
bits = new BitSet();
l2CacheTxFieldsToUpdateById.put(id, bits);
}
for (int i=0;i
* Any objects modified during the current transaction will be added/updated in the L2 cache.
* Any objects that aren't modified but have been enlisted will be added to the L2 cache.
* Any objects that are modified but no longer enlisted (due to garbage collection) will be
* removed from the L2 cache (to avoid giving out old data).
*
*/
private void performLevel2CacheUpdateAtCommit()
{
if (l2CacheTxIds == null)
{
return;
}
String cacheStoreMode = getLevel2CacheStoreMode();
if ("bypass".equalsIgnoreCase(cacheStoreMode))
{
// L2 cache storage turned off right now
return;
}
// Process all modified objects adding/updating/removing from L2 cache as appropriate
Set smsToCache = null;
Set idsToRemove = null;
for (Object id : l2CacheTxIds)
{
DNStateManager sm = enlistedSMCache.get(id);
if (sm == null)
{
// Modified object either no longer enlisted (GCed) OR is an embedded object without own identity. Remove from L2 if present
if (NucleusLogger.CACHE.isDebugEnabled())
{
if (nucCtx.getLevel2Cache().containsOid(id))
{
NucleusLogger.CACHE.debug(Localiser.msg("004014", IdentityUtils.getPersistableIdentityForId(id)));
}
}
if (idsToRemove == null)
{
idsToRemove = new HashSet();
}
idsToRemove.add(id);
}
else
{
// Modified object still enlisted so cacheable
Object obj = sm.getObject();
Object objID = getApiAdapter().getIdForObject(obj);
if (objID == null || objID instanceof IdentityReference)
{
// Must be embedded
}
else if (getApiAdapter().isDeleted(obj))
{
// Object has been deleted so remove from L2 cache
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("004007", IdentityUtils.getPersistableIdentityForId(sm.getInternalObjectId())));
}
if (idsToRemove == null)
{
idsToRemove = new HashSet();
}
idsToRemove.add(objID);
}
else if (!getApiAdapter().isDetached(obj))
{
// Object has been added/modified so update in L2 cache
if (smsToCache == null)
{
smsToCache = new HashSet<>();
}
smsToCache.add(sm);
if (l2CacheObjectsToEvictUponRollback == null)
{
l2CacheObjectsToEvictUponRollback = new LinkedList();
}
l2CacheObjectsToEvictUponRollback.add(id);
}
}
}
if (idsToRemove != null && !idsToRemove.isEmpty())
{
// Bulk evict from L2 cache
nucCtx.getLevel2Cache().evictAll(idsToRemove);
}
if (smsToCache != null && !smsToCache.isEmpty())
{
// Bulk put into L2 cache of required StateManagers
putObjectsIntoLevel2Cache(smsToCache);
}
l2CacheTxIds.clear();
l2CacheTxFieldsToUpdateById.clear();
}
/**
* Method to perform all necessary preparation for detach-all-on-commit/detach-all-on-rollback.
* Identifies all objects affected and makes sure that all fetch plan fields are loaded.
*/
private void performDetachAllOnTxnEndPreparation()
{
// JDO spec 12.7.3 "Root instances"
// "Root instances are parameter instances for retrieve, detachCopy, and refresh; result
// instances for queries. Root instances for DetachAllOnCommit are defined explicitly by
// the user via the FetchPlan property DetachmentRoots or DetachmentRootClasses.
// If not set explicitly, the detachment roots consist of the union of all root instances of
// methods executed since the last commit or rollback."
Collection sms = new ArrayList<>();
Collection roots = fetchPlan.getDetachmentRoots();
Class[] rootClasses = fetchPlan.getDetachmentRootClasses();
if (roots != null && !roots.isEmpty())
{
// Detachment roots specified
for (Object root : roots)
{
sms.add(findStateManager(root));
}
}
else if (rootClasses != null && rootClasses.length > 0)
{
// Detachment root classes specified
DNStateManager[] txSMs = enlistedSMCache.values().toArray(new DNStateManager[enlistedSMCache.size()]);
for (int i=0;i smsIter = sms.iterator();
while (smsIter.hasNext())
{
DNStateManager sm = smsIter.next();
Object pc = sm!=null ? sm.getObject() : null;
if (pc != null && !getApiAdapter().isDetached(pc) && !getApiAdapter().isDeleted(pc))
{
// Load all fields (and sub-objects) in the FetchPlan
FetchPlanState state = new FetchPlanState();
try
{
sm.loadFieldsInFetchPlan(state);
}
catch (NucleusObjectNotFoundException onfe)
{
// This object doesnt exist in the datastore at this point.
// Either the user has some other process that has deleted it or they have
// defined datastore based cascade delete and it has been deleted that way
NucleusLogger.PERSISTENCE.warn(Localiser.msg("010013", StringUtils.toJVMIDString(pc), sm.getInternalObjectId()));
smsIter.remove();
// TODO Move the object state to P_DELETED for consistency
}
}
}
detachAllOnTxnEndSMs = sms.toArray(new DNStateManager[sms.size()]);
}
/**
* Method to perform detach-all-on-commit, using the data identified by
* performDetachAllOnCommitPreparation().
*/
private void performDetachAllOnTxnEnd()
{
try
{
runningDetachAllOnTxnEnd = true;
if (detachAllOnTxnEndSMs != null)
{
// Detach all detachment root objects (causes recursion through the fetch plan)
DNStateManager[] smsToDetach = detachAllOnTxnEndSMs;
DetachState state = new DetachState(getApiAdapter());
for (int i=0;i failures = null;
try
{
for (DNStateManager sm : enlistedSMCache.values())
{
try
{
sm.preRollback(getTransaction());
}
catch (RuntimeException e)
{
if (failures == null)
{
failures = new ArrayList();
}
failures.add(e);
}
}
clearDirty();
}
finally
{
resetTransactionalVariables();
}
if (failures != null && !failures.isEmpty())
{
throw new RollbackStateTransitionException(failures.toArray(new Exception[failures.size()]));
}
if (getBooleanProperty(PropertyNames.PROPERTY_DETACH_ALL_ON_ROLLBACK))
{
// "detach-on-rollback"
performDetachAllOnTxnEndPreparation();
}
}
/**
* Callback invoked after the actual datastore rollback.
*/
public void postRollback()
{
if (getBooleanProperty(PropertyNames.PROPERTY_DETACH_ALL_ON_ROLLBACK))
{
// "detach-on-rollback"
performDetachAllOnTxnEnd();
}
if (l2CacheObjectsToEvictUponRollback != null)
{
nucCtx.getLevel2Cache().evictAll(l2CacheObjectsToEvictUponRollback);
l2CacheObjectsToEvictUponRollback = null;
}
}
/**
* Convenience method to reset all state variables for the transaction, performed at commit/rollback.
*/
private void resetTransactionalVariables()
{
if (pbrAtCommitHandler != null)
{
pbrAtCommitHandler.clear();
}
enlistedSMCache.clear();
dirtySMs.clear();
indirectDirtySMs.clear();
fetchPlan.resetDetachmentRoots();
if (managedRelationsHandler != null)
{
managedRelationsHandler.clear();
}
// L2 cache processing
if (l2CacheTxIds != null)
{
l2CacheTxIds.clear();
}
if (l2CacheTxFieldsToUpdateById != null)
{
l2CacheTxFieldsToUpdateById.clear();
}
if (operationQueue != null)
{
operationQueue.clear();
}
smAttachDetachObjectReferenceMap = null;
// Clear any locking requirements
lockMgr.clear();
}
// -------------------------------------- Cache Management ---------------------------------------
protected String getLevel2CacheRetrieveMode()
{
return properties.getFrequentProperties().getLevel2CacheRetrieveMode();
}
protected String getLevel2CacheStoreMode()
{
return properties.getFrequentProperties().getLevel2CacheStoreMode();
}
/**
* Convenience method to add an object to the L1 cache.
* @param sm StateManager
*/
public void putObjectIntoLevel1Cache(DNStateManager sm)
{
if (cache == null)
{
return;
}
if (sm.isEmbedded())
{
NucleusLogger.PERSISTENCE.warn("Attempt to L1 cache an embedded object! How did this occur? Trying to use an object as embedded yet also independently persistable? : " + sm, new Exception());
return;
}
Object id = sm.getInternalObjectId();
if (id == null || sm.getObject() == null)
{
NucleusLogger.CACHE.warn(Localiser.msg("003006"));
return;
}
// TODO This creates problem in JPA1 TCK entityTest.oneXmany.test3 Investigate it
/* if (cache.containsKey(id))
{
// Id already has an object in the L1 cache, so no need to update
// Note : can only have a single object with a particular id for an ExecutionContext
return;
}*/
if (sm.getClassMetaData().getUniqueMetaData() != null)
{
// Check for any unique keys on this object, and cache against the unique key also
List unimds = sm.getClassMetaData().getUniqueMetaData();
if (unimds != null && !unimds.isEmpty())
{
for (UniqueMetaData unimd : unimds)
{
CacheUniqueKey uniKey = getCacheUniqueKeyForStateManager(sm, unimd);
if (uniKey != null)
{
cache.putUnique(uniKey, sm);
}
}
}
}
// Put into Level 1 Cache
DNStateManager oldSM = cache.put(id, sm);
if (NucleusLogger.CACHE.isDebugEnabled())
{
if (oldSM == null)
{
NucleusLogger.CACHE.debug(Localiser.msg("003004", IdentityUtils.getPersistableIdentityForId(id), StringUtils.booleanArrayToString(sm.getLoadedFields())));
}
else if (oldSM != sm)
{
NucleusLogger.CACHE.debug(Localiser.msg("003005", IdentityUtils.getPersistableIdentityForId(id), StringUtils.booleanArrayToString(sm.getLoadedFields())));
}
}
}
/**
* Method to return a CacheUniqueKey to use when caching the object managed by the supplied StateManager for the specified unique key.
* @param sm StateManager
* @param unimd The unique key that this key will relate to
* @return The CacheUniqueKey, or null if any member of the unique key is null, or if the unique key is not defined on members
*/
private CacheUniqueKey getCacheUniqueKeyForStateManager(DNStateManager sm, UniqueMetaData unimd)
{
boolean nonNullMembers = true;
if (unimd.getNumberOfMembers() > 0)
{
Object[] fieldVals = new Object[unimd.getNumberOfMembers()];
for (int i=0;i= 0 && !fieldsToUpdateBitSet.get(versionFieldNum))
{
// Version is stored in a field, so make sure the field is also updated
fieldsToUpdateBitSet.set(versionFieldNum);
}
int num = 0;
for (int i=0;i sms)
{
int batchSize = nucCtx.getConfiguration().getIntProperty(PropertyNames.PROPERTY_CACHE_L2_BATCHSIZE);
Level2Cache l2Cache = nucCtx.getLevel2Cache();
Map dataToUpdate = new HashMap<>();
Map dataUniqueToUpdate = new HashMap<>();
for (DNStateManager sm : sms)
{
Object id = sm.getInternalObjectId();
if (id == null || !nucCtx.isClassCacheable(sm.getClassMetaData()))
{
continue;
}
CachedPC currentCachedPC = l2Cache.get(id);
CachedPC cachedPC = getL2CacheableObject(sm, currentCachedPC);
if (cachedPC != null && !(id instanceof IdentityReference))
{
// Only cache if something to be cached and has identity
dataToUpdate.put(id, cachedPC);
if (dataToUpdate.size() == batchSize)
{
// Put this batch of objects in the L2 cache
l2Cache.putAll(dataToUpdate);
dataToUpdate.clear();
}
}
if (sm.getClassMetaData().getUniqueMetaData() != null)
{
// Check for any unique keys on this object, and cache against the unique key also
List unimds = sm.getClassMetaData().getUniqueMetaData();
if (unimds != null && !unimds.isEmpty())
{
for (UniqueMetaData unimd : unimds)
{
CacheUniqueKey uniKey = getCacheUniqueKeyForStateManager(sm, unimd);
if (uniKey != null)
{
dataUniqueToUpdate.put(uniKey, cachedPC);
if (dataUniqueToUpdate.size() == batchSize)
{
// Put this batch of unique keyed objects in the L2 cache
l2Cache.putUniqueAll(dataUniqueToUpdate);
dataUniqueToUpdate.clear();
}
}
}
}
}
}
// Put all remaining objects
if (!dataToUpdate.isEmpty())
{
l2Cache.putAll(dataToUpdate);
dataToUpdate.clear();
}
if (!dataUniqueToUpdate.isEmpty())
{
l2Cache.putUniqueAll(dataUniqueToUpdate);
dataUniqueToUpdate.clear();
}
}
/**
* Convenience method to add/update an object in the L2 cache.
* @param sm StateManager of the object to add.
* @param updateIfPresent Whether to update the L2 cache if it is present
*/
protected void putObjectIntoLevel2CacheInternal(DNStateManager sm, boolean updateIfPresent)
{
Object id = sm.getInternalObjectId();
if (id == null || id instanceof IdentityReference)
{
return;
}
Level2Cache l2Cache = nucCtx.getLevel2Cache();
if (!updateIfPresent && l2Cache.containsOid(id))
{
// Already present and not wanting to update
return;
}
CachedPC currentCachedPC = l2Cache.get(id);
CachedPC cachedPC = getL2CacheableObject(sm, currentCachedPC);
if (cachedPC != null)
{
l2Cache.put(id, cachedPC);
}
if (sm.getClassMetaData().getUniqueMetaData() != null)
{
// Cache against any unique keys defined for this object
List unimds = sm.getClassMetaData().getUniqueMetaData();
if (unimds != null && !unimds.isEmpty())
{
for (UniqueMetaData unimd : unimds)
{
CacheUniqueKey uniKey = getCacheUniqueKeyForStateManager(sm, unimd);
if (uniKey != null)
{
l2Cache.putUnique(uniKey, cachedPC);
}
}
}
}
}
/**
* Convenience method to evict an object from the L1 cache.
* @param id The Persistable object id
*/
public void removeObjectFromLevel1Cache(Object id)
{
if (id != null && cache != null)
{
Object pcRemoved = cache.remove(id);
if (pcRemoved != null && NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("003009", IdentityUtils.getPersistableIdentityForId(id)));
}
}
}
/**
* Convenience method to remove the object with the specified identity from the L2 cache.
* @param id Identity of the object
*/
public void removeObjectFromLevel2Cache(Object id)
{
if (id != null && !(id instanceof IdentityReference))
{
Level2Cache l2Cache = nucCtx.getLevel2Cache();
if (l2Cache.containsOid(id))
{
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("004016", id));
}
l2Cache.evict(id);
}
}
}
/**
* Whether the specified identity is cached currently. Looks in L1 cache and L2 cache.
* @param id The identity
* @return Whether an object exists in the cache(s) with this identity
*/
public boolean hasIdentityInCache(Object id)
{
// Try Level 1 first
if (cache != null && cache.containsKey(id))
{
return true;
}
// Try Level 2 since not in Level 1
if (l2CacheEnabled)
{
Level2Cache l2Cache = nucCtx.getLevel2Cache();
if (l2Cache.containsOid(id))
{
return true;
}
}
return false;
}
/**
* Convenience method to access an object in the cache.
* Firstly looks in the L1 cache for this context, and if not found looks in the L2 cache.
* @param id Id of the object
* @return Persistable object (with connected StateManager).
*/
public Persistable getObjectFromCache(Object id)
{
// Try Level 1 first
Persistable pc = getObjectFromLevel1Cache(id);
if (pc != null)
{
return pc;
}
if (id instanceof SCOID)
{
return null;
}
// Try Level 2 since not in Level 1
return getObjectFromLevel2Cache(id);
}
/**
* Convenience method to access objects in the cache.
* Firstly looks in the L1 cache for this context, and if not found looks in the L2 cache.
* @param ids Ids of the objects
* @return Persistable objects (with connected StateManagers), or null.
*/
public Persistable[] getObjectsFromCache(Object[] ids)
{
if (ids == null || ids.length == 0)
{
return null;
}
Persistable[] objs = new Persistable[ids.length];
// Try L1 cache
Collection idsNotFound = new HashSet();
for (int i=0;i l2ObjsById = getObjectsFromLevel2Cache(idsNotFound);
for (int i=0;i getObjectsFromLevel2Cache(Collection ids)
{
if (l2CacheEnabled)
{
// TODO Restrict to only those ids that are cacheable
Level2Cache l2Cache = nucCtx.getLevel2Cache();
Map cachedPCs = l2Cache.getAll(ids);
Map pcsById = new HashMap(cachedPCs.size());
for (Map.Entry entry : cachedPCs.entrySet())
{
Object id = entry.getKey();
CachedPC cachedPC = entry.getValue();
if (cachedPC != null)
{
// Create active version of cached object with StateManager connected and same id
DNStateManager sm = nucCtx.getStateManagerFactory().newForCachedPC(this, id, cachedPC);
Persistable pc = (Persistable)sm.getObject(); // Object in P_CLEAN state
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("004006", IdentityUtils.getPersistableIdentityForId(id),
StringUtils.intArrayToString(cachedPC.getLoadedFieldNumbers()), cachedPC.getVersion(), StringUtils.toJVMIDString(pc)));
}
if (tx.isActive() && tx.getOptimistic())
{
// Optimistic txns, so return as P_NONTRANS (as per JDO spec)
sm.makeNontransactional();
}
else if (!tx.isActive() && getApiAdapter().isTransactional(pc))
{
// Non-tx context, so return as P_NONTRANS (as per JDO spec)
sm.makeNontransactional();
}
pcsById.put(id, pc);
}
else
{
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("004005", IdentityUtils.getPersistableIdentityForId(id)));
}
}
}
return pcsById;
}
return null;
}
/**
* Replace the previous object id for a persistable object with a new one.
* This is used where we have already added the object to the cache(s) and/or enlisted it in the txn before its real identity was fixed (attributed in the datastore).
* @param pc The Persistable object
* @param oldID the old id it was known by
* @param newID the new id
*/
public void replaceObjectId(Persistable pc, Object oldID, Object newID)
{
if (pc == null || newID == null)
{
NucleusLogger.CACHE.warn(Localiser.msg("003006"));
return;
}
DNStateManager sm = findStateManager(pc);
// Update L1 cache
if (cache != null)
{
if (oldID != null)
{
Object o = cache.get(oldID); //use get() because a cache.remove operation returns a weakReference instance
if (o != null)
{
// Remove the old variant
if (NucleusLogger.CACHE.isDebugEnabled())
{
NucleusLogger.CACHE.debug(Localiser.msg("003012", IdentityUtils.getPersistableIdentityForId(oldID), IdentityUtils.getPersistableIdentityForId(newID)));
}
cache.remove(oldID);
}
}
if (sm != null)
{
putObjectIntoLevel1Cache(sm);
}
}
if (oldID != null && enlistedSMCache.get(oldID) != null)
{
// Swap the enlisted object identity
if (sm != null)
{
enlistedSMCache.remove(oldID);
enlistedSMCache.put(newID, sm);
if (NucleusLogger.TRANSACTION.isDebugEnabled())
{
NucleusLogger.TRANSACTION.debug(Localiser.msg("015018", IdentityUtils.getPersistableIdentityForId(oldID), IdentityUtils.getPersistableIdentityForId(newID)));
}
}
}
if (oldID != null && l2CacheTxIds != null)
{
if (l2CacheTxIds.contains(oldID))
{
l2CacheTxIds.remove(oldID);
l2CacheTxIds.add(newID);
}
}
if (oldID != null && pbrAtCommitHandler != null && tx.isActive())
{
pbrAtCommitHandler.swapObjectId(oldID, newID);
}
}
/**
* Convenience method to return the setting for serialize read for the current transaction for
* the specified class name. Returns the setting for the transaction (if set), otherwise falls back to
* the setting for the class, otherwise returns false.
* @param className Name of the class
* @return Setting for serialize read
*/
public boolean getSerializeReadForClass(String className)
{
if (tx.isActive() && tx.getSerializeRead() != null)
{
// Within a transaction, and serializeRead set for txn
return tx.getSerializeRead();
}
Boolean serialiseRead = getBooleanProperty(PropertyNames.PROPERTY_SERIALIZE_READ);
if (serialiseRead != null)
{
if (serialiseRead == Boolean.TRUE)
{
// Globally ON TODO Should we allow a class to override the default ON
return serialiseRead;
}
else
{
// Globally OFF
if (className != null)
{
// Set for the class
AbstractClassMetaData cmd = getMetaDataManager().getMetaDataForClass(className, clr);
if (cmd != null)
{
return cmd.isSerializeRead();
}
}
return false;
}
}
return false;
}
// ------------------------------------- Queries/Extents --------------------------------------
/**
* Extents are collections of datastore objects managed by the datastore,
* not by explicit user operations on collections. Extent capability is a
* boolean property of classes that are persistence capable. If an instance
* of a class that has a managed extent is made persistent via reachability,
* the instance is put into the extent implicitly.
* @param pcClass The class to query
* @param subclasses Whether to include subclasses in the query.
* @return returns an Extent that contains all of the instances in the
* parameter class, and if the subclasses flag is true, all of the instances
* of the parameter class and its subclasses.
*/
public Extent getExtent(Class pcClass, boolean subclasses)
{
try
{
clr.setPrimary(pcClass.getClassLoader());
assertClassPersistable(pcClass);
return getStoreManager().getExtent(this, pcClass, subclasses);
}
finally
{
clr.unsetPrimary();
}
}
// ------------------------------------- Callback Listeners --------------------------------------
/**
* Retrieve the callback handler for this context.
* If the callback handler hasn't yet been created, this will create it.
* @return the callback handler
*/
public CallbackHandler getCallbackHandler()
{
if (callbackHandler != null)
{
return callbackHandler;
}
if (getBooleanProperty(PropertyNames.PROPERTY_ALLOW_CALLBACKS))
{
String callbackHandlerClassName = getNucleusContext().getPluginManager().getAttributeValueForExtension(
"org.datanucleus.callbackhandler", "name", getNucleusContext().getApiName(), "class-name");
if (callbackHandlerClassName != null)
{
try
{
callbackHandler = (CallbackHandler) getNucleusContext().getPluginManager().createExecutableExtension(
"org.datanucleus.callbackhandler", "name", getNucleusContext().getApiName(), "class-name",
new Class[] {ClassConstants.EXECUTION_CONTEXT}, new Object[] {this});
}
catch (Exception e)
{
NucleusLogger.PERSISTENCE.error(Localiser.msg("025000", callbackHandlerClassName, e));
}
}
}
else
{
callbackHandler = new NullCallbackHandler();
}
return callbackHandler;
}
/**
* Close the callback handler and disconnect any registered listeners.
*/
public void closeCallbackHandler()
{
if (callbackHandler != null)
{
// Clear out lifecycle listeners that were registered
callbackHandler.close();
}
}
// ------------------------------- Assert Utilities ---------------------------------
/**
* Method to assert if this context is open.
* Throws a NucleusUserException if the context is closed.
*/
protected void assertIsOpen()
{
if (isClosed())
{
throw new NucleusUserException(Localiser.msg("010002")).setFatal();
}
}
/**
* Method to assert if the specified class is Persistence Capable.
* @param cls The class to check
* @throws ClassNotPersistableException if class is not persistable
* @throws NoPersistenceInformationException if no metadata/annotations are found for class
*/
public void assertClassPersistable(Class cls)
{
if (cls == null)
{
return;
}
if (!getNucleusContext().getApiAdapter().isPersistable(cls) && !cls.isInterface())
{
throw new ClassNotPersistableException(cls.getName());
}
if (!hasPersistenceInformationForClass(cls))
{
throw new NoPersistenceInformationException(cls.getName());
}
}
/**
* Method to assert if the specified object is Detachable.
* Throws a ClassNotDetachableException if not capable
* @param object The object to check
*/
protected void assertDetachable(Object object)
{
if (object != null && !getApiAdapter().isDetachable(object))
{
throw new ClassNotDetachableException(object.getClass().getName());
}
}
/**
* Method to assert if the specified object is detached.
* Throws a ObjectDetachedException if it is detached.
* @param object The object to check
*/
protected void assertNotDetached(Object object)
{
if (object != null && getApiAdapter().isDetached(object))
{
throw new ObjectDetachedException(object.getClass().getName());
}
}
/**
* Method to assert if the current transaction is active. Throws a
* TransactionNotActiveException if not active
*/
protected void assertActiveTransaction()
{
if (!tx.isActive())
{
throw new TransactionNotActiveException();
}
}
/**
* Utility method to check if the specified class has reachable metadata or annotations.
* @param cls The class to check
* @return Whether the class has reachable metadata or annotations
*/
public boolean hasPersistenceInformationForClass(Class cls)
{
if (cls == null)
{
return false;
}
if (getMetaDataManager().getMetaDataForClass(cls, clr) != null)
{
return true;
}
if (cls.isInterface())
{
// JDO "persistent-interface"
// Try to create an implementation of the interface at runtime.
// It will register the MetaData and make an implementation available
try
{
newInstance(cls);
}
catch (RuntimeException ex)
{
NucleusLogger.PERSISTENCE.warn(ex);
}
return getMetaDataManager().getMetaDataForClass(cls, clr) != null;
}
return false;
}
// --------------------------- Fetch Groups ---------------------------------
/**
* Convenience accessor for the FetchGroupManager.
* Creates it if not yet existing.
* @return The FetchGroupManager
*/
protected FetchGroupManager getFetchGroupManager()
{
if (fetchGrpMgr == null)
{
fetchGrpMgr = new FetchGroupManager(getNucleusContext());
}
return fetchGrpMgr;
}
/**
* Method to add a dynamic FetchGroup.
* @param grp The group
*/
public void addInternalFetchGroup(FetchGroup grp)
{
getFetchGroupManager().addFetchGroup(grp);
}
/**
* Method to remove a dynamic FetchGroup.
* @param grp The group
*/
protected void removeInternalFetchGroup(FetchGroup grp)
{
if (fetchGrpMgr == null)
{
return;
}
getFetchGroupManager().removeFetchGroup(grp);
}
/**
* Accessor for an internal fetch group for the specified class.
* @param cls The class
* @param name Name of the group
* @return The FetchGroup
* @throws NucleusUserException if the class is not persistable
*/
public FetchGroup getInternalFetchGroup(Class cls, String name)
{
if (!cls.isInterface() && !getNucleusContext().getApiAdapter().isPersistable(cls))
{
// Class but not persistable!
throw new NucleusUserException("Cannot create FetchGroup for " + cls + " since it is not persistable");
}
else if (cls.isInterface() && !getNucleusContext().getMetaDataManager().isPersistentInterface(cls.getName()))
{
// Interface but not persistent
throw new NucleusUserException("Cannot create FetchGroup for " + cls + " since it is not persistable");
}
if (fetchGrpMgr == null)
{
return null;
}
return getFetchGroupManager().getFetchGroup(cls, name, true);
}
/**
* Accessor for the fetch groups for the specified name.
* @param name Name of the group
* @return The FetchGroup
*/
public Set getFetchGroupsWithName(String name)
{
if (fetchGrpMgr == null)
{
return null;
}
return getFetchGroupManager().getFetchGroupsWithName(name);
}
@Override
public EmbeddedOwnerRelation registerEmbeddedRelation(DNStateManager ownerSM, int ownerMemberNum, PersistableObjectType objectType, DNStateManager embSM)
{
EmbeddedOwnerRelation relation = new EmbeddedOwnerRelation(ownerSM, ownerMemberNum, objectType, embSM);
// Keyed by embedded
if (smEmbeddedInfoByEmbedded == null)
{
smEmbeddedInfoByEmbedded = new HashMap();
}
if (smEmbeddedInfoByEmbedded.containsKey(embSM))
{
// TODO Fix this situation
NucleusLogger.PERSISTENCE.warn("Attempt to register relation between embedded object " + embSM + " with owner " + ownerSM + " but already has an owner");
}
smEmbeddedInfoByEmbedded.put(embSM, relation);
// Keyed by owner
if (smEmbeddedInfoByOwner == null)
{
smEmbeddedInfoByOwner = new HashMap>();
}
List ownerRelations = smEmbeddedInfoByOwner.get(ownerSM);
if (ownerRelations == null)
{
ownerRelations = new ArrayList<>();
}
ownerRelations.add(relation);
smEmbeddedInfoByOwner.put(ownerSM, ownerRelations);
return relation;
}
@Override
public void deregisterEmbeddedRelation(EmbeddedOwnerRelation rel)
{
if (smEmbeddedInfoByEmbedded != null)
{
smEmbeddedInfoByEmbedded.remove(rel.getEmbeddedSM());
if (smEmbeddedInfoByEmbedded.isEmpty())
{
smEmbeddedInfoByEmbedded = null;
}
}
if (smEmbeddedInfoByOwner != null)
{
List ownerRels = smEmbeddedInfoByOwner.get(rel.getOwnerSM());
ownerRels.remove(rel);
if (ownerRels.isEmpty())
{
smEmbeddedInfoByOwner.remove(rel.getOwnerSM());
if (smEmbeddedInfoByOwner.isEmpty())
{
smEmbeddedInfoByOwner = null;
}
}
}
}
@Override
public void removeEmbeddedOwnerRelation(DNStateManager ownerSM, int ownerFieldNum, DNStateManager embSM)
{
if (smEmbeddedInfoByOwner != null)
{
List ownerRels = smEmbeddedInfoByOwner.get(ownerSM);
EmbeddedOwnerRelation rel = null;
for (EmbeddedOwnerRelation ownerRel : ownerRels)
{
if (ownerRel.getEmbeddedSM() == embSM && ownerRel.getOwnerMemberNum() == ownerFieldNum)
{
rel = ownerRel;
break;
}
}
if (rel != null)
{
deregisterEmbeddedRelation(rel);
}
}
}
@Override
public DNStateManager getOwnerForEmbeddedStateManager(DNStateManager embSM)
{
if (embSM == null || !embSM.isEmbedded() || smEmbeddedInfoByEmbedded == null || !smEmbeddedInfoByEmbedded.containsKey(embSM))
{
return null;
}
return smEmbeddedInfoByEmbedded.get(embSM).getOwnerSM();
}
@Override
public EmbeddedOwnerRelation getOwnerInformationForEmbedded(DNStateManager embSM)
{
if (embSM == null || !embSM.isEmbedded() || smEmbeddedInfoByEmbedded == null)
{
return null;
}
return smEmbeddedInfoByEmbedded.get(embSM);
}
@Override
public List getEmbeddedInformationForOwner(DNStateManager ownerSM)
{
if (smEmbeddedInfoByOwner == null)
{
return null;
}
return smEmbeddedInfoByOwner.get(ownerSM);
}
@Override
public void setStateManagerAssociatedValue(DNStateManager sm, Object key, Object value)
{
Map valueMap = null;
if (stateManagerAssociatedValuesMap == null)
{
stateManagerAssociatedValuesMap = new HashMap<>();
valueMap = new HashMap();
stateManagerAssociatedValuesMap.put(sm, valueMap);
}
else
{
valueMap = stateManagerAssociatedValuesMap.get(sm);
if (valueMap == null)
{
valueMap = new HashMap();
stateManagerAssociatedValuesMap.put(sm, valueMap);
}
}
valueMap.put(key, value);
}
@Override
public Object getStateManagerAssociatedValue(DNStateManager sm, Object key)
{
if (stateManagerAssociatedValuesMap == null)
{
return null;
}
Map valueMap = stateManagerAssociatedValuesMap.get(sm);
return valueMap == null ? null : valueMap.get(key);
}
@Override
public void removeStateManagerAssociatedValue(DNStateManager sm, Object key)
{
if (stateManagerAssociatedValuesMap != null)
{
Map valueMap = stateManagerAssociatedValuesMap.get(sm);
if (valueMap != null)
{
valueMap.remove(key);
}
}
}
@Override
public boolean containsStateManagerAssociatedValue(DNStateManager sm, Object key)
{
if (stateManagerAssociatedValuesMap != null && stateManagerAssociatedValuesMap.containsKey(sm))
{
return stateManagerAssociatedValuesMap.get(sm).containsKey(key);
}
return false;
}
/**
* Callback handler that does nothing. Provided for the case where the user wants to do bulk operations and isn't interested in callbacks.
*/
public static class NullCallbackHandler implements CallbackHandler
{
public void setBeanValidationHandler(BeanValidationHandler handler)
{
}
public void addListener(Object listener, Class[] classes)
{
}
public void removeListener(Object listener)
{
}
public void close()
{
}
}
}
