net.sourceforge.squirrel_sql.plugins.example
Class ExamplePlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.example.ExamplePlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class ExamplePlugin
extends DefaultSessionPlugin

 The Example plugin class. If the database session's type is DB2, this plugin 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
 

Field Summary

Fields inherited from class net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin

_app, applicationFiles, fileWrapperFactory

Constructor Summary

ExamplePlugin()

Method Summary

String	getAuthor() Returns the authors name.
String	getChangeLogFileName() Returns the name of the change log for the plugin.
String	getContributors()
String	getDescriptiveName() Return the descriptive name of this plugin.
IGlobalPreferencesPanel[]	getGlobalPreferencePanels() Create preferences panel for the Global Preferences dialog.
String	getHelpFileName() Returns the name of the Help file for the plugin.
String	getInternalName() Return the internal name of this plugin.
String	getLicenceFileName() Returns the name of the Licence file for the plugin.
String	getVersion() Returns the current version of this plugin.
void	initialize() Initialize this plugin.
PluginSessionCallback	sessionStarted(ISession session) Called when a session started.

Methods inherited from class net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin

allowsSessionStartedInBackground, getDefaultNodeExpander, getObjectTypes, getSessionPropertiesPanels, isPluginSession, registerSessionMenu, sessionCreated, sessionEnding

Methods inherited from class net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin

aliasCopied, aliasRemoved, getAliasPropertiesPanelControllers, getApplication, getExternalService, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load, setApplicationFiles, setFileWrapperFactory, unload

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sourceforge.squirrel_sql.client.plugin.IPlugin

aliasCopied, aliasRemoved, getAliasPropertiesPanelControllers, getExternalService, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load, setApplicationFiles, setFileWrapperFactory, unload

Constructor Detail

ExamplePlugin

public ExamplePlugin()

Method Detail

getInternalName

public String getInternalName()

Return the internal name of this plugin.

Returns:

the internal name of this plugin.

getDescriptiveName

public String getDescriptiveName()

Return the descriptive name of this plugin.

Returns:

the descriptive name of this plugin.

getVersion

public String getVersion()

Returns the current version of this plugin.

Returns:

the current version of this plugin.

getAuthor

public String getAuthor()

Returns the authors name.

Returns:

the authors name.

getChangeLogFileName

public String getChangeLogFileName()

Returns the name of the change log for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory.

Specified by:

getChangeLogFileName in interface IPlugin

Overrides:

getChangeLogFileName in class DefaultPlugin

Returns:

the changelog file name or null if plugin doesn't have a change log.

getHelpFileName

public String getHelpFileName()

Returns the name of the Help file for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory.

Specified by:

getHelpFileName in interface IPlugin

Overrides:

getHelpFileName in class DefaultPlugin

Returns:

the Help file name or null if plugin doesn't have a help file.

getLicenceFileName

public String getLicenceFileName()

Returns the name of the Licence file for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory.

Specified by:

getLicenceFileName in interface IPlugin

Overrides:

getLicenceFileName in class DefaultPlugin

Returns:

the Licence file name or null if plugin doesn't have a licence file.

getContributors

public String getContributors()

Specified by:

getContributors in interface IPlugin

Overrides:

getContributors in class DefaultPlugin

Returns:

Comma separated list of contributors.

getGlobalPreferencePanels

public IGlobalPreferencesPanel[] getGlobalPreferencePanels()

Create preferences panel for the Global Preferences dialog.

Specified by:

getGlobalPreferencePanels in interface IPlugin

Overrides:

getGlobalPreferencePanels in class DefaultPlugin

Returns:

Preferences panel.

initialize

public void initialize()
                throws PluginException

Initialize this plugin.

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class DefaultPlugin

Throws:

PluginException

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

Called when a session started. Add commands to popup menu in object tree.

Parameters:

session - The session that is starting.

Returns:

An implementation of PluginSessionCallback or null to indicate the plugin does not work with this session