Changeset 3960

Timestamp:

Nov 13, 2007, 8:25:01 PM (16 years ago)

Author:

Nicklas Nordborg

Message:

References #807

Added documentation for plug-in developers.

Location:

trunk/src

Files:

• core/net/sf/basedb/core/Application.java (modified) (1 diff)
• info/net/sf/basedb/info/VersionInfo.java (added)
• info/net/sf/basedb/info/package.html (modified) (1 diff)
• webservices/client/java/net/sf/basedb/ws/client/SessionClient.java (modified) (2 diffs)
• webservices/server/net/sf/basedb/ws/server/SessionService.java (modified) (2 diffs)

trunk/src/core/net/sf/basedb/core/Application.java

@@ -192 +192 @@
   
   /**
+    Get the maintenance version.
+  */
+  public static String getMaintenanceVersion()
+  {
+    return Version.getMaintenance();
+  }
+  
+  /**
+    Get the build number.
+  */
+  public static int getBuild()
+  {
+    return Version.getBuild();
+  }
+
+  /**
     Get the BASE version string. It is created by combining
     the major, minor, maintenance, build and schema versions.
-  */
-  public static String getMaintenanceVersion()
-  {
-    return Version.getMaintenance();
-  }
-  
-  /**
-    Get the build number.
-  */
-  public static int getBuild()
-  {
-    return Version.getBuild();
-  }
-
-  /**
-    Get the BASE version string
   */
   public static String getVersionString()

trunk/src/info/net/sf/basedb/info/package.html

@@ -46 +46 @@
   have access to the BASE core code.
 </p>
+<p>
+  NOTE! IT IS VERY IMPORTANT THAT THE CLASSES IN THIS PACKAGE ARE INDEPENDENT
+  OF ALL OTHER PACKAGES IN BASE. IT IS FORBIDDEN TO IMPORT FROM net.sf.basedb.core
+  AND ALL OTHER net.sf.basedb.* PACKAGES.
+</p>
 
 </body>

trunk/src/webservices/client/java/net/sf/basedb/ws/client/SessionClient.java

@@ -23 +23 @@
 */
 package net.sf.basedb.ws.client;
+
+import net.sf.basedb.info.VersionInfo;
 
 import org.apache.axis2.AxisFault;
@@ -130 +132 @@
   }
   
-  /**   
-      @return schema version as an int
+  
+  /**
+      @return A {@link VersionInfo} object
       @throws AxisFault
-   */
-  public int getSchemaVersion()
+  */
+  public VersionInfo getVersion()
     throws AxisFault
   {
-    return invokeBlocking("getSchemaVersion", Integer.class);
-  }
-  
-  /**
-      @return An string array with length of 4
-      @throws AxisFault
-   */
-  public String[] getVersion()
-    throws AxisFault
-  {
-    return invokeBlocking("getVersion", String[].class);
+    return invokeBlocking("getVersion", VersionInfo.class);
   }
 }

trunk/src/webservices/server/net/sf/basedb/ws/server/SessionService.java

@@ -26 +26 @@
 import net.sf.basedb.core.Application;
 import net.sf.basedb.core.SessionControl;
-import net.sf.basedb.core.Version;
+import net.sf.basedb.info.VersionInfo;
 
 /**
@@ -110 +110 @@
   
   /**
-    Gets the current schema version of the database 
-    on the Base server.
-      @return SchemaVersion as an integer.
+    Return information about which Base version is in use.
+
+      @return A {@link VersionInfo} object
    */
-  public int getSchemaVersion()
+  public VersionInfo getVersion()
   {
-    return Application.getSchemaVersion();
-  }
-  
-  /**
-    Return information about which Base version is in use.
-    The returned array has 4 strings,
-    <ol>
-      <li>Major version.</li>
-      <li>Minor version.</li>
-      <li>MaintenanceVersion.</li>
-      <li>Build number</li>
-    </ol>
-      @return An array with version information.
-   */
-  public String[] getVersion()
-  {
-    String[] version = new String[4];
-    version[0] = Application.getMajorVersion();
-    version[1] = Application.getMinorVersion();
-    version[2] = Application.getMaintenanceVersion();
-    version[3] = Integer.toString(Application.getBuild());
-    return version;
+    VersionInfo info = new VersionInfo();
+    info.setMajor(Application.getMajorVersion());
+    info.setMinor(Application.getMinorVersion());
+    info.setMaintenance(Application.getMaintenanceVersion());
+    info.setBuild(Application.getBuild());
+    info.setSchema(Application.getSchemaVersion());
+    return info;
   }
 }