|
From: <man...@us...> - 2010-12-25 23:00:20
|
Revision: 6055
http://squirrel-sql.svn.sourceforge.net/squirrel-sql/?rev=6055&view=rev
Author: manningr
Date: 2010-12-25 23:00:14 +0000 (Sat, 25 Dec 2010)
Log Message:
-----------
Demonstrate the implementation and registration of ISQLExecutionListener to intercept SQL that is being executed.
Modified Paths:
--------------
trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java
Added Paths:
-----------
trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListener.java
Modified: trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java
===================================================================
--- trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java 2010-12-25 00:55:49 UTC (rev 6054)
+++ trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java 2010-12-25 23:00:14 UTC (rev 6055)
@@ -10,18 +10,23 @@
import net.sourceforge.squirrel_sql.client.session.ISession;
import net.sourceforge.squirrel_sql.fw.dialects.DialectFactory;
import net.sourceforge.squirrel_sql.fw.sql.DatabaseObjectType;
+import net.sourceforge.squirrel_sql.fw.util.IMessageHandler;
/**
- * The Example plugin class.
+ * The Example plugin class. This plugin does the following: 1. If the database types is DB2, it registers a
+ * menu action in the popup menu for view and procedure nodes in the ObjectTree. For detailed information and
+ * usage of the Plugin API see the following:
+ * https://sourceforge.net/apps/trac/squirrel-sql/wiki/SQuirreLSQLClientPluginAPI
*/
public class ExamplePlugin extends DefaultSessionPlugin
{
private PluginResources _resources;
+
/**
* Return the internal name of this plugin.
- *
- * @return the internal name of this plugin.
+ *
+ * @return the internal name of this plugin.
*/
public String getInternalName()
{
@@ -30,8 +35,8 @@
/**
* Return the descriptive name of this plugin.
- *
- * @return the descriptive name of this plugin.
+ *
+ * @return the descriptive name of this plugin.
*/
public String getDescriptiveName()
{
@@ -40,8 +45,8 @@
/**
* Returns the current version of this plugin.
- *
- * @return the current version of this plugin.
+ *
+ * @return the current version of this plugin.
*/
public String getVersion()
{
@@ -50,8 +55,8 @@
/**
* Returns the authors name.
- *
- * @return the authors name.
+ *
+ * @return the authors name.
*/
public String getAuthor()
{
@@ -59,12 +64,10 @@
}
/**
- * Returns the name of the change log for the plugin. This should
- * be a text or HTML file residing in the <TT>getPluginAppSettingsFolder</TT>
- * directory.
- *
- * @return the changelog file name or <TT>null</TT> if plugin doesn't have
- * a change log.
+ * Returns the name of the change log for the plugin. This should be a text or HTML file residing in the
+ * <TT>getPluginAppSettingsFolder</TT> directory.
+ *
+ * @return the changelog file name or <TT>null</TT> if plugin doesn't have a change log.
*/
public String getChangeLogFileName()
{
@@ -72,12 +75,10 @@
}
/**
- * Returns the name of the Help file for the plugin. This should
- * be a text or HTML file residing in the <TT>getPluginAppSettingsFolder</TT>
- * directory.
- *
- * @return the Help file name or <TT>null</TT> if plugin doesn't have
- * a help file.
+ * Returns the name of the Help file for the plugin. This should be a text or HTML file residing in the
+ * <TT>getPluginAppSettingsFolder</TT> directory.
+ *
+ * @return the Help file name or <TT>null</TT> if plugin doesn't have a help file.
*/
public String getHelpFileName()
{
@@ -85,12 +86,10 @@
}
/**
- * Returns the name of the Licence file for the plugin. This should
- * be a text or HTML file residing in the <TT>getPluginAppSettingsFolder</TT>
- * directory.
- *
- * @return the Licence file name or <TT>null</TT> if plugin doesn't have
- * a licence file.
+ * Returns the name of the Licence file for the plugin. This should be a text or HTML file residing in the
+ * <TT>getPluginAppSettingsFolder</TT> directory.
+ *
+ * @return the Licence file name or <TT>null</TT> if plugin doesn't have a licence file.
*/
public String getLicenceFileName()
{
@@ -98,7 +97,7 @@
}
/**
- * @return Comma separated list of contributors.
+ * @return Comma separated list of contributors.
*/
public String getContributors()
{
@@ -107,8 +106,8 @@
/**
* Create preferences panel for the Global Preferences dialog.
- *
- * @return Preferences panel.
+ *
+ * @return Preferences panel.
*/
public IGlobalPreferencesPanel[] getGlobalPreferencePanels()
{
@@ -123,36 +122,48 @@
_resources = new PluginResources("net.sourceforge.squirrel_sql.plugins.example.example", this);
}
-
/**
- * Called when a session started. Add commands to popup menu
- * in object tree.
- *
- * @param session The session that is starting.
- *
- * @return An implementation of PluginSessionCallback or null to indicate
- * the plugin does not work with this session
+ * Called when a session started. Add commands to popup menu in object tree.
+ *
+ * @param session
+ * The session that is starting.
+ * @return An implementation of PluginSessionCallback or null to indicate the plugin does not work with this
+ * session
*/
public PluginSessionCallback sessionStarted(ISession session)
{
+ // Adds the view and procedure script actions if the session is DB2.
+ addTreeNodeMenuActionsForDB2(session);
+
+ // Register a custom ISQLExecutionListener implementation that simply prints all SQL being executed to
+ // the message panel.
+ IMessageHandler messageHandler = session.getApplication().getMessageHandler();
+ ExampleSqlExecutionListener sqlExecutionListener = new ExampleSqlExecutionListener(messageHandler);
+ session.getSessionSheet().getSQLPaneAPI().addSQLExecutionListener(sqlExecutionListener);
+
+ return new PluginSessionCallbackAdaptor(this);
+ }
+
+ private void addTreeNodeMenuActionsForDB2(ISession session)
+ {
try
{
- if (! DialectFactory.isDB2(session.getMetaData())) {
- // Plugin knows only how to script Views and Stored Procedures on DB2.
- // So if it's not a DB2 Session we tell SQuirreL the Plugin should not be used.
- return null;
+ if (DialectFactory.isDB2(session.getMetaData()))
+ {
+ // Plugin knows only how to script Views and Stored Procedures on DB2.
+ // So if it's not a DB2 Session we tell SQuirreL the Plugin should not be used.
+
+ // Add context menu items to the object tree's view and procedure nodes.
+ IObjectTreeAPI otApi = session.getSessionInternalFrame().getObjectTreeAPI();
+ otApi.addToPopup(DatabaseObjectType.VIEW, new ScriptDB2ViewAction(getApplication(), _resources,
+ session));
+ otApi.addToPopup(DatabaseObjectType.PROCEDURE, new ScriptDB2ProcedureAction(getApplication(),
+ _resources, session));
}
-
- // Add context menu items to the object tree's view and procedure nodes.
- IObjectTreeAPI otApi = session.getSessionInternalFrame().getObjectTreeAPI();
- otApi.addToPopup(DatabaseObjectType.VIEW, new ScriptDB2ViewAction(getApplication(), _resources, session));
- otApi.addToPopup(DatabaseObjectType.PROCEDURE, new ScriptDB2ProcedureAction(getApplication(), _resources, session));
-
- return new PluginSessionCallbackAdaptor(this);
}
- catch(Exception e)
+ catch (Exception e)
{
- throw new RuntimeException(e);
+ throw new RuntimeException(e);
}
}
Added: trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListener.java
===================================================================
--- trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListener.java (rev 0)
+++ trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListener.java 2010-12-25 23:00:14 UTC (rev 6055)
@@ -0,0 +1,52 @@
+package net.sourceforge.squirrel_sql.plugins.example;
+
+import net.sourceforge.squirrel_sql.client.session.event.ISQLExecutionListener;
+import net.sourceforge.squirrel_sql.fw.util.IMessageHandler;
+
+/*
+ * Copyright (C) 2010 Rob Manning
+ * man...@us...
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+/**
+ * A simple ISQLExecutionListener that displays the SQL as it is being executed in the main application
+ * message panel (at the bottom of the application).
+ */
+public class ExampleSqlExecutionListener implements ISQLExecutionListener
+{
+ private final IMessageHandler _messageHandler;
+
+ public ExampleSqlExecutionListener(IMessageHandler messageHandler) {
+ _messageHandler = messageHandler;
+ }
+
+ @Override
+ public void statementExecuted(String sql)
+ {
+ _messageHandler.showMessage("statementExecuted: "+sql);
+ }
+
+ @Override
+ public String statementExecuting(String sql)
+ {
+ _messageHandler.showMessage("statementExecuting: "+sql);
+
+ // We don't modify the SQL in this example. We could veto it's execution be returned null.
+ return sql;
+ }
+
+}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <man...@us...> - 2010-12-31 19:37:25
|
Revision: 6092
http://squirrel-sql.svn.sourceforge.net/squirrel-sql/?rev=6092&view=rev
Author: manningr
Date: 2010-12-31 19:37:18 +0000 (Fri, 31 Dec 2010)
Log Message:
-----------
Added an example exception formatter that demonstrates the use of the ExceptionFormatter API.
Modified Paths:
--------------
trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java
Added Paths:
-----------
trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleExceptionFormatter.java
Added: trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleExceptionFormatter.java
===================================================================
--- trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleExceptionFormatter.java (rev 0)
+++ trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleExceptionFormatter.java 2010-12-31 19:37:18 UTC (rev 6092)
@@ -0,0 +1,61 @@
+package net.sourceforge.squirrel_sql.plugins.example;
+
+import static net.sourceforge.squirrel_sql.fw.util.Utilities.checkNull;
+import net.sourceforge.squirrel_sql.fw.util.ExceptionFormatter;
+
+/*
+ * Copyright (C) 2010 Rob Manning
+ * man...@us...
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+public class ExampleExceptionFormatter implements ExceptionFormatter
+{
+
+ /**
+ * In this example, we simply prefix the original exception message with a string that lets us know that
+ * the Example plugin applied a custom format. In a real implementation, you might want to call the
+ * getCause() method on the Throwable to determine if there were chained exceptions available to drill
+ * down to the actual exception that contains the stack trace and message to the very first place in code
+ * where an exception was encountered.
+ *
+ * @see net.sourceforge.squirrel_sql.fw.util.ExceptionFormatter#format(java.lang.Throwable)
+ */
+ @Override
+ public String format(Throwable t) throws Exception
+ {
+ checkNull("format", "t", t);
+ return "ExampleExceptionFormatter: exception message was: "+t.getMessage();
+ }
+
+ /**
+ * In this example if the throwable is not null, we say that we want to format it. This lets SQuirreL
+ * know that it should not apply it's own formatting, but rather use the format applied by this formatter's
+ * format method. In a real implementation which is specific to a vendor's JDBC driver, the Throwable will
+ * be a particular vendor type and probably has a package like com.{vendor}. Also, if the vendor adds
+ * custom methods for accessing the message, they should be called using the Java reflection API so that
+ * compiling this class does not require proprietary class libraries.
+ *
+ * @see net.sourceforge.squirrel_sql.fw.util.ExceptionFormatter#formatsException(java.lang.Throwable)
+ */
+ @Override
+ public boolean formatsException(Throwable t)
+ {
+ checkNull("formatsException", "t", t);
+ return true;
+ }
+
+}
Modified: trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java
===================================================================
--- trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java 2010-12-31 18:58:54 UTC (rev 6091)
+++ trunk/sql12/plugins/example/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java 2010-12-31 19:37:18 UTC (rev 6092)
@@ -144,6 +144,13 @@
ExampleSqlExecutionListener sqlExecutionListener = new ExampleSqlExecutionListener(messageHandler);
session.getSessionSheet().getSQLPaneAPI().addSQLExecutionListener(sqlExecutionListener);
+ // We will override the default behavior of formatting exception messages that SQuirreL provides for
+ // this session with our own. If this was a real plugin implementation, care would need to be taken
+ // that the custom formatter is only applied to database vendor sessions that this plugin was written
+ // for. SQuirreL doesn't support registering multiple exception formatters for a single session. The
+ // last one to register overrides all former registrations and results in a log warning message.
+ session.setExceptionFormatter(new ExampleExceptionFormatter());
+
return new PluginSessionCallbackAdaptor(this);
}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
