001/*
002 * (C) Copyright 2017 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Florent Guillaume
018 */
019package org.nuxeo.runtime.kv;
020
021import java.util.stream.Stream;
022
023/**
024 * Key/Value Store SPI.
025 *
026 * @since 9.1
027 */
028public interface KeyValueStoreProvider extends KeyValueStore {
029
030    /**
031     * Initializes this Key/Value store provider.
032     *
033     * @param descriptor the store provider descriptor
034     */
035    void initialize(KeyValueStoreDescriptor descriptor);
036
037    /**
038     * Returns a {@link Stream} of the keys contained in this Key/Value store provider.
039     * <p>
040     * This operation may be slow and should only be used for management or debug purposes.
041     *
042     * @return the stream of keys
043     * @since 9.3
044     */
045    Stream<String> keyStream();
046
047    /**
048     * Returns a {@link Stream} of the keys with the given prefix contained in this Key/Value store provider.
049     * <p>
050     * This operation may be slow and should only be used for management or debug purposes.
051     *
052     * @return the stream of keys
053     * @since 10.3
054     */
055    Stream<String> keyStream(String prefix);
056
057    /**
058     * Closes this Key/Value store provider.
059     */
060    void close();
061
062    /**
063     * Clears the content of this Key/Value store provider.
064     */
065    void clear();
066
067}