public interface CDOSessionConfiguration extends INotifier
sessions
.
A session configuration can fire the following events:
CDOSessionConfiguration.SessionOpenedEvent
after a session has been opened by this configuration.
CDOSession
- - opens, CDOSessionConfiguration.SessionOpenedEvent
- - firesModifier and Type | Interface and Description |
---|---|
static interface |
CDOSessionConfiguration.SessionOpenedEvent
Fired from a
session configuration after a new session has been
opened. |
Modifier and Type | Method and Description |
---|---|
CDOAuthenticator |
getAuthenticator()
Deprecated.
As of 4.2 use
getCredentialsProvider() and setCredentialsProvider(IPasswordCredentialsProvider) , respectively |
CDOBranchManager |
getBranchManager() |
IPasswordCredentialsProvider |
getCredentialsProvider() |
CDOSession.ExceptionHandler |
getExceptionHandler() |
CDOFetchRuleManager |
getFetchRuleManager() |
CDOIDGenerator |
getIDGenerator() |
CDOCommonSession.Options.LockNotificationMode |
getLockNotificationMode() |
CDOCommonSession.Options.PassiveUpdateMode |
getPassiveUpdateMode() |
String |
getUserID() |
boolean |
isActivateOnOpen()
Returns
true if the session opened by openSession() will be automatically activated,
false otherwise. |
boolean |
isPassiveUpdateEnabled() |
boolean |
isSessionOpen()
Returns
true if the session for this configuration is currently open, false otherwise. |
CDOSession |
openSession()
Opens the session for this configuration.
|
void |
setActivateOnOpen(boolean activateOnOpen)
Specifies whether the session opened by
openSession() will be automatically activated or not. |
void |
setBranchManager(CDOBranchManager branchManager) |
void |
setCredentialsProvider(IPasswordCredentialsProvider credentialsProvider) |
void |
setExceptionHandler(CDOSession.ExceptionHandler exceptionHandler)
A special exception handler can be set before the session is opened and can not be changed thereafter.
|
void |
setFetchRuleManager(CDOFetchRuleManager fetchRuleManager)
A special ID generator can be set before the session is opened and can not be changed thereafter.
|
void |
setIDGenerator(CDOIDGenerator idGenerator)
A special ID generator can be set before the session is opened and can not be changed thereafter.
|
void |
setLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode) |
void |
setPassiveUpdateEnabled(boolean passiveUpdateEnabled) |
void |
setPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode passiveUpdateMode) |
void |
setUserID(String userID) |
addListener, getListeners, hasListeners, removeListener
String getUserID()
void setUserID(String userID)
boolean isPassiveUpdateEnabled()
CDOCommonSession.Options.isPassiveUpdateEnabled()
void setPassiveUpdateEnabled(boolean passiveUpdateEnabled)
CDOCommonSession.Options.setPassiveUpdateEnabled(boolean)
CDOCommonSession.Options.PassiveUpdateMode getPassiveUpdateMode()
CDOCommonSession.Options.getPassiveUpdateMode()
void setPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode passiveUpdateMode)
CDOCommonSession.Options.setPassiveUpdateMode(PassiveUpdateMode)
CDOCommonSession.Options.LockNotificationMode getLockNotificationMode()
void setLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode)
CDOSession.ExceptionHandler getExceptionHandler()
CDOSession.getExceptionHandler()
void setExceptionHandler(CDOSession.ExceptionHandler exceptionHandler)
CDOSession.getExceptionHandler()
CDOIDGenerator getIDGenerator()
CDOSession.getIDGenerator()
void setIDGenerator(CDOIDGenerator idGenerator)
null
, the passed generator must be thread-safe.CDOSession.getIDGenerator()
CDOFetchRuleManager getFetchRuleManager()
CDOSession.getFetchRuleManager()
void setFetchRuleManager(CDOFetchRuleManager fetchRuleManager)
null
, the passed generator must be thread-safe.CDOSession.getFetchRuleManager()
CDOBranchManager getBranchManager()
void setBranchManager(CDOBranchManager branchManager)
@Deprecated CDOAuthenticator getAuthenticator()
getCredentialsProvider()
and setCredentialsProvider(IPasswordCredentialsProvider)
, respectivelynull
.IPasswordCredentialsProvider getCredentialsProvider()
void setCredentialsProvider(IPasswordCredentialsProvider credentialsProvider)
boolean isActivateOnOpen()
true
if the session opened by openSession()
will be automatically activated,
false
otherwise.void setActivateOnOpen(boolean activateOnOpen)
openSession()
will be automatically activated or not.boolean isSessionOpen()
true
if the session for this configuration is currently open, false
otherwise.CDOSession openSession()
Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html