From fb0ed6d981d1e8e9b4cae810451d3916d80ff42f Mon Sep 17 00:00:00 2001 From: Eike Stepper Date: Sun, 10 Jun 2012 10:14:33 +0200 Subject: Javadocs: Include SPI --- .../eclipse/emf/spi/cdo/CDOSessionProtocol.html | 1497 ++++++++++++++++++++ 1 file changed, 1497 insertions(+) create mode 100644 plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/spi/cdo/CDOSessionProtocol.html (limited to 'plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/spi/cdo/CDOSessionProtocol.html') diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/spi/cdo/CDOSessionProtocol.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/spi/cdo/CDOSessionProtocol.html new file mode 100644 index 0000000000..981bae9c43 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/spi/cdo/CDOSessionProtocol.html @@ -0,0 +1,1497 @@ + + + + + + +CDOSessionProtocol (CDO Model Repository Documentation) + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Use  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.eclipse.emf.spi.cdo +
+Interface CDOSessionProtocol

+
+
All Superinterfaces:
CDOProtocol, InternalCDOBranchManager.BranchLoader, InternalCDOCommitInfoManager.CommitInfoLoader, InternalCDOPackageRegistry.PackageLoader, InternalCDORevisionManager.RevisionLoader
+
+
+
+
public interface CDOSessionProtocol +
extends CDOProtocol, InternalCDOPackageRegistry.PackageLoader, InternalCDOBranchManager.BranchLoader, InternalCDORevisionManager.RevisionLoader, InternalCDOCommitInfoManager.CommitInfoLoader +
+ + + + + + + + + + +
+ + + +

+

+
Since:
+
2.0
+
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
+static classCDOSessionProtocol.CommitTransactionResult + +
+           
+static classCDOSessionProtocol.LockObjectsResult + +
+           
+static classCDOSessionProtocol.OpenSessionResult + +
+           
+static classCDOSessionProtocol.RefreshSessionResult + +
+           
+static classCDOSessionProtocol.RepositoryTimeResult + +
+           
+static classCDOSessionProtocol.UnlockObjectsResult + +
+           
+  + + + + + + + +
Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.spi.common.branch.InternalCDOBranchManager.BranchLoader
InternalCDOBranchManager.BranchLoader.BranchInfo, InternalCDOBranchManager.BranchLoader.SubBranchInfo
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface org.eclipse.emf.cdo.spi.common.branch.InternalCDOBranchManager.BranchLoader
NEW_BRANCH, NEW_LOCAL_BRANCH
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleancancelQuery(int queryId) + +
+           
+ StringchangeLockArea(CDOView view, + boolean create) + +
+           
+ voidchangeSubscription(int viewId, + List<CDOID> ids, + boolean subscribeMode, + boolean clear) + +
+           
+ voidcloseView(int viewID) + +
+           
+ CDOSessionProtocol.CommitTransactionResultcommitDelegation(CDOBranch branch, + String userID, + String comment, + CDOCommitData commitData, + Map<CDOID,EClass> detachedObjectTypes, + Collection<CDOLob<?>> lobs, + OMMonitor monitor) + +
+          Deprecated. Not called anymore. Use #commitDelegation(InternalCDOCommitContext, OMMonitor) instead.
+ CDOSessionProtocol.CommitTransactionResultcommitDelegation(InternalCDOTransaction.InternalCDOCommitContext context, + OMMonitor monitor) + +
+           
+ CDOSessionProtocol.CommitTransactionResultcommitTransaction(InternalCDOTransaction.InternalCDOCommitContext context, + OMMonitor monitor) + +
+           
+ CDOSessionProtocol.CommitTransactionResultcommitTransaction(int transactionID, + String comment, + boolean releaseLocks, + CDOIDProvider idProvider, + CDOCommitData commitData, + Collection<CDOLob<?>> lobs, + OMMonitor monitor) + +
+          Deprecated. Not called anymore. Use #commitTransaction(InternalCDOCommitContext, OMMonitor) instead.
+ CDOSessionProtocol.CommitTransactionResultcommitXATransactionCancel(InternalCDOXATransaction.InternalCDOXACommitContext xaContext, + OMMonitor monitor) + +
+           
+ CDOSessionProtocol.CommitTransactionResultcommitXATransactionPhase1(InternalCDOXATransaction.InternalCDOXACommitContext xaContext, + OMMonitor monitor) + +
+           
+ CDOSessionProtocol.CommitTransactionResultcommitXATransactionPhase2(InternalCDOXATransaction.InternalCDOXACommitContext xaContext, + OMMonitor monitor) + +
+           
+ CDOSessionProtocol.CommitTransactionResultcommitXATransactionPhase3(InternalCDOXATransaction.InternalCDOXACommitContext xaContext, + OMMonitor monitor) + +
+           
+ CDOSessionProtocol.LockObjectsResultdelegateLockObjects(String lockAreaID, + List<CDORevisionKey> revisionKeys, + CDOBranch viewedBranch, + IRWLockManager.LockType lockType, + boolean recursive, + long timeout) + +
+           
+ CDOSessionProtocol.UnlockObjectsResultdelegateUnlockObjects(String lockAreaID, + Collection<CDOID> objectIDs, + IRWLockManager.LockType lockType, + boolean recursive) + +
+           
+ voiddisablePassiveUpdate() + +
+           
+ voidenableLockNotifications(int viewID, + boolean enable) + +
+           
+ CDOLockState[]getLockStates(int viewID, + Collection<CDOID> ids) + +
+           
+ List<CDORemoteSession>getRemoteSessions(InternalCDORemoteSessionManager manager, + boolean subscribe) + +
+           
+ CDOSessionProtocol.RepositoryTimeResultgetRepositoryTime() + +
+           
+ voidhandleRevisions(EClass eClass, + CDOBranch branch, + boolean exactBranch, + long timeStamp, + boolean exactTime, + CDORevisionHandler handler) + +
+           
+ booleanisObjectLocked(CDOView view, + CDOObject object, + IRWLockManager.LockType lockType, + boolean byOthers) + +
+           
+ CDOChangeSetData[]loadChangeSets(CDOBranchPointRange... ranges) + +
+           
+ ObjectloadChunk(InternalCDORevision revision, + EStructuralFeature feature, + int accessIndex, + int fetchIndex, + int fromIndex, + int toIndex) + +
+           
+ voidloadLob(CDOLobInfo info, + Object outputStreamOrWriter) + +
+           
+ Set<CDOID>loadMergeData(CDORevisionAvailabilityInfo targetInfo, + CDORevisionAvailabilityInfo sourceInfo, + CDORevisionAvailabilityInfo targetBaseInfo, + CDORevisionAvailabilityInfo sourceBaseInfo) + +
+           
+ CDOSessionProtocol.LockObjectsResultlockObjects(List<InternalCDORevision> viewedRevisions, + int viewID, + CDOBranch viewedBranch, + IRWLockManager.LockType lockType, + long timeout) + +
+          Deprecated. Not called anymore. Use #lockObjects2(List, int, CDOBranch, LockType, boolean, long) instead.
+ CDOSessionProtocol.LockObjectsResultlockObjects2(List<CDORevisionKey> revisionKeys, + int viewID, + CDOBranch viewedBranch, + IRWLockManager.LockType lockType, + boolean recursive, + long timeout) + +
+           
+ voidopenView(int viewID, + boolean readOnly, + CDOBranchPoint branchPoint) + +
+           
+ CDOBranchPointopenView(int viewID, + boolean readOnly, + String durableLockingID) + +
+           
+ voidquery(CDOView view, + AbstractQueryIterator<?> queryResult) + +
+           
+ List<byte[]>queryLobs(Set<byte[]> ids) + +
+           
+ CDOSessionProtocol.RefreshSessionResultrefresh(long lastUpdateTime, + Map<CDOBranch,Map<CDOID,InternalCDORevision>> viewedRevisions, + int initialChunkSize, + boolean enablePassiveUpdates) + +
+           
+ voidreplicateRepository(CDOReplicationContext context, + OMMonitor monitor) + +
+           
+ voidreplicateRepositoryRaw(CDORawReplicationContext context, + OMMonitor monitor) + +
+           
+ Set<Integer>sendRemoteMessage(CDORemoteSessionMessage message, + List<CDORemoteSession> recipients) + +
+           
+ voidsetLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode) + +
+           
+ voidsetPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode mode) + +
+           
+ voidswitchTarget(int viewID, + CDOBranchPoint branchPoint, + List<InternalCDOObject> invalidObjects, + List<CDORevisionKey> allChangedObjects, + List<CDOIDAndVersion> allDetachedObjects, + OMMonitor monitor) + +
+           
+ voidunlockObjects(CDOView view, + Collection<CDOID> objectIDs, + IRWLockManager.LockType lockType) + +
+          Deprecated. Not called anymore. Use #unlockObjects2(CDOView, Collection, LockType, boolean) instead.
+ CDOSessionProtocol.UnlockObjectsResultunlockObjects2(CDOView view, + Collection<CDOID> objectIDs, + IRWLockManager.LockType lockType, + boolean recursive) + +
+           
+ booleanunsubscribeRemoteSessions() + +
+           
+  + + + + + + + +
Methods inherited from interface org.eclipse.emf.cdo.common.protocol.CDOProtocol
getSession
+  + + + + + + + +
Methods inherited from interface org.eclipse.emf.cdo.spi.common.model.InternalCDOPackageRegistry.PackageLoader
loadPackages
+  + + + + + + + +
Methods inherited from interface org.eclipse.emf.cdo.spi.common.branch.InternalCDOBranchManager.BranchLoader
createBranch, loadBranch, loadBranches, loadSubBranches
+  + + + + + + + +
Methods inherited from interface org.eclipse.emf.cdo.spi.common.revision.InternalCDORevisionManager.RevisionLoader
loadRevisionByVersion, loadRevisions
+  + + + + + + + +
Methods inherited from interface org.eclipse.emf.cdo.spi.common.commit.InternalCDOCommitInfoManager.CommitInfoLoader
loadCommitData, loadCommitInfos
+  +

+ + + + + + + + +
+Method Detail
+ +

+getRepositoryTime

+
+CDOSessionProtocol.RepositoryTimeResult getRepositoryTime()
+
+
+
+
+
+
+
+
+
+ +

+disablePassiveUpdate

+
+void disablePassiveUpdate()
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+setPassiveUpdateMode

+
+void setPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode mode)
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+setLockNotificationMode

+
+void setLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode)
+
+
+
+
+
+
Since:
+
4.1
+
+
+
+
+ +

+refresh

+
+CDOSessionProtocol.RefreshSessionResult refresh(long lastUpdateTime,
+                                                Map<CDOBranch,Map<CDOID,InternalCDORevision>> viewedRevisions,
+                                                int initialChunkSize,
+                                                boolean enablePassiveUpdates)
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+loadChunk

+
+Object loadChunk(InternalCDORevision revision,
+                 EStructuralFeature feature,
+                 int accessIndex,
+                 int fetchIndex,
+                 int fromIndex,
+                 int toIndex)
+
+
+
+
+
+
Parameters:
accessIndex - Index of the item access at the client (with modifications)
fetchIndex - Index of the item access at the server (without any modifications)
fromIndex - Load objects at the client from fromIndex (inclusive)
toIndex - Load objects at the client to toIndex (inclusive)
+
+
+
+ +

+openView

+
+void openView(int viewID,
+              boolean readOnly,
+              CDOBranchPoint branchPoint)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+openView

+
+CDOBranchPoint openView(int viewID,
+                        boolean readOnly,
+                        String durableLockingID)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+switchTarget

+
+void switchTarget(int viewID,
+                  CDOBranchPoint branchPoint,
+                  List<InternalCDOObject> invalidObjects,
+                  List<CDORevisionKey> allChangedObjects,
+                  List<CDOIDAndVersion> allDetachedObjects,
+                  OMMonitor monitor)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+closeView

+
+void closeView(int viewID)
+
+
+
+
+
+
+
+
+
+ +

+changeSubscription

+
+void changeSubscription(int viewId,
+                        List<CDOID> ids,
+                        boolean subscribeMode,
+                        boolean clear)
+
+
+
+
+
+
+
+
+
+ +

+query

+
+void query(CDOView view,
+           AbstractQueryIterator<?> queryResult)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+cancelQuery

+
+boolean cancelQuery(int queryId)
+
+
+
+
+
+
+
+
+
+ +

+lockObjects

+
+@Deprecated
+CDOSessionProtocol.LockObjectsResult lockObjects(List<InternalCDORevision> viewedRevisions,
+                                                            int viewID,
+                                                            CDOBranch viewedBranch,
+                                                            IRWLockManager.LockType lockType,
+                                                            long timeout)
+                                                 throws InterruptedException
+
+
Deprecated. Not called anymore. Use #lockObjects2(List, int, CDOBranch, LockType, boolean, long) instead. +

+

+
+
+
+ +
Throws: +
InterruptedException
Since:
+
4.0
+
+
+
+
+ +

+lockObjects2

+
+CDOSessionProtocol.LockObjectsResult lockObjects2(List<CDORevisionKey> revisionKeys,
+                                                  int viewID,
+                                                  CDOBranch viewedBranch,
+                                                  IRWLockManager.LockType lockType,
+                                                  boolean recursive,
+                                                  long timeout)
+                                                  throws InterruptedException
+
+
+
+
+
+ +
Throws: +
InterruptedException
Since:
+
4.1
+
+
+
+
+ +

+delegateLockObjects

+
+CDOSessionProtocol.LockObjectsResult delegateLockObjects(String lockAreaID,
+                                                         List<CDORevisionKey> revisionKeys,
+                                                         CDOBranch viewedBranch,
+                                                         IRWLockManager.LockType lockType,
+                                                         boolean recursive,
+                                                         long timeout)
+                                                         throws InterruptedException
+
+
+
+
+
+ +
Throws: +
InterruptedException
Since:
+
4.1
+
+
+
+
+ +

+unlockObjects

+
+@Deprecated
+void unlockObjects(CDOView view,
+                              Collection<CDOID> objectIDs,
+                              IRWLockManager.LockType lockType)
+
+
Deprecated. Not called anymore. Use #unlockObjects2(CDOView, Collection, LockType, boolean) instead. +

+

+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+unlockObjects2

+
+CDOSessionProtocol.UnlockObjectsResult unlockObjects2(CDOView view,
+                                                      Collection<CDOID> objectIDs,
+                                                      IRWLockManager.LockType lockType,
+                                                      boolean recursive)
+
+
+
+
+
+
Since:
+
4.1
+
+
+
+
+ +

+delegateUnlockObjects

+
+CDOSessionProtocol.UnlockObjectsResult delegateUnlockObjects(String lockAreaID,
+                                                             Collection<CDOID> objectIDs,
+                                                             IRWLockManager.LockType lockType,
+                                                             boolean recursive)
+
+
+
+
+
+
Since:
+
4.1
+
+
+
+
+ +

+isObjectLocked

+
+boolean isObjectLocked(CDOView view,
+                       CDOObject object,
+                       IRWLockManager.LockType lockType,
+                       boolean byOthers)
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+changeLockArea

+
+String changeLockArea(CDOView view,
+                      boolean create)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+queryLobs

+
+List<byte[]> queryLobs(Set<byte[]> ids)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+loadLob

+
+void loadLob(CDOLobInfo info,
+             Object outputStreamOrWriter)
+             throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
Since:
+
4.0
+
+
+
+
+ +

+commitTransaction

+
+@Deprecated
+CDOSessionProtocol.CommitTransactionResult commitTransaction(int transactionID,
+                                                                        String comment,
+                                                                        boolean releaseLocks,
+                                                                        CDOIDProvider idProvider,
+                                                                        CDOCommitData commitData,
+                                                                        Collection<CDOLob<?>> lobs,
+                                                                        OMMonitor monitor)
+
+
Deprecated. Not called anymore. Use #commitTransaction(InternalCDOCommitContext, OMMonitor) instead. +

+

+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+commitTransaction

+
+CDOSessionProtocol.CommitTransactionResult commitTransaction(InternalCDOTransaction.InternalCDOCommitContext context,
+                                                             OMMonitor monitor)
+
+
+
+
+
+
Since:
+
4.1
+
+
+
+
+ +

+commitDelegation

+
+@Deprecated
+CDOSessionProtocol.CommitTransactionResult commitDelegation(CDOBranch branch,
+                                                                       String userID,
+                                                                       String comment,
+                                                                       CDOCommitData commitData,
+                                                                       Map<CDOID,EClass> detachedObjectTypes,
+                                                                       Collection<CDOLob<?>> lobs,
+                                                                       OMMonitor monitor)
+
+
Deprecated. Not called anymore. Use #commitDelegation(InternalCDOCommitContext, OMMonitor) instead. +

+

+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+commitDelegation

+
+CDOSessionProtocol.CommitTransactionResult commitDelegation(InternalCDOTransaction.InternalCDOCommitContext context,
+                                                            OMMonitor monitor)
+
+
+
+
+
+
Since:
+
4.1
+
+
+
+
+ +

+commitXATransactionPhase1

+
+CDOSessionProtocol.CommitTransactionResult commitXATransactionPhase1(InternalCDOXATransaction.InternalCDOXACommitContext xaContext,
+                                                                     OMMonitor monitor)
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+commitXATransactionPhase2

+
+CDOSessionProtocol.CommitTransactionResult commitXATransactionPhase2(InternalCDOXATransaction.InternalCDOXACommitContext xaContext,
+                                                                     OMMonitor monitor)
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+commitXATransactionPhase3

+
+CDOSessionProtocol.CommitTransactionResult commitXATransactionPhase3(InternalCDOXATransaction.InternalCDOXACommitContext xaContext,
+                                                                     OMMonitor monitor)
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+commitXATransactionCancel

+
+CDOSessionProtocol.CommitTransactionResult commitXATransactionCancel(InternalCDOXATransaction.InternalCDOXACommitContext xaContext,
+                                                                     OMMonitor monitor)
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+getRemoteSessions

+
+List<CDORemoteSession> getRemoteSessions(InternalCDORemoteSessionManager manager,
+                                         boolean subscribe)
+
+
+
+
+
+
+
+
+
+ +

+sendRemoteMessage

+
+Set<Integer> sendRemoteMessage(CDORemoteSessionMessage message,
+                               List<CDORemoteSession> recipients)
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+unsubscribeRemoteSessions

+
+boolean unsubscribeRemoteSessions()
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+replicateRepository

+
+void replicateRepository(CDOReplicationContext context,
+                         OMMonitor monitor)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+replicateRepositoryRaw

+
+void replicateRepositoryRaw(CDORawReplicationContext context,
+                            OMMonitor monitor)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+loadChangeSets

+
+CDOChangeSetData[] loadChangeSets(CDOBranchPointRange... ranges)
+
+
+
+
+
+
Since:
+
3.0
+
+
+
+
+ +

+loadMergeData

+
+Set<CDOID> loadMergeData(CDORevisionAvailabilityInfo targetInfo,
+                         CDORevisionAvailabilityInfo sourceInfo,
+                         CDORevisionAvailabilityInfo targetBaseInfo,
+                         CDORevisionAvailabilityInfo sourceBaseInfo)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+handleRevisions

+
+void handleRevisions(EClass eClass,
+                     CDOBranch branch,
+                     boolean exactBranch,
+                     long timeStamp,
+                     boolean exactTime,
+                     CDORevisionHandler handler)
+
+
+
+
+
+
Since:
+
4.0
+
+
+
+
+ +

+getLockStates

+
+CDOLockState[] getLockStates(int viewID,
+                             Collection<CDOID> ids)
+
+
+
+
+
+
Since:
+
4.1
+
+
+
+
+ +

+enableLockNotifications

+
+void enableLockNotifications(int viewID,
+                             boolean enable)
+
+
+
+
+
+
Since:
+
4.1
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Use  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright (c) 2004 - 2012 Eike Stepper (Berlin, Germany) and others. + + -- cgit v1.2.3