com.aquenos.cassandra.pvarchiver.server.archiving

Class RemoveChannelCommand

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.archiving.ArchiveConfigurationCommand

com.aquenos.cassandra.pvarchiver.server.archiving.RemoveChannelCommand

public final class RemoveChannelCommand
extends ArchiveConfigurationCommand

Command for removing a channel. This command object contains all data that is needed for the remove operation. Typically, it is passed to the ArchiveConfigurationService, but it might also be sent over the network before actually being processed.

Author:

Sebastian Marsching

Nested Class Summary

Nested classes/interfaces inherited from class com.aquenos.cassandra.pvarchiver.server.archiving.ArchiveConfigurationCommand

ArchiveConfigurationCommand.Type

Constructor Summary

Constructors

Constructor and Description
RemoveChannelCommand(String channelName, UUID expectedServerId) Creates a "remove channel" command.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getChannelName() Returns the name of the channel that shall be removed.
ArchiveConfigurationCommand.Type	getCommandType() Returns the type of the actual command type.
UUID	getExpectedServerId() Returns the ID of the server which is expected to currently own the channel.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoveChannelCommand

public RemoveChannelCommand(String channelName,
                            UUID expectedServerId)

Creates a "remove channel" command. If the specified expectedServerId does not match the actual ID of the server that currently owns the channel, the operation will fail.

Parameters:

channelName - name of the channel to be removed.

expectedServerId - if not null, the channel is only removed if it is currently registered with the specified server.

Throws:

IllegalArgumentException - if channelName is empty.

NullPointerException - if channelName is null.

Method Detail

getCommandType

public ArchiveConfigurationCommand.Type getCommandType()

Description copied from class: ArchiveConfigurationCommand

Returns the type of the actual command type. Please refer to the document in the ArchiveConfigurationCommand class or the ArchiveConfigurationCommand.Type enum for a list of types. The return value is never null .

Specified by:

getCommandType in class ArchiveConfigurationCommand

Returns:

type of this command.

getChannelName

public String getChannelName()

Returns the name of the channel that shall be removed. The value returned is never null or the empty string.

Returns:

name of the channel to be removed.

getExpectedServerId

public UUID getExpectedServerId()

Returns the ID of the server which is expected to currently own the channel. If null the channel will be removed regardless of which server currently owns the channel. If not null, the remove operation will fail if the channel is currently registered with a different server than the specified one.

Returns:

ID of the server that is expected to currently own the channel or null if the channel should be removed regardless of the server that currently owns the channel.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object