net.sourceforge.squirrel_sql.plugins.sessionscript
Class SessionScriptPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.sessionscript.SessionScriptPlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class SessionScriptPlugin
extends DefaultSessionPlugin

The plugin class.

Field Summary

static String

BUNDLE_BASE_NAME

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

_app

Constructor Summary

SessionScriptPlugin()

Method Summary

String	getAuthor() Returns the authors name.
String	getChangeLogFileName() Returns the name of the change log for the plugin.
String	getDescriptiveName() Return the descriptive name of this plugin.
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)
void	unload() Application is shutting down so save data.

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, getContributors, getExternalService, getGlobalPreferencePanels, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load

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, getContributors, getExternalService, getGlobalPreferencePanels, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load

Field Detail

BUNDLE_BASE_NAME

public static final String BUNDLE_BASE_NAME

See Also:

Constant Field Values

Constructor Detail

SessionScriptPlugin

public SessionScriptPlugin()

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.

initialize

public void initialize()
                throws PluginException

Initialize this plugin.

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class DefaultPlugin

Throws:

PluginException

unload

public void unload()

Application is shutting down so save data.

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)