Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Annotation Types
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Interfaces

Interface and Description
org.graylog2.rest.resources.system.RemoteSystemShutdownResource

Deprecated Classes

Class and Description
org.graylog2.rest.resources.system.ClusterStatsResource
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.graylog.schema.GraylogSchemaFields Please use the appropriate enums in this package rather than this collection of strings
org.graylog2.plugin.Message.MessageIdFunction
org.graylog2.shared.rest.resources.ProxiedResource.MasterResponse Use ProxiedResource.NodeResponse instead.
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.

Deprecated Annotation Types

Annotation Type and Description
org.graylog2.shared.security.RestrictToMaster Use RestrictToLeader instead

Deprecated Fields

Field and Description
org.graylog2.plugin.Version.abbrevCommitSha Use Version.getVersion()
org.graylog2.plugin.Version.additional Use Version.getVersion()
org.graylog.schema.DestinationFields.DESTINATION_GEO_CITY_NAME
org.graylog.schema.DestinationFields.DESTINATION_GEO_STATE_NAME
org.graylog.schema.DestinationFields.DESTINATION_PACKETS
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.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.graylog2.plugin.Message.ID_FUNCTION
org.graylog2.plugin.Version.major Use Version.getVersion()
org.graylog2.plugin.Version.minor Use Version.getVersion()
org.graylog.schema.NetworkFields.NETWORK_BYTES_RX
org.graylog.schema.NetworkFields.NETWORK_BYTES_TX
org.graylog2.shared.security.RestPermissions.NODE_SHUTDOWN
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.PARSER
org.graylog2.plugin.Version.patch Use Version.getVersion()
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.plugins.pipelineprocessor.parser.RuleLangParser.tokenNames Use RuleLangParser.VOCABULARY instead.
org.graylog.plugins.pipelineprocessor.parser.RuleLangLexer.tokenNames Use RuleLangLexer.VOCABULARY instead.

Deprecated Methods

Method and Description
org.graylog2.streams.StreamService.addAlertReceiver(Stream, String, String)
org.graylog2.plugin.Message.addDoubleFields(Map<String, Double>)
org.graylog2.plugin.Message.addLongFields(Map<String, Long>)
org.graylog2.plugin.PluginModule.addNotificationType(String, Class<? extends EventNotificationConfig>, Class<? extends EventNotification>, Class<? extends EventNotification.Factory>)
org.graylog2.rest.resources.streams.alerts.StreamAlertResource.addReceiver(String, String, String)
org.graylog2.plugin.Message.addStringFields(Map<String, String>)
org.graylog2.rest.resources.alarmcallbacks.StreamAlarmCallbackResource.available(String)
org.graylog2.plugin.ServerStatus.awaitRunning(Runnable) Preferably use ServerStatus.awaitRunning() instead, which is interruptible.
org.graylog2.system.stats.elasticsearch.IndicesStats.create(int, long, long, long)
org.graylog2.rest.resources.system.DeflectorResource.deprecatedCycle()
org.graylog2.rest.resources.system.DeflectorResource.deprecatedDeflector()
org.graylog.security.authservice.UserDetails.Builder.fullName(String)
org.graylog2.rest.resources.streams.StreamResource.get()
org.graylog2.rest.resources.users.UsersResource.get(String, UserContext)
org.graylog2.users.UserServiceImpl.getAdminUser()
org.graylog2.shared.users.UserService.getAdminUser() If you really need the root user, use UserService.getRootUser() instead.
org.graylog2.Configuration.getAlertCheckInterval()
org.graylog2.configuration.ElasticsearchConfiguration.getAnalyzer()
org.graylog2.plugin.inputs.MessageInput.getAttributesWithMaskedPasswords()
org.graylog.plugins.views.search.validation.LineCountingCharStream.getColumn()
org.graylog2.database.MongoConnection.getDatabase() Use MongoConnection.getMongoDatabase().
org.graylog2.Configuration.getEnabledTlsProtocols()
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>>, Function<RemoteCallResponseType, FinalResponseType>)
org.graylog2.indexer.messages.Indexable.getId()
org.graylog2.configuration.ElasticsearchConfiguration.getIndexOptimizationMaxNumSegments()
org.graylog2.configuration.ElasticsearchConfiguration.getIndexPrefix()
org.graylog2.plugin.Message.getIsSourceInetAddress()
org.graylog2.plugin.Message.getJournalOffset() Use Message.getMessageQueueId() instead.
org.graylog2.plugin.journal.RawMessage.getJournalOffset() use RawMessage.getMessageQueueId() instead
org.graylog2.inputs.codecs.gelf.GELFMessage.getJSON() Use GELFMessage.getJSON(long).
org.graylog.plugins.views.search.validation.LineCountingCharStream.getLine()
org.graylog2.configuration.ElasticsearchConfiguration.getMaxDocsPerIndex()
org.graylog2.configuration.ElasticsearchConfiguration.getMaxNumberOfIndices()
org.graylog2.configuration.ElasticsearchConfiguration.getMaxSizePerIndex()
org.graylog2.configuration.ElasticsearchConfiguration.getMaxTimePerIndex()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.Builder.getMutableOptionTemplate()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.Builder.getMutableTemplates()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9OrBuilder.getOptionTemplate()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.getOptionTemplate()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.Builder.getOptionTemplate()
org.graylog2.configuration.ElasticsearchConfiguration.getReplicas()
org.graylog2.configuration.ElasticsearchConfiguration.getRetentionStrategy()
org.graylog2.configuration.ElasticsearchConfiguration.getRotationStrategy()
org.graylog2.configuration.ElasticsearchConfiguration.getShards()
org.graylog2.Configuration.getStaleMasterTimeout() Use getStaleLeaderTimeout instead
org.graylog2.configuration.ElasticsearchConfiguration.getTemplateName()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9OrBuilder.getTemplates()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.getTemplates()
org.graylog.plugins.netflow.v9.NetFlowV9Journal.RawNetflowV9.Builder.getTemplates()
org.graylog.plugins.pipelineprocessor.parser.RuleLangParser.getTokenNames()
org.graylog.plugins.pipelineprocessor.parser.RuleLangLexer.getTokenNames()
org.graylog2.plugin.Message.getValidationErrors()
org.graylog2.plugin.Version.greaterMinor(Version)
org.graylog2.plugin.lookup.LookupCache.incrHitCount()
org.graylog2.plugin.lookup.LookupCache.incrMissCount()
org.graylog2.plugin.lookup.LookupCache.incrTotalCount()
org.graylog2.rest.resources.system.indexer.IndexerOverviewResource.index()
org.graylog2.configuration.ElasticsearchConfiguration.isDisableIndexOptimization()
org.graylog2.Configuration.isEnableLegacyAlerts()
org.graylog2.Configuration.isMaster() Use Configuration.isLeader() instead.
org.graylog2.rest.models.system.cluster.responses.NodeSummary.isMaster()
org.graylog2.cluster.Node.isMaster()
org.graylog2.plugin.Tools.iso8601() Use Tools.nowUTC() instead.
org.graylog2.rest.resources.system.GrokResource.listGrokPatterns()
org.graylog2.rest.resources.users.UsersResource.listUsers()
org.graylog2.plugin.periodical.Periodical.masterOnly() Use Periodical.leaderOnly() instead.
org.graylog2.streams.StreamService.removeAlertReceiver(Stream, String, String)
org.graylog2.plugin.configuration.ConfigurationRequest.removeField(String)
org.graylog2.rest.resources.streams.alerts.StreamAlertResource.removeReceiver(String, String, String)
org.graylog2.shared.rest.resources.ProxiedResource.requestOnMaster(Function<RemoteInterfaceType, Call<RemoteCallResponseType>>, Function<String, Optional<RemoteInterfaceType>>) Use ProxiedResource.requestOnLeader(Function, Function) instead.
org.graylog2.indexer.searches.Searches.scroll(String, TimeRange, int, int, List<String>, String, int)
org.graylog2.plugin.lookup.LookupDataAdapter.set(Object, Object)
org.graylog2.plugin.database.users.User.setFullName(String)
org.graylog2.users.UserImpl.setFullName(String)
org.graylog2.Configuration.setIsMaster(boolean) Use Configuration.setIsLeader(boolean) instead
org.graylog2.plugin.Message.setStreams(List<Stream>)
org.graylog2.rest.resources.system.SystemShutdownResource.shutdown()
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.rest.resources.system.SessionsResource.terminateSessionWithId(String, ContainerRequestContext)
org.graylog2.rest.resources.streams.rules.StreamRuleResource.updateDeprecated(String, String, CreateStreamRuleRequest)
org.graylog2.buffers.Buffers.waitForEmptyBuffers() Use Buffers.waitForEmptyBuffers(EnumSet) instead
org.graylog2.buffers.Buffers.waitForEmptyBuffers(long, TimeUnit) Use Buffers.waitForEmptyBuffers(EnumSet, long, TimeUnit) instead

Deprecated Constructors

Constructor and Description
org.graylog2.plugin.inputs.transports.AbstractTcpTransport(Configuration, ThroughputCounter, LocalMetricRegistry, EventLoopGroup, EventLoopGroupFactory, NettyTransportConfiguration, Configuration)
org.graylog.plugins.views.search.engine.QueryEngine(Map<String, QueryBackend<? extends GeneratedQueryContext>>, Set<QueryMetadataDecorator>, QueryParser, Provider<SearchConfig>)
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 and Description
org.graylog2.plugin.ServerStatus.Capability.MASTER Use LeaderElectionService.isLeader() to determine if the node currently acts as a leader, if you absolutely must.
org.graylog2.notifications.Notification.Type.MULTI_MASTER
org.graylog2.notifications.Notification.Type.NO_MASTER
org.graylog2.plugin.journal.RawMessage.SourceNode.Type.RADIO