org.eclipse.persistence.internal.sessions.remote

Class RemoteUnitOfWork

java.lang.Object

org.eclipse.persistence.internal.sessions.AbstractSession

org.eclipse.persistence.internal.sessions.UnitOfWorkImpl

org.eclipse.persistence.internal.sessions.remote.RemoteUnitOfWork

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, CommandProcessor, Session, UnitOfWork

public class RemoteUnitOfWork
extends UnitOfWorkImpl

Counter part of the unit of work which exists on the client side.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.eclipse.persistence.internal.sessions.UnitOfWorkImpl

AfterExternalTransactionRolledBack, Birth, CommitPending, CommitTransactionPending, Death, DO_NOT_THROW_CONFORM_EXCEPTIONS, Full, LOCK_QUERIES_PROPERTY, MergePending, None, Partial, ReadLockOnly, ReadLockUpdateVersion, THROW_ALL_CONFORM_EXCEPTIONS, WriteChangesFailed

Fields inherited from interface org.eclipse.persistence.sessions.coordination.CommandProcessor

LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_WARNING

Constructor Summary

Constructors

Constructor and Description
RemoteUnitOfWork(RemoteSession parent)
RemoteUnitOfWork(RemoteSession parent, ReferenceMode referenceMode)
RemoteUnitOfWork(RemoteUnitOfWork parent)
RemoteUnitOfWork(RemoteUnitOfWork parent, ReferenceMode referenceMode)

Method Summary

Modifier and Type	Method and Description
UnitOfWorkImpl	acquireUnitOfWork() The nested unit of work must also be remote.
UnitOfWorkImpl	acquireUnitOfWork(ReferenceMode referenceMode) The nested unit of work must also be remote.
void	commitRootUnitOfWork() Starts committing the remote unit of work.
java.lang.Object	executeQuery(java.lang.String queryName) PUBLIC: Execute the pre-defined query by name and return the result.
java.lang.Object	executeQuery(java.lang.String queryName, java.lang.Class domainClass) PUBLIC: Execute the pre-defined query by name and return the result.
java.lang.Object	executeQuery(java.lang.String queryName, java.lang.Class domainClass, java.util.Vector argumentValues) PUBLIC: Execute the pre-defined query by name and return the result.
java.lang.Object	executeQuery(java.lang.String queryName, java.util.Vector argumentValues) PUBLIC: Execute the pre-defined query by name and return the result.
Platform	getDatasourcePlatform() INTERNAL: Return the database platform currently connected to.
ClassDescriptor	getDescriptor(java.lang.Class domainClass) Return the table descriptor specified for the class.
java.util.Vector	getNewObjectsCache() Returns a new object cache
RemoteSessionController	getParentSessionController() INTERNAL: Method returns the parent RemoteSessionController for this Remote UnitOfWork Used to retrieve Valueholders that were used on the client
DatabasePlatform	getPlatform() INTERNAL: Return the database platform currently connected to.
java.util.Vector	getUnregisteredNewObjectsCache() Returns an unregistered new object cache
java.lang.Object	internalExecuteQuery(DatabaseQuery query, AbstractRecord Record) INTERNAL: Return the results from exeucting the database query.
boolean	isRemoteUnitOfWork() Return if this session is a unit of work.
void	reinitializeForSession(AbstractSession session, RemoteSessionController parentSessionController) INTERNAL: Re-initialize for the server-side session.
void	setParentSessionController(RemoteSessionController parentSessionController) INTERNAL: Sets the parent RemoteSessionController for this Remote UnitOfWork Used to retrieve Valueholders that were used on the client
java.lang.String	toString() Avoid the toString printing the accessor and platform.
boolean	verifyDelete(java.lang.Object domainObject) TESTING: This is used by testing code to ensure that a deletion was successful.

Methods inherited from class org.eclipse.persistence.internal.sessions.UnitOfWorkImpl

acquireHistoricalSession, addDeletedPrivateOwnedObjects, addDeletionDependency, addNewAggregate, addObjectDeletedDuringCommit, addPessimisticLockedClone, addPrivateOwnedObject, addReadOnlyClass, addReadOnlyClasses, addRemovedObject, addToChangeTrackedHardList, afterExternalTransactionRollback, assignSequenceNumber, assignSequenceNumber, assignSequenceNumbers, beginEarlyTransaction, beginTransaction, buildOriginal, calculateChanges, checkExistence, checkForUnregisteredExistingObject, checkIfAlreadyRegistered, clear, clearForClose, cloneAndRegisterObject, cloneAndRegisterObject, collectAndPrepareObjectsForNestedMerge, commit, commitAndResume, commitAndResumeOnFailure, commitAndResumeWithPreBuiltChangeSet, commitRootUnitOfWorkWithPreBuiltChangeSet, commitTransaction, commitTransactionAfterWriteChanges, copyReadOnlyClasses, createCloneQueryValueHolder, createCloneTransformationValueHolder, deepMergeClone, deepRevertObject, deepUnregisterObject, deleteAllObjects, discoverAndPersistUnregisteredNewObjects, discoverUnregisteredNewObjects, dontPerformValidation, executeCall, forceUpdateToVersionField, getAccessor, getAccessors, getAccessors, getActiveUnitOfWork, getAllFromNewObjects, getBackupClone, getBackupClone, getBackupCloneForCommit, getBackupCloneForCommit, getBatchQueries, getCascadeDeleteObjects, getChangeTrackedHardList, getCloneMapping, getCloneToOriginals, getCommitManager, getContainerBeans, getContainerUnitOfWork, getCurrentChanges, getDefaultReadOnlyClasses, getDeletedObjects, getDeletionDependencies, getDeletionDependencies, getExecutionSession, getLifecycle, getMergeManager, getNewAggregates, getNewObjectsCloneToOriginal, getNewObjectsInParentOriginalToClone, getNewObjectsOriginalToClone, getObjectFromNewObjects, getObjectFromNewObjects, getObjectsDeletedDuringCommit, getOptimisticReadLockObjects, getOriginalVersionOfNewObject, getOriginalVersionOfObject, getOriginalVersionOfObjectOrNull, getOriginalVersionOfObjectOrNull, getParent, getParentIdentityMapSession, getPessimisticLockedObjects, getPlatform, getProperty, getQuery, getQuery, getReadOnlyClasses, getReference, getReferenceMode, getSequencing, getServerPlatform, getSessionTypeString, getShouldThrowConformExceptions, getState, getTransaction, getUnitOfWorkChangeSet, getUnregisteredExistingObjects, getValidationLevel, hasCascadeDeleteObjects, hasChanges, hasCloneMapping, hasContainerBeans, hasDeletedObjects, hasNewObjects, hasOptimisticReadLockObjects, hasPrivateOwnedObjects, hasUnregisteredNewObjects, initializeIdentityMapAccessor, internalRegisterObject, isActive, isAfterWriteChangesButBeforeCommit, isClassReadOnly, isCloneNewObject, isCloneNewObjectFromParent, isCommitPending, isConsideredInvalid, isDead, isInTransaction, isMergePending, isNestedUnitOfWork, isNewObjectInParent, isObjectDeleted, isObjectNew, isObjectRegistered, isOriginalNewObject, isPessimisticLocked, isPreDeleteComplete, isSmartMerge, issueSQLbeforeCompletion, issueSQLbeforeCompletion, isUnitOfWork, isUnregisteredExistingObject, isUnregisteredNewObjectInParent, mergeClone, mergeClone, mergeClonesAfterCompletion, mergeCloneWithReferences, mergeCloneWithReferences, mergeCloneWithReferences, mergeCloneWithReferences, newInstance, performFullValidation, performPartialValidation, performRemove, performRemovePrivateOwnedObjectFromChangeSet, printRegisteredObjects, processDeleteObjectQuery, registerAllObjects, registerAllObjects, registerExistingObject, registerExistingObject, registerExistingObject, registerNewContainerBean, registerNewContainerBeanForCMP, registerNewObject, registerNewObjectForPersist, registerObject, registerOriginalNewObjectFromNestedUnitOfWork, registerWithTransactionIfRequired, release, releaseJTSConnection, releaseReadConnection, releaseWriteLocks, removeAllReadOnlyClasses, removeForceUpdateToVersionField, removePrivateOwnedObject, removeReadOnlyClass, resumeUnitOfWork, retryQuery, revertAndResume, revertObject, revertObject, rollbackTransaction, scanForConformingInstances, setBatchQueries, setDead, setMergeManager, setObjectsDeletedDuringCommit, setParent, setPendingMerge, setPreDeleteComplete, setReadOnlyClasses, setResumeUnitOfWorkOnTransactionCompletion, setShouldCascadeCloneToJoinedRelationship, setShouldDiscoverNewObjects, setShouldNewObjectsBeCached, setShouldOrderUpdates, setShouldPerformDeletesFirst, setShouldThrowConformExceptions, setShouldValidateExistence, setSmartMerge, setSynchronized, setTransaction, setUnitOfWorkChangeSet, setValidationLevel, setWasNonObjectLevelModifyQueryExecuted, setWasTransactionBegunPrematurely, shallowMergeClone, shallowRevertObject, shallowUnregisterObject, shouldCascadeCloneToJoinedRelationship, shouldClearForCloseOnRelease, shouldDiscoverNewObjects, shouldForceReadFromDB, shouldNewObjectsBeCached, shouldOrderUpdates, shouldPerformDeletesFirst, shouldPerformFullValidation, shouldPerformNoValidation, shouldPerformPartialValidation, shouldReadFromDB, shouldResumeUnitOfWorkOnTransactionCompletion, shouldStoreBypassCache, shouldValidateExistence, storeDeferredModifyAllQuery, storeModifyAllQuery, synchronizeAndResume, unregisterObject, unregisterObject, unregisterObject, updateChangeTrackersIfRequired, validateObjectSpace, verifyMutexThreadIntegrityBeforeRelease, wasDeleted, wasNonObjectLevelModifyQueryExecuted, wasTransactionBegunPrematurely, writeChanges, writesCompleted

Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractSession

acquireNonSynchronizedUnitOfWork, acquireNonSynchronizedUnitOfWork, addAlias, addJPAQuery, addMultitenantContextProperty, addQuery, addStaticMetamodelClass, basicExecuteCall, beginExternalTransaction, checkAndRefreshInvalidObject, clearDescriptors, clearIntegrityChecker, clearLastDescriptorAccessed, clearProfile, clone, commitExternalTransaction, compareObjects, compareObjectsDontMatch, config, containsQuery, copy, copy, copyDescriptorNamedQueries, copyDescriptorsFromProject, copyInternal, copyObject, copyObject, createProtectedInstanceFromCachedData, deferEvent, deleteAllObjects, deleteObject, doesObjectExist, dontLogMessages, endOperationProfile, endOperationProfile, executeDeferredEvents, executeNonSelectingCall, executeNonSelectingSQL, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeSelectingCall, executeSQL, fine, finer, finest, getActiveCommandThreads, getActiveSession, getAliasDescriptors, getAllQueries, getAsOfClause, getAttributeGroups, getBroker, getClassDescriptor, getClassDescriptor, getClassDescriptorForAlias, getCommandManager, getDatasourceLogin, getDefaultReferenceMode, getDescriptor, getDescriptorForAlias, getDescriptors, getEventManager, getExceptionHandler, getExceptionHandlerClass, getExternalTransactionController, getId, getIdentityMapAccessor, getIdentityMapAccessorInstance, getIntegrityChecker, getJPAQueries, getLoader, getLog, getLogin, getLogLevel, getLogLevel, getLogSessionString, getMappedSuperclass, getMultitenantContextProperties, getName, getNextQueryId, getNextSequenceNumberValue, getNumberOfActiveUnitsOfWork, getParentIdentityMapSession, getParentIdentityMapSession, getPartitioningPolicy, getPessimisticLockTimeoutDefault, getProfiler, getProject, getProperties, getQueries, getQuery, getQuery, getQueryBuilder, getQueryTimeoutDefault, getRefreshMetadataListener, getRootSession, getSessionForClass, getSessionForName, getSessionLog, getStaticMetamodelClass, getTablePerTenantDescriptors, getTransactionMutex, handleException, handleSevere, hasBroker, hasCommitManager, hasDescriptor, hasEventManager, hasExceptionHandler, hasExternalTransactionController, hasProperties, hasTablePerTenantDescriptors, incrementProfile, incrementProfile, info, insertObject, isBroker, isClassReadOnly, isClientSession, isConnected, isDatabaseSession, isDistributedSession, isExclusiveConnectionRequired, isExclusiveIsolatedClientSession, isFinalizersEnabled, isHistoricalSession, isInBroker, isInProfile, isIsolatedClientSession, isLoggingOff, isProtectedSession, isRemoteSession, isServerSession, isSessionBroker, isSynchronized, keyFromObject, keyFromObject, load, log, log, log, log, log, log, log, log, log, log, logMessage, logMessage, logThrowable, postAcquireConnection, prepareDatabaseQuery, preReleaseConnection, priviledgedExecuteNonSelectingCall, priviledgedExecuteSelectingCall, processCommand, processJPAQueries, readAllObjects, readAllObjects, readAllObjects, readAllObjects, readObject, readObject, readObject, readObject, readObject, refreshAndLockObject, refreshAndLockObject, refreshObject, registerFinalizer, releaseUnitOfWork, removeProperty, removeQuery, removeQuery, retrieveCacheKey, retryTransaction, setAccessor, setBroker, setCommandManager, setCommitManager, setDatasourceLogin, setDefaultReferenceMode, setEventManager, setExceptionHandler, setExternalTransactionController, setIntegrityChecker, setIsFinalizersEnabled, setIsInBroker, setIsInProfile, setLog, setLogin, setLogin, setLogLevel, setName, setPartitioningPolicy, setPessimisticLockTimeoutDefault, setProfiler, setProject, setProperties, setProperty, setQueryTimeoutDefault, setRefreshMetadataListener, setSessionLog, setShouldPropagateChanges, setWasJTSTransactionInternallyStarted, severe, shouldDisplayData, shouldLog, shouldLogMessages, shouldLogMessages, shouldPropagateChanges, startOperationProfile, startOperationProfile, unwrapObject, updateObject, updateProfile, updateTablePerTenantDescriptors, validateCache, validateQuery, warning, wasJTSTransactionInternallyStarted, wrapObject, writeObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.persistence.sessions.UnitOfWork

deleteAllObjects, deleteObject, isClassReadOnly, refreshAndLockObject, refreshAndLockObject

Methods inherited from interface org.eclipse.persistence.sessions.Session

addJPAQuery, addQuery, clearIntegrityChecker, clearProfile, containsQuery, copy, copy, copyObject, copyObject, doesObjectExist, dontLogMessages, executeNonSelectingCall, executeNonSelectingSQL, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeSelectingCall, executeSQL, getActiveSession, getAsOfClause, getClassDescriptor, getClassDescriptor, getClassDescriptorForAlias, getDatasourceLogin, getDefaultReferenceMode, getDescriptor, getDescriptorForAlias, getDescriptors, getEventManager, getExceptionHandler, getExternalTransactionController, getId, getIdentityMapAccessor, getIntegrityChecker, getJPAQueries, getLog, getLogin, getLogLevel, getLogLevel, getName, getNextSequenceNumberValue, getPartitioningPolicy, getProfiler, getProject, getProperties, getQueries, getQuery, getSessionLog, handleException, handleSevere, hasDescriptor, hasExceptionHandler, hasExternalTransactionController, isClientSession, isConnected, isDatabaseSession, isDistributedSession, isFinalizersEnabled, isInProfile, isRemoteSession, isServerSession, isSessionBroker, keyFromObject, log, logMessage, readAllObjects, readAllObjects, readAllObjects, readObject, readObject, readObject, readObject, refreshObject, removeProperty, removeQuery, setDefaultReferenceMode, setExceptionHandler, setExternalTransactionController, setIntegrityChecker, setIsFinalizersEnabled, setLog, setLogLevel, setName, setPartitioningPolicy, setProfiler, setProperty, setQueryTimeoutDefault, setSessionLog, shouldLog, shouldLogMessages, validateCache

Constructor Detail

RemoteUnitOfWork

public RemoteUnitOfWork(RemoteUnitOfWork parent)

RemoteUnitOfWork

public RemoteUnitOfWork(RemoteSession parent)

RemoteUnitOfWork

public RemoteUnitOfWork(RemoteUnitOfWork parent,
                        ReferenceMode referenceMode)

RemoteUnitOfWork

public RemoteUnitOfWork(RemoteSession parent,
                        ReferenceMode referenceMode)

Method Detail

acquireUnitOfWork

public UnitOfWorkImpl acquireUnitOfWork()

The nested unit of work must also be remote.

Specified by:

acquireUnitOfWork in interface Session

Overrides:

acquireUnitOfWork in class UnitOfWorkImpl

See Also:

UnitOfWorkImpl

acquireUnitOfWork

public UnitOfWorkImpl acquireUnitOfWork(ReferenceMode referenceMode)

The nested unit of work must also be remote.

Specified by:

acquireUnitOfWork in interface Session

Overrides:

acquireUnitOfWork in class AbstractSession

Parameters:

referenceMode - The reference type the UOW should use internally when referencing Working clones. Setting this to WEAK means the UOW will use weak references to reference clones that support active object change tracking and hard references for deferred change tracked objects. Setting to FORCE_WEAK means that all objects will be referenced by weak references and if the application no longer references the clone the clone may be garbage collected. If the clone has uncommitted changes then those changes will be lost.

See Also:

UnitOfWorkImpl

commitRootUnitOfWork

public void commitRootUnitOfWork()

Starts committing the remote unit of work. This must serialize the unit of work across to the server, commit the unit of work on the server, serialize it back and merge any server-side changes (such as sequence numbers) it into itself, then merge into the parent remote session.

Overrides:

commitRootUnitOfWork in class UnitOfWorkImpl

executeQuery

public java.lang.Object executeQuery(java.lang.String queryName)
                              throws DatabaseException

PUBLIC: Execute the pre-defined query by name and return the result. Queries can be pre-defined and named to allow for their reuse. The named query can be defined on the remote session or the server-side session.

Specified by:

executeQuery in interface Session

Overrides:

executeQuery in class AbstractSession

Throws:

DatabaseException

See Also:

AbstractSession.addQuery(String, DatabaseQuery)

executeQuery

public java.lang.Object executeQuery(java.lang.String queryName,
                                     java.lang.Class domainClass)
                              throws DatabaseException

PUBLIC: Execute the pre-defined query by name and return the result. Queries can be pre-defined and named to allow for their reuse. The class is the descriptor in which the query was pre-defined. The query is executed on the server-side session.

Specified by:

executeQuery in interface Session

Overrides:

executeQuery in class AbstractSession

Throws:

DatabaseException

See Also:

DescriptorQueryManager.addQuery(String, DatabaseQuery)

executeQuery

public java.lang.Object executeQuery(java.lang.String queryName,
                                     java.lang.Class domainClass,
                                     java.util.Vector argumentValues)
                              throws DatabaseException

PUBLIC: Execute the pre-defined query by name and return the result. Queries can be pre-defined and named to allow for their reuse. The class is the descriptor in which the query was pre-defined.

Overrides:

executeQuery in class AbstractSession

Throws:

DatabaseException

See Also:

DescriptorQueryManager.addQuery(String, DatabaseQuery)

executeQuery

public java.lang.Object executeQuery(java.lang.String queryName,
                                     java.util.Vector argumentValues)
                              throws DatabaseException

PUBLIC: Execute the pre-defined query by name and return the result. Queries can be pre-defined and named to allow for their reuse.

Overrides:

executeQuery in class AbstractSession

Throws:

DatabaseException

See Also:

AbstractSession.addQuery(String, DatabaseQuery)

getDescriptor

public ClassDescriptor getDescriptor(java.lang.Class domainClass)

Return the table descriptor specified for the class.

Specified by:

getDescriptor in interface Session

Overrides:

getDescriptor in class AbstractSession

getNewObjectsCache

public java.util.Vector getNewObjectsCache()

Returns a new object cache

getParentSessionController

public RemoteSessionController getParentSessionController()

INTERNAL: Method returns the parent RemoteSessionController for this Remote UnitOfWork Used to retrieve Valueholders that were used on the client

getPlatform

public DatabasePlatform getPlatform()

INTERNAL: Return the database platform currently connected to. The platform is used for database specific behavior.

Specified by:

getPlatform in interface Session

Overrides:

getPlatform in class AbstractSession

getDatasourcePlatform

public Platform getDatasourcePlatform()

INTERNAL: Return the database platform currently connected to. The platform is used for database specific behavior.

Specified by:

getDatasourcePlatform in interface Session

Overrides:

getDatasourcePlatform in class AbstractSession

getUnregisteredNewObjectsCache

public java.util.Vector getUnregisteredNewObjectsCache()

Returns an unregistered new object cache

internalExecuteQuery

public java.lang.Object internalExecuteQuery(DatabaseQuery query,
                                             AbstractRecord Record)
                                      throws DatabaseException,
                                             QueryException

INTERNAL: Return the results from exeucting the database query. the arguments should be a database row with raw data values.

Overrides:

internalExecuteQuery in class UnitOfWorkImpl

Throws:

DatabaseException

QueryException

isRemoteUnitOfWork

public boolean isRemoteUnitOfWork()

Return if this session is a unit of work.

Specified by:

isRemoteUnitOfWork in interface Session

Overrides:

isRemoteUnitOfWork in class AbstractSession

reinitializeForSession

public void reinitializeForSession(AbstractSession session,
                                   RemoteSessionController parentSessionController)

INTERNAL: Re-initialize for the server-side session. This is done when the uow is passed back to the server for committing.

setParentSessionController

public void setParentSessionController(RemoteSessionController parentSessionController)

INTERNAL: Sets the parent RemoteSessionController for this Remote UnitOfWork Used to retrieve Valueholders that were used on the client

toString

public java.lang.String toString()

Avoid the toString printing the accessor and platform.

Overrides:

toString in class AbstractSession

verifyDelete

public boolean verifyDelete(java.lang.Object domainObject)

TESTING: This is used by testing code to ensure that a deletion was successful.

Overrides:

verifyDelete in class AbstractSession