org.graylog.plugins.views.ViewsModule Maven / Gradle / Ivy
/*
* Copyright (C) 2020 Graylog, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* .
*/
package org.graylog.plugins.views;
import com.google.inject.TypeLiteral;
import com.google.inject.binder.LinkedBindingBuilder;
import com.google.inject.binder.ScopedBindingBuilder;
import com.google.inject.multibindings.MapBinder;
import com.google.inject.multibindings.Multibinder;
import org.graylog.plugins.views.search.QueryMetadataDecorator;
import org.graylog.plugins.views.search.Search;
import org.graylog.plugins.views.search.engine.GeneratedQueryContext;
import org.graylog.plugins.views.search.engine.QueryBackend;
import org.graylog.plugins.views.search.engine.QueryStringDecorator;
import org.graylog.plugins.views.search.export.ExportBackend;
import org.graylog.plugins.views.search.rest.SeriesDescription;
import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSpec;
import org.graylog.plugins.views.search.views.ViewDTO;
import org.graylog2.plugin.PluginMetaData;
import org.graylog2.plugin.Version;
import org.graylog2.plugin.VersionAwareModule;
public abstract class ViewsModule extends VersionAwareModule {
protected LinkedBindingBuilder bindExportBackend(Version supportedVersion) {
return bindForVersion(supportedVersion, ExportBackend.class);
}
protected void registerQueryMetadataDecorator(Class queryMetadataDecorator) {
queryMetadataDecoratorBinder().addBinding().to(queryMetadataDecorator);
}
protected Multibinder queryMetadataDecoratorBinder() {
return Multibinder.newSetBinder(binder(), QueryMetadataDecorator.class);
}
protected void registerProvidedViewsCapability(String capability, PluginMetaData plugin) {
viewsCapabilityBinder().addBinding(capability).toInstance(plugin);
}
protected MapBinder viewsCapabilityBinder() {
return MapBinder.newMapBinder(binder(), String.class, PluginMetaData.class);
}
protected void registerViewRequirement(Class> viewRequirement) {
viewRequirementBinder().addBinding().to(viewRequirement);
}
protected Multibinder> viewRequirementBinder() {
return Multibinder.newSetBinder(binder(), new TypeLiteral>() {});
}
protected void registerSearchRequirement(Class> searchRequirement) {
searchRequirementBinder().addBinding().to(searchRequirement);
}
protected Multibinder> searchRequirementBinder() {
return Multibinder.newSetBinder(binder(), new TypeLiteral>() {});
}
protected MapBinder seriesSpecBinder() {
return MapBinder.newMapBinder(binder(), String.class, SeriesDescription.class);
}
protected void registerPivotAggregationFunction(String name, String description, Class seriesSpecClass) {
registerJacksonSubtype(seriesSpecClass);
seriesSpecBinder().addBinding(name).toInstance(SeriesDescription.create(name, description));
}
protected MapBinder> queryBackendBinder(Version version) {
return MapBinder.newMapBinder(binder(),
TypeLiteral.get(String.class),
new TypeLiteral>() {});
}
protected ScopedBindingBuilder registerQueryBackend(Version version, String name, Class> implementation) {
return queryBackendBinder(version).addBinding(name).to(implementation);
}
protected void registerESQueryDecorator(Class esQueryDecorator) {
esQueryDecoratorBinder().addBinding().to(esQueryDecorator);
}
protected Multibinder esQueryDecoratorBinder() {
return Multibinder.newSetBinder(binder(), QueryStringDecorator.class);
}
}