com.aquenos.cassandra.pvarchiver.server.archiving

Class MoveChannelCommand

java.lang.Object

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

com.aquenos.cassandra.pvarchiver.server.archiving.MoveChannelCommand

public final class MoveChannelCommand
extends ArchiveConfigurationCommand

Command for moving a channel from one server to another one. This command object contains all data that is needed for the move 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
MoveChannelCommand(String channelName, UUID expectedOldServerId, UUID newServerId) Creates a "move 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 moved.
ArchiveConfigurationCommand.Type	getCommandType() Returns the type of the actual command type.
UUID	getExpectedOldServerId() Returns the ID of the server which is expected to currently own the channel.
UUID	getNewServerId() Returns the ID of the server to which the channel shall be moved.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MoveChannelCommand

public MoveChannelCommand(String channelName,
                          UUID expectedOldServerId,
                          UUID newServerId)

Creates a "move channel" command. If the specified expectedOldServerId 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 moved.

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

newServerId - ID of the server to which the channel shall be moved.

Throws:

IllegalArgumentException - if channelName is empty.

NullPointerException - if channelName or newServerId 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 moved. The value returned is never null or the empty string.

Returns:

name of the channel to be moved.

getNewServerId

public UUID getNewServerId()

Returns the ID of the server to which the channel shall be moved. The value returned is never null.

Returns:

ID of the server to which the channel shall be moved.

getExpectedOldServerId

public UUID getExpectedOldServerId()

Returns the ID of the server which is expected to currently own the channel. If null the channel will be moved to the new server regardless of which server currently owns the channel. If not null, the move 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 moved 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