Package org.graylog2.plugin

Class PluginModule

java.lang.Object

com.google.inject.AbstractModule

org.graylog2.plugin.inject.Graylog2Module

org.graylog2.plugin.PluginModule

All Implemented Interfaces:

com.google.inject.Module

Direct Known Subclasses:

AlertConditionBindings, AuditBindings, BeatsInputPluginModule, CEFInputModule, ClusterConfigValidatorModule, ContentPacksModule, EnterpriseModule, EventsModule, FakeLeaderElectionModule, GRNModule, GRNTypesModule, InMemoryServicesModule, JobSchedulerModule, LeaderElectionModule, LocalKafkaJournalModule, LockServiceModule, MapWidgetModule, MessageProcessorModule, MessageQueueModule, MigrationsModule, MongoDbServicesModule, NetFlowPluginModule, PipelineProcessorModule, PreflightCheckModule, ProcessorFunctionsModule, PrometheusMetricsModule, RestApiBindings, RetentionStrategyBindings, RotationStrategyBindings, ScopedEntitiesModule, SecurityBindings, SecurityModule, ServerNodeCapabilitiesModule, SidecarModule, ThreatIntelPluginModule, VersionAwareModule

public abstract class PluginModule
extends Graylog2Module

Field Summary

Fields inherited from class org.graylog2.plugin.inject.Graylog2Module

SYSTEM_REST_RESOURCES

Constructor Summary

Constructors

Constructor	Description
PluginModule()

Method Summary

Modifier and Type	Method	Description
protected void	addAlarmCallback(Class<? extends AlarmCallback> alarmCallbackClass)
protected void	addAlertCondition(String name, Class<? extends AlertCondition> alertConditionClass, Class<? extends AlertCondition.Factory> alertConditionFactoryClass)
protected void	addAuditEventFormatter(AuditEventType auditEventType, Class<? extends AuditEventFormatter> auditEventFormatterClass)
protected void	addAuditEventTypes(Class<? extends PluginAuditEventTypes> auditEventTypesClass)
protected void	addAuthServiceBackend(String name, Class<? extends AuthServiceBackend> backendClass, Class<? extends AuthServiceBackend.Factory<? extends AuthServiceBackend>> factoryClass, Class<? extends AuthServiceBackendConfig> configClass)
protected void	addClusterConfigValidator(Class<?> configClass, Class<? extends ClusterConfigValidator> configValidatorClass)
protected void	addCodec(String name, Class<? extends Codec> codecClass)
protected void	addCodec(String name, Class<? extends Codec> codecClass, Class<? extends Codec.Config> configClass, Class<? extends Codec.Factory<? extends Codec>> factoryClass)
protected void	addConfigBeans()
protected void	addConstraintChecker(Class<? extends ConstraintChecker> constraintCheckerClass)
protected void	addEntityFacade(ModelType entityType, Class<? extends EntityWithExcerptFacade<?,?>> entityFacadeClass)
protected void	addEntityScope(Class<? extends EntityScope> entityScopeType)
protected void	addEventFieldValueProvider(String name, Class<? extends FieldValueProvider> fieldValueProviderClass, Class<? extends FieldValueProvider.Factory> factoryClass, Class<? extends FieldValueProvider.Config> configClass)
protected void	addEventProcessor(String name, Class<? extends EventProcessor> processorClass, Class<? extends EventProcessor.Factory> factoryClass, Class<? extends EventProcessorConfig> configClass, Class<? extends EventProcessorParameters> parametersClass)
protected void	addEventStorageHandler(String name, Class<? extends EventStorageHandler> handlerClass, Class<? extends EventStorageHandler.Factory> factoryClass, Class<? extends EventStorageHandler.Config> configClass)
protected void	addExportFormat(Class<? extends ExportFormat> exportFormat)
protected void	addExportFormat(ExportFormat exportFormat)
protected void	addGRNType(GRNType type, Class<? extends GRNDescriptorProvider> descriptorProvider)
protected void	addInitializer(Class<? extends com.google.common.util.concurrent.Service> initializerClass)
protected void	addJerseyExceptionMapper(Class<? extends javax.ws.rs.ext.ExceptionMapper> exceptionMapperClass)
protected void	addJobResourceHandler(String jobType, Class<? extends JobResourceHandler> jobResourceHandlerClass)
protected void	addJobSchedulerSchedule(String name, Class<? extends JobSchedule> scheduleClass)
protected void	addMessageFilter(Class<? extends MessageFilter> messageFilterClass)
protected void	addMessageInput(Class<? extends MessageInput> messageInputClass)
protected <T extends MessageInput> void	addMessageInput(Class<T> messageInputClass, Class<? extends MessageInput.Factory<T>> factoryClass)
protected void	addMessageOutput(Class<? extends MessageOutput> messageOutputClass)
protected <T extends MessageOutput> void	addMessageOutput(Class<T> messageOutputClass, Class<? extends MessageOutput.Factory<T>> factory)
protected <T extends MessageOutput> void	addMessageOutput2(Class<T> messageOutputClass, Class<? extends MessageOutput.Factory2<T>> factory)
protected void	addMessageProcessor(Class<? extends MessageProcessor> processorClass, Class<? extends MessageProcessor.Descriptor> descriptorClass)
protected void	addMigration(Class<? extends Migration> migrationClass)
protected void	addNotificationType(String name, Class<? extends EventNotificationConfig> notificationClass, Class<? extends EventNotification> handlerClass, Class<? extends EventNotification.Factory> factoryClass)	Deprecated.
protected void	addNotificationType(String name, Class<? extends EventNotificationConfig> notificationClass, Class<? extends EventNotification> handlerClass, Class<? extends EventNotification.Factory> factoryClass, String contentPackEntityName, Class<? extends EventNotificationConfigEntity> contentPackEntityClass)
protected void	addPasswordAlgorithm(String passwordAlgorithmName, Class<? extends PasswordAlgorithm> passwordAlgorithmClass)
protected void	addPeriodical(Class<? extends Periodical> periodicalClass)
protected void	addPermissions(Class<? extends PluginPermissions> permissionsClass)
protected void	addPluginUISettingsProvider(String providerKey, Class<? extends PluginUISettingsProvider> uiSettingsProviderClass)
protected void	addRestResource(Class<? extends PluginRestResource> restResourceClass)
protected void	addRetentionStrategy(Class<? extends RetentionStrategy> retentionStrategyClass)
protected void	addRotationStrategy(Class<? extends RotationStrategy> rotationStrategyClass)
protected void	addSchedulerCapabilities(Class<? extends SchedulerCapabilities> schedulerCapabilitiesClass)
protected void	addSchedulerJob(String name, Class<? extends Job> jobClass, Class<? extends Job.Factory> factoryClass, Class<? extends JobDefinitionConfig> configClass)
protected void	addSchedulerJob(String name, Class<? extends Job> jobClass, Class<? extends Job.Factory> factoryClass, Class<? extends JobDefinitionConfig> configClass, Class<? extends JobTriggerData> dataClass)
protected void	addTransport(String name, Class<? extends Transport> transportClass)
protected void	addTransport(String name, Class<? extends Transport> transportClass, Class<? extends Transport.Config> configClass, Class<? extends Transport.Factory<? extends Transport>> factoryClass)
protected com.google.inject.multibindings.MapBinder<String,AuthServiceBackend.Factory<? extends AuthServiceBackend>>	authServiceBackendBinder()
protected void	bindMessageQueueImplementation(Class<? extends MessageQueueReader> readerClass, Class<? extends MessageQueueWriter> writerClass, Class<? extends MessageQueueAcknowledger> acknowledgerClass)	Bind a message queue implementation.
Set<? extends PluginConfigBean>	getConfigBeans()
protected boolean	isCloud()
protected com.google.inject.multibindings.MapBinder<String,JobResourceHandler>	jobResourceHandlerBinder()
protected com.google.inject.multibindings.MapBinder<String,PluginUISettingsProvider>	pluginUISettingsProviderBinder()
protected com.google.inject.multibindings.Multibinder<MessageProcessor>	processorBinder()
protected com.google.inject.multibindings.Multibinder<MessageProcessor.Descriptor>	processorDescriptorBinder()
protected com.google.inject.multibindings.Multibinder<SchedulerCapabilities>	schdulerCapabilitiesBinder()

Methods inherited from class org.graylog2.plugin.inject.Graylog2Module

addPreflightCheck, addSystemRestResource, alertConditionBinder, auditEventFormatterMapBinder, auditEventSenderBinder, auditEventTypesBinder, authenticationRealmBinder, authorizationOnlyRealmBinder, clusterConfigMapBinder, codecMapBinder, constraintCheckerBinder, entityFacadeBinder, findInnerClassAnnotatedWith, inputsMapBinder, installAlertCondition, installAlertConditionWithCustomName, installAuditEventFormatter, installAuditEventTypes, installCodec, installCodec, installCodec, installInput, installInput, installLookupCache, installLookupDataAdapter, installLookupDataAdapter2, installOutput, installOutput, installOutput2, installPermissions, installRetentionStrategy, installRotationStrategy, installSearchResponseDecorator, installTransport, installTransport, installViewResolver, jacksonSubTypesBinder, jerseyAdditionalComponentsBinder, jerseyContainerResponseFilterBinder, jerseyDynamicFeatureBinder, jerseyExceptionMapperBinder, lookupCacheBinder, lookupDataAdapterBinder, lookupDataAdapterBinder2, migrationsBinder, outputsMapBinder, outputsMapBinder2, passwordAlgorithmBinder, permissionsBinder, preflightChecksBinder, registerJacksonSubtype, registerJacksonSubtype, retentionStrategyMapBinder, rotationStrategiesMapBinder, searchResponseDecoratorBinder, serviceBinder, transportMapBinder, viewResolverBinder

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, 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 Details

PluginModule

public PluginModule()

Method Details

getConfigBeans

public Set<? extends PluginConfigBean> getConfigBeans()

addMessageInput

protected void addMessageInput(Class<? extends MessageInput> messageInputClass)

addMessageInput

protected <T extends MessageInput> void addMessageInput(Class<T> messageInputClass,
 Class<? extends MessageInput.Factory<T>> factoryClass)

addMessageFilter

protected void addMessageFilter(Class<? extends MessageFilter> messageFilterClass)

addPeriodical

protected void addPeriodical(Class<? extends Periodical> periodicalClass)

addRotationStrategy

protected void addRotationStrategy(Class<? extends RotationStrategy> rotationStrategyClass)

addRetentionStrategy

protected void addRetentionStrategy(Class<? extends RetentionStrategy> retentionStrategyClass)

addAlarmCallback

protected void addAlarmCallback(Class<? extends AlarmCallback> alarmCallbackClass)

addInitializer

protected void addInitializer(Class<? extends com.google.common.util.concurrent.Service> initializerClass)

addMessageOutput

protected void addMessageOutput(Class<? extends MessageOutput> messageOutputClass)

addMessageOutput

protected <T extends MessageOutput> void addMessageOutput(Class<T> messageOutputClass,
 Class<? extends MessageOutput.Factory<T>> factory)

addMessageOutput2

protected <T extends MessageOutput> void addMessageOutput2(Class<T> messageOutputClass,
 Class<? extends MessageOutput.Factory2<T>> factory)

addRestResource

protected void addRestResource(Class<? extends PluginRestResource> restResourceClass)

addJerseyExceptionMapper

protected void addJerseyExceptionMapper(Class<? extends javax.ws.rs.ext.ExceptionMapper> exceptionMapperClass)

addConfigBeans

protected void addConfigBeans()

addTransport

protected void addTransport(String name,
 Class<? extends Transport> transportClass)

addTransport

protected void addTransport(String name,
 Class<? extends Transport> transportClass,
 Class<? extends Transport.Config> configClass,
 Class<? extends Transport.Factory<? extends Transport>> factoryClass)

addCodec

protected void addCodec(String name,
 Class<? extends Codec> codecClass)

addCodec

protected void addCodec(String name,
 Class<? extends Codec> codecClass,
 Class<? extends Codec.Config> configClass,
 Class<? extends Codec.Factory<? extends Codec>> factoryClass)

addPasswordAlgorithm

protected void addPasswordAlgorithm(String passwordAlgorithmName,
 Class<? extends PasswordAlgorithm> passwordAlgorithmClass)

processorBinder

protected com.google.inject.multibindings.Multibinder<MessageProcessor> processorBinder()

processorDescriptorBinder

protected com.google.inject.multibindings.Multibinder<MessageProcessor.Descriptor> processorDescriptorBinder()

addMessageProcessor

protected void addMessageProcessor(Class<? extends MessageProcessor> processorClass,
 Class<? extends MessageProcessor.Descriptor> descriptorClass)

addPermissions

protected void addPermissions(Class<? extends PluginPermissions> permissionsClass)

addAuditEventTypes

protected void addAuditEventTypes(Class<? extends PluginAuditEventTypes> auditEventTypesClass)

addAuditEventFormatter

protected void addAuditEventFormatter(AuditEventType auditEventType,
 Class<? extends AuditEventFormatter> auditEventFormatterClass)

addAlertCondition

protected void addAlertCondition(String name,
 Class<? extends AlertCondition> alertConditionClass,
 Class<? extends AlertCondition.Factory> alertConditionFactoryClass)

addMigration

protected void addMigration(Class<? extends Migration> migrationClass)

addEntityFacade

protected void addEntityFacade(ModelType entityType,
 Class<? extends EntityWithExcerptFacade<?,?>> entityFacadeClass)

addConstraintChecker

protected void addConstraintChecker(Class<? extends ConstraintChecker> constraintCheckerClass)

addEventProcessor

protected void addEventProcessor(String name,
 Class<? extends EventProcessor> processorClass,
 Class<? extends EventProcessor.Factory> factoryClass,
 Class<? extends EventProcessorConfig> configClass,
 Class<? extends EventProcessorParameters> parametersClass)

addEventStorageHandler

protected void addEventStorageHandler(String name,
 Class<? extends EventStorageHandler> handlerClass,
 Class<? extends EventStorageHandler.Factory> factoryClass,
 Class<? extends EventStorageHandler.Config> configClass)

addEventFieldValueProvider

protected void addEventFieldValueProvider(String name,
 Class<? extends FieldValueProvider> fieldValueProviderClass,
 Class<? extends FieldValueProvider.Factory> factoryClass,
 Class<? extends FieldValueProvider.Config> configClass)

addSchedulerJob

protected void addSchedulerJob(String name,
 Class<? extends Job> jobClass,
 Class<? extends Job.Factory> factoryClass,
 Class<? extends JobDefinitionConfig> configClass)

addSchedulerJob

protected void addSchedulerJob(String name,
 Class<? extends Job> jobClass,
 Class<? extends Job.Factory> factoryClass,
 Class<? extends JobDefinitionConfig> configClass,
 Class<? extends JobTriggerData> dataClass)

addJobSchedulerSchedule

protected void addJobSchedulerSchedule(String name,
 Class<? extends JobSchedule> scheduleClass)

addNotificationType

@Deprecated
protected void addNotificationType(String name,
 Class<? extends EventNotificationConfig> notificationClass,
 Class<? extends EventNotification> handlerClass,
 Class<? extends EventNotification.Factory> factoryClass)

Deprecated.

Deprecated. Please use the below version of the method that also accepts the contentPackEntityName and contentPackEntityClass arguments, so that content pack entities are properly registered. TODO: Consider removing in Graylog 5.0.

addNotificationType

protected void addNotificationType(String name,
 Class<? extends EventNotificationConfig> notificationClass,
 Class<? extends EventNotification> handlerClass,
 Class<? extends EventNotification.Factory> factoryClass,
 String contentPackEntityName,
 Class<? extends EventNotificationConfigEntity> contentPackEntityClass)

addGRNType

protected void addGRNType(GRNType type,
 Class<? extends GRNDescriptorProvider> descriptorProvider)

authServiceBackendBinder

protected com.google.inject.multibindings.MapBinder<String,AuthServiceBackend.Factory<? extends AuthServiceBackend>> authServiceBackendBinder()

addAuthServiceBackend

protected void addAuthServiceBackend(String name,
 Class<? extends AuthServiceBackend> backendClass,
 Class<? extends AuthServiceBackend.Factory<? extends AuthServiceBackend>> factoryClass,
 Class<? extends AuthServiceBackendConfig> configClass)

pluginUISettingsProviderBinder

protected com.google.inject.multibindings.MapBinder<String,PluginUISettingsProvider> pluginUISettingsProviderBinder()

addPluginUISettingsProvider

protected void addPluginUISettingsProvider(String providerKey,
 Class<? extends PluginUISettingsProvider> uiSettingsProviderClass)

addExportFormat

protected void addExportFormat(Class<? extends ExportFormat> exportFormat)

addExportFormat

protected void addExportFormat(ExportFormat exportFormat)

isCloud

protected boolean isCloud()

Returns:

A boolean indicating if the plugin is being loaded on Graylog Cloud. The graylog.cloud system property is set in the startup sequence of the Graylog Cloud Plugin.

bindMessageQueueImplementation

protected void bindMessageQueueImplementation(Class<? extends MessageQueueReader> readerClass,
 Class<? extends MessageQueueWriter> writerClass,
 Class<? extends MessageQueueAcknowledger> acknowledgerClass)

Bind a message queue implementation. If any of the given classes implements the Service interface, it will also be registered with the Graylog2Module.serviceBinder().

Parameters:

readerClass - Reader implementation

writerClass - Writer implementation

acknowledgerClass - Acknowledger implementation

addClusterConfigValidator

protected void addClusterConfigValidator(Class<?> configClass,
 Class<? extends ClusterConfigValidator> configValidatorClass)

schdulerCapabilitiesBinder

protected com.google.inject.multibindings.Multibinder<SchedulerCapabilities> schdulerCapabilitiesBinder()

addSchedulerCapabilities

protected void addSchedulerCapabilities(Class<? extends SchedulerCapabilities> schedulerCapabilitiesClass)

jobResourceHandlerBinder

protected com.google.inject.multibindings.MapBinder<String,JobResourceHandler> jobResourceHandlerBinder()

addJobResourceHandler

protected void addJobResourceHandler(String jobType,
 Class<? extends JobResourceHandler> jobResourceHandlerClass)

addEntityScope

protected void addEntityScope(Class<? extends EntityScope> entityScopeType)