content: /*
   * 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.processor.internals;
  
  import org.apache.kafka.streams.StreamsConfig;
  import org.apache.kafka.streams.TopologyConfig;
  import org.apache.kafka.streams.processor.StateStore;
  import org.apache.kafka.streams.state.StoreBuilder;
  
  import java.util.Map;
  import java.util.Set;
  
  /**
   * What! Another mechanism for obtaining a {@link StateStore}? This isn't just
   * an abuse of Java-isms... there's good reason for it. Here's how they are
   * interconnected:
   *
   * <ul>
   *     <li>{@link org.apache.kafka.streams.state.StoreBuilder} is the innermost
   *     layer to provide state stores and is used directly by the PAPI.</li>
   *
   *     <li>{@link org.apache.kafka.streams.state.StoreSupplier} is used by the
   *     DSL to provide preconfigured state stores as well as type-safe stores
   *     (e.g. {@link org.apache.kafka.streams.state.KeyValueBytesStoreSupplier}.</li>
   *
   *     <li>{@link StoreFactory} (this class) is internal and not exposed to
   *     the users. It allows the above store specifications to be wrapped in
   *     an internal interface that can then be configured <i>after</i> the
   *     creation of the Topology but before the stores themselves are created.
   *     This allows Kafka Streams to respect configurations such as
   *     {@link StreamsConfig#DEFAULT_DSL_STORE_CONFIG} even if it isn't passed
   *     to {@link org.apache.kafka.streams.StreamsBuilder#StreamsBuilder(TopologyConfig)}</li>
   * </ul>
   */
  public interface StoreFactory extends ConfigurableStore {
  
      StoreBuilder<?> builder();
  
      long retentionPeriod();
  
      long historyRetention();
  
      Set<String> connectedProcessorNames();
  
      boolean loggingEnabled();
  
      String storeName();
  
      boolean isWindowStore();
  
      boolean isVersionedStore();
  
      Map<String, String> logConfig();
  
      StoreFactory withCachingDisabled();
  
      StoreFactory withLoggingDisabled();
  
      boolean isCompatibleWith(StoreFactory storeFactory);
  
      class FactoryWrappingStoreBuilder<T extends StateStore> implements StoreBuilder<T>, ConfigurableStore {
  
          private final StoreFactory storeFactory;
  
          public FactoryWrappingStoreBuilder(final StoreFactory storeFactory) {
              this.storeFactory = storeFactory;
          }
  
          public StoreFactory storeFactory() {
              return storeFactory;
          }
  
          public void configure(final StreamsConfig config) {
              storeFactory.configure(config);
          }
  
          @Override
          public boolean equals(final Object o) {
              if (this == o) {
                  return true;
              }
              if (o == null || getClass() != o.getClass()) {
                  return false;
              }
  
              final FactoryWrappingStoreBuilder<?> that = (FactoryWrappingStoreBuilder<?>) o;
  
              return storeFactory.isCompatibleWith(that.storeFactory);
          }
  
          @Override
          public int hashCode() {
              return storeFactory.hashCode();
          }
  
          @Override
          public StoreBuilder<T> withCachingEnabled() {
              throw new IllegalStateException("Should not try to modify StoreBuilder wrapper");
          }
  
          @Override
          public StoreBuilder<T> withCachingDisabled() {
              storeFactory.withCachingDisabled();
              return this;
          }
  
          @Override
          public StoreBuilder<T> withLoggingEnabled(final Map<String, String> config) {
              throw new IllegalStateException("Should not try to modify StoreBuilder wrapper");
          }
  
          @Override
          public StoreBuilder<T> withLoggingDisabled() {
              storeFactory.withLoggingDisabled();
              return this;
          }
  
          @SuppressWarnings("unchecked")
          @Override
          public T build() {
              return (T) storeFactory.builder().build();
          }
  
          @Override
          public Map<String, String> logConfig() {
              return storeFactory.logConfig();
          }
  
          @Override
          public boolean loggingEnabled() {
              return storeFactory.loggingEnabled();
          }
  
          @Override
          public String name() {
              return storeFactory.storeName();
          }
      }
  
  }
  