Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics / src / org / simantics / internal / SessionUtil.java

diff --git a/bundles/org.simantics/src/org/simantics/internal/SessionUtil.java b/bundles/org.simantics/src/org/simantics/internal/SessionUtil.java
new file mode 100644 (file)
index 0000000..f106244
--- /dev/null
+++ b/bundles/org.simantics/src/org/simantics/internal/SessionUtil.java
@@ -0,0 +1,102 @@
+/*******************************************************************************\r
+ * Copyright (c) 2013 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
+ *     Semantum Oy - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.internal;\r
+\r
+import java.io.File;\r
+import java.util.Properties;\r
+import java.util.UUID;\r
+\r
+import org.eclipse.core.runtime.IProduct;\r
+import org.eclipse.core.runtime.Platform;\r
+import org.simantics.db.ServerEx;\r
+import org.simantics.db.Session;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.db.service.LifecycleSupport;\r
+import org.simantics.db.service.XSupport;\r
+import org.simantics.project.management.ServerManager;\r
+import org.simantics.project.management.ServerManagerFactory;\r
+\r
+/**\r
+ * An as-simple-as-possible utility class for starting a Simantics database\r
+ * instance and opening a connection ({@link Session}) to it.\r
+ *\r
+ * <p>\r
+ * To get up and running, simply invoke:\r
+ * <pre>\r
+ *     SessionUtil util = new SessionUtil("my-client-id");\r
+ *     try {\r
+ *         File workspaceLocation = ...;\r
+ *         Session session = util.openSession(workspaceLocation);\r
+ *         // do something with the database session\r
+ *     } finally {\r
+ *         util.close();\r
+ *     }\r
+ * </pre>\r
+ *\r
+ * <p>\r
+ * This class is a provisional utility, pending for public inclusion.\r
+ *\r
+ * @author Tuukka Lehtonen\r
+ * @see Session\r
+ */\r
+public class SessionUtil {\r
+\r
+       private String clientId;\r
+       @SuppressWarnings("unused")\r
+       private File workspace;\r
+\r
+       private ServerManager serverManager;\r
+       private ServerEx server;\r
+       private Session session;\r
+\r
+       public static String getApplicationClientId() {\r
+               IProduct product = Platform.getProduct();\r
+               if(product == null) return "noProduct";\r
+               String application = product.getApplication();\r
+               return application != null ? application : UUID.randomUUID().toString();\r
+       }\r
+\r
+       public SessionUtil() {\r
+               this(UUID.randomUUID().toString());\r
+       }\r
+\r
+       public SessionUtil(String clientId) {\r
+               serverManager = ServerManagerFactory.getServerManager();\r
+               this.clientId = clientId;\r
+       }\r
+\r
+       public void close() throws DatabaseException {\r
+               if (session != null) {\r
+                       session.getService(LifecycleSupport.class).close();\r
+               }\r
+               serverManager.close();\r
+       }\r
+\r
+//     public Session open(File workspace) throws IOException, DatabaseException {\r
+//             File dbDir = new File(workspace, "db");\r
+//             if (!dbDir.exists() || !dbDir.isDirectory())\r
+//                     throw new FileNotFoundException("database directory " + dbDir + " not found");\r
+//             server = serverManager.getServer(dbDir);\r
+//             server.start(null);\r
+//             session = openSession(server, dbDir);\r
+//             this.workspace = workspace;\r
+//             return session;\r
+//     }\r
+\r
+       private Session openSession(ServerEx server, File dbDir) throws DatabaseException {\r
+               Properties info = new Properties(ServerManager.DEFAULT);\r
+               session = server.createSession(info);\r
+               session.getService(XSupport.class).setServiceMode(true, true);\r
+               return session;\r
+       }\r
+\r
+}\r