com.hivemq.spi

Class HiveMQPluginModule

java.lang.Object

com.google.inject.AbstractModule

com.hivemq.spi.HiveMQPluginModule

All Implemented Interfaces:

com.google.inject.Module

public abstract class HiveMQPluginModule
extends com.google.inject.AbstractModule

The HiveMQ Plugin Guice Module class from which you should inherit when writing a HiveMQ plugin.

The entryPointClass() must return a subclass of PluginEntryPoint. It's possible to use Dependency Injection with Guice in this entry point

Since:

1.4

Author:

Dominik Obermaier, Christoph Schäbel

Constructor Summary

Constructors

Constructor and Description
HiveMQPluginModule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure()
protected abstract void	configurePlugin() This method should be used to configure the Guice Bindings and Guice Configurations.
protected abstract Class<? extends PluginEntryPoint>	entryPointClass() Must return the main plugin class which is the "entry point" of the plugin.

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HiveMQPluginModule

public HiveMQPluginModule()

Method Detail

configure

protected final void configure()

Specified by:

configure in class com.google.inject.AbstractModule

configurePlugin

protected abstract void configurePlugin()

This method should be used to configure the Guice Bindings and Guice Configurations.

entryPointClass

protected abstract Class<? extends PluginEntryPoint> entryPointClass()

Must return the main plugin class which is the "entry point" of the plugin.

Note: This plugin class can use Dependency Injection via Guice

Returns:

the main entry class