co.cask.cdap.data2.transaction.queue

Interface QueueAdmin

All Known Implementing Classes:

AbstractQueueAdmin, HBaseQueueAdmin, InMemoryQueueAdmin, InMemoryStreamAdmin, LevelDBQueueAdmin

public interface QueueAdmin

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAllForFlow(Id.Flow flowId) Clears all queues for a flow, for example if the flow is upgraded and old.
void	create(QueueName queueName) Creates queue if doesn't exist.
void	create(QueueName queueName, Properties props) Creates queue if doesn't exist.
void	dropAllForFlow(Id.Flow flowId) Deletes all queues for a flow, for example if the flow is deleted.
void	dropAllInNamespace(Id.Namespace namespaceId) Deletes all queues in a namespace
boolean	exists(QueueName queueName)
QueueConfigurer	getQueueConfigurer(QueueName queueName) Returns a QueueConfigurer for configuring the queue.
void	truncate(QueueName queueName) Wipes out queue data.
void	upgrade() Performs upgrade action for all queues.

Method Detail

dropAllInNamespace

void dropAllInNamespace(Id.Namespace namespaceId)
                        throws Exception

Deletes all queues in a namespace

Parameters:

namespaceId - the namespace to delete flows in

Throws:

Exception

dropAllForFlow

void dropAllForFlow(Id.Flow flowId)
                    throws Exception

Deletes all queues for a flow, for example if the flow is deleted. todo: make this independent of the concept of a flow

Throws:

Exception

clearAllForFlow

void clearAllForFlow(Id.Flow flowId)
                     throws Exception

Clears all queues for a flow, for example if the flow is upgraded and old. todo: make this independent of the concept of a flow

Throws:

Exception

getQueueConfigurer

QueueConfigurer getQueueConfigurer(QueueName queueName)
                                   throws Exception

Returns a QueueConfigurer for configuring the queue.

Throws:

Exception

upgrade

void upgrade()
             throws Exception

Performs upgrade action for all queues.

Throws:

Exception

exists

boolean exists(QueueName queueName)
               throws Exception

Parameters:

queueName - Name of the queue

Returns:

true if queue with given name exists, otherwise false

Throws:

Exception - if check fails

create

void create(QueueName queueName)
            throws Exception

Creates queue if doesn't exist. If queue exists does nothing.

Parameters:

queueName - Name of the queue

Throws:

Exception - if creation fails

create

void create(QueueName queueName,
          @Nullable
          Properties props)
            throws Exception

Creates queue if doesn't exist. If queue exists does nothing.

Parameters:

queueName - Name of the queue

props - additional properties

Throws:

Exception - if creation fails

truncate

void truncate(QueueName queueName)
              throws Exception

Wipes out queue data.

Parameters:

queueName - Name of the queue

Throws:

Exception - if cleanup fails