org.graylog.plugins.views.ViewsBindings Maven / Gradle / Ivy
/**
* This file is part of Graylog.
*
* Graylog is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Graylog 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
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Graylog. If not, see .
*/
package org.graylog.plugins.views;
import com.google.common.collect.ImmutableSet;
import com.google.inject.Scopes;
import com.google.inject.assistedinject.FactoryModuleBuilder;
import org.graylog.plugins.views.audit.ViewsAuditEventTypes;
import org.graylog.plugins.views.migrations.V20181220133700_AddViewsAdminRole;
import org.graylog.plugins.views.migrations.V20190127111728_MigrateWidgetFormatSettings;
import org.graylog.plugins.views.migrations.V20190304102700_MigrateMessageListStructure;
import org.graylog.plugins.views.migrations.V20190805115800_RemoveDashboardStateFromViews;
import org.graylog.plugins.views.migrations.V20191125144500_MigrateDashboardsToViewsSupport.V20191125144500_MigrateDashboardsToViews;
import org.graylog.plugins.views.migrations.V20191203120602_MigrateSavedSearchesToViewsSupport.V20191203120602_MigrateSavedSearchesToViews;
import org.graylog.plugins.views.migrations.V20191204000000_RemoveLegacyViewsPermissions;
import org.graylog.plugins.views.migrations.V20200204122000_MigrateUntypedViewsToDashboards.V20200204122000_MigrateUntypedViewsToDashboards;
import org.graylog.plugins.views.search.SearchRequirements;
import org.graylog.plugins.views.search.SearchRequiresParameterSupport;
import org.graylog.plugins.views.search.ValueParameter;
import org.graylog.plugins.views.search.db.InMemorySearchJobService;
import org.graylog.plugins.views.search.db.SearchJobService;
import org.graylog.plugins.views.search.db.SearchesCleanUpJob;
import org.graylog.plugins.views.search.elasticsearch.ESGeneratedQueryContext;
import org.graylog.plugins.views.search.elasticsearch.ElasticsearchQueryString;
import org.graylog.plugins.views.search.filter.AndFilter;
import org.graylog.plugins.views.search.filter.OrFilter;
import org.graylog.plugins.views.search.filter.QueryStringFilter;
import org.graylog.plugins.views.search.filter.StreamFilter;
import org.graylog.plugins.views.search.rest.ViewsRestPermissions;
import org.graylog.plugins.views.search.rest.exceptionmappers.MissingCapabilitiesExceptionMapper;
import org.graylog.plugins.views.search.rest.exceptionmappers.PermissionExceptionMapper;
import org.graylog.plugins.views.search.searchtypes.MessageList;
import org.graylog.plugins.views.search.searchtypes.events.EventList;
import org.graylog.plugins.views.search.searchtypes.pivot.Pivot;
import org.graylog.plugins.views.search.searchtypes.pivot.PivotSort;
import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSort;
import org.graylog.plugins.views.search.searchtypes.pivot.buckets.AutoInterval;
import org.graylog.plugins.views.search.searchtypes.pivot.buckets.Time;
import org.graylog.plugins.views.search.searchtypes.pivot.buckets.TimeUnitInterval;
import org.graylog.plugins.views.search.searchtypes.pivot.buckets.Values;
import org.graylog.plugins.views.search.searchtypes.pivot.series.Average;
import org.graylog.plugins.views.search.searchtypes.pivot.series.Cardinality;
import org.graylog.plugins.views.search.searchtypes.pivot.series.Count;
import org.graylog.plugins.views.search.searchtypes.pivot.series.Max;
import org.graylog.plugins.views.search.searchtypes.pivot.series.Min;
import org.graylog.plugins.views.search.searchtypes.pivot.series.Percentile;
import org.graylog.plugins.views.search.searchtypes.pivot.series.StdDev;
import org.graylog.plugins.views.search.searchtypes.pivot.series.Sum;
import org.graylog.plugins.views.search.searchtypes.pivot.series.SumOfSquares;
import org.graylog.plugins.views.search.searchtypes.pivot.series.Variance;
import org.graylog.plugins.views.search.views.RequiresParameterSupport;
import org.graylog.plugins.views.search.views.ViewRequirements;
import org.graylog.plugins.views.search.views.sharing.AllUsersOfInstance;
import org.graylog.plugins.views.search.views.sharing.AllUsersOfInstanceStrategy;
import org.graylog.plugins.views.search.views.sharing.SpecificRoles;
import org.graylog.plugins.views.search.views.sharing.SpecificRolesStrategy;
import org.graylog.plugins.views.search.views.sharing.SpecificUsers;
import org.graylog.plugins.views.search.views.sharing.SpecificUsersStrategy;
import org.graylog.plugins.views.search.views.widgets.aggregation.AggregationConfigDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.AreaVisualizationConfigDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.AutoIntervalDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.BarVisualizationConfigDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.LineVisualizationConfigDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.NumberVisualizationConfigDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.TimeHistogramConfigDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.TimeUnitIntervalDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.ValueConfigDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.WorldMapVisualizationConfigDTO;
import org.graylog.plugins.views.search.views.widgets.aggregation.sort.PivotSortConfig;
import org.graylog.plugins.views.search.views.widgets.aggregation.sort.SeriesSortConfig;
import org.graylog.plugins.views.search.views.widgets.messagelist.MessageListConfigDTO;
import org.graylog2.plugin.PluginConfigBean;
import java.util.Set;
public class ViewsBindings extends ViewsModule {
@Override
public Set getConfigBeans() {
return ImmutableSet.of(new ViewsConfig());
}
@Override
protected void configure() {
registerRestControllerPackage(getClass().getPackage().getName());
addPermissions(ViewsRestPermissions.class);
// filter
registerJacksonSubtype(AndFilter.class);
registerJacksonSubtype(OrFilter.class);
registerJacksonSubtype(StreamFilter.class);
registerJacksonSubtype(QueryStringFilter.class);
// query backends for jackson
registerJacksonSubtype(ElasticsearchQueryString.class);
// search types
registerJacksonSubtype(MessageList.class);
registerJacksonSubtype(Pivot.class);
registerJacksonSubtype(EventList.class);
// pivot specs
registerJacksonSubtype(Values.class);
registerJacksonSubtype(Time.class);
registerPivotAggregationFunction(Average.NAME, Average.class);
registerPivotAggregationFunction(Cardinality.NAME, Cardinality.class);
registerPivotAggregationFunction(Count.NAME, Count.class);
registerPivotAggregationFunction(Max.NAME, Max.class);
registerPivotAggregationFunction(Min.NAME, Min.class);
registerPivotAggregationFunction(StdDev.NAME, StdDev.class);
registerPivotAggregationFunction(Sum.NAME, Sum.class);
registerPivotAggregationFunction(SumOfSquares.NAME, SumOfSquares.class);
registerPivotAggregationFunction(Variance.NAME, Variance.class);
registerPivotAggregationFunction(Percentile.NAME, Percentile.class);
registerJacksonSubtype(TimeUnitInterval.class);
registerJacksonSubtype(TimeUnitIntervalDTO.class);
registerJacksonSubtype(AutoInterval.class);
registerJacksonSubtype(AutoIntervalDTO.class);
bind(SearchJobService.class).to(InMemorySearchJobService.class).in(Scopes.SINGLETON);
registerWidgetConfigSubtypes();
registerVisualizationConfigSubtypes();
addPeriodical(SearchesCleanUpJob.class);
addMigration(V20181220133700_AddViewsAdminRole.class);
addMigration(V20190304102700_MigrateMessageListStructure.class);
addMigration(V20190805115800_RemoveDashboardStateFromViews.class);
addMigration(V20191204000000_RemoveLegacyViewsPermissions.class);
addMigration(V20191125144500_MigrateDashboardsToViews.class);
addMigration(V20191203120602_MigrateSavedSearchesToViews.class);
addMigration(V20190127111728_MigrateWidgetFormatSettings.class);
addMigration(V20200204122000_MigrateUntypedViewsToDashboards.class);
addAuditEventTypes(ViewsAuditEventTypes.class);
registerViewSharingSubtypes();
registerSharingStrategies();
registerSortConfigSubclasses();
registerParameterSubtypes();
install(new FactoryModuleBuilder().build(ViewRequirements.Factory.class));
install(new FactoryModuleBuilder().build(SearchRequirements.Factory.class));
install(new FactoryModuleBuilder().build(ESGeneratedQueryContext.Factory.class));
registerViewRequirement(RequiresParameterSupport.class);
registerSearchRequirement(SearchRequiresParameterSupport.class);
// trigger capability binder once to set it up
viewsCapabilityBinder();
queryMetadataDecoratorBinder();
registerExceptionMappers();
}
private void registerSortConfigSubclasses() {
registerJacksonSubtype(SeriesSortConfig.class);
registerJacksonSubtype(PivotSortConfig.class);
registerJacksonSubtype(SeriesSort.class);
registerJacksonSubtype(PivotSort.class);
}
private void registerWidgetConfigSubtypes() {
registerJacksonSubtype(AggregationConfigDTO.class);
registerJacksonSubtype(MessageListConfigDTO.class);
registerJacksonSubtype(TimeHistogramConfigDTO.class);
registerJacksonSubtype(ValueConfigDTO.class);
}
private void registerVisualizationConfigSubtypes() {
registerJacksonSubtype(WorldMapVisualizationConfigDTO.class);
registerJacksonSubtype(BarVisualizationConfigDTO.class);
registerJacksonSubtype(NumberVisualizationConfigDTO.class);
registerJacksonSubtype(LineVisualizationConfigDTO.class);
registerJacksonSubtype(AreaVisualizationConfigDTO.class);
}
private void registerViewSharingSubtypes() {
registerJacksonSubtype(AllUsersOfInstance.class);
registerJacksonSubtype(SpecificRoles.class);
registerJacksonSubtype(SpecificUsers.class);
}
private void registerParameterSubtypes() {
registerJacksonSubtype(ValueParameter.class);
}
private void registerSharingStrategies() {
registerSharingStrategy(AllUsersOfInstance.TYPE, AllUsersOfInstanceStrategy.class);
registerSharingStrategy(SpecificRoles.TYPE, SpecificRolesStrategy.class);
registerSharingStrategy(SpecificUsers.TYPE, SpecificUsersStrategy.class);
}
private void registerExceptionMappers() {
addJerseyExceptionMapper(MissingCapabilitiesExceptionMapper.class);
addJerseyExceptionMapper(PermissionExceptionMapper.class);
}
}