blob: 5a5b66a33ef4e564c0fa71782194a1bd1be043a3 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*
* Copyright (c) 2004 - 2012 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
*
* Contributors:
* Eike Stepper - initial API and implementation
*/
package org.eclipse.emf.cdo.session;
import org.eclipse.emf.cdo.common.CDOCommonSession.Options.LockNotificationMode;
import org.eclipse.emf.cdo.common.CDOCommonSession.Options.PassiveUpdateMode;
import org.eclipse.emf.cdo.common.id.CDOIDGenerator;
import org.eclipse.emf.cdo.common.protocol.CDOAuthenticator;
import org.eclipse.emf.cdo.view.CDOFetchRuleManager;
import org.eclipse.net4j.util.event.IEvent;
import org.eclipse.net4j.util.event.INotifier;
/**
* Configures and opens new {@link CDOSession sessions}.
* <p>
* A session configuration can fire the following events:
* <ul>
* <li> {@link CDOSessionConfiguration.SessionOpenedEvent} after a session has been opened by this configuration.
* </ul>
*
* @author Eike Stepper
* @since 2.0
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
* @apiviz.landmark
* @apiviz.uses {@link CDOSession} - - opens
* @apiviz.uses {@link CDOSessionConfiguration.SessionOpenedEvent} - - fires
*/
public interface CDOSessionConfiguration extends INotifier
{
/**
* @since 4.2
*/
public String getUserID();
/**
* @since 4.2
*/
public void setUserID(String userID);
/**
* @see CDOSession.Options#isPassiveUpdateEnabled()
* @since 3.0
*/
public boolean isPassiveUpdateEnabled();
/**
* @see CDOSession.Options#setPassiveUpdateEnabled(boolean)
* @since 3.0
*/
public void setPassiveUpdateEnabled(boolean passiveUpdateEnabled);
/**
* @see CDOSession.Options#getPassiveUpdateMode()
* @since 3.0
*/
public PassiveUpdateMode getPassiveUpdateMode();
/**
* @see CDOSession.Options#setPassiveUpdateMode(PassiveUpdateMode)
* @since 3.0
*/
public void setPassiveUpdateMode(PassiveUpdateMode passiveUpdateMode);
/**
* @since 4.1
*/
public LockNotificationMode getLockNotificationMode();
/**
* @since 4.1
*/
public void setLockNotificationMode(LockNotificationMode mode);
/**
* @see CDOSession#getExceptionHandler()
*/
public CDOSession.ExceptionHandler getExceptionHandler();
/**
* A special exception handler can be set <b>before</b> the session is opened and can not be changed thereafter.
*
* @see CDOSession#getExceptionHandler()
*/
public void setExceptionHandler(CDOSession.ExceptionHandler exceptionHandler);
/**
* @see CDOSession#getIDGenerator()
* @since 4.1
*/
public CDOIDGenerator getIDGenerator();
/**
* A special ID generator can be set <b>before</b> the session is opened and can not be changed thereafter. If not
* <code>null</code>, the passed generator <b>must be</b> thread-safe.
*
* @see CDOSession#getIDGenerator()
* @since 4.1
*/
public void setIDGenerator(CDOIDGenerator idGenerator);
/**
* @see CDOSession#getFetchRuleManager()
* @since 4.1
*/
public CDOFetchRuleManager getFetchRuleManager();
/**
* A special ID generator can be set <b>before</b> the session is opened and can not be changed thereafter. If not
* <code>null</code>, the passed generator <b>must be</b> thread-safe.
*
* @see CDOSession#getFetchRuleManager()
* @since 4.1
*/
public void setFetchRuleManager(CDOFetchRuleManager fetchRuleManager);
/**
* Returns the authenticator of this configuration, never <code>null</code>.
*/
public CDOAuthenticator getAuthenticator();
/**
* Returns <code>true</code> if the session opened by {@link #openSession()} will be automatically activated,
* <code>false</code> otherwise.
*/
public boolean isActivateOnOpen();
/**
* Specifies whether the session opened by {@link #openSession()} will be automatically activated or not.
*/
public void setActivateOnOpen(boolean activateOnOpen);
/**
* Returns <code>true</code> if the session for this configuration is currently open, <code>false</code> otherwise.
*/
public boolean isSessionOpen();
/**
* 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.
*/
public CDOSession openSession();
/**
* Fired from a {@link CDOSessionConfiguration session configuration} after a new {@link CDOSession session} has been
* opened.
*
* @author Eike Stepper
* @since 4.0
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface SessionOpenedEvent extends IEvent
{
public CDOSessionConfiguration getSource();
public CDOSession getOpenedSession();
}
}
|
