Deprecated API

Contents

• Terminally Deprecated
• Interfaces
• Classes
• Enum Classes
• Record Classes
• Annotation Interfaces
• Fields
• Methods
• Constructors
• Enum Constants

Terminally Deprecated Elements

Element	Description
org.graylog2.database.CollectionName	Use DbEntity instead

Deprecated Interfaces

Interface	Description
org.graylog.security.certutil.CertRenewalService
org.graylog2.cluster.NodeService	Please use the generic org.graylog2.cluster.nodes.NodeService specifying the type of node to be returned (either server or data node).
org.graylog2.rest.resources.system.RemoteSystemShutdownResource
org.mongojack.WriteResult	use MongoCollections as an entrypoint for interacting with MongoDB.

Deprecated Classes

Class	Description
org.graylog.integrations.notifications.types.microsoftteams.TeamsEventNotification
org.graylog.integrations.notifications.types.microsoftteams.TeamsEventNotificationConfig
org.graylog.integrations.notifications.types.microsoftteams.TeamsEventNotificationConfigEntity
org.graylog.plugins.views.migrations.V20191203120602_MigrateSavedSearchesToViewsSupport.savedsearch.SavedSearchService	Needed only by migrations.
org.graylog.scheduler.DBCustomJobDefinitionService
org.graylog.schema.GraylogSchemaFields	Please use the appropriate enums in this package rather than this collection of strings
org.graylog.security.certutil.CertRenewalServiceImpl
org.graylog2.bindings.providers.CommonMongoJackObjectMapperProvider	Use MongoJackObjectMapperProvider directly.
org.graylog2.cluster.NodeServiceImpl	This is left for compatibility reasons, delegating calls to org.graylog2.cluster.nodes.NodeService<ServerNodeEntity>
org.graylog2.cluster.preflight.DataNodeProvisioningConfig
org.graylog2.contentpacks.model.entities.StreamAlertConditionEntity
org.graylog2.database.jackson.legacy.LegacyDeleteResult	use MongoCollections as an entrypoint for interacting with MongoDB.
org.graylog2.database.jackson.legacy.LegacyInsertManyResult	use MongoCollections as an entrypoint for interacting with MongoDB.
org.graylog2.database.jackson.legacy.LegacyInsertOneResult	use MongoCollections as an entrypoint for interacting with MongoDB.
org.graylog2.database.jackson.legacy.LegacyUpdateOneResult	use MongoCollections as an entrypoint for interacting with MongoDB.
org.graylog2.database.jackson.legacy.LegacyUpdateResult	use MongoCollections as an entrypoint for interacting with MongoDB.
org.graylog2.plugin.inputs.transports.ThrottleableTransport	Please use ThrottleableTransport2 instead
org.graylog2.plugin.Message.MessageIdFunction
org.graylog2.rest.resources.cluster.ClusterSystemShutdownResource	Shutting down nodes using an API request is discouraged in favor of using a service manager to control the server process.
org.graylog2.rest.resources.system.ClusterStatsResource
org.graylog2.rest.resources.system.SystemShutdownResource	shutting down the node using an API request is discouraged in favor of using a service manager to control the server process.
org.graylog2.shared.rest.resources.ProxiedResource.MasterResponse	Use ProxiedResource.NodeResponse instead.
org.mongojack.DBCursor	use MongoCollections as an entrypoint for interacting with MongoDB.
org.mongojack.JacksonDBCollection	use MongoCollections as an entrypoint for interacting with MongoDB.

Deprecated Enum Classes

Enum Class	Description
org.graylog2.cluster.preflight.DataNodeProvisioningConfig.State

Deprecated Record Classes

Record Class	Description
org.graylog2.bootstrap.preflight.PreflightConfig

Deprecated Annotation Interfaces

Annotation Interface	Description
org.graylog2.database.CollectionName	Use DbEntity instead
org.graylog2.shared.security.RestrictToMaster	Use RestrictToLeader instead

Deprecated Fields

Field	Description
org.graylog.integrations.ipfix.IpfixJournal.DataSet.PARSER
org.graylog.integrations.ipfix.IpfixJournal.RawIpfix.PARSER
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.PARSER
org.graylog.plugins.pipelineprocessor.parser.RuleLangLexer.tokenNames	Use RuleLangLexer.VOCABULARY instead.
org.graylog.plugins.pipelineprocessor.parser.RuleLangParser.tokenNames	Use RuleLangParser.VOCABULARY instead.
org.graylog.schema.DestinationFields.DESTINATION_GEO_CITY_NAME
org.graylog.schema.DestinationFields.DESTINATION_GEO_STATE_NAME
org.graylog.schema.DestinationFields.DESTINATION_PACKETS
org.graylog.schema.GeoFields.GEO_CITY_NAME
org.graylog.schema.GeoFields.GEO_STATE_NAME
org.graylog.schema.HostFields.HOST_GEO_CITY_NAME
org.graylog.schema.HostFields.HOST_GEO_STATE_NAME
org.graylog.schema.HttpFields.HTTP_URL
org.graylog.schema.HttpFields.HTTP_URL_CATEGORY
org.graylog.schema.NetworkFields.NETWORK_BYTES_RX
org.graylog.schema.NetworkFields.NETWORK_BYTES_TX
org.graylog.schema.SourceFields.SOURCE_AS_ORGANIZATION_NAME
org.graylog.schema.SourceFields.SOURCE_GEO_CITY_NAME
org.graylog.schema.SourceFields.SOURCE_GEO_STATE_NAME
org.graylog.schema.SourceFields.SOURCE_PACKETS
org.graylog.security.certutil.CertConstants.DATANODE_KEY_ALIAS
org.graylog.security.certutil.CertutilHttp.DATANODE_KEY_ALIAS
org.graylog2.plugin.Message.FIELD_GL2_SOURCE_COLLECTOR_INPUT	This was used in the legacy collector/sidecar system and contained the database ID of the collector input.
org.graylog2.plugin.Message.FIELD_GL2_SOURCE_RADIO	This was used with the now removed radio system and contained the ID of a radio node. TODO: Due to be removed in Graylog 3.x
org.graylog2.plugin.Message.FIELD_GL2_SOURCE_RADIO_INPUT	This was used with the now removed radio system and contained the input ID of a radio node. TODO: Due to be removed in Graylog 3.x
org.graylog2.plugin.Message.ID_FUNCTION
org.graylog2.shared.security.RestPermissions.NODE_SHUTDOWN

Deprecated Methods

Method	Description
org.graylog.events.rest.EventDefinitionsResource.list(int, int, String)
org.graylog.events.rest.EventNotificationsResource.listNotifications(int, int, String)
org.graylog.integrations.ipfix.IpfixJournal.RawIpfix.Builder.getMutableOptionTemplates()
org.graylog.integrations.ipfix.IpfixJournal.RawIpfix.Builder.getMutableTemplates()
org.graylog.integrations.ipfix.IpfixJournal.RawIpfix.Builder.getOptionTemplates()
org.graylog.integrations.ipfix.IpfixJournal.RawIpfix.Builder.getTemplates()
org.graylog.integrations.ipfix.IpfixJournal.RawIpfix.getOptionTemplates()
org.graylog.integrations.ipfix.IpfixJournal.RawIpfix.getTemplates()
org.graylog.integrations.ipfix.IpfixJournal.RawIpfixOrBuilder.getOptionTemplates()
org.graylog.integrations.ipfix.IpfixJournal.RawIpfixOrBuilder.getTemplates()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.Builder.getMutableOptionTemplate()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.Builder.getMutableTemplates()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.Builder.getOptionTemplate()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.Builder.getTemplates()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.getOptionTemplate()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.getTemplates()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9OrBuilder.getOptionTemplate()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9OrBuilder.getTemplates()
org.graylog.plugins.pipelineprocessor.parser.RuleLangLexer.getTokenNames()
org.graylog.plugins.pipelineprocessor.parser.RuleLangParser.getTokenNames()
org.graylog.plugins.threatintel.ThreatIntelPluginConfiguration.Builder.otxEnabled(boolean)
org.graylog.plugins.threatintel.ThreatIntelPluginConfiguration.otxApiKey()
org.graylog.plugins.threatintel.ThreatIntelPluginConfiguration.otxEnabled()
org.graylog.plugins.views.search.rest.scriptingapi.request.Grouping.fieldName()
org.graylog.plugins.views.search.rest.scriptingapi.request.MessagesRequestSpec.fields()
org.graylog.scheduler.DBCustomJobDefinitionService.findOrCreate(JobDefinitionDto)
org.graylog.scheduler.DBJobTriggerService.cancelTriggerByQuery(DBQuery.Query)
org.graylog.scheduler.DBJobTriggerService.countByQuery(DBQuery.Query)
org.graylog.scheduler.DBJobTriggerService.deleteByQuery(DBQuery.Query)
org.graylog.scheduler.DBJobTriggerService.findByQuery(DBQuery.Query)
org.graylog.scheduler.JobSchedule.toDBUpdate(String)	This method won't be called by the persistence layer anymore.
org.graylog.security.authservice.UserDetails.Builder.fullName(String)
org.graylog2.buffers.Buffers.waitForEmptyBuffers()	Use Buffers.waitForEmptyBuffers(EnumSet) instead
org.graylog2.buffers.Buffers.waitForEmptyBuffers(long, TimeUnit)	Use Buffers.waitForEmptyBuffers(EnumSet, long, TimeUnit) instead
org.graylog2.cluster.Node.isMaster()	Use LeaderElectionService.isLeader() or Node.isLeader() instead.
org.graylog2.configuration.ExposedConfiguration.staleMasterTimeout()	We will serialize the field to the same value as ExposedConfiguration.staleLeaderTimeout() for backwards compatibility but ignore it on deserialization.
org.graylog2.Configuration.getAlertCheckInterval()
org.graylog2.Configuration.getEnabledTlsProtocols()
org.graylog2.Configuration.getStaleMasterTimeout()	Use getStaleLeaderTimeout instead
org.graylog2.Configuration.isMaster()	Use Configuration.isLeader() instead.
org.graylog2.Configuration.setIsMaster(boolean)	Use Configuration.setIsLeader(boolean) instead
org.graylog2.contentpacks.model.entities.StreamEntity.alertConditions()
org.graylog2.database.MongoCollections.get(String, Class<T>)	Use MongoCollections.collection(String, Class) or MongoCollections.nonEntityCollection(String, Class) instead.
org.graylog2.database.MongoConnection.getDatabase()	Use MongoConnection.getMongoDatabase().
org.graylog2.database.PaginatedDbService.getMultiFieldSortBuilder(String, List<String>)	DBSort is deprecated. Consider using Sorts instead.
org.graylog2.database.PaginatedDbService.getSortBuilder(String, String)	DBSort is deprecated. Consider using Sorts instead.
org.graylog2.database.utils.MongoUtils.initializeLegacyMongoJackBsonObject(InitializationRequiredForTransformation)	This method is only meant as an interim solution. Rewrite your deprecated MongoJack objects so that you don't have to use it.
org.graylog2.indexer.indexset.profile.IndexFieldTypeProfileService.getAll()
org.graylog2.indexer.messages.Indexable.getId()
org.graylog2.indexer.messages.SerializationMemoizingMessage.getId()
org.graylog2.indexer.searches.Searches.scroll(String, TimeRange, int, int, List<String>, String, int)
org.graylog2.inputs.codecs.gelf.GELFMessage.getJSON()	Use GELFMessage.getJSON(long).
org.graylog2.plugin.configuration.ConfigurationRequest.removeField(String)
org.graylog2.plugin.database.users.User.setFullName(String)
org.graylog2.plugin.inputs.MessageInput.getAttributesWithMaskedPasswords()
org.graylog2.plugin.inputs.MessageInput.launch(InputBuffer)
org.graylog2.plugin.journal.RawMessage.getJournalOffset()	use RawMessage.getMessageQueueId() instead
org.graylog2.plugin.lookup.LookupCache.incrHitCount()
org.graylog2.plugin.lookup.LookupCache.incrMissCount()
org.graylog2.plugin.lookup.LookupCache.incrTotalCount()
org.graylog2.plugin.lookup.LookupDataAdapter.set(Object, Object)
org.graylog2.plugin.Message.getIsSourceInetAddress()
org.graylog2.plugin.Message.getJournalOffset()	Use Message.getMessageQueueId() instead.
org.graylog2.plugin.Message.setStreams(List<Stream>)
org.graylog2.plugin.periodical.Periodical.masterOnly()	Use Periodical.leaderOnly() instead.
org.graylog2.plugin.PluginModule.addNotificationType(String, Class<? extends EventNotificationConfig>, Class<? extends EventNotification>, Class<? extends EventNotification.Factory>)
org.graylog2.plugin.ServerStatus.awaitRunning(Runnable)	Preferably use ServerStatus.awaitRunning() instead, which is interruptible.
org.graylog2.plugin.system.NodeId.toUnescapedString()
org.graylog2.plugin.Tools.iso8601()	Use Tools.nowUTC() instead.
org.graylog2.rest.models.system.cluster.responses.NodeSummary.isMaster()
org.graylog2.rest.resources.streams.rules.StreamRuleResource.updateDeprecated(String, String, CreateStreamRuleRequest)
org.graylog2.rest.resources.streams.StreamResource.get()
org.graylog2.rest.resources.system.DeflectorResource.deprecatedCycle()
org.graylog2.rest.resources.system.DeflectorResource.deprecatedDeflector()
org.graylog2.rest.resources.system.GrokResource.listGrokPatterns()
org.graylog2.rest.resources.system.indexer.IndexerOverviewResource.index()
org.graylog2.rest.resources.system.SessionsResource.terminateSessionWithId(String, ContainerRequestContext)
org.graylog2.rest.resources.system.SystemShutdownResource.shutdown()
org.graylog2.rest.resources.users.UsersResource.get(String, UserContext)
org.graylog2.rest.resources.users.UsersResource.listUsers(boolean, boolean, SearchUser)	Use the paginated call instead
org.graylog2.shared.rest.resources.ProxiedResource.getForAllNodes(Function<RemoteInterfaceType, Call<RemoteCallResponseType>>, Function<String, Optional<RemoteInterfaceType>>)
org.graylog2.shared.rest.resources.ProxiedResource.getForAllNodes(Function<RemoteInterfaceType, Call<RemoteCallResponseType>>, Function<String, Optional<RemoteInterfaceType>>, Duration)
org.graylog2.shared.rest.resources.ProxiedResource.getForAllNodes(Function<RemoteInterfaceType, Call<RemoteCallResponseType>>, Function<String, Optional<RemoteInterfaceType>>, Function<RemoteCallResponseType, FinalResponseType>)
org.graylog2.shared.rest.resources.ProxiedResource.getForAllNodes(Function<RemoteInterfaceType, Call<RemoteCallResponseType>>, Function<String, Optional<RemoteInterfaceType>>, Function<RemoteCallResponseType, FinalResponseType>, Duration)
org.graylog2.shared.users.UserService.getAdminUser()	If you really need the root user, use UserService.getRootUser() instead.
org.graylog2.streams.StreamDTO.alertConditions()
org.graylog2.streams.StreamDTO.alertReceivers()
org.graylog2.streams.StreamDTO.Builder.alertConditions(Collection<AlertConditionSummary>)
org.graylog2.streams.StreamDTO.Builder.alertReceivers(AlertReceivers)
org.graylog2.system.stats.elasticsearch.IndicesStats.create(int, long, long, long)
org.graylog2.users.UserImpl.setFullName(String)
org.graylog2.users.UserServiceImpl.getAdminUser()

Deprecated Constructors

Constructor	Description
org.graylog.events.event.EventProcessorEventFactory(ULID, NodeService, NodeId)
org.graylog.scheduler.DBJobTriggerService(MongoConnection, MongoCollections, MongoJackObjectMapperProvider, NodeId, JobSchedulerClock, SchedulerCapabilitiesService, Duration)
org.graylog2.cluster.ClusterConfigServiceImpl(MongoJackObjectMapperProvider, MongoConnection, NodeId, ChainingClassLoader, ClusterEventBus)
org.graylog2.events.ClusterEventPeriodical(MongoJackObjectMapperProvider, MongoConnection, NodeId, ChainingClassLoader, EventBus, ClusterEventBus)
org.graylog2.plugin.inputs.transports.AbstractTcpTransport(Configuration, ThroughputCounter, LocalMetricRegistry, EventLoopGroup, EventLoopGroupFactory, NettyTransportConfiguration, Configuration)
org.graylog2.plugin.Version(int, int, int)	Use Version(com.github.zafarkhaja.semver.Version) or Version.from(int, int, int)
org.graylog2.plugin.Version(int, int, int, String)	Use Version(com.github.zafarkhaja.semver.Version) or Version.from(int, int, int, String)
org.graylog2.plugin.Version(int, int, int, String, String)	Use Version(com.github.zafarkhaja.semver.Version)

Deprecated Enum Constants

Enum Constant	Description
org.graylog2.notifications.Notification.Type.GC_TOO_LONG
org.graylog2.notifications.Notification.Type.MULTI_MASTER
org.graylog2.notifications.Notification.Type.NO_MASTER
org.graylog2.plugin.journal.RawMessage.SourceNode.Type.RADIO
org.graylog2.plugin.ServerStatus.Capability.MASTER	Use LeaderElectionService.isLeader() to determine if the node currently acts as a leader, if you absolutely must.