WIP: SQLDEV-2076 Add ConnectionHelperClient

TODO: Get cancel (server) task working TODO: Negative testing TODO: Doc/Walkthrough

Author: bjeffrie

sqldeveloper/extension/java/ConnectionHelper/src/oracle/db/example/sqldeveloper/extension/connectionHelper/ConnectionHelper.java

@@ -75,7 +75,7 @@ public void shutdown() {
 
 // TODO Refactor to handle request from server
 public static void processPotentialConnectionRequest(String arg) {
-
+processPotentialConnectionArgument(arg);
 }
 
 }

sqldeveloper/extension/java/ConnectionHelper/src/oracle/db/example/sqldeveloper/extension/connectionHelper/ConnectionHelperAddin.java

@@ -34,6 +34,9 @@ public void mainWindowOpened(IdeEvent e) {
 if (ConnectionHelperPreferenceModel.getInstance().isAcceptCommandLineConnections()) {
 ConnectionHelper.processCommandLineArgs();
 }
+if (ConnectionHelperPreferenceModel.getInstance().isAutostartExternalConnectionServer()) {
+ConnectionHelperServer.start();
+}
 }
 
 @Override

sqldeveloper/extension/java/ConnectionHelper/src/oracle/db/example/sqldeveloper/extension/connectionHelper/ConnectionHelperPreferencePanel.java

@@ -43,12 +43,21 @@ private void layoutControls() {
 JSpinner.NumberEditor editor = new JSpinner.NumberEditor(svrPort, "###0"); //$NON-NLS-1$
 svrPort.setEditor(editor);
 
-// Add action listeners for the enable check boxes
+// Add action listeners for the enable check boxes TODO: Add StructureChangeListener 
+// in Addin to watch these ... or ... add buttons to manually execute/start them?
+// The more I think about it, I like this better than buttons. Maybe better than 
+// the listener but the listener would also demonstrate how to listen for preference
+// changes.
 clAcceptConn.addActionListener(e -> {
 if (clAcceptConn.isSelected()) {
 ConnectionHelper.processCommandLineArgs();
 }
 });
+svrAutostart.addActionListener(e -> {
+if (svrAutostart.isSelected()) {
+ConnectionHelperServer.start();
+}
+});
 
 final FieldLayoutBuilder builder = new FieldLayoutBuilder(this);
 builder.setAlignLabelsLeft(true);
@@ -64,11 +73,6 @@ private void layoutControls() {
 builder.add(builder.indentedField().label().withText(ConnectionHelperResources.getString(ConnectionHelperResources.EXT_CONN_SVR_PERSIST_CONN))
 .component(svrPersistConn));
 builder.addVerticalSpring();
-
-// TODO TEMP until svr built
-svrAutostart.setEnabled(false);
-svrPort.setEnabled(false);
-svrPersistConn.setEnabled(false);
 }
 
 /* (non-Javadoc)

sqldeveloper/extension/java/ConnectionHelper/src/oracle/db/example/sqldeveloper/extension/connectionHelper/ConnectionHelperServer.java

@@ -53,7 +53,9 @@ protected Void doWork() throws TaskException {
 try (ServerSocket serverSocket = new ServerSocket(port)) {
 while (listening) {
 checkCanProceed();
+this.setMessage("Waiting for connection");
 ConnectionHelperTask helperTask = new ConnectionHelperTask(serverSocket.accept()); 
+this.setMessage("Initializing ConnectionHelperTask");
 RaptorTaskManager.getInstance().addTask(helperTask);
 }
 }
@@ -90,10 +92,8 @@ public String getQuery() {
 @Override
 protected Void doWork() throws TaskException {
 try (BufferedReader in = new BufferedReader(new InputStreamReader(socket.getInputStream()))) {
-String inputLine;
-while ((inputLine = in.readLine()) != null) {
-ConnectionHelper.processPotentialConnectionRequest(inputLine);
-}
+String inputLine= in.readLine();
+ConnectionHelper.processPotentialConnectionRequest(inputLine);
 }
 catch (Throwable t) {
 throw asTaskException(t);

sqldeveloper/extension/java/ConnectionHelperClient/build.properties

@@ -0,0 +1,8 @@
+extension.id=ConnectionHelperClient
+extension.name=Connection Helper Client
+extension.descr=Example to send connection info to the ConnectionHelperServer
+extension.version=20.1.0
+extension.resources=ConnectionHelperClientResources
+
+extension.lib=external:$oracle.fcp.home$/sqldeveloper/extensions/${extension.id}/lib
+osgi.bundle.classpath=.

sqldeveloper/extension/java/ConnectionHelperClient/build.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="windows-1252" ?>
+<project name="ConnectionHelperClient" default="deploy">
+ <import file="../../buildtools/ant/build.xml" />
+
+<!-- This module has a custom compile classpath. It produces a standard
+ executable jar file designed to be run from the command line. It can
+ NOT depend on anything in SQL Developer. -->
+<path id="compile.classpath" />
+<path id="local.classpath" />
+
+<!-- Raw jar, no osgi stuff
+<property name="osgi.required.bundles" value="${osgi.bundle.oracle.core},${osgi.bundle.jfxrt},${osgi.bundle.utils-nodeps}" />
+<property name="osgi.bundle.name" value="${osgi.bundle.jfx-nodeps}"/>
+ -->
+
+ <target name="jar" depends="compile" description="Create the extension jar">
+ <jar basedir="${built}/classes" destfile="${built}/${extension.filename}" excludes="**/.data/*" />
+<manifest file="${jar.manifest.template}" mode="update">
+<attribute name="Main-Class" value="ConnectionHelperClient" />
+</manifest>
+ </target>
+ <target name="deploy" depends="jar, manifest" description="Deploy plugins directory">
+ <copy file="${built}/${extension.filename}" tofile="${ide.home}/sqldeveloper/lib/${extension.filename}" />
+ <!-- Raw jar, no osgi stuff
+	<antcall target="bundleupdate-inc">
+	<param name="bundle.location" value="../sqldeveloper/lib/${extension.filename}"/>
+	</antcall>
+ -->
+ </target>
+</project>

sqldeveloper/extension/java/ConnectionHelperClient/src/ConnectionHelperClient.java

@@ -1,10 +1,19 @@
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.PrintWriter;
+import java.net.InetAddress;
+import java.net.Socket;
+import java.net.UnknownHostException;
+
 // Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
 
 /**
  * ConnectionHelperClient - a simple client for the ConnectionHelperServer<p/>
- * usage: java -jar ConnectionHelperClient.jar port connectionInfo
- *
- * @author <a href="mailto:brian.jeffries@oracle.com?subject=.ConnectionHelperClient">Brian Jeffries</a>
+ * usage: <code>java -jar ConnectionHelperClient.jar connectionInfo [svrPort]</code><br/>
+ * {@link #showUsage()}
+ * 
+ * @author <a href="mailto:brian.jeffries@oracle.com?subject=ConnectionHelperClient">Brian Jeffries</a>
  * @since SQL Developer 20.1
  */
 public class ConnectionHelperClient {
@@ -13,7 +22,67 @@ public class ConnectionHelperClient {
  * @param args
  */
 public static void main(String[] args) {
-
+int svrPort = 4444;
+try {
+if (args.length > 1) {
+svrPort = Integer.parseInt(args[1]);
+}
+String connectionInfo = args[0];
+InetAddress localhost = InetAddress.getLocalHost();
+ try (
+ Socket svrSocket = new Socket(localhost, svrPort);
+ PrintWriter out =
+ new PrintWriter(svrSocket.getOutputStream(), true);
+ BufferedReader in =
+ new BufferedReader(
+ new InputStreamReader(svrSocket.getInputStream()));
+ ) {
+ out.println(connectionInfo);
+ System.out.println(in.readLine()); // TODO: What kind of responses do we want?
+ } catch (UnknownHostException e) {
+ System.err.println("Don't know about host " + localhost);
+ System.exit(1);
+ } catch (IOException e) {
+ System.err.println("Couldn't get I/O for the connection to " +
+ localhost);
+ System.exit(1);
+ } 
+ } 
+catch (Throwable t) {
+t.printStackTrace();
+showUsage();
+}
 }
 
+/** <pre>
+"Usage: java -jar ConnectionHelperClient.jar connectionInfo [svrPort]\n" +
+"connectionInfo = -conName=user[/[pw]]@host:port(:sid|/svc)[#role]" +
+"Where:\n" + 
+"- connName is the name you would like for the connection\n" + 
+"- user is the user name for the schema you want to use\n" + 
+"- /password is the password for that user *(optional - if missing e.g., user@ or user/@, SQLDeveloper will prompt for it)*\n" + 
+"- host is the host that the database is on\n" + 
+"- port is the port the database is listening on\n" + 
+"- :sid is the sid for the database *(One of :sid or /svc MUST be supplied)*\n" + 
+"- /svc is the service name for the database *(One of :sid or /svc MUST be supplied)*\n" + 
+"- #role is the role *(optional - one of SYSDBA, SYSOPER, SYSBACKUP, SYSDG, SYSKM, SYSASM if used)*\n" + 
+"and\n" +
+"svrPort = the port the ConnectionHelperServer is listening on (optional default: 4444)\n";
+</pre>*/
+private static void showUsage() {
+String usage = "Usage: java -jar ConnectionHelperClient.jar connectionInfo [svrPort]\n" +
+ "connectionInfo = -conName=user[/[pw]]@host:port(:sid|/svc)[#role]" +
+ "Where:\n" + 
+ "- connName is the name you would like for the connection\n" + 
+ "- user is the user name for the schema you want to use\n" + 
+ "- /password is the password for that user *(optional - if missing e.g., user@ or user/@, SQLDeveloper will prompt for it)*\n" + 
+ "- host is the host that the database is on\n" + 
+ "- port is the port the database is listening on\n" + 
+ "- :sid is the sid for the database *(One of :sid or /svc MUST be supplied)*\n" + 
+ "- /svc is the service name for the database *(One of :sid or /svc MUST be supplied)*\n" + 
+ "- #role is the role *(optional - one of SYSDBA, SYSOPER, SYSBACKUP, SYSDG, SYSKM, SYSASM if used)*\n" + 
+ "and\n" +
+ "svrPort = the port the ConnectionHelperServer is listening on (optional default: 4444)\n";
+System.out.println(usage);
+}
 }