Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.db.management / src / org / simantics / db / management / ISessionContext.java

diff --git a/bundles/org.simantics.db.management/src/org/simantics/db/management/ISessionContext.java b/bundles/org.simantics.db.management/src/org/simantics/db/management/ISessionContext.java
new file mode 100644 (file)
index 0000000..bab16e1
--- /dev/null
+++ b/bundles/org.simantics.db.management/src/org/simantics/db/management/ISessionContext.java
@@ -0,0 +1,54 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2011 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.db.management;\r
+\r
+import java.util.concurrent.TimeoutException;\r
+\r
+import org.simantics.db.Session;\r
+import org.simantics.utils.datastructures.disposable.IDisposable;\r
+import org.simantics.utils.datastructures.hints.IHintContext;\r
+\r
+/**\r
+ * A container for a database session. Also hosts a hint context that can be\r
+ * used to carry arbitrary values around. A server activation can be attached to\r
+ * an ISessionContext for information value only - ISessionContext will never\r
+ * dispose or do anything else with it.\r
+ * \r
+ * <p>\r
+ * Disposal of an ISessionContext closes the session contained by this context.\r
+ * Further use of this context is prohibited.\r
+ * </p>\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface ISessionContext extends IDisposable, IHintContext {\r
+\r
+    void close() throws IllegalStateException, InterruptedException, TimeoutException;\r
+\r
+//    /**\r
+//     * @return the socket address this session is connected to\r
+//     */\r
+//    IServerAddress getAddress();\r
+\r
+    /**\r
+     * @return the database session contained by this context\r
+     * @throws IllegalStateException if this context has been disposed\r
+     */\r
+    Session getSession();\r
+\r
+    /**\r
+     * @return the database session contained by this context or\r
+     *         <code>null</code> if session context has already been disposed.\r
+     */\r
+    Session peekSession();\r
+\r
+}\r