co.cask.cdap.store

Interface NamespaceStore

All Known Implementing Classes:

DefaultNamespaceStore, InMemoryNamespaceStore

public interface NamespaceStore

Store for namespaces.

Method Summary

Methods

Modifier and Type	Method and Description
NamespaceMeta	create(NamespaceMeta metadata) Creates a new namespace.
NamespaceMeta	delete(Id.Namespace id) Deletes a namespace from the namespace metadata store.
NamespaceMeta	get(Id.Namespace id) Retrieves a namespace from the namespace metadata store.
List<NamespaceMeta>	list() Lists all registered namespaces.
void	update(NamespaceMeta metadata) Updates the namespace meta.

Method Detail

create

@Nullable
NamespaceMeta create(NamespaceMeta metadata)

Creates a new namespace.

Parameters:

metadata - NamespaceMeta representing the namespace metadata

Returns:

existing NamespaceMeta if a namespace with the specified name existed already, null if the a namespace with the specified name did not exist, and was created successfully These semantics of return type are borrowed from ConcurrentHashMap.putIfAbsent(K, V)

update

void update(NamespaceMeta metadata)

Updates the namespace meta.

Parameters:

metadata - NamespaceMeta representing the namespace metadata

get

@Nullable
NamespaceMeta get(Id.Namespace id)

Retrieves a namespace from the namespace metadata store.

Parameters:

id - Id.Namespace of the requested namespace

Returns:

NamespaceMeta of the requested namespace

delete

@Nullable
NamespaceMeta delete(Id.Namespace id)

Deletes a namespace from the namespace metadata store.

Parameters:

id - Id.Namespace of the namespace to delete

Returns:

NamespaceMeta of the namespace if it was found and deleted, null if the specified namespace did not exist These semantics of return type are borrowed from ConcurrentHashMap.remove(java.lang.Object)

list

List<NamespaceMeta> list()

Lists all registered namespaces.

Returns:

a list of all registered namespaces