Package net.sf.basedb.plugins
Class PluginConfigurationImporter
java.lang.Object
net.sf.basedb.core.plugin.AbstractPlugin
net.sf.basedb.plugins.PluginConfigurationImporter
- All Implemented Interfaces:
AutoDetectingImporter
,InteractivePlugin
,Plugin
,SignalTarget
public class PluginConfigurationImporter
extends AbstractPlugin
implements InteractivePlugin, AutoDetectingImporter, SignalTarget
This plugin imports pluginconfiguration from an XML-file.
The XML-file need to have a DOCLET definition in the first 30 lines
and the format in the XML-file should use: plugin-configuration-file.dtd in /net/sf/basedb/core/dtd/.
- Version:
- 2.1
- Author:
- Martin
- Last modified
- $Date$
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.sf.basedb.core.plugin.Plugin
Plugin.MainType
-
Field Summary
Modifier and TypeFieldDescriptionprivate static final String
private RequestInformation
private RequestInformation
private static final String
private static final Set<GuiContext>
private boolean
private static final PluginParameter<Boolean>
private static final GuiContext
private boolean
private static final PluginParameter<Boolean>
private ThreadSignalHandler
private File
private static final PluginParameter<File>
Fields inherited from class net.sf.basedb.core.plugin.AbstractPlugin
annotationSection, configuration, COPY_ANNOTATIONS, job, OVERWRITE_ANNOTATIONS, sc
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(GuiContext context, Request request, Response response) Configure the plugin.void
doImport
(InputStream in, ProgressReporter progress) Import the data from the givenInputStream
.private boolean
getConfigurationInstallOption
(int orderNumber) Returns if a configuration in a certain place/order in the XML-file should be importedprivate RequestInformation
private RequestInformation
Gets request information to set which configuration to importGet a set containing all items that the plugin handles.Get the type of the plugin.getRequestInformation
(GuiContext context, String command) This method will return theRequestInformation
for a given command, i.e.Get the signal handler that is handling signals on behalf of this object.void
importPluginConfigurationsFromJar
(String jarPath, String xmlPath, HashMap<Integer, Boolean> configurations, boolean importAll, boolean setPermissions) Imports plugin configurations direct from an xml file, located in a jar.boolean
Check if the givenInputStream
can be imported by this plugin.isInContext
(GuiContext context, Object item) Check if the plugin can be used on the specified object.boolean
Returns FALSE, since that is how the plugins used to work before this method was introduced.void
run
(Request request, Response response, ProgressReporter progress) Run the plugin.boolean
Returns TRUE, since that is how the plugins used to work before this method was introduced.Methods inherited from class net.sf.basedb.core.plugin.AbstractPlugin
cloneParameterWithDefaultValue, closeLogFile, createLogFile, done, getCopyAnnotationsParmeter, getCurrentConfiguration, getCurrentJob, getJobOrConfigurationValue, getOverwriteAnnotationsParameters, getPermissions, init, isLogging, log, log, storeValue, storeValue, storeValues, validateRequestParameters
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.basedb.core.plugin.Plugin
done, getPermissions, init
-
Field Details
-
COMMAND_SELECT_CONFIGURATIONS
- See Also:
-
dtdFileName
- See Also:
-
pluginConfigurationList
-
guiContexts
-
xmlFileParameter
-
setPermissionsParameter
-
importAllParameter
-
configureJob
-
configureSelection
-
xmlFile
-
setPermissions
private boolean setPermissions -
importAll
private boolean importAll -
configurationMap
-
signalHandler
-
-
Constructor Details
-
PluginConfigurationImporter
public PluginConfigurationImporter()
-
-
Method Details
-
getGuiContexts
Description copied from interface:InteractivePlugin
Get a set containing all items that the plugin handles. Ie. if the plugin imports reporters, return a set containingItem.REPORTER
. This information is used by client applications to put the plugin in the proper place in the user interface.- Specified by:
getGuiContexts
in interfaceInteractivePlugin
- Returns:
- A
Set
containingItem
:s, or null if the plugin is not concerned about items
-
isInContext
Description copied from interface:InteractivePlugin
Check if the plugin can be used on the specified object. The item is either aBasicItem
orBasicData
object, or null if called from a list context. A client application should only call this method for contexts matching one of the contexts in the set returned by theInteractivePlugin.getGuiContexts()
method. ForGuiContext.Type.ITEM
contexts an item of the correct type should be passed as a parameter.The plug-in can response with a null value indicating success, a warning-level message or throw an exception to indicate an error-level message. Client application should normally only show error-level messages to users, unless the user has requested to see warning messages.
NOTE! Before BASE 2.4 all messages were treated as error-level messages.
- Specified by:
isInContext
in interfaceInteractivePlugin
- Parameters:
context
- The current context of the client application, it is one of the values found in set returned byInteractivePlugin.getGuiContexts()
item
- The currently active item, it's type should match theGuiContext.getItem()
type, or null if the context is a list context- Returns:
Null
if the plugin can use that item, or a warning-level message explaining why the plugin can't be used
-
getRequestInformation
public RequestInformation getRequestInformation(GuiContext context, String command) throws BaseException Description copied from interface:InteractivePlugin
This method will return theRequestInformation
for a given command, i.e. the list of parameters and some nice help text.- Specified by:
getRequestInformation
in interfaceInteractivePlugin
- Parameters:
context
- The current context of the client application, it is one of the values found in set returned byInteractivePlugin.getGuiContexts()
command
- The command- Returns:
- The
RequestInformation
for the command - Throws:
BaseException
- if there is an error
-
configure
Description copied from interface:InteractivePlugin
Configure the plugin. Hopefully the client is supplying values for the parameters specified byInteractivePlugin.getRequestInformation(GuiContext, String)
.- Specified by:
configure
in interfaceInteractivePlugin
- Parameters:
context
- The current context of the client application, it is one of the values found in set returned byInteractivePlugin.getGuiContexts()
request
- Request object with the command and parametersresponse
- Response object in for the plugin to response through
-
getMainType
Description copied from interface:Plugin
Get the type of the plugin. This method must always return the same value.- Specified by:
getMainType
in interfacePlugin
- Returns:
- One of the defined types
-
supportsConfigurations
public boolean supportsConfigurations()Description copied from class:AbstractPlugin
Returns TRUE, since that is how the plugins used to work before this method was introduced.- Specified by:
supportsConfigurations
in interfacePlugin
- Overrides:
supportsConfigurations
in classAbstractPlugin
- Returns:
- TRUE or FALSE
-
requiresConfiguration
public boolean requiresConfiguration()Description copied from class:AbstractPlugin
Returns FALSE, since that is how the plugins used to work before this method was introduced.- Specified by:
requiresConfiguration
in interfacePlugin
- Overrides:
requiresConfiguration
in classAbstractPlugin
- Returns:
- TRUE or FALSE
-
run
Description copied from interface:Plugin
Run the plugin. If a progress reporter object is passed it is recommended that the plugin makes use of it.- Specified by:
run
in interfacePlugin
- Parameters:
request
- Request object with the command and parametersresponse
- Response object in for the plugin to response throughprogress
- AProgressReporter
where the plugin can report its progess, can be null
-
isImportable
Description copied from interface:AutoDetectingImporter
Check if the givenInputStream
can be imported by this plugin.- Specified by:
isImportable
in interfaceAutoDetectingImporter
- Parameters:
in
- The input stream to check- Returns:
- TRUE if the stream can be imported, FALSE otherwise
- Throws:
BaseException
- If something goes wrong
-
doImport
Description copied from interface:AutoDetectingImporter
Import the data from the givenInputStream
.- Specified by:
doImport
in interfaceAutoDetectingImporter
- Parameters:
in
- The input stream to read fromprogress
- Progress reporter used by the caller to keep track of the progress. Null is allowed- Throws:
BaseException
- If something goes wrong
-
getSignalHandler
Description copied from interface:SignalTarget
Get the signal handler that is handling signals on behalf of this object. Multiple invokations of this method may receive the same or different objects. Null may be returned if, for some reason, the current object instance doesn't want to receive signals. Returning null is the same as not implementing this interface.- Specified by:
getSignalHandler
in interfaceSignalTarget
- Returns:
- A SignalHandler object, or null if the current instance doesn't support signals
-
importPluginConfigurationsFromJar
public void importPluginConfigurationsFromJar(String jarPath, String xmlPath, HashMap<Integer, Boolean> configurations, boolean importAll, boolean setPermissions) throws IOException, BaseExceptionImports plugin configurations direct from an xml file, located in a jar.- Parameters:
jarPath
- Path to the jar-filexmlPath
- Where in the jar-file the XML-file is locatedconfigurations
- A hasmap with a boolean value for each configuration in the xml-file. The value should be TRUE if the configuration should be imported, FALSE otherwise.importAll
- If all configurations in the xml-file should be imported or not.setPermissions
- If the configurations should be shared to the same users as the plugins they belong to.- Throws:
IOException
- When something goes wrong accessing a fileBaseException
- When the hashmap with import options has different size compared to number of configurations in XML-file- Since:
- 2.5
-
getConfiguredJobParameters
-
getConfiguredSelectionParameters
Gets request information to set which configuration to import- Returns:
- request information with parameter to use.
-
getConfigurationInstallOption
private boolean getConfigurationInstallOption(int orderNumber) Returns if a configuration in a certain place/order in the XML-file should be imported- Parameters:
orderNumber
- The number of order the configuration has in the XML-file- Returns:
- TRUE if the configuration should be imported, FALSE otherwise.
-