de.intarsys.claptz

Interface IInstrument

All Superinterfaces:

IAttributeSupport, IClassLoaderSupport, IFileEnvironment, IMessageBundleSupport, IMetaInfoSupport

All Known Implementing Classes:

StandardInstrument.Facade

public interface IInstrument
extends IFileEnvironment, IClassLoaderSupport, IMessageBundleSupport, IMetaInfoSupport, IAttributeSupport

The instrument specification. An instrument is a dynamic extension to the system runtime.

The platform is designed to be extended via IInstrument objects. These objects are registered with the IInstrumentRegistry. An IInstrument may be anything from a static initialization, a sophisticated handler for special document features, up to a endpoint for web service call-ins or a scripting engine.

The instrument is a dynamically loadable component that is not known in advance at development time. The instrument is represented by an IInstrument instance

The IInstrument itself is loaded by a new classloader instance, so that the implementation of the instrument need not be referenced in the vm class path. This class loader tries to load its implementations from the "classes" and "lib" directories described below.

An instrument is physically represented by a directory structure in the "instruments" directory of the installation. The structure contains the following information:

• a "instrument.xml" file with configuration information.
• an optional "classes" directory that contain ".class" files
• an optional "lib" directory that contain ".jar" files

           example:
            
           +-instruments
             | 
             +-instrument1
             | | 
             | +-INSTRUMENT-INF
             | | | 
             | | + instrument.xml 
             | | | 
             | | +-lib 
             | | | |
             | | | + ... your libraries
             | | | 
             | | +-classes
             | |   |
             | |   + ... your classes
             | |
             | + ... your files
             |
             + ... more instruments
 
 

this example defines a single instrument "instrument1" with the home directory "instrument1"

Field Summary

Fields inherited from interface de.intarsys.tools.component.IMetaInfoSupport

META_ID, META_NAME, META_VENDOR, META_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
void	addPrerequisite(IInstrument prerequisite, String absentAction)
IExtension	createExtension(String extensionPointId, String id)
void	flush()
IExtension[]	getExtensions() The extensions made by this IExtensionProvider.
String	getId() A unique name for the instrument.
IInstrumentRegistry	getInstrumentRegistry() The IInstrumentRegistry where this IInstrument is currently registered.
IInstrumentPrerequisite[]	getPrerequisites() The collection of IInstrumentPrerequisite objects that are required to be available for this one to run.
State	getState()
void	registerExtension(IExtension extension) Add extension to the IExtension instances managed by this IExtensionProvider
void	removePrerequisite(IInstrument prerequisite)
void	unregisterExtension(IExtension extension) Remove extension from the IExtension instances managed by this IExtensionProvider

Methods inherited from interface de.intarsys.tools.environment.file.IFileEnvironment

getBaseDir, getProfileDir, getTempDir, getWorkingDir

Methods inherited from interface de.intarsys.tools.reflect.IClassLoaderSupport

getClassLoader

Methods inherited from interface de.intarsys.tools.message.IMessageBundleSupport

getMessageBundle

Methods inherited from interface de.intarsys.tools.component.IMetaInfoSupport

getMetaInfo

Methods inherited from interface de.intarsys.tools.attribute.IAttributeSupport

getAttribute, removeAttribute, setAttribute

Method Detail

addPrerequisite

void addPrerequisite(IInstrument prerequisite,
                   String absentAction)

createExtension

IExtension createExtension(String extensionPointId,
                         String id)
                           throws ObjectCreationException

Throws:

ObjectCreationException

flush

void flush()
           throws IOException

Throws:

IOException

getExtensions

IExtension[] getExtensions()

The extensions made by this IExtensionProvider.

Returns:

The extensions made by this IExtensionProvider.

getId

String getId()

A unique name for the instrument.

It is used for identifying uniquely a instrument within the IInstrumentRegistry. Clients may lookup instruments with well known names, for example the annotation handling instrument.

By convention this should conform to the standard java notation for class names.

Returns:

A string identifying the instrument uniquely.

getInstrumentRegistry

IInstrumentRegistry getInstrumentRegistry()

The IInstrumentRegistry where this IInstrument is currently registered.

Returns:

The IInstrumentRegistry where this IInstrument is currently registered.

getPrerequisites

IInstrumentPrerequisite[] getPrerequisites()

The collection of IInstrumentPrerequisite objects that are required to be available for this one to run.

Returns:

The collection of IInstrumentPrerequisite objects that are required to be available for this one to run.

getState

State getState()

registerExtension

void registerExtension(IExtension extension)
                       throws InstrumentRegistryException

Add extension to the IExtension instances managed by this IExtensionProvider

Parameters:

extension -

Throws:

InstrumentRegistryException

removePrerequisite

void removePrerequisite(IInstrument prerequisite)

unregisterExtension

void unregisterExtension(IExtension extension)
                         throws InstrumentRegistryException

Remove extension from the IExtension instances managed by this IExtensionProvider

Parameters:

extension -

Throws:

InstrumentRegistryException