org.graylog2.plugin.inputs.codecs.Codec 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.AbstractDescriptor;
import org.graylog2.plugin.Message;
import org.graylog2.plugin.configuration.Configuration;
import org.graylog2.plugin.configuration.ConfigurationRequest;
import org.graylog2.plugin.journal.RawMessage;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
public interface Codec {
@Nullable
Message decode(@Nonnull RawMessage rawMessage);
@Nullable
CodecAggregator getAggregator();
String getName();
@Nonnull
Configuration getConfiguration();
interface Factory {
C create(Configuration configuration);
Config getConfig();
Descriptor getDescriptor();
}
interface Config {
String CK_OVERRIDE_SOURCE = "override_source";
ConfigurationRequest getRequestedConfiguration();
void overrideDefaultValues(@Nonnull ConfigurationRequest cr);
}
class Descriptor extends AbstractDescriptor {
public Descriptor() {
// We ensure old Codec plugins remain compatible by setting an empty name in here
this("");
}
protected Descriptor(String name) {
super(name, false, "");
}
}
}