io.deephaven.server.plugin.PluginsModule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-server Show documentation

The 'server' project

The newest version!

//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.server.plugin;

import dagger.Binds;
import dagger.Module;
import io.deephaven.plugin.PluginModule;
import io.deephaven.plugin.Registration;
import io.deephaven.plugin.Registration.Callback;
import io.deephaven.plugin.js.JsPlugin;
import io.deephaven.server.plugin.js.JsPluginModule;
import io.deephaven.server.plugin.type.ObjectTypesModule;

/**
 * Includes the {@link Module modules} necessary to provide {@link PluginRegistration}.
 *
 * 
 * Downstream servers will need to provide an appropriate {@link JsPlugin} implementation, or include
 * {@link io.deephaven.server.plugin.js.JsPluginNoopConsumerModule}.
 *
 * 
 * Note: runtime plugin registration is not currently supported - ie, no {@link Callback} is provided. See
 * deephaven-core#1809 for the feature request.
 *
 * @see ObjectTypesModule
 * @see JsPluginModule
 * @see PluginModule
 */
@Module(includes = {ObjectTypesModule.class, JsPluginModule.class, PluginModule.class})
public interface PluginsModule {

    @Binds
    Registration.Callback bindPluginRegistrationCallback(PluginRegistrationVisitor visitor);
}