-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
SharedInformerFactory.java
90 lines (78 loc) · 3.03 KB
/
SharedInformerFactory.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/**
* 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.
*
* <b>Note:</b>It watches for events in <b>ALL NAMESPACES</b>.
*
* @param apiTypeClass apiType class
* @param resyncPeriodInMillis resync period in milliseconds
* @param <T> 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
*/
<T extends HasMetadata> SharedIndexInformer<T> sharedIndexInformerFor(Class<T> 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 <T> type of API type
* @return SharedIndexInformer object
*/
<T> SharedIndexInformer<T> getExistingSharedIndexInformer(Class<T> apiTypeClass);
/**
* Starts all registered informers in an asynchronous fashion.
*
* @return {@link Future} for status of all started informer tasks.
*/
Future<Void> 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);
}