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
public static interface CDOSession.Options extends CDOCommonSession.Options
Encapsulates a set of notifyingsession
configuration options.The session options can fire the following events:
-
CDOSession.Options.GeneratedPackageEmulationEvent
after thegenerated package emulation mode
has changed. -
CDOSession.Options.CollectionLoadingPolicyEvent
after thecollection loading policy
has changed. -
CDOSession.Options.LobCacheEvent
after thelarge object cache
has 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 Classes Modifier and Type Interface Description static interface
CDOSession.Options.CollectionLoadingPolicyEvent
static interface
CDOSession.Options.DelegableViewLockEvent
static interface
CDOSession.Options.GeneratedPackageEmulationEvent
Anoptions event
fired when thegenerated package emulation enabled
option of asession
has changed.static interface
CDOSession.Options.LobCacheEvent
static interface
CDOSession.Options.PermissionUpdaterEvent
-
Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession.Options
CDOCommonSession.Options.LockNotificationMode, CDOCommonSession.Options.LockNotificationModeEvent, CDOCommonSession.Options.PassiveUpdateEvent, CDOCommonSession.Options.PassiveUpdateMode
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CDOCollectionLoadingPolicy
getCollectionLoadingPolicy()
Thecollection loading policy
of thissession
controls how a list gets populated.CDOSession
getContainer()
Returns thesession
of this options object.CDOLobStore
getLobCache()
Returns thelarge object cache
currently being used by this session.CDOPermissionUpdater
getPermissionUpdater()
Returns thepermission updater
currently being used by this session.boolean
isDelegableViewLockEnabled()
boolean
isGeneratedPackageEmulationEnabled()
void
setCollectionLoadingPolicy(CDOCollectionLoadingPolicy policy)
Sets thecollection loading
to be used by this session.void
setDelegableViewLockEnabled(boolean delegableViewLockEnabled)
This method is useful, for example, if EMFadapters
callDisplay.syncExec()
in response to CDO notifications.void
setGeneratedPackageEmulationEnabled(boolean generatedPackageEmulationEnabled)
void
setLobCache(CDOLobStore lobCache)
Sets thelarge object cache
to be used by this session.void
setPermissionUpdater(CDOPermissionUpdater permissionUpdater)
Sets thepermission updater
to be used by this session.-
Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession.Options
getLockNotificationMode, getPassiveUpdateMode, isPassiveUpdateEnabled, setLockNotificationMode, setPassiveUpdateEnabled, setPassiveUpdateMode
-
-
-
-
Method Detail
-
getContainer
CDOSession getContainer()
Returns thesession
of this options object.- Specified by:
getContainer
in interfaceCDOCommonSession.Options
- Specified by:
getContainer
in interfaceorg.eclipse.net4j.util.options.IOptions
- Since:
- 4.0
-
isGeneratedPackageEmulationEnabled
boolean isGeneratedPackageEmulationEnabled()
-
setGeneratedPackageEmulationEnabled
void setGeneratedPackageEmulationEnabled(boolean generatedPackageEmulationEnabled)
-
getCollectionLoadingPolicy
CDOCollectionLoadingPolicy getCollectionLoadingPolicy()
Thecollection loading policy
of thissession
controls 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
void setCollectionLoadingPolicy(CDOCollectionLoadingPolicy policy)
Sets thecollection loading
to be used by this session.
-
getLobCache
CDOLobStore getLobCache()
Returns thelarge object cache
currently being used by this session.- Since:
- 4.0
-
setLobCache
void setLobCache(CDOLobStore lobCache)
Sets thelarge object cache
to be used by this session.- Since:
- 4.0
-
getPermissionUpdater
CDOPermissionUpdater getPermissionUpdater()
Returns thepermission updater
currently being used by this session.- Since:
- 4.3
-
setPermissionUpdater
void setPermissionUpdater(CDOPermissionUpdater permissionUpdater)
Sets thepermission updater
to 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 EMFadapters
callDisplay.syncExec()
in response to CDO notifications. In these cases aDelegableReentrantLock
can 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:
CDOUtil.setNextViewLock(Lock)
-
-