All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.graylog2.plugin.lookup.LookupCacheKey Maven / Gradle / Ivy

There is a newer version: 6.0.6
Show newest version
/*
 * 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.plugin.lookup;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.auto.value.AutoValue;

import javax.annotation.Nullable;

/**
 * This class is used as a key in {@link LookupCache} implementations.
 * 

* It combines the actual key object and a prefix value to allow the same key to be cached for different data adapters * without overwriting each other. *

* Using a {@link LookupCacheKey} with only a prefix might be used for operations like purging all cache keys for * the given prefix. *

* Examples: *

{@code
 * // Key with prefix and key
 * LookupCacheKey.create(dataAdapter.id(), "foo");
 *
 * // Key with prefix only
 * LookupCacheKey.prefix(dataAdapter.id());
 * }
*

* For convenience, this class can be serialized and deserialized with Jackson (see * {@link com.fasterxml.jackson.databind.ObjectMapper}, but we strongly recommend implementing your own * serialization and deserialization logic if you're implementing a lookup cache. *

* There are no guarantees about binary compatibility of this class across Graylog releases! */ @AutoValue public abstract class LookupCacheKey { @JsonProperty("prefix") public abstract String prefix(); @JsonProperty("key") @Nullable public abstract Object key(); @JsonCreator @SuppressWarnings("unused") public static LookupCacheKey createFromJSON(@JsonProperty("prefix") String prefix, @JsonProperty("key") @Nullable Object key) { return new AutoValue_LookupCacheKey(prefix, key); } public static LookupCacheKey create(LookupDataAdapter adapter, @Nullable Object key) { return new AutoValue_LookupCacheKey(adapter.id(), key); } public static LookupCacheKey prefix(LookupDataAdapter adapter) { return create(adapter, null); } /** * If the cache key instance does not have a key object, this returns true. *

* A cache key with only a prefix can be used to operate on all keys for the given prefix. (e.g. cache purge) * * @return true if there is no key object, false otherwise */ @JsonIgnore public boolean isPrefixOnly() { return key() == null; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy