io.cdap.cdap.api

Interface Admin

All Superinterfaces:

DatasetManager, MessagingAdmin, SecureStoreManager

@Beta
public interface Admin
extends DatasetManager, SecureStoreManager, MessagingAdmin

This interface provides methods for operational calls from within a CDAP application.

Method Summary

Modifier and Type	Method and Description
NamespaceSummary	getNamespaceSummary(String namespace) Get information about the specified namespace.
boolean	namespaceExists(String namespace) Return whether the specified namespace exists or not

Methods inherited from interface io.cdap.cdap.api.dataset.DatasetManager

createDataset, datasetExists, dropDataset, getDatasetProperties, getDatasetType, truncateDataset, updateDataset

Methods inherited from interface io.cdap.cdap.api.security.store.SecureStoreManager

delete, put

Methods inherited from interface io.cdap.cdap.api.messaging.MessagingAdmin

createTopic, createTopic, deleteTopic, getTopicProperties, updateTopic

Method Detail

namespaceExists

boolean namespaceExists(String namespace)
                 throws IOException

Return whether the specified namespace exists or not

Parameters:

namespace - the namespace to check

Returns:

true if the namespace exists, false if not

Throws:

IOException - if there was a error making the request to check namespace existence

getNamespaceSummary

@Nullable
NamespaceSummary getNamespaceSummary(String namespace)
                                        throws IOException

Get information about the specified namespace. Returns null if the namespace does not exist.

Parameters:

namespace - the namespace to get information about

Returns:

information about the namespace

Throws:

IOException - if there was a error making the request to get namespace information