org.graylog2.plugin.inputs.codecs.AbstractCodec 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.graylog2.plugin.inputs.codecs;
import org.graylog2.plugin.configuration.Configuration;
import org.graylog2.plugin.configuration.ConfigurationRequest;
import org.graylog2.plugin.configuration.fields.ConfigurationField;
import org.graylog2.plugin.configuration.fields.TextField;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
public abstract class AbstractCodec implements Codec {
private static final Logger log = LoggerFactory.getLogger(AbstractCodec.class);
protected final Configuration configuration;
private String name;
protected AbstractCodec(Configuration configuration) {
this.configuration = configuration;
}
@Override
@Nonnull
public Configuration getConfiguration() {
return configuration;
}
@Override
public String getName() {
// can be a race condition, but we don't care the outcome is always the same
if (name == null) {
if (this.getClass().isAnnotationPresent(org.graylog2.plugin.inputs.annotations.Codec.class)) {
name = this.getClass().getAnnotation(org.graylog2.plugin.inputs.annotations.Codec.class).name();
} else {
log.error("Annotation {} missing on codec {}. This is a bug and this codec will not be available.",
org.graylog2.plugin.inputs.annotations.Codec.class, this.getClass());
}
}
return name;
}
@Nullable
@Override
public CodecAggregator getAggregator() {
return null;
}
public abstract static class Config implements Codec.Config {
@Override
public ConfigurationRequest getRequestedConfiguration() {
final ConfigurationRequest configurationRequest = new ConfigurationRequest();
// TODO implement universal override (in raw message maybe?)
configurationRequest.addField(new TextField(
CK_OVERRIDE_SOURCE,
"Override source",
null,
"The source is a hostname derived from the received packet by default. Set this if you want to override " +
"it with a custom string.",
ConfigurationField.Optional.OPTIONAL
));
return configurationRequest;
}
@Override
public void overrideDefaultValues(@Nonnull ConfigurationRequest cr) {
}
}
public static class Descriptor extends Codec.Descriptor {
public Descriptor(String name) {
super(name);
}
}
}