co.cask.cdap.data2.transaction.queue.inmemory

Class InMemoryQueueAdmin

java.lang.Object

co.cask.cdap.data2.transaction.queue.inmemory.InMemoryQueueAdmin

All Implemented Interfaces:

QueueAdmin

Direct Known Subclasses:

InMemoryStreamAdmin

public class InMemoryQueueAdmin
extends Object
implements QueueAdmin

admin for queues in memory.

Field Summary

Fields

Modifier and Type	Field and Description
protected InMemoryQueueService	queueService

Constructor Summary

Constructors

Constructor and Description
InMemoryQueueAdmin(InMemoryQueueService queueService)

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.

Methods inherited from class java.lang.Object

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

Field Detail

queueService

protected final InMemoryQueueService queueService

Constructor Detail

InMemoryQueueAdmin

@Inject
public InMemoryQueueAdmin(InMemoryQueueService queueService)

Method Detail

exists

public boolean exists(QueueName queueName)
               throws Exception

Specified by:

exists in interface QueueAdmin

Parameters:

queueName - Name of the queue

Returns:

true if queue with given name exists, otherwise false

Throws:

Exception - if check fails

create

public void create(QueueName queueName)
            throws Exception

Description copied from interface: QueueAdmin

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

Specified by:

create in interface QueueAdmin

Parameters:

queueName - Name of the queue

Throws:

Exception - if creation fails

create

public void create(QueueName queueName,
          Properties props)
            throws Exception

Description copied from interface: QueueAdmin

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

Specified by:

create in interface QueueAdmin

Parameters:

queueName - Name of the queue

props - additional properties

Throws:

Exception - if creation fails

truncate

public void truncate(QueueName queueName)
              throws Exception

Description copied from interface: QueueAdmin

Wipes out queue data.

Specified by:

truncate in interface QueueAdmin

Parameters:

queueName - Name of the queue

Throws:

Exception - if cleanup fails

clearAllForFlow

public void clearAllForFlow(Id.Flow flowId)
                     throws Exception

Description copied from interface: QueueAdmin

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

Specified by:

clearAllForFlow in interface QueueAdmin

Throws:

Exception

getQueueConfigurer

public QueueConfigurer getQueueConfigurer(QueueName queueName)

Description copied from interface: QueueAdmin

Returns a QueueConfigurer for configuring the queue.

Specified by:

getQueueConfigurer in interface QueueAdmin

dropAllInNamespace

public void dropAllInNamespace(Id.Namespace namespaceId)
                        throws Exception

Description copied from interface: QueueAdmin

Deletes all queues in a namespace

Specified by:

dropAllInNamespace in interface QueueAdmin

Parameters:

namespaceId - the namespace to delete flows in

Throws:

Exception

dropAllForFlow

public void dropAllForFlow(Id.Flow flowId)
                    throws Exception

Description copied from interface: QueueAdmin

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

Specified by:

dropAllForFlow in interface QueueAdmin

Throws:

Exception

upgrade

public void upgrade()
             throws Exception

Description copied from interface: QueueAdmin

Performs upgrade action for all queues.

Specified by:

upgrade in interface QueueAdmin

Throws:

Exception