org.graylog2.lookup.LookupTableConfigService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * 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.graylog2.lookup;

import org.graylog2.lookup.dto.CacheDto;
import org.graylog2.lookup.dto.DataAdapterDto;
import org.graylog2.lookup.dto.LookupTableDto;

import java.util.Collection;
import java.util.Optional;
import java.util.Set;

/**
 * Abstracts the configuration retrieval for {@link LookupTableService}.
 */
public interface LookupTableConfigService {
    /**
     * Returns the lookup table config for the given ID.
     *
     * @param id lookup table ID
     * @return Filled optional with the lookup table config or an empty optional if the lookup table doesn't exist
     */
    Optional getTable(String id);

    /**
     * Returns all existing lookup table config objects.
     *
     * @return collection of lookup table config objects
     */
    Collection loadAllTables();

    /**
     * Returns all lookup table config objets that use the given data adapter IDs.
     *
     * @param ids data adapter IDs
     * @return collection of lookup table config objects
     */
    Collection findTablesForDataAdapterIds(Set ids);

    /**
     * Returns all lookup table config objets that use the given cache IDs.
     *
     * @param ids cache IDs
     * @return collection of lookup table config objects
     */
    Collection findTablesForCacheIds(Set ids);

    /**
     * Returns all existing lookup data adapter config objects.
     *
     * @return collection of lookup data adapter config objects
     */
    Collection loadAllDataAdapters();

    /**
     * Returns all lookup data adapter config objects for the given IDs.
     *
     * @param ids data dapter IDs
     * @return collection of lookup data adapter config objects
     */
    Collection findDataAdaptersForIds(Set ids);

    /**
     * Returns all existing lookup cache config objects.
     *
     * @return collection of lookup cache config objects
     */
    Collection loadAllCaches();

    /**
     * Returns all lookup cache config objects for the given IDs.
     *
     * @param ids cache IDs
     * @return collection of lookup data adapter config objects
     */
    Collection findCachesForIds(Set ids);
}