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 notifying session configuration options.

The session options can fire the following events:

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.

  • Method Details

    • getContainer

      CDOSession getContainer()
      Returns the session of this options object.
      Specified by:
      getContainer in interface CDOCommonSession.Options
      Specified by:
      getContainer in interface org.eclipse.net4j.util.options.IOptions
      Since:
      4.0

    • isGeneratedPackageEmulationEnabled

      boolean isGeneratedPackageEmulationEnabled()

    • setGeneratedPackageEmulationEnabled

      void setGeneratedPackageEmulationEnabled(boolean generatedPackageEmulationEnabled)

    • getCollectionLoadingPolicy

      @Deprecated CDOCollectionLoadingPolicy getCollectionLoadingPolicy()
      Deprecated.
      As of 4.31 use getCollectionLoadingConfig().
      The collection loading policy of this session 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:

      1. How many CDOIDs to fill when an object is loaded for the first time;
      2. Which elements to fill with CDOIDs when the accessed element is not yet filled.
      Example:

      CDOUtil.createCollectionLoadingPolicy(initialElements, subsequentElements);

      The user can also provide its own implementation of the CDOCollectionLoadingPolicy interface.

    • setCollectionLoadingPolicy

      @Deprecated void setCollectionLoadingPolicy(CDOCollectionLoadingPolicy policy)
      Deprecated.
      As of 4.31 use setCollectionLoadingConfig(CDOCollectionLoadingConfig).
      Sets the collection loading to be used by this session.

    • getCollectionLoadingConfig

      default CDOCollectionLoadingConfig getCollectionLoadingConfig()
      Returns the modern session-wide collection-loading configuration, or null if modern partial collection loading is disabled.
      Returns:
      the immutable configuration snapshot, or null
      Since:
      4.31

    • setCollectionLoadingConfig

      default void setCollectionLoadingConfig(CDOCollectionLoadingConfig config)
      Replaces the complete modern session-wide collection-loading configuration snapshot.
      Parameters:
      config - the new immutable configuration, or null to disable modern partial collection loading
      Since:
      4.31

    • getLobCache

      CDOLobStore getLobCache()
      Returns the large object cache currently being used by this session.
      Since:
      4.0

    • setLobCache

      void setLobCache(CDOLobStore lobCache)
      Sets the large object cache to be used by this session.
      Since:
      4.0

    • getPermissionUpdater

      CDOPermissionUpdater getPermissionUpdater()
      Returns the permission updater currently being used by this session.
      Since:
      4.3

    • setPermissionUpdater

      void setPermissionUpdater(CDOPermissionUpdater permissionUpdater)
      Sets the permission 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 EMF adapters call Display.syncExec() in response to CDO notifications. In these cases a DelegableReentrantLock can be injected into the new view, 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