MessageInput (Graylog 4.3.10 API)

java.lang.Object
- org.graylog2.plugin.inputs.MessageInput

All Implemented Interfaces:

Stoppable

Direct Known Subclasses:

Beats2Input, BeatsInput, CEFAmqpInput, CEFKafkaInput, CEFTCPInput, CEFUDPInput, FakeHttpMessageInput, GELFAMQPInput, GELFHttpInput, GELFKafkaInput, GELFTCPInput, GELFUDPInput, JsonPathInput, NetFlowUdpInput, RawAMQPInput, RawKafkaInput, RawTCPInput, RawUDPInput, SyslogAMQPInput, SyslogKafkaInput, SyslogTCPInput, SyslogUDPInput
```
public abstract class MessageInput
extends Object
implements Stoppable
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MessageInput.Config

static class MessageInput.Descriptor

static interface MessageInput.Factory<M>

Nested Classes
Modifier and Type	Class and Description
`static class`	`MessageInput.Config`
`static class`	`MessageInput.Descriptor`
`static interface`	`MessageInput.Factory<M>`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Configuration`	`configuration`
`protected String`	`contentPack`
`protected org.joda.time.DateTime`	`createdAt`
`protected String`	`creatorUserId`
`protected IOState.Type`	`desiredState`
`static String`	`FIELD_ATTRIBUTES`
`static String`	`FIELD_CONFIGURATION`
`static String`	`FIELD_CONTENT_PACK`
`static String`	`FIELD_CREATED_AT`
`static String`	`FIELD_CREATOR_USER_ID`
`static String`	`FIELD_DESIRED_STATE`
`static String`	`FIELD_GLOBAL`
`static String`	`FIELD_ID`
`static String`	`FIELD_NAME`
`static String`	`FIELD_NODE_ID`
`static String`	`FIELD_STARTED_AT`
`static String`	`FIELD_STATIC_FIELDS`
`static String`	`FIELD_TITLE`
`static String`	`FIELD_TYPE`
`protected Boolean`	`global`
`protected InputBuffer`	`inputBuffer`
`protected String`	`persistId`
`protected String`	`title`

Constructor Summary

Constructors
Constructor and Description
`MessageInput(com.codahale.metrics.MetricRegistry metricRegistry, Configuration configuration, Transport transport, LocalMetricRegistry localRegistry, Codec codec, MessageInput.Config config, MessageInput.Descriptor descriptor, ServerStatus serverStatus)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addStaticField(String key, String value)`
`void`	`addStaticFields(Map<String,String> staticFields)`
`Map<String,Object>`	`asMap()`
`Map<String,Object>`	`asMapMasked()`
`void`	`checkConfiguration()`
`boolean`	`equals(Object obj)`
`Map<String,Object>`	`getAttributesWithMaskedPasswords()` Deprecated.
`Codec`	`getCodec()`
`Configuration`	`getConfiguration()`
`String`	`getContentPack()`
`org.joda.time.DateTime`	`getCreatedAt()`
`String`	`getCreatorUserId()`
`static int`	`getDefaultRecvBufferSize()`
`MessageInput.Descriptor`	`getDescriptor()`
`IOState.Type`	`getDesiredState()`
`String`	`getId()`
`String`	`getName()`
`String`	`getNodeId()`
`String`	`getPersistId()`
`ConfigurationRequest`	`getRequestedConfiguration()`
`Map<String,String>`	`getStaticFields()`
`String`	`getTitle()`
`String`	`getType()`
`String`	`getUniqueReadableId()`
`int`	`hashCode()`
`void`	`initialize()`
`boolean`	`isExclusive()`
`Boolean`	`isGlobal()`
`void`	`launch(InputBuffer buffer)`
`boolean`	`onlyOnePerCluster()` Determines if Graylog should only launch a single instance of this input at a time in the cluster.
`void`	`processRawMessage(RawMessage rawMessage)`
`void`	`setContentPack(String contentPack)`
`void`	`setCreatedAt(org.joda.time.DateTime createdAt)`
`void`	`setCreatorUserId(String creatorUserId)`
`static void`	`setDefaultRecvBufferSize(int size)`
`void`	`setDesiredState(IOState.Type newDesiredState)`
`void`	`setGlobal(Boolean global)`
`void`	`setNodeId(String nodeId)`
`void`	`setPersistId(String id)`
`void`	`setTitle(String title)`
`void`	`stop()`
`void`	`terminate()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FIELD_ID
```
public static final String FIELD_ID
```
See Also:

Constant Field Values

FIELD_TYPE
```
public static final String FIELD_TYPE
```
See Also:

Constant Field Values

FIELD_NODE_ID

public static final String FIELD_NODE_ID

See Also:: Constant Field Values

FIELD_NAME
```
public static final String FIELD_NAME
```
See Also:

Constant Field Values

FIELD_TITLE
```
public static final String FIELD_TITLE
```
See Also:

Constant Field Values

FIELD_CONFIGURATION

public static final String FIELD_CONFIGURATION

See Also:: Constant Field Values

FIELD_CREATOR_USER_ID

public static final String FIELD_CREATOR_USER_ID

See Also:: Constant Field Values

FIELD_CREATED_AT

public static final String FIELD_CREATED_AT

See Also:: Constant Field Values

FIELD_STARTED_AT

public static final String FIELD_STARTED_AT

See Also:: Constant Field Values

FIELD_ATTRIBUTES

public static final String FIELD_ATTRIBUTES

See Also:: Constant Field Values

FIELD_STATIC_FIELDS

public static final String FIELD_STATIC_FIELDS

See Also:: Constant Field Values

FIELD_GLOBAL

public static final String FIELD_GLOBAL

See Also:: Constant Field Values

FIELD_DESIRED_STATE

public static final String FIELD_DESIRED_STATE

See Also:: Constant Field Values

FIELD_CONTENT_PACK

public static final String FIELD_CONTENT_PACK

See Also:: Constant Field Values

title
```
protected String title
```

creatorUserId
```
protected String creatorUserId
```

persistId
```
protected String persistId
```

createdAt

protected org.joda.time.DateTime createdAt

global
```
protected Boolean global
```

desiredState
```
protected IOState.Type desiredState
```

contentPack
```
protected String contentPack
```

configuration

protected final Configuration configuration

inputBuffer
```
protected InputBuffer inputBuffer
```

Constructor Detail

MessageInput

public MessageInput(com.codahale.metrics.MetricRegistry metricRegistry,
                    Configuration configuration,
                    Transport transport,
                    LocalMetricRegistry localRegistry,
                    Codec codec,
                    MessageInput.Config config,
                    MessageInput.Descriptor descriptor,
                    ServerStatus serverStatus)

Method Detail

getDefaultRecvBufferSize

public static int getDefaultRecvBufferSize()

setDefaultRecvBufferSize

public static void setDefaultRecvBufferSize(int size)

initialize
```
public void initialize()
```

checkConfiguration

public void checkConfiguration()
                        throws ConfigurationException

Throws:: ConfigurationException

launch

public void launch(InputBuffer buffer)
            throws MisfireException

Throws:: MisfireException

stop
```
public void stop()
```
Specified by:

stop in interface Stoppable

terminate
```
public void terminate()
```

getRequestedConfiguration

public ConfigurationRequest getRequestedConfiguration()

getDescriptor

public MessageInput.Descriptor getDescriptor()

getName
```
public String getName()
```

isExclusive
```
public boolean isExclusive()
```

getId
```
public String getId()
```

getPersistId
```
public String getPersistId()
```

setPersistId
```
public void setPersistId(String id)
```

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

getCreatorUserId
```
public String getCreatorUserId()
```

setCreatorUserId

public void setCreatorUserId(String creatorUserId)

getCreatedAt

public org.joda.time.DateTime getCreatedAt()

setCreatedAt

public void setCreatedAt(org.joda.time.DateTime createdAt)

getConfiguration

public Configuration getConfiguration()

isGlobal
```
public Boolean isGlobal()
```

onlyOnePerCluster
```
public boolean onlyOnePerCluster()
```
Determines if Graylog should only launch a single instance of this input at a time in the cluster.
This might be useful for an input which polls data from an external source and maintains local state, i.e. a cursor, to determine records have been fetched already. In that case, running a second instance of the input at the same time on a different node in the cluster might then lead to the same data fetched again, which would produce duplicate log messages in Graylog.
Returning true from this method will only really make sense if the input also isGlobal.

Returns:

true if only a single instance of the input should be launched in the cluster. It will be launched on the leader node.
false otherwise

setGlobal

public void setGlobal(Boolean global)

getDesiredState
```
public IOState.Type getDesiredState()
```

setDesiredState

public void setDesiredState(IOState.Type newDesiredState)

getContentPack
```
public String getContentPack()
```

setContentPack

public void setContentPack(String contentPack)

getAttributesWithMaskedPasswords

@Deprecated
public Map<String,Object> getAttributesWithMaskedPasswords()

Deprecated.

asMapMasked

public Map<String,Object> asMapMasked()

asMap
```
public Map<String,Object> asMap()
```

addStaticField

public void addStaticField(String key,
                           String value)

addStaticFields

public void addStaticFields(Map<String,String> staticFields)

getStaticFields

public Map<String,String> getStaticFields()

getUniqueReadableId
```
public String getUniqueReadableId()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

getCodec
```
public Codec getCodec()
```

processRawMessage

public void processRawMessage(RawMessage rawMessage)

getType
```
public String getType()
```

getNodeId
```
public String getNodeId()
```

setNodeId
```
public void setNodeId(String nodeId)
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class MessageInput

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIELD_ID

FIELD_TYPE

FIELD_NODE_ID

FIELD_NAME

FIELD_TITLE

FIELD_CONFIGURATION

FIELD_CREATOR_USER_ID

FIELD_CREATED_AT

FIELD_STARTED_AT

FIELD_ATTRIBUTES

FIELD_STATIC_FIELDS

FIELD_GLOBAL

FIELD_DESIRED_STATE

FIELD_CONTENT_PACK

title

creatorUserId

persistId

createdAt

global

desiredState

contentPack

configuration

inputBuffer

Constructor Detail

MessageInput

Method Detail

getDefaultRecvBufferSize

setDefaultRecvBufferSize

initialize

checkConfiguration

launch

stop

terminate

getRequestedConfiguration

getDescriptor

getName

isExclusive

getId

getPersistId

setPersistId

getTitle

setTitle

getCreatorUserId

setCreatorUserId

getCreatedAt

setCreatedAt

getConfiguration

isGlobal

onlyOnePerCluster

setGlobal

getDesiredState

setDesiredState

getContentPack

setContentPack

getAttributesWithMaskedPasswords

asMapMasked

asMap

addStaticField

addStaticFields

getStaticFields

getUniqueReadableId

hashCode

equals

getCodec

processRawMessage

getType

getNodeId

setNodeId

toString