Table of Contents

26.1. How to organize your plug-in project

26.1.1. Using Ant

Directory layout

The build file

Building the plug-in

26.1.2. With Eclipse

26.1.3. Make the plug-in compatible with the auto-installation wizard

26.2. The Plug-in API

26.2.1. The main plug-in interfaces

The net.sf.basedb.core.plugin.Plugin interface

The net.sf.basedb.core.plugin.InteractivePlugin interface

26.2.2. How the BASE core interacts with the plug-in when...

Installing a plug-in

Configuring a plug-in

Checking if a plug-in can be used in a given context

Creating a new job

Executing a job

26.2.3. Using custom JSP pages for parameter input

26.3. Import plug-ins

26.3.1. Autodetect file formats

The net.sf.basedb.core.plugin.AutoDetectingImporter interface

Call sequence during autodetection

26.3.2. The AbstractFlatFileImporter superclass

26.4. Export plug-ins

26.4.1. Immediate download of exported data

The ImmediateDownloadExporter interface

The ExportOutputStream class

Call sequence during immediate download

26.4.2. The AbstractExporterPlugin class

26.5. Analysis plug-ins

26.5.1. The AbstractAnalysisPlugin class

26.5.2. The AnalysisFilterPlugin interface

26.6. Other plug-ins

26.6.1. Authentication plug-ins

Internal vs. external authentation

The Authenticator interface

Configuration settings

26.6.2. Secondary file storage plugins

Primary vs. secondary storage

The SecondaryStorageController interface

Configuration settings

26.6.3. File unpacker plug-ins

26.6.4. File packer plug-ins

26.6.5. File validator and metadata reader plug-ins

26.6.6. Logging plug-ins

The LogManagerFactory interface

The LogManager interface

The EntityLogger interface

26.7. Enable support for aborting a running a plug-in

26.8. How BASE load plug-in classes

26.9. Example plug-ins (with download)