Package org.eclipse.emf.cdo.session
Interface CDOSession.Options
- All Superinterfaces:
CDOCommonSession.Options,org.eclipse.net4j.util.event.INotifier,org.eclipse.net4j.util.options.IOptions
- All Known Subinterfaces:
CDONet4jSession.Options,CDOSession.Options
- Enclosing interface:
- CDOSession
Encapsulates a set of notifying
session configuration options.
The session options can fire the following events:
-
CDOSession.Options.GeneratedPackageEmulationEventafter thegenerated package emulation modehas changed. -
CDOSession.Options.CollectionLoadingPolicyEventafter thecollection loading policyhas changed. -
CDOSession.Options.LobCacheEventafter thelarge object cachehas changed.
- 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
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfacestatic interfacestatic interfaceAnoptions eventfired when thegenerated package emulation enabledoption of asessionhas changed.static interfacestatic interfacestatic interfaceNested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession.Options
CDOCommonSession.Options.LockNotificationEvent, CDOCommonSession.Options.LockNotificationMode, CDOCommonSession.Options.LockNotificationModeEvent, CDOCommonSession.Options.PassiveUpdateEvent, CDOCommonSession.Options.PassiveUpdateModeNested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier
org.eclipse.net4j.util.event.INotifier.INotifier2 -
Method Summary
Modifier and TypeMethodDescriptionThecollection loading policyof thissessioncontrols how a list gets populated.Returns thesessionof this options object.Returns thelarge object cachecurrently being used by this session.Returns thepermission updatercurrently being used by this session.intbooleanbooleanvoidSets thecollection loadingto be used by this session.voidsetDelegableViewLockEnabled(boolean delegableViewLockEnabled) This method is useful, for example, if EMFadapterscallDisplay.syncExec()in response to CDO notifications.voidsetGeneratedPackageEmulationEnabled(boolean generatedPackageEmulationEnabled) voidsetLobCache(CDOLobStore lobCache) Sets thelarge object cacheto be used by this session.voidsetPermissionUpdater(CDOPermissionUpdater permissionUpdater) Sets thepermission updaterto be used by this session.voidsetPrefetchSendMaxRevisionKeys(int prefetchSendMaxRevisionKeys) Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession.Options
getLockNotificationMode, getPassiveUpdateMode, isLockNotificationEnabled, isPassiveUpdateEnabled, setLockNotificationEnabled, setLockNotificationMode, setPassiveUpdateEnabled, setPassiveUpdateModeMethods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListener
-
Method Details
-
getContainer
CDOSession getContainer()Returns thesessionof this options object.- Specified by:
getContainerin interfaceCDOCommonSession.Options- Specified by:
getContainerin interfaceorg.eclipse.net4j.util.options.IOptions- Since:
- 4.0
-
isGeneratedPackageEmulationEnabled
boolean isGeneratedPackageEmulationEnabled() -
setGeneratedPackageEmulationEnabled
void setGeneratedPackageEmulationEnabled(boolean generatedPackageEmulationEnabled) -
getCollectionLoadingPolicy
CDOCollectionLoadingPolicy getCollectionLoadingPolicy()Thecollection loading policyof thissessioncontrols how a list gets populated. By default, when an object is fetched, all its elements are filled with the proper values.This could be time-consuming, especially if the reference list does not need to be accessed. In CDO it is possible to partially load collections. The default list implementation that is shipped with CDO makes a distinction between the two following situations:
- How many CDOIDs to fill when an object is loaded for the first time;
- Which elements to fill with CDOIDs when the accessed element is not yet filled.
CDOUtil.createCollectionLoadingPolicy(initialElements, subsequentElements);The user can also provide its own implementation of the CDOCollectionLoadingPolicy interface.
-
setCollectionLoadingPolicy
Sets thecollection loadingto be used by this session. -
getLobCache
CDOLobStore getLobCache()Returns thelarge object cachecurrently being used by this session.- Since:
- 4.0
-
setLobCache
Sets thelarge object cacheto be used by this session.- Since:
- 4.0
-
getPermissionUpdater
CDOPermissionUpdater getPermissionUpdater()Returns thepermission updatercurrently being used by this session.- Since:
- 4.3
-
setPermissionUpdater
Sets thepermission updaterto be used by this session.- Since:
- 4.3
-
isDelegableViewLockEnabled
boolean isDelegableViewLockEnabled()- Since:
- 4.5
-
setDelegableViewLockEnabled
void setDelegableViewLockEnabled(boolean delegableViewLockEnabled) This method is useful, for example, if EMFadapterscallDisplay.syncExec()in response to CDO notifications. In these cases aDelegableReentrantLockcan be injected into the newview, which does not deadlock when both CDO's invalidation thread and the display thread acquire the view lock.- Since:
- 4.5
- See Also:
-
getPrefetchSendMaxRevisionKeys
int getPrefetchSendMaxRevisionKeys()- Since:
- 4.26
-
setPrefetchSendMaxRevisionKeys
void setPrefetchSendMaxRevisionKeys(int prefetchSendMaxRevisionKeys) - Since:
- 4.26
-