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

Class InMemoryStreamAdmin

java.lang.Object

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

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

All Implemented Interfaces:

QueueAdmin, StreamAdmin

public class InMemoryStreamAdmin
extends InMemoryQueueAdmin
implements StreamAdmin

admin for queues in memory.

Field Summary

Fields inherited from class co.cask.cdap.data2.transaction.queue.inmemory.InMemoryQueueAdmin

queueService

Constructor Summary

Constructors

Constructor and Description
InMemoryStreamAdmin(InMemoryQueueService queueService, UsageRegistry usageRegistry, LineageWriter lineageWriter, StreamMetaStore streamMetaStore, MetadataStore metadataStore, ViewAdmin viewAdmin)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAccess(Id.Run run, Id.Stream streamId, AccessType accessType) Record access of stream by a program run for lineage computation.
void	configureGroups(Id.Stream streamId, Map<Long,Integer> groupInfo) Sets the consumer groups information for the given stream.
void	configureInstances(Id.Stream streamId, long groupId, int instances) Sets the number of consumer instances for the given consumer group in a stream.
StreamConfig	create(Id.Stream streamId) Creates stream if doesn't exist.
StreamConfig	create(Id.Stream streamId, Properties props) Creates stream if doesn't exist.
boolean	createOrUpdateView(Id.Stream.View viewId, ViewSpecification spec) Creates or updates a stream view.
void	deleteView(Id.Stream.View viewId) Deletes a stream view.
void	drop(Id.Stream streamId) Deletes stream from the system completely.
void	dropAllInNamespace(Id.Namespace namespace) Deletes all queues in a namespace
boolean	exists(Id.Stream streamId)
StreamConfig	getConfig(Id.Stream streamId) Returns the configuration of the given stream.
ViewSpecification	getView(Id.Stream.View viewId) Gets the details of a stream view.
List<Id.Stream.View>	listViews(Id.Stream streamId) Lists views associated with a stream.
void	register(Iterable<? extends Id> owners, Id.Stream streamId) Register stream used by program.
void	truncate(Id.Stream streamId) Wipes out stream data.
void	updateConfig(Id.Stream streamId, StreamProperties properties) Overwrites existing configuration for the given stream.
boolean	viewExists(Id.Stream.View viewId) Checks if the view exists

Methods inherited from class co.cask.cdap.data2.transaction.queue.inmemory.InMemoryQueueAdmin

clearAllForFlow, create, create, dropAllForFlow, exists, getQueueConfigurer, truncate, upgrade

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.cask.cdap.data2.transaction.stream.StreamAdmin

upgrade

Constructor Detail

InMemoryStreamAdmin

@Inject
public InMemoryStreamAdmin(InMemoryQueueService queueService,
                          UsageRegistry usageRegistry,
                          LineageWriter lineageWriter,
                          StreamMetaStore streamMetaStore,
                          MetadataStore metadataStore,
                          ViewAdmin viewAdmin)

Method Detail

dropAllInNamespace

public void dropAllInNamespace(Id.Namespace namespace)
                        throws Exception

Description copied from interface: QueueAdmin

Deletes all queues in a namespace

Specified by:

dropAllInNamespace in interface QueueAdmin

Specified by:

dropAllInNamespace in interface StreamAdmin

Overrides:

dropAllInNamespace in class InMemoryQueueAdmin

Parameters:

namespace - the namespace to delete flows in

Throws:

Exception

configureInstances

public void configureInstances(Id.Stream streamId,
                      long groupId,
                      int instances)
                        throws Exception

Description copied from interface: StreamAdmin

Sets the number of consumer instances for the given consumer group in a stream.

Specified by:

configureInstances in interface StreamAdmin

Parameters:

streamId - Id of the stream.

groupId - The consumer group to alter.

instances - Number of instances.

Throws:

Exception

configureGroups

public void configureGroups(Id.Stream streamId,
                   Map<Long,Integer> groupInfo)
                     throws Exception

Description copied from interface: StreamAdmin

Sets the consumer groups information for the given stream.

Specified by:

configureGroups in interface StreamAdmin

Parameters:

streamId - Id of the stream.

groupInfo - A map from groupId to number of instances of each group.

Throws:

Exception

getConfig

public StreamConfig getConfig(Id.Stream streamId)

Description copied from interface: StreamAdmin

Returns the configuration of the given stream.

Specified by:

getConfig in interface StreamAdmin

Parameters:

streamId - Id of the stream.

Returns:

A StreamConfig instance.

updateConfig

public void updateConfig(Id.Stream streamId,
                StreamProperties properties)
                  throws IOException

Description copied from interface: StreamAdmin

Overwrites existing configuration for the given stream.

Specified by:

updateConfig in interface StreamAdmin

Parameters:

streamId - Id of the stream whose properties are being updated

properties - New configuration of the stream.

Throws:

IOException

exists

public boolean exists(Id.Stream streamId)
               throws Exception

Specified by:

exists in interface StreamAdmin

Parameters:

streamId - Id of the stream.

Returns:

true if stream with given Id exists, otherwise false

Throws:

Exception - if check fails

create

public StreamConfig create(Id.Stream streamId)
                    throws Exception

Description copied from interface: StreamAdmin

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

Specified by:

create in interface StreamAdmin

Parameters:

streamId - Id of the stream to create

Returns:

The StreamConfig associated with the new stream

Throws:

Exception - if creation fails

create

public StreamConfig create(Id.Stream streamId,
                  @Nullable
                  Properties props)
                    throws Exception

Description copied from interface: StreamAdmin

Creates stream if doesn't exist. If stream exists, does nothing.

Specified by:

create in interface StreamAdmin

Parameters:

streamId - Id of the stream to create

props - additional properties

Returns:

The StreamConfig associated with the new stream

Throws:

Exception - if creation fails

truncate

public void truncate(Id.Stream streamId)
              throws Exception

Description copied from interface: StreamAdmin

Wipes out stream data.

Specified by:

truncate in interface StreamAdmin

Parameters:

streamId - Id of the stream to truncate

Throws:

Exception - if cleanup fails

drop

public void drop(Id.Stream streamId)
          throws Exception

Description copied from interface: StreamAdmin

Deletes stream from the system completely.

Specified by:

drop in interface StreamAdmin

Parameters:

streamId - Id of the stream to delete

Throws:

Exception - if deletion fails

createOrUpdateView

public boolean createOrUpdateView(Id.Stream.View viewId,
                         ViewSpecification spec)
                           throws Exception

Description copied from interface: StreamAdmin

Creates or updates a stream view.

Specified by:

createOrUpdateView in interface StreamAdmin

Parameters:

viewId - the view

spec - specification for the view

Returns:

true if a stream view was created

Throws:

Exception

deleteView

public void deleteView(Id.Stream.View viewId)
                throws Exception

Description copied from interface: StreamAdmin

Deletes a stream view.

Specified by:

deleteView in interface StreamAdmin

Parameters:

viewId - the view

Throws:

Exception

listViews

public List<Id.Stream.View> listViews(Id.Stream streamId)
                               throws Exception

Description copied from interface: StreamAdmin

Lists views associated with a stream.

Specified by:

listViews in interface StreamAdmin

Parameters:

streamId - the stream

Returns:

the associated views

Throws:

Exception

getView

public ViewSpecification getView(Id.Stream.View viewId)
                          throws Exception

Description copied from interface: StreamAdmin

Gets the details of a stream view.

Specified by:

getView in interface StreamAdmin

Parameters:

viewId - the view

Returns:

the details of the view

Throws:

Exception

viewExists

public boolean viewExists(Id.Stream.View viewId)
                   throws Exception

Description copied from interface: StreamAdmin

Checks if the view exists

Specified by:

viewExists in interface StreamAdmin

Parameters:

viewId - the view

Returns:

boolean which is true if view exists else false

Throws:

Exception

register

public void register(Iterable<? extends Id> owners,
            Id.Stream streamId)

Description copied from interface: StreamAdmin

Register stream used by program.

Specified by:

register in interface StreamAdmin

Parameters:

owners - the ids that are using the stream

streamId - the stream being used

addAccess

public void addAccess(Id.Run run,
             Id.Stream streamId,
             AccessType accessType)

Description copied from interface: StreamAdmin

Record access of stream by a program run for lineage computation.

Specified by:

addAccess in interface StreamAdmin

Parameters:

run - program run

streamId - stream being accessed

accessType - type of access