org.apache.kafka.streams.state.QueryableStoreType Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.kafka.streams.state;
import org.apache.kafka.streams.KafkaStreams;
import org.apache.kafka.streams.processor.StateStore;
import org.apache.kafka.streams.state.internals.StateStoreProvider;
/**
* Used to enable querying of custom {@link StateStore} types via the {@link KafkaStreams} API.
*
* @param The store type
* @see QueryableStoreTypes
*/
public interface QueryableStoreType {
/**
* Called when searching for {@link StateStore}s to see if they
* match the type expected by implementors of this interface.
*
* @param stateStore The stateStore
* @return true if it is a match
*/
boolean accepts(final StateStore stateStore);
/**
* Create an instance of {@code T} (usually a facade) that developers can use
* to query the underlying {@link StateStore}s.
*
* @param storeProvider provides access to all the underlying StateStore instances
* @param storeName The name of the Store
* @return a read-only interface over a {@code StateStore}
* (cf. {@link QueryableStoreTypes.KeyValueStoreType})
*/
T create(final StateStoreProvider storeProvider,
final String storeName);
}