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.INotifierConfigures and opens newsessions.A session configuration can fire the following events: -  CDOSessionConfiguration.SessionOpenedEventafter 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 SummaryNested Classes Modifier and Type Interface Description static interfaceCDOSessionConfiguration.SessionOpenedEventFired from asession configurationafter a newsessionhas been opened.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description CDOAuthenticatorgetAuthenticator()Deprecated.As of 4.2 usegetCredentialsProvider()andsetCredentialsProvider(IPasswordCredentialsProvider), respectivelyCDOBranchManagergetBranchManager()org.eclipse.net4j.util.security.IPasswordCredentialsProvidergetCredentialsProvider()CDOSession.ExceptionHandlergetExceptionHandler()CDOFetchRuleManagergetFetchRuleManager()CDOIDGeneratorgetIDGenerator()CDOCommonSession.Options.LockNotificationModegetLockNotificationMode()CDOCommonSession.Options.PassiveUpdateModegetPassiveUpdateMode()java.lang.StringgetUserID()booleanisActivateOnOpen()Returnstrueif the session opened byopenSession()will be automatically activated,falseotherwise.booleanisPassiveUpdateEnabled()booleanisSessionOpen()Returnstrueif the session for this configuration is currently open,falseotherwise.CDOSessionopenSession()Opens the session for this configuration.voidsetActivateOnOpen(boolean activateOnOpen)Specifies whether the session opened byopenSession()will be automatically activated or not.voidsetBranchManager(CDOBranchManager branchManager)voidsetCredentialsProvider(org.eclipse.net4j.util.security.IPasswordCredentialsProvider credentialsProvider)voidsetExceptionHandler(CDOSession.ExceptionHandler exceptionHandler)A special exception handler can be set before the session is opened and can not be changed thereafter.voidsetFetchRuleManager(CDOFetchRuleManager fetchRuleManager)A special ID generator can be set before the session is opened and can not be changed thereafter.voidsetIDGenerator(CDOIDGenerator idGenerator)A special ID generator can be set before the session is opened and can not be changed thereafter.voidsetLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode)voidsetPassiveUpdateEnabled(boolean passiveUpdateEnabled)voidsetPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode passiveUpdateMode)voidsetUserID(java.lang.String userID)
 
- 
- 
- 
Method Detail- 
getUserIDjava.lang.String getUserID() - Since:
- 4.2
 
 - 
setUserIDvoid setUserID(java.lang.String userID) - Since:
- 4.2
 
 - 
isPassiveUpdateEnabledboolean isPassiveUpdateEnabled() - Since:
- 3.0
- See Also:
- CDOCommonSession.Options.isPassiveUpdateEnabled()
 
 - 
setPassiveUpdateEnabledvoid setPassiveUpdateEnabled(boolean passiveUpdateEnabled) - Since:
- 3.0
- See Also:
- CDOCommonSession.Options.setPassiveUpdateEnabled(boolean)
 
 - 
getPassiveUpdateModeCDOCommonSession.Options.PassiveUpdateMode getPassiveUpdateMode() - Since:
- 3.0
- See Also:
- CDOCommonSession.Options.getPassiveUpdateMode()
 
 - 
setPassiveUpdateModevoid setPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode passiveUpdateMode) - Since:
- 3.0
- See Also:
- CDOCommonSession.Options.setPassiveUpdateMode(PassiveUpdateMode)
 
 - 
getLockNotificationModeCDOCommonSession.Options.LockNotificationMode getLockNotificationMode() - Since:
- 4.1
 
 - 
setLockNotificationModevoid setLockNotificationMode(CDOCommonSession.Options.LockNotificationMode mode) - Since:
- 4.1
 
 - 
getExceptionHandlerCDOSession.ExceptionHandler getExceptionHandler() - See Also:
- CDOSession.getExceptionHandler()
 
 - 
setExceptionHandlervoid setExceptionHandler(CDOSession.ExceptionHandler exceptionHandler) A special exception handler can be set before the session is opened and can not be changed thereafter.- See Also:
- CDOSession.getExceptionHandler()
 
 - 
getIDGeneratorCDOIDGenerator getIDGenerator() - Since:
- 4.1
- See Also:
- CDOSession.getIDGenerator()
 
 - 
setIDGeneratorvoid setIDGenerator(CDOIDGenerator idGenerator) 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:
- CDOSession.getIDGenerator()
 
 - 
getFetchRuleManagerCDOFetchRuleManager getFetchRuleManager() - Since:
- 4.1
- See Also:
- CDOSession.getFetchRuleManager()
 
 - 
setFetchRuleManagervoid setFetchRuleManager(CDOFetchRuleManager fetchRuleManager) 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:
- CDOSession.getFetchRuleManager()
 
 - 
getBranchManagerCDOBranchManager getBranchManager() - Since:
- 4.2
 
 - 
setBranchManagervoid setBranchManager(CDOBranchManager branchManager) - Since:
- 4.2
 
 - 
getAuthenticator@Deprecated CDOAuthenticator getAuthenticator() Deprecated.As of 4.2 usegetCredentialsProvider()andsetCredentialsProvider(IPasswordCredentialsProvider), respectivelyReturns the authenticator of this configuration, nevernull.
 - 
getCredentialsProviderorg.eclipse.net4j.util.security.IPasswordCredentialsProvider getCredentialsProvider() - Since:
- 4.2
 
 - 
setCredentialsProvidervoid setCredentialsProvider(org.eclipse.net4j.util.security.IPasswordCredentialsProvider credentialsProvider) - Since:
- 4.2
 
 - 
isActivateOnOpenboolean isActivateOnOpen() Returnstrueif the session opened byopenSession()will be automatically activated,falseotherwise.
 - 
setActivateOnOpenvoid setActivateOnOpen(boolean activateOnOpen) Specifies whether the session opened byopenSession()will be automatically activated or not.
 - 
isSessionOpenboolean isSessionOpen() Returnstrueif the session for this configuration is currently open,falseotherwise.
 - 
openSessionCDOSession 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.
 
- 
 
-