reorg java example doc, add cfu example

Author: bjeffrie

sqldeveloper/extension/.gitignore

@@ -0,0 +1 @@
+**/*.md.html

sqldeveloper/extension/build.properties

@@ -15,5 +15,5 @@ extension.owner.url=https://github.com/oracle/oracle-db-examples/sqldeveloper
 #
 # Base location of the CFU site. 
 # This is where the produced updates.xml will say the cfu bundle files are.
-update.url=http://localhost/
+update.url=http://localhost
 

sqldeveloper/extension/buildtools/ant/includes.xml

@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License. 
 -->
 
-<project name="includes">
+<project name="includes" xmlns:if="ant:if">
 	<import file="./buildutils.xml"/>
     <import file="./classpaths.xml"/>
 
@@ -45,7 +45,7 @@ limitations under the License.
 	<target name="clean-inc">
         <!-- wipe them out, all of them -->
         <delete dir="${built}" failonerror="false" />
-        <echo>${extension.filename}</echo>
+        <echo>Deleting ${ide.home}/sqldeveloper/extensions/${extension.id}[.jar, /*]</echo>
         <delete failonerror="false">
             <fileset dir="${ide.home}/sqldeveloper/extensions" includes="${extension.filename}"></fileset>
             <fileset dir="${ide.home}/sqldeveloper/extensions/${extension.id}"></fileset>
@@ -200,12 +200,68 @@ limitations under the License.
     		<param name="bundle.location" value="../sqldeveloper/extensions/${extension.filename}"/>
     	</antcall>
     </target>
-   	<target name="bundleupdate-inc" description="Update the bundle.info file">
+   	<target name="bundleupdate-inc" description="Update the bundle.info file in the deployment target">
    		<echo message="${extension.id},${extension.version},${bundle.location},4,false"/>
    		<echo file="${ide.home}/configuration/bundles.info" append="yes">
 ${extension.id},${extension.version},${bundle.location},4,false</echo>
 	</target>
-	
-	
 
+    <property name="update.snippet" value="${built}/update.snippet"/>
+    <property name="bundle.xml" value="${built}/bundle.xml"/>
+    <property name="update-center.xml" value="${cfu.dir}/update-center.xml"/>
+    <property name="bundle.filename" value="${extension.id}-${extension.version}.zip"/>
+    <property name="extension.bundle.url" value="${update.url}/${bundle.filename}"/>
+    <target name="cfu-inc" description="Create CFU bundle">
+    	<mkdir dir="${cfu.dir}"/>
+        <mkdir dir="${cfu.dir}/tmp"/>
+    	<!-- ${built} has the jar and lib if any -->
+        <antcall target="create-update-snippet"/>
+        <antcall target="create-bundle-xml"/>
+        <antcall target="create-update-center-xml"/>
+        <antcall target="create-update-bundle"/>
+    </target>
+    <target name="create-update-snippet" description="Create the update snippet to be used in bundle and center xml files">
+        <loadmf jar="${ide.home}/sqldeveloper/extensions/oracle.sqldeveloper.jar" prefix="oracle.sqldeveloper.jar" />
+        <copy file="${buildtools.dir}/update.template.xml" tofile="${update.snippet}" />
+        <!-- replace some strings -->
+        <replace file="${update.snippet}">
+            <replacefilter token="@@extension.owner@@" value="${extension.owner}" />
+            <replacefilter token="@@extension.owner.url@@" value="${extension.owner.url}" />
+            <replacefilter token="@@extension.id@@" value="${extension.id}" />
+            <replacefilter token="@@extension.name@@" value="${extension.name}" />
+            <replacefilter token="@@extension.resources@@" value="${extension.resources}" />
+            <replacefilter token="@@extension.descr@@" value="${extension.descr}" />
+            <replacefilter token="@@extension.version@@" value="${extension.version}" />
+            <replacefilter token="@@extension.build@@" value="${build.number}" />
+            <replacefilter token="@@extension.agreement@@" value="${extension.agreement}" />
+            <replacefilter token="@@extension.bundle.url@@" value="${extension.bundle.url}" />
+            <replacefilter token="@@sqldeveloper.min.version@@" value="${oracle.sqldeveloper.jar.Bundle-Version}" />
+        </replace>
+    </target>
+    <target name="create-bundle-xml" description="">
+        <copy file="${buildtools.dir}/update-bundle.template.xml" tofile="${bundle.xml}" />
+    	<loadfile property="update" srcFile="${update.snippet}"/>
+        <replace file="${bundle.xml}">
+            <replacefilter token="@@update@@" value="${update}" />
+         </replace>	
+	</target>
+    <target name="create-update-center-xml" description="">
+        <copy file="${buildtools.dir}/update-center.template.xml" tofile="${update-center.xml}" />
+        <loadfile property="update" srcFile="${update.snippet}"/>
+        <replace file="${update-center.xml}">
+            <replacefilter token="@@update@@" value="${update}" />
+         </replace> 
+    </target>
+    <target name="create-update-bundle" description="">
+    	<!-- zip extension, lib, and bundle.xml to bundle.filename in cfu dir -->
+        <move file="${built.destination.file}" tofile="${cfu.dir}/tmp/sqldeveloper/extensions/${extension.filename}" />
+        <!-- If there is a lib file or other resource file, it will get put in "extension name" dir in extension -->
+        <copy todir="${cfu.dir}/tmp/sqldeveloper/extensions/${extension.id}/lib" failonerror="false">
+            <fileset dir="${built}/lib" />
+        </copy>
+        <zip basedir="${cfu.dir}/tmp" destfile="${cfu.dir}/${bundle.filename}">
+            <zipfileset prefix="META-INF" dir="${built}" includes="bundle.xml" />
+        </zip>
+        <delete dir="${cfu.dir}/tmp" failonerror="false" />
+    </target>
 </project>

sqldeveloper/extension/buildtools/ant/properties.xml

@@ -15,11 +15,12 @@ See the License for the specific language governing permissions and
 limitations under the License. 
 -->
 
-<project name="properties">
+<project name="properties" xmlns:if="ant:if" xmlns:unless="ant:unless">
 <!-- buildtools -->
 	<dirname property="ant.build.dir" file="${ant.file.props}"/>
 	<property name="root.directory" value="${ant.build.dir}/../.."/>
-    <property name="buildutils.dir" value="${root.directory}/buildtools/buildutils" />
+    <property name="buildtools.dir" value="${root.directory}/buildtools" />
+    <property name="buildutils.dir" value="${buildtools.dir}/buildutils" />
 
 <!-- master properties -->
 	<property file="${root.directory}/build.properties" />
@@ -52,7 +53,8 @@ limitations under the License.
 	<property name="built.classpath" value="${built}/classes"/>
 	<property name="gen-src.dir" value="${built}/gen-src"/>
 	<property name="built.destination.file" value="${built}/${extension.filename}"/>
-
+    <property name="cfu.dir" value="${built}/cfu"/>
+    
 	<property name="jar.manifest.template" value="${built}/manifest.template" />
     <property name="module.default.exported.packages" value=""/>
 
@@ -64,5 +66,8 @@ limitations under the License.
 	<property name="cfu.bundle.template" value="cfu.bundle.template"/>
 	<property name="cfu.master.template" value="cfu.master.template"/>
 	<property name="built.cfu" value="${built.dir}/cfu"/>	
-	
+	<property if:set="extension.agreement.url" name="extension.agreement" 
+	 value="
+		&lt;requires-agreement url=&quot;${extension.agreement.url}&quot;/>"/>
+    <property unless:set="extension.agreement.url" name="extension.agreement" value=""/>
 </project>

sqldeveloper/extension/buildtools/ant/targets.xml

@@ -65,12 +65,12 @@ limitations under the License.
 	<target name="manifest" depends="jar" description="Create the jar manifest">
         <antcall target="manifest-inc" inheritAll="true" inheritRefs="true" />
 	</target>
-	<target name="rebuild" depends="clean,deploy" description="Shortcut to clean and then rebuild/deploy"/>
-    <target name="deploy" depends="jar, manifest" description="Deploy into the SQLDeveloper extensions directory">
+    <target name="_deploy" depends="jar, manifest" description="Deploy into the SQLDeveloper extensions directory">
         <antcall target="deploy-inc" inheritAll="true" inheritRefs="true" />
     </target>
-	<target name="cfu" depends="jar,manifest" description="Create CFU bundle">
+	<target name="_cfu" depends="clean,jar,manifest" description="Create CFU bundle">
         <antcall target="cfu-inc" inheritAll="true" inheritRefs="true" />
 	</target>
+    <target name="_rebuild" depends="clean,_deploy" description="Shortcut to clean and then rebuild/deploy"/>
 
 </project>

sqldeveloper/extension/buildtools/update-bundle.template.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--  
+Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved. 
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License. 
+-->
+
+<update-bundle version="1.0" xmlns="http://xmlns.oracle.com/jdeveloper/updatebundle">
+@@update@@
+</update-bundle>

sqldeveloper/extension/buildtools/update-center.template.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--  
+Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved. 
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License. 
+-->
+
+<updates version="2.0" xmlns="http://xmlns.oracle.com/jdeveloper/updatecenter" xmlns:u="http://xmlns.oracle.com/jdeveloper/update">   
+@@update@@
+</updates>

sqldeveloper/extension/buildtools/update.template.xml

@@ -0,0 +1,14 @@
+    <update id="@@extension.id@@" xmlns="http://xmlns.oracle.com/jdeveloper/update">
+        <name>@@extension.name@@</name>
+        <version>@@extension.version@@.@@extension.build@@</version>
+        <author>@@extension.owner@@</author>
+        <author-url>@@extension.owner.url@@</author-url>
+        <description>@@extension.descr@@</description>
+        <requirements>@@extension.agreement@@
+            <requires-extension id="oracle.sqldeveloper" minVersion="@@sqldeveloper.min.version@@"/>
+        </requirements>
+        <bundle-url>
+            @@extension.bundle.url@@
+        </bundle-url>
+        <destination>${oracle.home}</destination>
+    </update>

sqldeveloper/extension/cfu/README.md

@@ -1,4 +1,6 @@
 # SQL Developer Examples
 ## Check For Updates (cfu)
-Coming soon(tm)
- 
+This is a bit of a table of contents trick to bring cfu closer to the top.  
+Go to one of the projects and run the cfu ant task. The results will be in the built/cfu directory in the project.  
+* [Packaged XML extension](../xml/packaged)
+* [Java extension](../java/DependencyExample)

sqldeveloper/extension/java/.README.md.html

@@ -643,14 +643,8 @@ <h1> <a id="sql-developer-examples" class="anchor" href="#sql-developer-examples
 <h2> <a id="standard-extensions-java" class="anchor" href="#standard-extensions-java" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Standard Extensions (java)</h2> 
 <p>Standard extensions are jar files with an <a href="https://en.wikipedia.org/wiki/OSGi">OSGi</a> manifest and an extension.xml defining the extension and how it integrates with SQL Developer.</p> 
 <ul> 
- <li>DependencyExample<br /> This example is built with ant but is also set up for editing &amp; (remote) debugging in the eclipse extension project.<br /> </li> 
- <li>Building this example requires two external libraries. Copy the required jar files to DependencyExample/lib.<br /> The exact jars needed from them as well as SQL Developer can be found in <em>DependencyExample/DependencyExample.userlibraries</em> which you will also need to modify (SQL Developer paths) and import to use eclipse.<br /> 
-  <ul> 
-   <li> <a href="http://dl.bintray.com/jankoehnlein/FXDiagram/standalone/:fxdiagram-jars-0.35.0.zip" title="fxdiagram-jars-0.35.0.zip">FXDiagram 0.35.0</a><br /> </li> 
-   <li><a href="http://rtsys.informatik.uni-kiel.de/%7Ekieler/files/release_pragmatics_2015-02/klay/klay_2015-02.jar" title="klay_2015-02.jar">KIELER KLay Layouters 0.14.0</a></li> 
-  </ul> </li> 
-</ul> 
-<p><a href="..\..\.setup.md.html">Set up your environment</a>, get the required libraries (see above), build the (default) deploy target, and start SQLDeveloper from the command line WITH THE (sqldeveloper/bin/)sqldeveloper -clean OPTION. </p> 
-<p>On the first run, only the triggers defined in extension.xml will load.<br /> <a href="images/DependencyExampleAbout.png" target="_blank"><img src="images/DependencyExampleAbout.png" alt="DependencyExampleAbout diagram" style="max-width:100%;" /></a><br /> In our case, that means the context menu entry only and NOT the dependency viewer tab referenced in the hook section (via DependencyExampleGraphViewer.xml which is in the directory the hook says to load xml from) <a href="images/DependencyExampleContextMenu.png" target="_blank"><img src="images/DependencyExampleContextMenu.png" alt="DependencyExampleContextMenu diagram" style="max-width:100%;" /></a><br /> Which opens the dependency diagram AND causes the rest of the extension hooks to load. (The editor tab name is pulled from the 1st selected node but will switch when focus goes to another editor and back. TODO: This really should be implemented as it's own dockable, not as an 'editor'.) <a href="images/DependencyExampleZoomedOut.png" target="_blank"><img src="images/DependencyExampleZoomedOut.png" alt="DependencyExampleZoomedOut diagram" style="max-width:100%;" /></a><br /> the diagram is scrollable, zoomable, editable, and can be exported to svg (all thanks to the FXDiagram library.) Double clicking on a node performs a &quot;DrillLink&quot; to open the SQL Developer editor for that node.<br /> <a href="images/DependencyExampleZoomedIn.png" target="_blank"><img src="images/DependencyExampleZoomedIn.png" alt="DependencyExampleZoomedIn diagram" style="max-width:100%;" /></a><br /> Now that it is fully loaded, the viewer definition is active and a dependency graph tab is added to the object viewers. (The next time a new one is opened.) <a href="images/DependencyExampleViewer.png" target="_blank"><img src="images/DependencyExampleViewer.png" alt="DependencyExampleViewer diagram" style="max-width:100%;" /></a> </p>
+ <li><p><a href="..\xml\.packaged.md.html">packaged XML</a><br /> XML Examples packaged as an extension.jar </p></li> 
+ <li><p><a href=".DependencyExample.md.html">DependencyExample</a> An example editor and viewer for object dependency graphs. </p></li> 
+</ul>
 </body>
 </html>