CDOSessionConfiguration (CDO API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.emf.cdo.session
Interface CDOSessionConfiguration

All Known Subinterfaces:: CDOSessionConfiguration, CDOSessionConfiguration, FailoverCDOSessionConfiguration, InternalCDOSessionConfiguration, ReconnectingCDOSessionConfiguration, RecoveringCDOSessionConfiguration

public interface CDOSessionConfiguration

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.

Method Summary
`CDOAuthenticator`	`getAuthenticator()` Returns the authenticator of this configuration, never `null`.
`CDOSession.ExceptionHandler`	`getExceptionHandler()`
`CDOCommonSession.Options.PassiveUpdateMode`	`getPassiveUpdateMode()`
`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`	`setExceptionHandler(CDOSession.ExceptionHandler exceptionHandler)` A special exception handler can be set before the session is opened and can not be changed thereafter.
`void`	`setPassiveUpdateEnabled(boolean passiveUpdateEnabled)`
`void`	`setPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode passiveUpdateMode)`

Method Detail

isPassiveUpdateEnabled

boolean isPassiveUpdateEnabled()

Since:: 3.0
See Also:: CDOCommonSession.Options.isPassiveUpdateEnabled()

setPassiveUpdateEnabled

void setPassiveUpdateEnabled(boolean passiveUpdateEnabled)

Since:: 3.0
See Also:: CDOCommonSession.Options.setPassiveUpdateEnabled(boolean)

getPassiveUpdateMode

CDOCommonSession.Options.PassiveUpdateMode getPassiveUpdateMode()

Since:: 3.0
See Also:: CDOCommonSession.Options.getPassiveUpdateMode()

setPassiveUpdateMode

void setPassiveUpdateMode(CDOCommonSession.Options.PassiveUpdateMode passiveUpdateMode)

Since:: 3.0
See Also:: CDOCommonSession.Options.setPassiveUpdateMode(PassiveUpdateMode)

getExceptionHandler

CDOSession.ExceptionHandler getExceptionHandler()

See Also:: CDOSession.getExceptionHandler()

setExceptionHandler

void 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()

getAuthenticator

CDOAuthenticator getAuthenticator()

Returns the authenticator of this configuration, never null.

isActivateOnOpen

boolean isActivateOnOpen()

Returns true if the session opened by openSession() will be automatically activated, false otherwise.

setActivateOnOpen

void setActivateOnOpen(boolean activateOnOpen)

Specifies whether the session opened by openSession() will be automatically activated or not.

isSessionOpen

boolean isSessionOpen()

Returns true 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.