io.fabric8.kubernetes.client.informers.SharedInformerFactory Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2015 Red Hat, Inc.
 *
 * Licensed 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 io.fabric8.kubernetes.client.informers;

import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.client.dsl.Informable;

import java.util.concurrent.Future;

public interface SharedInformerFactory {

  /**
   * Configure Namespace for {@link SharedInformerFactory}
   *
   * @param namespace namespace to configure
   * @return {@link SharedInformerFactory} with namespace configured
   * @deprecated use {@link Informable} instead
   */
  @Deprecated
  SharedInformerFactory inNamespace(String namespace);

  /**
   * Configure Name for {@link SharedInformerFactory}
   *
   * @param name name to be configured
   * @return {@link SharedInformerFactory} with name configured
   * @deprecated use {@link Informable} instead
   */
  @Deprecated
  SharedInformerFactory withName(String name);

  /**
   * Constructs and returns a shared index informer with resync period specified. And the
   * informer cache will be overwritten.
   *
   * Note:It watches for events in ALL NAMESPACES.
   *
   * @param apiTypeClass apiType class
   * @param resyncPeriodInMillis resync period in milliseconds
   * @param  the type parameter (should extend {@link io.fabric8.kubernetes.api.model.HasMetadata} and implement
   *        {@link io.fabric8.kubernetes.api.model.Namespaced}) if Namespace scoped resource
   * @return the shared index informer
   */
   SharedIndexInformer sharedIndexInformerFor(Class apiTypeClass,
      long resyncPeriodInMillis);

  /**
   * Gets existing shared index informer, return null if the requesting informer
   * is never constructed. If there are multiple SharedIndexInformer objects corresponding
   * to a Kubernetes resource, then it returns the first one
   *
   * @param apiTypeClass API type class
   * @param  type of API type
   * @return SharedIndexInformer object
   */
   SharedIndexInformer getExistingSharedIndexInformer(Class apiTypeClass);

  /**
   * Starts all registered informers in an asynchronous fashion.
   *
   * @return {@link Future} for status of all started informer tasks.
   */
  Future startAllRegisteredInformers();

  /**
   * Stop all registered informers and shut down thread pool.
   */
  void stopAllRegisteredInformers();

  /**
   * @deprecated use {@link SharedIndexInformer#stopped()} method to get notified when an informer stops.
   */
  @Deprecated
  void addSharedInformerEventListener(SharedInformerEventListener event);

}