com.aquenos.cassandra.pvarchiver.server.archiving

Class RenameChannelCommand

java.lang.Object

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

com.aquenos.cassandra.pvarchiver.server.archiving.RenameChannelCommand

public final class RenameChannelCommand
extends ArchiveConfigurationCommand

Command for renaming 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
RenameChannelCommand(UUID expectedServerId, String newChannelName, String oldChannelName) Creates a "rename channel" command.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
String	getNewChannelName() Returns the new name for the channel to be renamed.
String	getOldChannelName() Returns the old name of the channel to be renamed.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameChannelCommand

public RenameChannelCommand(UUID expectedServerId,
                            String newChannelName,
                            String oldChannelName)

Creates a "rename 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:

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

newChannelName - name under which the channel shall be known after the rename operation finishes.

oldChannelName - name under which the channel is currently known.

Throws:

IllegalArgumentException - if newChannelName or oldChannelName is empty.

NullPointerException - if newChannelName or oldChannelName 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.

getExpectedServerId

public UUID getExpectedServerId()

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

getNewChannelName

public String getNewChannelName()

Returns the new name for the channel to be renamed. After the rename operation finishes successfully, the channel will be known under that name. The value returned is never null or the empty string.

Returns:

new name for the channel.

getOldChannelName

public String getOldChannelName()

Returns the old name of the channel to be renamed. After the rename operation finishes successfully, the channel will not be known under that name any longer. The value returned is never null or the empty string.

Returns:

old name of 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