bundles/org.simantics.db.management/src/org/simantics/db/management/SessionContext.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2011 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.db.management;\r
  13 \r
  14 import java.io.IOException;\r
  15 import java.lang.reflect.Method;\r
  16 import java.util.Arrays;\r
  17 import java.util.UUID;\r
  18 import java.util.concurrent.TimeoutException;\r
  19 \r
  20 import org.eclipse.core.runtime.IStatus;\r
  21 import org.simantics.db.Disposable;\r
  22 import org.simantics.db.ReadGraph;\r
  23 import org.simantics.db.ServerReference;\r
  24 import org.simantics.db.Session;\r
  25 import org.simantics.db.SessionManager;\r
  26 import org.simantics.db.SessionReference;\r
  27 import org.simantics.db.VirtualGraph;\r
  28 import org.simantics.db.authentication.UserAuthenticationAgent;\r
  29 import org.simantics.db.common.processor.MergingDelayedWriteProcessor;\r
  30 import org.simantics.db.common.processor.MergingGraphRequestProcessor;\r
  31 import org.simantics.db.common.request.ReadRequest;\r
  32 import org.simantics.db.exception.DatabaseException;\r
  33 import org.simantics.db.exception.InternalException;\r
  34 import org.simantics.db.management.internal.Activator;\r
  35 import org.simantics.db.service.LifecycleSupport;\r
  36 import org.simantics.db.service.VirtualGraphSupport;\r
  37 import org.simantics.db.services.GlobalServiceInitializer;\r
  38 import org.simantics.layer0.Layer0;\r
  39 import org.simantics.utils.datastructures.disposable.DisposeState;\r
  40 import org.simantics.utils.datastructures.disposable.IDisposable;\r
  41 import org.simantics.utils.datastructures.disposable.IDisposeListener;\r
  42 import org.simantics.utils.datastructures.hints.HintContext;\r
  43 import org.simantics.utils.threads.IThreadWorkQueue;\r
  44 import org.simantics.utils.threads.SyncListenerList;\r
  45 \r
  46 import fi.vtt.simantics.procore.ProCoreServerReference;\r
  47 import fi.vtt.simantics.procore.ProCoreSessionReference;\r
  48 import fi.vtt.simantics.procore.SessionManagerSource;\r
  49 \r
  50 /**\r
  51  * Holds all information that is needed to create and manage a single database\r
  52  * session in the Simantics workbench UI.\r
  53  *\r
  54  * @see org.simantics.ui.SimanticsUI\r
  55  * @see org.simantics.db.layer0.util.Simantics\r
  56  * @author Tuukka Lehtonen\r
  57  */\r
  58 public class SessionContext extends HintContext implements ISessionContext, Disposable {\r
  59     private static final boolean    SESSION_DEBUG            = false;\r
  60 \r
  61 //    private final IServerAddress        address;\r
  62 \r
  63     private Session                 session;\r
  64 \r
  65     private UserAuthenticationAgent authenticator;\r
  66 \r
  67     private boolean                 servicesRegistered       = false;\r
  68 \r
  69     private IStatus                 servicesRegisteredStatus = null;\r
  70 \r
  71     public static SessionContext create(Session session, boolean initialize) throws DatabaseException {\r
  72         return new SessionContext(session, initialize);\r
  73     }\r
  74 \r
  75 //    public static SessionContext openSession(IServerAddress info, UserAuthenticationAgent auth) throws IOException, DatabaseException {\r
  76 //        return new SessionContext(info, auth, false);\r
  77 //    }\r
  78 //\r
  79 //    public static SessionContext openAndInitializeSession(IServerAddress info, UserAuthenticationAgent auth) throws IOException, DatabaseException {\r
  80 //        return new SessionContext(info, auth, true);\r
  81 //    }\r
  82 \r
  83     private static SessionReference createSessionReference(/*IServerAddress address,*/ long sessionId) throws InternalException {\r
  84         ProCoreServerReference server = new ProCoreServerReference();\r
  85         ProCoreSessionReference ref = new ProCoreSessionReference(server, sessionId);\r
  86         return ref;\r
  87     }\r
  88 \r
  89 //    private SessionContext(IServerAddress addr, UserAuthenticationAgent auth, boolean initialize) throws IOException, DatabaseException {\r
  90 //        if (addr == null)\r
  91 //            throw new IllegalArgumentException("null address");\r
  92 ////        this.address = addr;\r
  93 //        this.authenticator = auth;\r
  94 //\r
  95 //        SessionManager sessionManager = SessionManagerProvider.getInstance().getSessionManager();\r
  96 //\r
  97 //        if (initialize) {\r
  98 //            initializeSession(sessionManager);\r
  99 //            if (SESSION_DEBUG) {\r
 100 //                System.err.println("Initialized session: " + addr);\r
 101 //                System.err.flush();\r
 102 //            }\r
 103 //        } else {\r
 104 //            SessionReference ref = createSessionReference(SessionManagerSource.NullSessionId);\r
 105 //            this.session = sessionManager.createSession(ref, auth);\r
 106 //            if (SESSION_DEBUG) {\r
 107 //                System.err.println("Opened session: " + addr);\r
 108 //                System.err.flush();\r
 109 //            }\r
 110 //        }\r
 111 //\r
 112 //    }\r
 113 \r
 114     private SessionContext(Session session, boolean initialize) throws DatabaseException {\r
 115         if (initialize)\r
 116             initializeSession(session);\r
 117         ServerReference ref = session.getService( LifecycleSupport.class ).getSessionReference().getServerReference();\r
 118 //        this.address = ref.serverAddress();\r
 119         this.session = session;\r
 120     }\r
 121 \r
 122     private void initializeSession(SessionManager sessionManager) throws DatabaseException, IOException {\r
 123         Session s = null;\r
 124         boolean success = false;\r
 125         try {\r
 126             SessionReference ref = createSessionReference(SessionManagerSource.NullSessionId);\r
 127             s = sessionManager.createSession(ref, authenticator);\r
 128             initializeSession(s);\r
 129             this.session = s;\r
 130             success = true;\r
 131         } finally {\r
 132             if (!success) {\r
 133                 if (s != null) {\r
 134                     LifecycleSupport support = s.getService(LifecycleSupport.class);\r
 135                     support.close();\r
 136                 }\r
 137             }\r
 138         }\r
 139     }\r
 140 \r
 141     private void initializeSession(Session s) throws DatabaseException {\r
 142         s.registerService(MergingGraphRequestProcessor.class, new MergingGraphRequestProcessor("SessionService", s, 20));\r
 143         s.registerService(MergingDelayedWriteProcessor.class, new MergingDelayedWriteProcessor(s, 20));\r
 144         s.registerService(VirtualGraph.class, s.getService(VirtualGraphSupport.class).getMemoryPersistent(UUID.randomUUID().toString()));\r
 145 \r
 146         // Builtins needs to be initialized for the new session before\r
 147         // anything useful can be done with it.\r
 148         s.syncRequest(new ReadRequest() {\r
 149             @Override\r
 150             public void run(ReadGraph g) {\r
 151                 // Registers Builtins with the ServiceLocator of the Graph's session.\r
 152                 Layer0.getInstance(g);\r
 153             }\r
 154         });\r
 155     }\r
 156 \r
 157     public void registerServices() {\r
 158         if (servicesRegistered)\r
 159             return;\r
 160 \r
 161         // Register any services available for the SessionLocator of the new\r
 162         // Session.\r
 163         servicesRegisteredStatus = new GlobalServiceInitializer().initialize(session);\r
 164         if (!servicesRegisteredStatus.isOK()) {\r
 165             Activator.getDefault().getLog().log(servicesRegisteredStatus);\r
 166         }\r
 167 \r
 168         servicesRegistered = true;\r
 169     }\r
 170 \r
 171 //    @Override\r
 172 //    public IServerAddress getAddress() {\r
 173 //        return address;\r
 174 //    }\r
 175 \r
 176     @Override\r
 177     public Session getSession() {\r
 178         if (session == null)\r
 179             throw new IllegalStateException("SessionContext is disposed");\r
 180         return session;\r
 181     }\r
 182 \r
 183     @Override\r
 184     public Session peekSession() {\r
 185         return session;\r
 186     }\r
 187 \r
 188     /**\r
 189      * Do dispose procedures. This method is invoked at most once.\r
 190      */\r
 191     protected void doDispose() {\r
 192         try {\r
 193             doClose();\r
 194         } catch (Exception e) {\r
 195             throw new RuntimeException(e);\r
 196         }\r
 197     }\r
 198 \r
 199     @Override\r
 200     public void close() throws IllegalStateException, InterruptedException, TimeoutException {\r
 201         try {\r
 202             dispose();\r
 203         } catch (RuntimeException e) {\r
 204             Throwable t = e.getCause();\r
 205             if (t instanceof RuntimeException) {\r
 206                 throw (RuntimeException) t;\r
 207             } else if (t instanceof Error) {\r
 208                 throw (Error) t;\r
 209             } else if (t instanceof InterruptedException) {\r
 210                 throw (InterruptedException) t;\r
 211             } else if (t instanceof TimeoutException) {\r
 212                 throw (TimeoutException) t;\r
 213             }\r
 214             throw e;\r
 215         }\r
 216     }\r
 217 \r
 218     private void doClose() throws DatabaseException {\r
 219         for (Key k : getHints().keySet()) {\r
 220             if (k != null) {\r
 221                 Object o = removeHint(k);\r
 222                 if (o instanceof IDisposable) {\r
 223                     ((IDisposable) o).safeDispose();\r
 224                 }\r
 225             }\r
 226         }\r
 227 \r
 228         if (session != null) {\r
 229             if (SESSION_DEBUG) {\r
 230                 System.err.println("Closing session: " + session/*address*/);\r
 231                 System.err.flush();\r
 232             }\r
 233             LifecycleSupport support = session.getService(LifecycleSupport.class);\r
 234             support.close(0, true);\r
 235             session = null;\r
 236         }\r
 237     }\r
 238 \r
 239     @Override\r
 240     public int hashCode() {\r
 241         if (session == null) return 0;\r
 242         return session.hashCode();\r
 243     }\r
 244 \r
 245     @Override\r
 246     public boolean equals(Object obj) {\r
 247         if (this == obj)\r
 248             return true;\r
 249         if (obj == null || getClass() != obj.getClass())\r
 250             return false;\r
 251         final SessionContext other = (SessionContext) obj;\r
 252 //        if (!address.equals(other.address))\r
 253 //            return false;\r
 254         return session.equals(other.session);\r
 255     }\r
 256 \r
 257     @Override\r
 258     public String toString() {\r
 259         StringBuilder s = new StringBuilder();\r
 260         s.append("SessionContext [info=" + session + ", hints=");\r
 261         s.append(Arrays.toString(getHints().values().toArray()));\r
 262         s.append("]");\r
 263         return s.toString();\r
 264     }\r
 265 \r
 266 \r
 267     // IDisposable implementation (AbstractDisposable)\r
 268 \r
 269     SyncListenerList<IDisposeListener> disposeListeners = null;\r
 270 \r
 271     private DisposeState disposeStatus = DisposeState.Alive;\r
 272 \r
 273     protected void assertNotDisposed() {\r
 274         if (isDisposed())\r
 275             throw new AssertionError(this + " is disposed.");\r
 276     }\r
 277 \r
 278     @Override\r
 279     public DisposeState getDisposeState() {\r
 280         return disposeStatus;\r
 281     }\r
 282 \r
 283     @Override\r
 284     public boolean isDisposed() {\r
 285         return disposeStatus == DisposeState.Disposed;\r
 286     }\r
 287 \r
 288     public boolean isAlive() {\r
 289         return disposeStatus == DisposeState.Alive;\r
 290     }\r
 291 \r
 292     @Override\r
 293     public void dispose() {\r
 294         try {\r
 295             synchronized (this) {\r
 296                 if (disposeStatus == DisposeState.Disposing)\r
 297                     return;\r
 298                 assertNotDisposed();\r
 299                 disposeStatus = DisposeState.Disposing;\r
 300             }\r
 301             try {\r
 302                 fireDisposed();\r
 303             } finally {\r
 304                 doDispose();\r
 305             }\r
 306         } finally {\r
 307             synchronized(this) {\r
 308                 disposeStatus = DisposeState.Disposed;\r
 309             }\r
 310         }\r
 311     }\r
 312 \r
 313     /**\r
 314      * Disposes if not disposed\r
 315      */\r
 316     @Override\r
 317     public void safeDispose() {\r
 318         try {\r
 319             synchronized (this) {\r
 320                 if (disposeStatus != DisposeState.Alive)\r
 321                     return;\r
 322                 disposeStatus = DisposeState.Disposing;\r
 323             }\r
 324             try {\r
 325                 fireDisposed();\r
 326             } finally {\r
 327                 doDispose();\r
 328             }\r
 329         } finally {\r
 330             synchronized(this) {\r
 331                 disposeStatus = DisposeState.Disposed;\r
 332             }\r
 333         }\r
 334     }\r
 335 \r
 336     protected boolean hasDisposeListeners() {\r
 337         return disposeListeners!=null && !disposeListeners.isEmpty();\r
 338     }\r
 339 \r
 340     private final static Method onDisposed = SyncListenerList.getMethod(IDisposeListener.class, "onDisposed");\r
 341 \r
 342     private void fireDisposed() {\r
 343         if (disposeListeners==null) return;\r
 344         disposeListeners.fireEventSync(onDisposed, this);\r
 345     }\r
 346 \r
 347     @SuppressWarnings("unused")\r
 348     private void fireDisposedAsync() {\r
 349         if (disposeListeners==null) return;\r
 350         disposeListeners.fireEventAsync(onDisposed, this);\r
 351     }\r
 352 \r
 353     @Override\r
 354     public void addDisposeListener(IDisposeListener listener) {\r
 355         lazyGetListenerList().add(listener);\r
 356     }\r
 357 \r
 358     @Override\r
 359     public void addDisposeListener(IDisposeListener listener, IThreadWorkQueue thread) {\r
 360         lazyGetListenerList().add(thread, listener);\r
 361     }\r
 362 \r
 363     @Override\r
 364     public void removeDisposeListener(IDisposeListener listener) {\r
 365         if (disposeListeners==null) return;\r
 366         disposeListeners.remove(listener);\r
 367     }\r
 368 \r
 369     @Override\r
 370     public void removeDisposeListener(IDisposeListener listener, IThreadWorkQueue thread) {\r
 371         if (disposeListeners==null) return;\r
 372         disposeListeners.remove(thread, listener);\r
 373     }\r
 374 \r
 375     private synchronized SyncListenerList<IDisposeListener> lazyGetListenerList()\r
 376     {\r
 377         if (disposeListeners==null)\r
 378             disposeListeners = new SyncListenerList<IDisposeListener>(IDisposeListener.class);\r
 379         return disposeListeners;\r
 380     }\r
 381 \r
 382     @Override\r
 383     protected void finalize() throws Throwable {\r
 384         try {\r
 385             safeDispose();\r
 386         } finally {\r
 387             super.finalize();\r
 388         }\r
 389     }\r
 390 \r
 391 }\r