All Superinterfaces:: AutoCloseable, CDOCommonSession, CDOCommonSession.Options, CDOIDProvider, CDOLobLoader, CDOPermissionProvider, org.eclipse.net4j.util.collection.Closeable, org.eclipse.net4j.util.collection.Entity.Store.Provider, IAdaptable, org.eclipse.net4j.util.container.IContainer<IView>, org.eclipse.net4j.util.concurrent.IExecutorServiceProvider, org.eclipse.net4j.util.event.INotifier, org.eclipse.net4j.util.options.IOptions, org.eclipse.net4j.util.options.IOptionsContainer, org.eclipse.net4j.util.properties.IPropertiesContainer, ISession, org.eclipse.net4j.util.security.IUserAware

public interface InternalSession extends ISession, CDOIDProvider, CDOPermissionProvider, CDOCommonSession.Options, org.eclipse.net4j.util.concurrent.IExecutorServiceProvider, org.eclipse.net4j.util.collection.Entity.Store.Provider

Server representation of one connected client session. It owns that client's views and protocol, supplies ID and permission context for requests, and projects repository notifications—including ordered lock changes—into the state visible to that client.

Since:: 4.3
Author:: Eike Stepper
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

InternalSession.LockChangeReservation

Represents a position reserved in this session's lock-change sequence.

static interface

InternalSession.LockChangeResult

The session-specific result of a completed lock-change reservation.

Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession
CDOCommonSession.Options

Nested 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.PassiveUpdateMode

Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.security.CDOPermissionProvider
CDOPermissionProvider.Constant

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.container.IContainer
org.eclipse.net4j.util.container.IContainer.Modifiable<E>, org.eclipse.net4j.util.container.IContainer.Persistable<E>, org.eclipse.net4j.util.container.IContainer.Persistence<E>

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier
org.eclipse.net4j.util.event.INotifier.INotifier2
Field Summary

Fields

Modifier and Type

Field

Description

static final int

TEMP_VIEW_ID

Fields inherited from interface org.eclipse.emf.cdo.common.id.CDOIDProvider
NOOP

Fields inherited from interface org.eclipse.emf.cdo.common.security.CDOPermissionProvider
NONE, READ, WRITE
Method Summary

Modifier and Type

Method

Description

void

awaitLockChangesQuiescent()

Waits until all reserved lock changes for this session have completed.

void

collectContainedRevisions(InternalCDORevision revision, CDOBranchPoint branchPoint, int referenceChunk, Set<CDOID> revisions, List<CDORevision> additionalRevisions)

CDOCollectionLoadingConfig

getCollectionLoadingConfig()

Returns the complete modern collection-loading configuration snapshot.

long

getFirstUpdateTime()

long

getLockModCount()

Returns the last lock modification count assigned to this server session.

InternalSessionManager

getManager()

InternalRepository

getRepository()

InternalView

getView(int viewID)

InternalView[]

getViews()

boolean

isLockChangesQuiescent()

Returns whether all reserved lock changes for this session have completed.

boolean

isLockStateRelevantForSnapshot(CDOLockState state)

Returns whether a lock state belongs in a snapshot for this session.

boolean

isOpenOnClientSide()

InternalTransaction

openTransaction(int viewID, CDOBranchPoint branchPoint)

InternalTransaction

openTransaction(int viewID, CDOBranchPoint branchPoint, String durableLockingID)

InternalView

openView(int viewID, CDOBranchPoint branchPoint)

InternalView

openView(int viewID, CDOBranchPoint branchPoint, String durableLockingID)

InternalSession.LockChangeReservation

reserveLockChange(boolean forceFull)

Reserves this session's place in the lock-change notification sequence.

void

sendBranchNotification(CDOBranchChangedEvent.ChangeKind changeKind, CDOBranch... branches)

void

sendBranchNotification(InternalCDOBranch branch)

Deprecated.
As of 4.3 use sendBranchNotification(InternalCDOBranch, ChangeKind).

void

sendBranchNotification(InternalCDOBranch branch, CDOBranchChangedEvent.ChangeKind changeKind)

Deprecated.
As of 4.15 use sendBranchNotification(ChangeKind, CDOBranch...).

void

sendCommitNotification(CDOCommitInfo commitInfo)

Deprecated.
As of 4.2 use sendCommitNotification(CDOCommitInfo, boolean).

void

sendCommitNotification(CDOCommitInfo commitInfo, boolean clearResourcePathCache)

Deprecated.
As of 4.3 use sendCommitNotification(CommitNotificationInfo).

void

sendCommitNotification(CDOProtocol.CommitNotificationInfo info)

void

sendLockNotification(CDOLockChangeInfo lockChangeInfo)

void

sendLockNotification(InternalSession.LockChangeResult result)

Sends the visible result of a reserved lock change with its assigned sequence number.

void

sendLockOwnerRemappedNotification(CDOBranch branch, CDOLockOwner oldOwner, CDOLockOwner newOwner)

Deprecated.
As of 4.27 use sendLockOwnerRemappedNotification(CDOBranch, CDOLockOwner, CDOLockOwner, long).

void

sendLockOwnerRemappedNotification(CDOBranch branch, CDOLockOwner oldOwner, CDOLockOwner newOwner, long lockModCount)

Sends an owner remap with the sequence number assigned to this exact change for this session.

void

sendRemoteMessageNotification(InternalSession sender, CDORemoteSessionMessage message)

Deprecated.
As of 4.8 use sendRemoteMessageNotification(InternalSession, InternalTopic, CDORemoteSessionMessage).

void

sendRemoteMessageNotification(InternalSession sender, InternalTopic topic, CDORemoteSessionMessage message)

void

sendRemoteSessionNotification(InternalSession sender, byte opcode)

Deprecated.
As of 4.8 use sendRemoteSessionNotification(InternalSession, InternalTopic, byte).

void

sendRemoteSessionNotification(InternalSession sender, InternalTopic topic, byte opcode)

void

sendRepositoryStateNotification(CDOCommonRepository.State oldState, CDOCommonRepository.State newState)

Deprecated.
use sendRepositoryStateNotification(org.eclipse.emf.cdo.common.CDOCommonRepository.State, org.eclipse.emf.cdo.common.CDOCommonRepository.State, CDOID) instead

void

sendRepositoryStateNotification(CDOCommonRepository.State oldState, CDOCommonRepository.State newState, CDOID rootResourceID)

void

sendRepositoryTypeNotification(CDOCommonRepository.Type oldType, CDOCommonRepository.Type newType)

void

sendTagNotification(int modCount, String oldName, String newName, CDOBranchPoint branchPoint)

void

setCollectionLoadingConfig(CDOCollectionLoadingConfig config)

Replaces the complete modern collection-loading configuration snapshot.

void

setFirstUpdateTime(long firstUpdateTime)

void

setLockModCountBaseline(long lockModCount)

Sets the initial lock-change sequence number when a server session is reconnected.

void

setOpeningTime(long openingTime)

void

setOpenOnClientSide()

void

setSubscribed(boolean subscribed)

void

setUserID(String userID)

void

viewClosed(InternalView view)

Deprecated.
As of 4.15 use viewClosed(InternalView, boolean).

void

viewClosed(InternalView view, boolean inverse)

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession
authorizeOperations, getBranchManager, getCommitInfoManager, getOpeningTime, getRevisionManager, getSessionID, options

Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession.Options
getContainer, getLockNotificationMode, getPassiveUpdateMode, isLockNotificationEnabled, isPassiveUpdateEnabled, setLockNotificationEnabled, setLockNotificationMode, setPassiveUpdateEnabled, setPassiveUpdateMode

Methods inherited from interface org.eclipse.emf.cdo.common.id.CDOIDProvider
provideCDOID

Methods inherited from interface org.eclipse.emf.cdo.common.lob.CDOLobLoader
loadLob

Methods inherited from interface org.eclipse.emf.cdo.common.security.CDOPermissionProvider
getPermission

Methods inherited from interface org.eclipse.net4j.util.collection.Closeable
close, isClosed

Methods inherited from interface org.eclipse.net4j.util.collection.Entity.Store.Provider
getEntityStore

Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter

Methods inherited from interface org.eclipse.net4j.util.container.IContainer
getElements, isEmpty

Methods inherited from interface org.eclipse.net4j.util.concurrent.IExecutorServiceProvider
getExecutorService

Methods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListener

Methods inherited from interface org.eclipse.net4j.util.properties.IPropertiesContainer
properties

Methods inherited from interface org.eclipse.emf.cdo.server.ISession
getLastUpdateTime, getProtocol, isSubscribed

Methods inherited from interface org.eclipse.net4j.util.security.IUserAware
getUserID

Field Details
- TEMP_VIEW_ID
  
  static final int TEMP_VIEW_ID
  See Also:
  
  Constant Field Values
Method Details
- getManager
  
  InternalSessionManager getManager()
  
  Specified by:
  
  getManager in interface ISession
- getRepository
  
  InternalRepository getRepository()
  
  Specified by:
  
  getRepository in interface ISession
  
  Since:
  
  4.13
- setUserID
  
  void setUserID(String userID)
  
  Since:
  
  4.2
- getCollectionLoadingConfig
  
  CDOCollectionLoadingConfig getCollectionLoadingConfig()
  
  Returns the complete modern collection-loading configuration snapshot.
  
  Returns:
  
  the configuration, or null
  
  Since:
  
  4.27
- setCollectionLoadingConfig
  
  void setCollectionLoadingConfig(CDOCollectionLoadingConfig config)
  
  Replaces the complete modern collection-loading configuration snapshot.
  
  Parameters:
  
  config - the configuration, or null to disable modern partial collection loading
  
  Since:
  
  4.27
- setOpeningTime
  
  void setOpeningTime(long openingTime)
  
  Since:
  
  4.12
- getFirstUpdateTime
  
  long getFirstUpdateTime()
  
  Since:
  
  4.5
- setFirstUpdateTime
  
  void setFirstUpdateTime(long firstUpdateTime)
  
  Since:
  
  4.5
- isOpenOnClientSide
  
  boolean isOpenOnClientSide()
  
  Since:
  
  4.5
- setOpenOnClientSide
  
  void setOpenOnClientSide()
  
  Since:
  
  4.5
- getViews
  
  InternalView[] getViews()
  
  Specified by:
  
  getViews in interface CDOCommonSession
  
  Specified by:
  
  getViews in interface ISession
- getView
  
  InternalView getView(int viewID)
  
  Specified by:
  
  getView in interface CDOCommonSession
  
  Specified by:
  
  getView in interface ISession
- openView
  
  InternalView openView(int viewID, CDOBranchPoint branchPoint)
  
  Specified by:
  
  openView in interface ISession
- openView
  
  InternalView openView(int viewID, CDOBranchPoint branchPoint, String durableLockingID)
  
  Specified by:
  
  openView in interface ISession
  
  Since:
  
  4.19
- openTransaction
  
  InternalTransaction openTransaction(int viewID, CDOBranchPoint branchPoint)
  
  Specified by:
  
  openTransaction in interface ISession
- openTransaction
  
  InternalTransaction openTransaction(int viewID, CDOBranchPoint branchPoint, String durableLockingID)
  
  Specified by:
  
  openTransaction in interface ISession
  
  Since:
  
  4.19
- viewClosed
  
  void viewClosed(InternalView view, boolean inverse)
  
  Since:
  
  4.15
- setSubscribed
  
  void setSubscribed(boolean subscribed)
- collectContainedRevisions
  
  void collectContainedRevisions(InternalCDORevision revision, CDOBranchPoint branchPoint, int referenceChunk, Set<CDOID> revisions, List<CDORevision> additionalRevisions)
- sendRepositoryTypeNotification
  
  void sendRepositoryTypeNotification(CDOCommonRepository.Type oldType, CDOCommonRepository.Type newType) throws Exception
  
  Throws:
  
  Exception
- sendRepositoryStateNotification
  
  void sendRepositoryStateNotification(CDOCommonRepository.State oldState, CDOCommonRepository.State newState, CDOID rootResourceID) throws Exception
  
  Throws:
  
  Exception
  
  Since:
  
  4.1
- sendBranchNotification
  
  void sendBranchNotification(CDOBranchChangedEvent.ChangeKind changeKind, CDOBranch... branches) throws Exception
  
  Throws:
  
  Exception
  
  Since:
  
  4.15
- sendTagNotification
  
  void sendTagNotification(int modCount, String oldName, String newName, CDOBranchPoint branchPoint) throws Exception
  
  Throws:
  
  Exception
  
  Since:
  
  4.10
- sendCommitNotification
  
  void sendCommitNotification(CDOProtocol.CommitNotificationInfo info) throws Exception
  
  Throws:
  
  Exception
  
  Since:
  
  4.3
- sendRemoteSessionNotification
  
  void sendRemoteSessionNotification(InternalSession sender, InternalTopic topic, byte opcode) throws Exception
  
  Throws:
  
  Exception
  
  Since:
  
  4.17
- sendRemoteMessageNotification
  
  void sendRemoteMessageNotification(InternalSession sender, InternalTopic topic, CDORemoteSessionMessage message) throws Exception
  
  Throws:
  
  Exception
  
  Since:
  
  4.17
- sendLockNotification
  
  void sendLockNotification(CDOLockChangeInfo lockChangeInfo) throws Exception
  
  Throws:
  
  Exception
  
  Since:
  
  4.1
- sendLockOwnerRemappedNotification
  
  void sendLockOwnerRemappedNotification(CDOBranch branch, CDOLockOwner oldOwner, CDOLockOwner newOwner, long lockModCount) throws Exception
  
  Sends an owner remap with the sequence number assigned to this exact change for this session.
  
  Throws:
  
  Exception
  
  Since:
  
  4.27
- getLockModCount
  
  long getLockModCount()
  
  Returns the last lock modification count assigned to this server session.
  
  Since:
  
  4.27
- setLockModCountBaseline
  
  void setLockModCountBaseline(long lockModCount)
  
  Sets the initial lock-change sequence number when a server session is reconnected.
  
  Since:
  
  4.27
- reserveLockChange
  
  InternalSession.LockChangeReservation reserveLockChange(boolean forceFull)
  
  Reserves this session's place in the lock-change notification sequence.
  
  Parameters:
  
  forceFull - whether the resulting notification must contain the full change
  
  Returns:
  
  the reservation, or null if this session is closed
  
  Since:
  
  4.27
- isLockChangesQuiescent
  
  boolean isLockChangesQuiescent()
  
  Returns whether all reserved lock changes for this session have completed.
  
  Since:
  
  4.27
- awaitLockChangesQuiescent
  
  void awaitLockChangesQuiescent()
  
  Waits until all reserved lock changes for this session have completed.
  
  Since:
  
  4.27
- isLockStateRelevantForSnapshot
  
  boolean isLockStateRelevantForSnapshot(CDOLockState state)
  
  Returns whether a lock state belongs in a snapshot for this session.
  
  Since:
  
  4.27
- sendLockNotification
  
  void sendLockNotification(InternalSession.LockChangeResult result) throws Exception
  
  Sends the visible result of a reserved lock change with its assigned sequence number.
  
  Throws:
  
  Exception
  
  Since:
  
  4.27
- viewClosed
  
  @Deprecated void viewClosed(InternalView view)
  
  Deprecated.
  As of 4.15 use viewClosed(InternalView, boolean).
- sendRepositoryStateNotification
  
  @Deprecated void sendRepositoryStateNotification(CDOCommonRepository.State oldState, CDOCommonRepository.State newState) throws Exception
  
  Deprecated.
  use sendRepositoryStateNotification(org.eclipse.emf.cdo.common.CDOCommonRepository.State, org.eclipse.emf.cdo.common.CDOCommonRepository.State, CDOID) instead
  
  Throws:
  
  Exception
- sendBranchNotification
  
  @Deprecated void sendBranchNotification(InternalCDOBranch branch) throws Exception
  
  Deprecated.
  As of 4.3 use sendBranchNotification(InternalCDOBranch, ChangeKind).
  
  Throws:
  
  Exception
- sendBranchNotification
  
  @Deprecated void sendBranchNotification(InternalCDOBranch branch, CDOBranchChangedEvent.ChangeKind changeKind) throws Exception
  
  Deprecated.
  As of 4.15 use sendBranchNotification(ChangeKind, CDOBranch...).
  
  Throws:
  
  Exception
  
  Since:
  
  4.3
- sendCommitNotification
  
  @Deprecated void sendCommitNotification(CDOCommitInfo commitInfo) throws Exception
  
  Deprecated.
  As of 4.2 use sendCommitNotification(CDOCommitInfo, boolean).
  
  Throws:
  
  Exception
- sendCommitNotification
  
  @Deprecated void sendCommitNotification(CDOCommitInfo commitInfo, boolean clearResourcePathCache) throws Exception
  
  Deprecated.
  As of 4.3 use sendCommitNotification(CommitNotificationInfo).
  
  Throws:
  
  Exception
  
  Since:
  
  4.2
- sendRemoteSessionNotification
  
  @Deprecated void sendRemoteSessionNotification(InternalSession sender, byte opcode) throws Exception
  
  Deprecated.
  As of 4.8 use sendRemoteSessionNotification(InternalSession, InternalTopic, byte).
  
  Throws:
  
  Exception
- sendRemoteMessageNotification
  
  @Deprecated void sendRemoteMessageNotification(InternalSession sender, CDORemoteSessionMessage message) throws Exception
  
  Deprecated.
  As of 4.8 use sendRemoteMessageNotification(InternalSession, InternalTopic, CDORemoteSessionMessage).
  
  Throws:
  
  Exception
- sendLockOwnerRemappedNotification
  
  @Deprecated void sendLockOwnerRemappedNotification(CDOBranch branch, CDOLockOwner oldOwner, CDOLockOwner newOwner) throws Exception
  
  Deprecated.
  As of 4.27 use sendLockOwnerRemappedNotification(CDOBranch, CDOLockOwner, CDOLockOwner, long).
  
  Throws:
  
  Exception
  
  Since:
  
  4.19

Interface InternalSession

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession

Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession.Options

Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.common.security.CDOPermissionProvider

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.container.IContainer

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier

Field Summary

Fields inherited from interface org.eclipse.emf.cdo.common.id.CDOIDProvider

Fields inherited from interface org.eclipse.emf.cdo.common.security.CDOPermissionProvider

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession

Methods inherited from interface org.eclipse.emf.cdo.common.CDOCommonSession.Options

Methods inherited from interface org.eclipse.emf.cdo.common.id.CDOIDProvider

Methods inherited from interface org.eclipse.emf.cdo.common.lob.CDOLobLoader

Methods inherited from interface org.eclipse.emf.cdo.common.security.CDOPermissionProvider

Methods inherited from interface org.eclipse.net4j.util.collection.Closeable

Methods inherited from interface org.eclipse.net4j.util.collection.Entity.Store.Provider

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

Methods inherited from interface org.eclipse.net4j.util.container.IContainer

Methods inherited from interface org.eclipse.net4j.util.concurrent.IExecutorServiceProvider

Methods inherited from interface org.eclipse.net4j.util.event.INotifier

Methods inherited from interface org.eclipse.net4j.util.properties.IPropertiesContainer

Methods inherited from interface org.eclipse.emf.cdo.server.ISession

Methods inherited from interface org.eclipse.net4j.util.security.IUserAware

Field Details

TEMP_VIEW_ID

Method Details

getManager

getRepository

setUserID

getCollectionLoadingConfig

setCollectionLoadingConfig

setOpeningTime

getFirstUpdateTime

setFirstUpdateTime

isOpenOnClientSide

setOpenOnClientSide

getViews

getView

openView

openView

openTransaction

openTransaction

viewClosed

setSubscribed

collectContainedRevisions

sendRepositoryTypeNotification

sendRepositoryStateNotification

sendBranchNotification

sendTagNotification

sendCommitNotification

sendRemoteSessionNotification

sendRemoteMessageNotification

sendLockNotification

sendLockOwnerRemappedNotification

getLockModCount

setLockModCountBaseline

reserveLockChange

isLockChangesQuiescent

awaitLockChangesQuiescent

isLockStateRelevantForSnapshot

sendLockNotification

viewClosed

sendRepositoryStateNotification

sendBranchNotification

sendBranchNotification

sendCommitNotification

sendCommitNotification

sendRemoteSessionNotification

sendRemoteMessageNotification

sendLockOwnerRemappedNotification