Package org.eclipse.emf.cdo.transaction
Interface CDOTransaction.Options
- All Superinterfaces:
CDOCommonView.Options
,CDOView.Options
,org.eclipse.net4j.util.event.INotifier
,org.eclipse.net4j.util.options.IOptions
- Enclosing interface:
- CDOTransaction
Encapsulates a set of notifying
transaction
configuration options.- Author:
- Simon McDuff
- No Implement
- This interface is not intended to be implemented by clients.
- No Extend
- This interface is not intended to be extended by clients.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
static interface
Anoptions event
fired from transactionoptions
when theauto release locks enabled
orauto release locks exemptions
options have changed.static interface
static interface
static interface
Anoptions event
fired from transactionoptions
when theoptimistic locking timeout
option has changed.static interface
Anoptions event
fired from transactionoptions
when thestale reference cleaner
option has changed.static interface
Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.CDOCommonView.Options
CDOCommonView.Options.LockNotificationEvent
Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.view.CDOView.Options
CDOView.Options.CacheReferenceTypeEvent, CDOView.Options.ChangeSubscriptionPoliciesEvent, CDOView.Options.ClearAdapterPolicyEvent, CDOView.Options.DetachmentNotificationEvent, CDOView.Options.FeatureAnalyzerEvent, CDOView.Options.InvalidationNotificationEvent, CDOView.Options.InvalidationPolicyEvent, CDOView.Options.LoadNotificationEvent, CDOView.Options.ReferencePolicyEvent, CDOView.Options.RevisionPrefetchingPolicyEvent, CDOView.Options.StaleReferencePolicyEvent, CDOView.Options.StrongReferencePolicyEvent
Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier
org.eclipse.net4j.util.event.INotifier.INotifier2
-
Field Summary
Modifier and TypeFieldDescriptionstatic final long
static final long
Indicates to use the timeout value that is configured on the server.static final CDOUndoDetector
static final long
Fields inherited from interface org.eclipse.emf.cdo.view.CDOView.Options
DEFAULT_REVISION_PREFETCHING, NO_REVISION_PREFETCHING
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAutoReleaseLocksExemptions
(boolean recursive, EObject... objects) Adds the givenobject
to the set of objects that are to be treated as exemptions to theisAutoReleaseLocksEnabled()
option.void
addConflictResolver
(CDOConflictResolver resolver) Adds a conflict resolver to the list of conflict resolvers of this transaction.void
Clears the set ofobjects
that are to be treated as exemptions to theisAutoReleaseLocksEnabled()
option.Returns a map which, if non-null
, stores copies of the initialrevisions
of newly attached objects.Returns the set ofobjects
that are to be treated as exemptions to theisAutoReleaseLocksEnabled()
option.long
Returns the number of milliseconds to wait for the transaction update whenCDOUserTransaction.commit()
is called.Returns a copy of the conflict resolver list of this transaction.Returns thetransaction
of this options object.long
Returns the number of milliseconds to wait for the successful acquisition of all required implicit locks on the server whenCDOUserTransaction.commit()
is called.Get theCDOStaleReferenceCleaner
to be used to clean stale references when receiving remote changes on invalidation.Returns the undo detector of this transaction.boolean
Returnstrue
if locks in this transaction will be released whenCDOUserTransaction.commit()
orCDOUserTransaction.rollback()
are called,false
otherwise.boolean
isAutoReleaseLocksExemption
(EObject object) Returnstrue
if the given object is treated as an exemption to theisAutoReleaseLocksEnabled()
option,false
otherwise.void
removeAutoReleaseLocksExemptions
(boolean recursive, EObject... objects) Removes the givenobject
from the set of objects that are to be treated as exemptions to theisAutoReleaseLocksEnabled()
option.void
removeConflictResolver
(CDOConflictResolver resolver) Removes a conflict resolver from the list of conflict resolvers of this transaction.void
setAttachedRevisionsMap
(Map<CDOID, CDORevision> attachedRevisionsMap) Sets a map which, if non-null
, stores copies of the initialrevisions
of newly attached objects, so that these objects can and will be rolled back to the model values they had at attachment time.void
setAutoReleaseLocksEnabled
(boolean on) Specifies whether locks in this transaction will be released whenCDOUserTransaction.commit()
orCDOUserTransaction.rollback()
are called.void
setCommitInfoTimeout
(long commitInfoTimeout) Specifies the number of milliseconds to wait for the transaction update whenCDOUserTransaction.commit()
is called.void
setConflictResolvers
(CDOConflictResolver[] resolvers) Sets the conflict resolver list of this transaction.void
setOptimisticLockingTimeout
(long optimisticLockingTimeout) Returns the number of milliseconds to wait for the successful acquisition of all required implicit locks on the server whenCDOUserTransaction.commit()
is called.void
setStaleReferenceCleaner
(CDOStaleReferenceCleaner staleReferenceCleaner) Set theCDOStaleReferenceCleaner
to be used to clean stale references when receiving remote changes on invalidation.void
setUndoDetector
(CDOUndoDetector undoDetector) Sets the undo detector of this transaction.Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonView.Options
isLockNotificationEnabled, setLockNotificationEnabled
Methods inherited from interface org.eclipse.emf.cdo.view.CDOView.Options
addChangeSubscriptionPolicy, getCacheReferenceType, getChangeSubscriptionPolicies, getClearAdapterPolicy, getFeatureAnalyzer, getInvalidationPolicy, getRevisionPrefetchingPolicy, getStaleReferenceBehaviour, getStaleReferencePolicy, getStrongReferencePolicy, isDetachmentNotificationEnabled, isInvalidationNotificationEnabled, isLoadNotificationEnabled, removeChangeSubscriptionPolicy, setCacheReferenceType, setClearAdapterPolicy, setDetachmentNotificationEnabled, setFeatureAnalyzer, setInvalidationNotificationEnabled, setInvalidationPolicy, setLoadNotificationEnabled, setRevisionPrefetchingPolicy, setStaleReferenceBehaviour, setStaleReferencePolicy, setStrongReferencePolicy
Methods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListener
-
Field Details
-
DEFAULT_UNDO_DETECTOR
- Since:
- 4.3
-
DEFAULT_COMMIT_INFO_TIMEOUT
static final long DEFAULT_COMMIT_INFO_TIMEOUT- Since:
- 4.5
- See Also:
-
DEFAULT_OPTIMISTIC_LOCKING_TIMEOUT
static final long DEFAULT_OPTIMISTIC_LOCKING_TIMEOUTIndicates to use the timeout value that is configured on the server.- Since:
- 4.15
- See Also:
-
NO_OPTIMISTIC_LOCKING_TIMEOUT
static final long NO_OPTIMISTIC_LOCKING_TIMEOUT- Since:
- 4.15
- See Also:
-
-
Method Details
-
getContainer
CDOTransaction getContainer()Returns thetransaction
of this options object.- Specified by:
getContainer
in interfaceCDOView.Options
- Specified by:
getContainer
in interfaceorg.eclipse.net4j.util.options.IOptions
- Since:
- 4.0
-
getUndoDetector
CDOUndoDetector getUndoDetector()Returns the undo detector of this transaction.- Since:
- 4.3
-
setUndoDetector
Sets the undo detector of this transaction.- Since:
- 4.3
-
getConflictResolvers
CDOConflictResolver[] getConflictResolvers()Returns a copy of the conflict resolver list of this transaction. -
setConflictResolvers
Sets the conflict resolver list of this transaction. -
addConflictResolver
Adds a conflict resolver to the list of conflict resolvers of this transaction. -
removeConflictResolver
Removes a conflict resolver from the list of conflict resolvers of this transaction. -
getStaleReferenceCleaner
CDOStaleReferenceCleaner getStaleReferenceCleaner()Get theCDOStaleReferenceCleaner
to be used to clean stale references when receiving remote changes on invalidation.- Since:
- 4.4
-
setStaleReferenceCleaner
Set theCDOStaleReferenceCleaner
to be used to clean stale references when receiving remote changes on invalidation.- Since:
- 4.4
-
isAutoReleaseLocksEnabled
boolean isAutoReleaseLocksEnabled()Returnstrue
if locks in this transaction will be released whenCDOUserTransaction.commit()
orCDOUserTransaction.rollback()
are called,false
otherwise.The default value is
true
.- See Also:
-
setAutoReleaseLocksEnabled
void setAutoReleaseLocksEnabled(boolean on) Specifies whether locks in this transaction will be released whenCDOUserTransaction.commit()
orCDOUserTransaction.rollback()
are called.If set to
false
all locks will be kept whenCDOUserTransaction.commit()
orCDOUserTransaction.rollback()
are called.The default value is
true
.- See Also:
-
getAutoReleaseLocksExemptions
Returns the set ofobjects
that are to be treated as exemptions to theisAutoReleaseLocksEnabled()
option.That means:
- If
isAutoReleaseLocksEnabled()
returnstrue
, the locks on the objects in this set are not released whenCDOUserTransaction.commit()
orCDOUserTransaction.rollback()
are called. - If
isAutoReleaseLocksEnabled()
returnsfalse
, the locks on the objects in this set are released nevertheless whenCDOUserTransaction.commit()
orCDOUserTransaction.rollback()
are called.
The returned set is unmodifiable. To modify the set use the
clearAutoReleaseLocksExemptions()
,addAutoReleaseLocksExemption()
, andremoveAutoReleaseLocksExemption()
methods.Implementation note: This set stores weak references to the contained objects.
- If
-
isAutoReleaseLocksExemption
Returnstrue
if the given object is treated as an exemption to theisAutoReleaseLocksEnabled()
option,false
otherwise.- Since:
- 4.6
- See Also:
-
clearAutoReleaseLocksExemptions
void clearAutoReleaseLocksExemptions()Clears the set ofobjects
that are to be treated as exemptions to theisAutoReleaseLocksEnabled()
option. -
addAutoReleaseLocksExemptions
Adds the givenobject
to the set of objects that are to be treated as exemptions to theisAutoReleaseLocksEnabled()
option. -
removeAutoReleaseLocksExemptions
Removes the givenobject
from the set of objects that are to be treated as exemptions to theisAutoReleaseLocksEnabled()
option. -
getAttachedRevisionsMap
Map<CDOID,CDORevision> getAttachedRevisionsMap()Returns a map which, if non-null
, stores copies of the initialrevisions
of newly attached objects.- Since:
- 4.8
- See Also:
-
setAttachedRevisionsMap
Sets a map which, if non-null
, stores copies of the initialrevisions
of newly attached objects, so that these objects can and will be rolled back to the model values they had at attachment time. If this map isnull
newly attached objects will keep the model values they have at rollback time. Note that remembering copies of all newly attached objects can impose resource problems when many objects are attached, e.g., during larger imports.- Since:
- 4.8
-
getOptimisticLockingTimeout
long getOptimisticLockingTimeout()Returns the number of milliseconds to wait for the successful acquisition of all required implicit locks on the server whenCDOUserTransaction.commit()
is called.Default value is
DEFAULT_OPTIMISTIC_LOCKING_TIMEOUT
.- Since:
- 4.15
-
setOptimisticLockingTimeout
void setOptimisticLockingTimeout(long optimisticLockingTimeout) Returns the number of milliseconds to wait for the successful acquisition of all required implicit locks on the server whenCDOUserTransaction.commit()
is called.Default value is
DEFAULT_OPTIMISTIC_LOCKING_TIMEOUT
.- Since:
- 4.15
-
getCommitInfoTimeout
long getCommitInfoTimeout()Returns the number of milliseconds to wait for the transaction update whenCDOUserTransaction.commit()
is called.Default value is 10000.
- Since:
- 4.5
-
setCommitInfoTimeout
void setCommitInfoTimeout(long commitInfoTimeout) Specifies the number of milliseconds to wait for the transaction update whenCDOUserTransaction.commit()
is called.Default value is 10000.
- Since:
- 4.5
-