Package org.eclipse.emf.cdo.session
Interface CDOSessionConfiguration
- All Superinterfaces:
org.eclipse.net4j.util.event.INotifier
- All Known Subinterfaces:
CDONet4jSessionConfiguration
,CDOSessionConfiguration
,FailoverCDOSessionConfiguration
,InternalCDOSessionConfiguration
,ReconnectingCDOSessionConfiguration
,RecoveringCDOSessionConfiguration
public interface CDOSessionConfiguration
extends org.eclipse.net4j.util.event.INotifier
Configures and opens new
sessions
.
A session configuration can fire the following events:
-
CDOSessionConfiguration.SessionOpenedEvent
after a session has been opened by this configuration.
- Since:
- 2.0
- 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
Modifier and TypeInterfaceDescriptionstatic interface
Fired from asession configuration
after a newsession
has been opened.Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier
org.eclipse.net4j.util.event.INotifier.INotifier2
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.org.eclipse.net4j.util.security.IPasswordCredentialsProvider
boolean
Returnstrue
if the session opened byopenSession()
will be automatically activated,false
otherwise.boolean
boolean
Returnstrue
if the session for this configuration is currently open,false
otherwise.Opens the session for this configuration.void
setActivateOnOpen
(boolean activateOnOpen) Specifies whether the session opened byopenSession()
will be automatically activated or not.void
setBranchManager
(CDOBranchManager branchManager) void
setCredentialsProvider
(org.eclipse.net4j.util.security.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
void
setPassiveUpdateEnabled
(boolean passiveUpdateEnabled) void
setPassiveUpdateMode
(CDOCommonSession.Options.PassiveUpdateMode passiveUpdateMode) void
Methods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListener
-
Method Details
-
getUserID
String getUserID()- Since:
- 4.2
-
setUserID
- Since:
- 4.2
-
isPassiveUpdateEnabled
boolean isPassiveUpdateEnabled()- Since:
- 3.0
- See Also:
-
setPassiveUpdateEnabled
void setPassiveUpdateEnabled(boolean passiveUpdateEnabled) - Since:
- 3.0
- See Also:
-
getPassiveUpdateMode
CDOCommonSession.Options.PassiveUpdateMode getPassiveUpdateMode()- Since:
- 3.0
- See Also:
-
setPassiveUpdateMode
- Since:
- 3.0
- See Also:
-
getLockNotificationMode
CDOCommonSession.Options.LockNotificationMode getLockNotificationMode()- Since:
- 4.1
-
setLockNotificationMode
- Since:
- 4.1
-
getExceptionHandler
CDOSession.ExceptionHandler getExceptionHandler()- See Also:
-
setExceptionHandler
A special exception handler can be set before the session is opened and can not be changed thereafter.- See Also:
-
getIDGenerator
CDOIDGenerator getIDGenerator()- Since:
- 4.1
- See Also:
-
setIDGenerator
A special ID generator can be set before the session is opened and can not be changed thereafter. If notnull
, the passed generator must be thread-safe.- Since:
- 4.1
- See Also:
-
getFetchRuleManager
CDOFetchRuleManager getFetchRuleManager()- Since:
- 4.1
- See Also:
-
setFetchRuleManager
A special ID generator can be set before the session is opened and can not be changed thereafter. If notnull
, the passed generator must be thread-safe.- Since:
- 4.1
- See Also:
-
getBranchManager
CDOBranchManager getBranchManager()- Since:
- 4.2
-
setBranchManager
- Since:
- 4.2
-
getAuthenticator
Deprecated.As of 4.2 usegetCredentialsProvider()
andsetCredentialsProvider(IPasswordCredentialsProvider)
, respectivelyReturns the authenticator of this configuration, nevernull
. -
getCredentialsProvider
org.eclipse.net4j.util.security.IPasswordCredentialsProvider getCredentialsProvider()- Since:
- 4.2
-
setCredentialsProvider
void setCredentialsProvider(org.eclipse.net4j.util.security.IPasswordCredentialsProvider credentialsProvider) - Since:
- 4.2
-
isActivateOnOpen
boolean isActivateOnOpen()Returnstrue
if the session opened byopenSession()
will be automatically activated,false
otherwise. -
setActivateOnOpen
void setActivateOnOpen(boolean activateOnOpen) Specifies whether the session opened byopenSession()
will be automatically activated or not. -
isSessionOpen
boolean isSessionOpen()Returnstrue
if the session for this configuration is currently open,false
otherwise. -
openSession
CDOSession openSession()Opens the session for this configuration. Once the session is openend this method always returns the same session instance. Therefore it is impossible to change this configuration while the session is open.
-
getCredentialsProvider()
andsetCredentialsProvider(IPasswordCredentialsProvider)
, respectively