PluginImpl (DMX 5.0-SNAPSHOT API)

java.lang.Object
- systems.dmx.core.impl.PluginImpl

All Implemented Interfaces:: org.osgi.service.event.EventHandler, Plugin

public class PluginImpl
extends Object
implements Plugin, org.osgi.service.event.EventHandler

Field Summary

Fields
Modifier and Type	Field and Description
`private org.osgi.framework.BundleContext`	`bundleContext`
`private CoreServiceImpl`	`dmx`
`private org.osgi.service.event.EventAdmin`	`eventService`
`private StaticResourcesPublication`	`fileSystemResources`
`private Map<Class<?>,InjectableService>`	`injectableServices`
`private Logger`	`logger`
`private ModelFactory`	`mf`
`private static String`	`PLUGIN_ACTIVATED`
`private static String`	`PLUGIN_CONFIG_FILE`
`private static String`	`PLUGIN_DEFAULT_PACKAGE`
`private org.osgi.framework.Bundle`	`pluginBundle`
`private PluginContext`	`pluginContext`
`private List<String>`	`pluginDependencies`
`private PluginInfo`	`pluginInfo`
`private String`	`pluginPackage`
`private Properties`	`pluginProperties`
`private Topic`	`pluginTopic`
`private String`	`pluginUri`
`private String`	`providedServiceInterface`
`private RestResourcesPublication`	`restResources`
`private List<org.osgi.util.tracker.ServiceTracker>`	`serviceTrackers`
`private StaticResourcesPublication`	`webResources`

Constructor Summary

Constructors
Constructor and Description

PluginImpl(PluginContext pluginContext)

Constructors
Constructor and Description
`PluginImpl(PluginContext pluginContext)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`activate()` Activates this plugin and then posts the PLUGIN_ACTIVATED OSGi event.
`private void`	`addService(Object service, Class serviceInterface)`
`private void`	`checkRequirementsForActivation()` Checks if this plugin's requirements are met, and if so, activates this plugin.
`private void`	`closeServiceTrackers()`
`private void`	`createCoreServiceTrackers()`
`private List<InjectableService>`	`createInjectableServices()`
`private void`	`createInjectedServiceTrackers()`
`private Topic`	`createPluginTopic()` Creates a Plugin topic in the DB.
`private boolean`	`createPluginTopicIfNotExists()`
`private org.osgi.util.tracker.ServiceTracker`	`createServiceTracker(Class serviceInterface)`
`(package private) void`	`deactivate()`
`private boolean`	`dependenciesAvailable()`
`private void`	`dispatchEvent(DMXEvent event, Object... params)` Checks weather this plugin is a listener for the given event, and if so, dispatches the event to this plugin.
`private String`	`entryPathToClassName(String entryPath)`
`private Topic`	`fetchPluginTopic()`
`private URL`	`getBundleEntry(String path)`
`(package private) String`	`getConfigProperty(String key)` Returns a plugin configuration property (as read from file "plugin.properties") or `null` if no such property exists.
`(package private) String`	`getConfigProperty(String key, String defaultValue)`
`(package private) PluginContext`	`getContext()`
`private List<DMXEvent>`	`getEvents()` Returns the events this plugin is listening to.
`(package private) PluginInfo`	`getInfo()`
`(package private) static List<Field>`	`getInjectableFields(Class<?> clazz)`
`(package private) Object`	`getInjectedService(Class<?> serviceInterface)`
`private List<Class<?>>`	`getInterfaces(String suffix)`
`(package private) String`	`getMigrationClassName(int migrationNr)` Returns the migration class name for the given migration number.
`private Enumeration<String>`	`getPluginPaths(String relativePath)`
`(package private) Topic`	`getPluginTopic()`
`(package private) String`	`getProvidedServiceInterface()`
`private List<Class<?>>`	`getProviderClasses()`
`private List<Object>`	`getRootResources()`
`InputStream`	`getStaticResource(String name)` Accesses a static resource of the plugin.
`String`	`getUri()`
`private String`	`getWebResourcesNamespace()`
`void`	`handleEvent(org.osgi.service.event.Event event)`
`private boolean`	`hasDependency(String pluginUri)`
`boolean`	`hasStaticResource(String name)` Checks if this plugin bundle contains a static resource with the given name.
`private boolean`	`injectedServicesAvailable()`
`private void`	`installPluginInDB()` Installs the plugin in the database.
`private void`	`introduceAssociationTypesToPlugin()`
`private void`	`introduceTopicTypesToPlugin()`
`private void`	`invokeInitHook()`
`private void`	`invokePreInstallHook()`
`private void`	`invokeShutdownHook()`
`private boolean`	`isListenerInterface(Class interfaze)` Returns true if the specified interface is an event listener interface.
`private boolean`	`isPluginActivated(String pluginUri)`
`(package private) Class`	`loadClass(String className)` Uses the plugin bundle's class loader to load a class by name.
`private void`	`openServiceTrackers()`
`private List<String>`	`pluginDependencies()`
`private String`	`pluginName()`
`private void`	`postPluginActivatedEvent()`
`private String`	`providedServiceInterface()`
`void`	`publishFileSystem(String uriNamespace, String path)` Publishes a directory of the server's file system.
`private void`	`publishRestResources()` Publishes this plugin's REST resources (via WebPublishingService).
`private void`	`publishWebResources()` Publishes this plugin's web resources (via WebPublishingService).
`private Properties`	`readConfigFile()`
`private void`	`registerListeners()`
`private void`	`registerPluginActivatedEventListener()`
`private void`	`registerProvidedService()` Registers the provided service at the OSGi framework.
`private void`	`removeService(Object service, Class serviceInterface)`
`private List<String>`	`scanPackage(String relativePath)`
`private void`	`setCoreService(CoreServiceImpl dmx)`
`(package private) void`	`setMigrationNr(int migrationNr)`
`void`	`start()`
`void`	`stop()`
`String`	`toString()`
`private void`	`unpublishFileSystem()`
`private void`	`unpublishRestResources()`
`private void`	`unpublishWebResources()`
`private void`	`unregisterListeners()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PLUGIN_DEFAULT_PACKAGE
```
private static final String PLUGIN_DEFAULT_PACKAGE
```
    See Also:
    
    Constant Field Values
  - PLUGIN_CONFIG_FILE
```
private static final String PLUGIN_CONFIG_FILE
```
    See Also:
    
    Constant Field Values
  - PLUGIN_ACTIVATED
```
private static final String PLUGIN_ACTIVATED
```
    See Also:
    
    Constant Field Values
  - pluginContext
```
private PluginContext pluginContext
```
  - bundleContext
```
private org.osgi.framework.BundleContext bundleContext
```
  - pluginBundle
```
private org.osgi.framework.Bundle pluginBundle
```
  - pluginUri
```
private String pluginUri
```
  - pluginProperties
```
private Properties pluginProperties
```
  - pluginPackage
```
private String pluginPackage
```
  - pluginInfo
```
private PluginInfo pluginInfo
```
  - pluginDependencies
```
private List<String> pluginDependencies
```
  - pluginTopic
```
private Topic pluginTopic
```
  - dmx
```
private CoreServiceImpl dmx
```
  - mf
```
private ModelFactory mf
```
  - eventService
```
private org.osgi.service.event.EventAdmin eventService
```
  - injectableServices
```
private Map<Class<?>,InjectableService> injectableServices
```
  - serviceTrackers
```
private List<org.osgi.util.tracker.ServiceTracker> serviceTrackers
```
  - providedServiceInterface
```
private String providedServiceInterface
```
  - webResources
```
private StaticResourcesPublication webResources
```
  - fileSystemResources
```
private StaticResourcesPublication fileSystemResources
```
  - restResources
```
private RestResourcesPublication restResources
```
  - logger
```
private Logger logger
```
- Constructor Detail
  - PluginImpl
```
public PluginImpl(PluginContext pluginContext)
```
- Method Detail
  - start
```
public void start()
```
  - stop
```
public void stop()
```
  - publishFileSystem
```
public void publishFileSystem(String uriNamespace,
                              String path)
```
    Publishes a directory of the server's file system.
    
    Parameters:
    
    path - An absolute path to the directory to be published.
  - getUri
```
public String getUri()
```
  - getStaticResource
```
public InputStream getStaticResource(String name)
```
    Description copied from interface: Plugin
    
    Accesses a static resource of the plugin. A static resource is some data (images, audio, text, etc) that is contained in the plugin bundle (that is the jar file).
    
    Specified by:
    
    getStaticResource in interface Plugin
    
    Parameters:
    
    name - The resource name: a "/"-separated path name, relative to the plugin bundle's root directory. It may or may not begin with "/" (it makes no difference).
    
    Returns:
    
    An InputStream to read the static resource content.
  - hasStaticResource
```
public boolean hasStaticResource(String name)
```
    Description copied from interface: Plugin
    
    Checks if this plugin bundle contains a static resource with the given name.
    
    Specified by:
    
    hasStaticResource in interface Plugin
    
    Parameters:
    
    name - The resource name: a "/"-separated path name, relative to the plugin bundle's root directory. It may or may not begin with "/" (it makes no difference).
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getInfo
```
PluginInfo getInfo()
```
  - getContext
```
PluginContext getContext()
```
  - getPluginTopic
```
Topic getPluginTopic()
```
  - getProvidedServiceInterface
```
String getProvidedServiceInterface()
```
  - getConfigProperty
```
String getConfigProperty(String key)
```
    Returns a plugin configuration property (as read from file "plugin.properties") or null if no such property exists.
  - getConfigProperty
```
String getConfigProperty(String key,
                         String defaultValue)
```
  - getMigrationClassName
```
String getMigrationClassName(int migrationNr)
```
    Returns the migration class name for the given migration number.
    
    Returns:
    
    the fully qualified migration class name, or null if the migration package is unknown. This is the case if the plugin bundle contains no Plugin subclass and the "dmx.plugin.main_package" config property is not set.
  - setMigrationNr
```
void setMigrationNr(int migrationNr)
```
  - loadClass
```
Class loadClass(String className)
```
    Uses the plugin bundle's class loader to load a class by name.
    
    Returns:
    
    the class, or null if the class is not found.
  - readConfigFile
```
private Properties readConfigFile()
```
  - createCoreServiceTrackers
```
private void createCoreServiceTrackers()
```
  - createInjectedServiceTrackers
```
private void createInjectedServiceTrackers()
```
  - createInjectableServices
```
private List<InjectableService> createInjectableServices()
```
  - injectedServicesAvailable
```
private boolean injectedServicesAvailable()
```
  - getInjectableFields
```
static List<Field> getInjectableFields(Class<?> clazz)
```
  - getInjectedService
```
Object getInjectedService(Class<?> serviceInterface)
```
  - createServiceTracker
```
private org.osgi.util.tracker.ServiceTracker createServiceTracker(Class serviceInterface)
```
  - openServiceTrackers
```
private void openServiceTrackers()
```
  - closeServiceTrackers
```
private void closeServiceTrackers()
```
  - addService
```
private void addService(Object service,
                        Class serviceInterface)
```
  - removeService
```
private void removeService(Object service,
                           Class serviceInterface)
```
  - setCoreService
```
private void setCoreService(CoreServiceImpl dmx)
```
  - checkRequirementsForActivation
```
private void checkRequirementsForActivation()
```
    Checks if this plugin's requirements are met, and if so, activates this plugin. The requirements: - the 2 core services are available (CoreService, EventAdmin). - the injected services (according to the "Inject" annotation) are available. - the plugin dependencies (according to the "dmx.plugin.activate_after" config property) are active.
  - activate
```
void activate()
```
    Activates this plugin and then posts the PLUGIN_ACTIVATED OSGi event. Activation comprises: - invoke the plugin's preInstall() hook - install the plugin in the database (includes plugin topic, migrations, type introduction) - register the plugin's event listeners - register the plugin's OSGi service - invoke the plugin's init() hook
  - deactivate
```
void deactivate()
```
  - installPluginInDB
```
private void installPluginInDB()
```
    Installs the plugin in the database. This comprises: 1) create "Plugin" topic 2) run migrations 3) type introduction (fires the CoreEvent.INTRODUCE_TOPIC_TYPE and CoreEvent.INTRODUCE_ASSOCIATION_TYPE events)
  - createPluginTopicIfNotExists
```
private boolean createPluginTopicIfNotExists()
```
  - createPluginTopic
```
private Topic createPluginTopic()
```
    Creates a Plugin topic in the DB.
    A Plugin topic represents an installed plugin and is used to track its version.
  - fetchPluginTopic
```
private Topic fetchPluginTopic()
```
  - introduceTopicTypesToPlugin
```
private void introduceTopicTypesToPlugin()
```
  - introduceAssociationTypesToPlugin
```
private void introduceAssociationTypesToPlugin()
```
  - invokePreInstallHook
```
private void invokePreInstallHook()
```
  - invokeInitHook
```
private void invokeInitHook()
```
  - invokeShutdownHook
```
private void invokeShutdownHook()
```
  - registerListeners
```
private void registerListeners()
```
  - unregisterListeners
```
private void unregisterListeners()
```
  - getEvents
```
private List<DMXEvent> getEvents()
```
    Returns the events this plugin is listening to.
  - dispatchEvent
```
private void dispatchEvent(DMXEvent event,
                           Object... params)
```
    Checks weather this plugin is a listener for the given event, and if so, dispatches the event to this plugin. Otherwise nothing is performed.
    Called internally to dispatch the INTRODUCE_TOPIC_TYPE and INTRODUCE_ASSOCIATION_TYPE events.
  - isListenerInterface
```
private boolean isListenerInterface(Class interfaze)
```
    Returns true if the specified interface is an event listener interface. A event listener interface is a sub-interface of EventListener.
  - registerProvidedService
```
private void registerProvidedService()
```
    Registers the provided service at the OSGi framework. If this plugin doesn't provide a service nothing is performed.
  - providedServiceInterface
```
private String providedServiceInterface()
```
  - publishWebResources
```
private void publishWebResources()
```
    Publishes this plugin's web resources (via WebPublishingService). If the plugin doesn't provide web resources nothing is performed.
  - unpublishWebResources
```
private void unpublishWebResources()
```
  - getWebResourcesNamespace
```
private String getWebResourcesNamespace()
```
  - getBundleEntry
```
private URL getBundleEntry(String path)
```
  - unpublishFileSystem
```
private void unpublishFileSystem()
```
  - publishRestResources
```
private void publishRestResources()
```
    Publishes this plugin's REST resources (via WebPublishingService). If the plugin doesn't provide REST resources nothing is performed.
  - unpublishRestResources
```
private void unpublishRestResources()
```
  - getRootResources
```
private List<Object> getRootResources()
```
  - getProviderClasses
```
private List<Class<?>> getProviderClasses()
                                   throws IOException
```
    Throws:
    
    IOException
  - pluginDependencies
```
private List<String> pluginDependencies()
```
  - hasDependency
```
private boolean hasDependency(String pluginUri)
```
  - dependenciesAvailable
```
private boolean dependenciesAvailable()
```
  - isPluginActivated
```
private boolean isPluginActivated(String pluginUri)
```
  - registerPluginActivatedEventListener
```
private void registerPluginActivatedEventListener()
```
  - postPluginActivatedEvent
```
private void postPluginActivatedEvent()
```
  - handleEvent
```
public void handleEvent(org.osgi.service.event.Event event)
```
    Specified by:
    
    handleEvent in interface org.osgi.service.event.EventHandler
  - pluginName
```
private String pluginName()
```
  - getInterfaces
```
private List<Class<?>> getInterfaces(String suffix)
```
  - scanPackage
```
private List<String> scanPackage(String relativePath)
```
  - getPluginPaths
```
private Enumeration<String> getPluginPaths(String relativePath)
```
  - entryPathToClassName
```
private String entryPathToClassName(String entryPath)
```

Class PluginImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PLUGIN_DEFAULT_PACKAGE

PLUGIN_CONFIG_FILE

PLUGIN_ACTIVATED

pluginContext

bundleContext

pluginBundle

pluginUri

pluginProperties

pluginPackage

pluginInfo

pluginDependencies

pluginTopic

dmx

mf

eventService

injectableServices

serviceTrackers

providedServiceInterface

webResources

fileSystemResources

restResources

logger

Constructor Detail

PluginImpl

Method Detail

start

stop

publishFileSystem

getUri

getStaticResource

hasStaticResource

toString

getInfo

getContext

getPluginTopic

getProvidedServiceInterface

getConfigProperty

getConfigProperty

getMigrationClassName

setMigrationNr

loadClass

readConfigFile

createCoreServiceTrackers

createInjectedServiceTrackers

createInjectableServices

injectedServicesAvailable

getInjectableFields

getInjectedService

createServiceTracker

openServiceTrackers

closeServiceTrackers

addService

removeService

setCoreService

checkRequirementsForActivation

activate

deactivate

installPluginInDB

createPluginTopicIfNotExists

createPluginTopic

fetchPluginTopic

introduceTopicTypesToPlugin

introduceAssociationTypesToPlugin

invokePreInstallHook

invokeInitHook

invokeShutdownHook

registerListeners

unregisterListeners

getEvents

dispatchEvent

isListenerInterface

registerProvidedService

providedServiceInterface

publishWebResources