Package io.fabric8.kubernetes.client.informers.impl.cache

Class CacheImpl<T extends HasMetadata>

java.lang.Object

io.fabric8.kubernetes.client.informers.impl.cache.CacheImpl<T>

Type Parameters:

T - type for cache object

All Implemented Interfaces:

Cache<T>, Indexer<T>, Store<T>

public class CacheImpl<T extends HasMetadata>
extends Object
implements Cache<T>

It basically saves and indexes all the entries.
Index reads byIndex(String, String), indexKeys(String, String), index(String, HasMetadata) are not globally locked and thus may not be fully consistent with the current state

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAMESPACE_INDEX

Constructor Summary

Constructors

Constructor	Description
CacheImpl()
CacheImpl(String indexName, Function<T,List<String>> indexFunc, Function<T,String> keyFunc)

Method Summary

Modifier and Type	Method	Description
void	addIndexers(Map<String,Function<T,List<String>>> indexersNew)
CacheImpl<T>	addIndexFunc(String indexName, Function<T,List<String>> indexFunc)	Add index func.
List<T>	byIndex(String indexName, String indexKey)	By index list
T	get(T obj)	Get object
T	getByKey(String key)	Gets get by key.
Map<String,Function<T,List<String>>>	getIndexers()	Returns the indexers registered with the cache.
String	getKey(T obj)	Get the key for the given object
Object	getLockObject()
List<T>	index(String indexName, T obj)	Get objects
List<String>	indexKeys(String indexName, String indexKey)	Index keys list
boolean	isFullState()
List<T>	list()	List all objects in the cache.
List<String>	listKeys()	List keys
static List<String>	metaNamespaceIndexFunc(Object obj)	It is a default index function that indexes based on an object's namespace
static String	metaNamespaceKeyFunc(Object obj)	It's is a convenient default KeyFunc which know show to make keys for API objects which implement HasMetadata interface.
static String	namespaceKeyFunc(String objectNamespace, String objectName)	Default index function that indexes based on an object's namespace and name.
T	put(T obj)	Update the object.
T	remove(T obj)	Delete the object.
void	removeIndexer(String name)
void	setItemStore(ItemStore<T> items)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAMESPACE_INDEX

public static final String NAMESPACE_INDEX

See Also:

Constant Field Values

Constructor Detail

CacheImpl

public CacheImpl()

CacheImpl

public CacheImpl(String indexName,
                 Function<T,List<String>> indexFunc,
                 Function<T,String> keyFunc)

Method Detail

setItemStore

public void setItemStore(ItemStore<T> items)

getIndexers

public Map<String,Function<T,List<String>>> getIndexers()

Returns the indexers registered with the cache.

Specified by:

getIndexers in interface Indexer<T extends HasMetadata>

Returns:

registered indexers

addIndexers

public void addIndexers(Map<String,Function<T,List<String>>> indexersNew)

Specified by:

addIndexers in interface Indexer<T extends HasMetadata>

put

public T put(T obj)

Update the object.

Parameters:

obj - the object

Returns:

the old object

remove

public T remove(T obj)

Delete the object.

Parameters:

obj - object

Returns:

the old object

listKeys

public List<String> listKeys()

List keys

Specified by:

listKeys in interface Store<T extends HasMetadata>

Returns:

the list of keys

get

public T get(T obj)

Get object

Specified by:

get in interface Store<T extends HasMetadata>

Parameters:

obj - the object

Returns:

the object

getKey

public String getKey(T obj)

Get the key for the given object

Specified by:

getKey in interface Store<T extends HasMetadata>

list

public List<T> list()

List all objects in the cache.

Specified by:

list in interface Store<T extends HasMetadata>

Returns:

the list

getByKey

public T getByKey(String key)

Gets get by key.

Specified by:

getByKey in interface Store<T extends HasMetadata>

Parameters:

key - specific key

Returns:

the get by key

index

public List<T> index(String indexName,
                     T obj)

Get objects

Specified by:

index in interface Indexer<T extends HasMetadata>

Parameters:

indexName - specific indexing function

obj - object

Returns:

the list

indexKeys

public List<String> indexKeys(String indexName,
                              String indexKey)

Index keys list

Specified by:

indexKeys in interface Indexer<T extends HasMetadata>

Parameters:

indexName - specific indexing function

indexKey - specific index key

Returns:

the list

byIndex

public List<T> byIndex(String indexName,
                       String indexKey)

By index list

Specified by:

byIndex in interface Indexer<T extends HasMetadata>

Parameters:

indexName - specific indexing function

indexKey - specific index key

Returns:

the list

addIndexFunc

public CacheImpl<T> addIndexFunc(String indexName,
                                 Function<T,List<String>> indexFunc)

Add index func.

Parameters:

indexName - the index name

indexFunc - the index func

metaNamespaceKeyFunc

public static String metaNamespaceKeyFunc(Object obj)

It's is a convenient default KeyFunc which know show to make keys for API objects which implement HasMetadata interface. The key uses the format namespace/name unless namespace is empty, then it's just name

Parameters:

obj - specific object

Returns:

the key

namespaceKeyFunc

public static String namespaceKeyFunc(String objectNamespace,
                                      String objectName)

Default index function that indexes based on an object's namespace and name.

See Also:

metaNamespaceKeyFunc(java.lang.Object)

metaNamespaceIndexFunc

public static List<String> metaNamespaceIndexFunc(Object obj)

It is a default index function that indexes based on an object's namespace

Parameters:

obj - the specific object

Returns:

the indexed value

removeIndexer

public void removeIndexer(String name)

Specified by:

removeIndexer in interface Indexer<T extends HasMetadata>

isFullState

public boolean isFullState()

getLockObject

public Object getLockObject()