org.graylog.plugins.map.geoip.GeoIpResolver Maven / Gradle / Ivy

/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */

package org.graylog.plugins.map.geoip;

import com.codahale.metrics.Timer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.net.InetAddress;
import java.nio.file.Files;
import java.util.Optional;

public abstract class GeoIpResolver {

    private static final Logger LOG = LoggerFactory.getLogger(GeoIpResolver.class);

    protected String lastError = null;
    protected final Timer resolveTime;
    private final boolean enabled;

    GeoIpResolver(Timer resolveTime, String configPath, boolean enabled) {

        this.resolveTime = resolveTime;
        if (enabled) {
            final File configFile = new File(configPath);
            if (Files.exists(configFile.toPath())) {
                this.enabled = createDataProvider(configFile);
            } else {
                LOG.warn("'{}' database file does not exist: {}", getClass().getName(), configPath);
                this.enabled = false;
            }
        } else {
            this.enabled = false;
        }
    }

    public boolean isEnabled() {
        return enabled;
    }

    abstract boolean createDataProvider(File configFile);

    public Optional getGeoIpData(InetAddress address) {
        lastError = null;
        if (!enabled || address == null) {
            return Optional.empty();
        }
        return doGetGeoIpData(address);
    }

    /**
     * Get the last error, if any, produced after having called {@link #getGeoIpData(InetAddress)}.
     *
     * @return optional error message
     */
    public Optional getLastError() {
        return Optional.ofNullable(lastError);
    }

    protected abstract Optional doGetGeoIpData(InetAddress address);
}