com.aquenos.cassandra.pvarchiver.server.database

Class ChannelMetaDataDAO.ChannelOperation

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.database.ChannelMetaDataDAO.ChannelOperation

Enclosing interface:

ChannelMetaDataDAO

public static final class ChannelMetaDataDAO.ChannelOperation
extends Object

Value object representing an operation on a channel. Each operation is identified by a unique ID. The meaning of different operation types and the associated data is left to the code using the object.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
ChannelOperation(String channelName, String operationData, UUID operationId, String operationType, UUID serverId) Creates a channel operation object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getChannelName() Returns the name of the channel that is affected by this operation.
String	getOperationData() Returns the data associated with this operation.
UUID	getOperationId() Returns the unique ID identifying this operation.
String	getOperationType() Returns the textual identifier defining the type of this operation.
UUID	getServerId() Returns the ID of the server that is affected by this operation.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelOperation

public ChannelOperation(String channelName,
                        String operationData,
                        UUID operationId,
                        String operationType,
                        UUID serverId)

Creates a channel operation object.

Parameters:

channelName - name of the channel that is affected by this operation. The name is a textual identifier that uniquely identifies the channel within the archive.

operationData - data associated with this operation. The interpretation of the data depends on the operationType. May be null.

operationId - unique ID identifying this operation. The ID is mainly used to allow updates or deletes of the operation in a way that ensures that no other operation is modified accidentally.

operationType - textual identifier defining the type of this operation. The operation type also defines which kind of data is expected for operationData (if any). The definition of types is left to the code using this object.

serverId - ID of the server that is affected by this operation. Most likely, this is the server that is responsible for the channel, but for some operations, a different server might be involved.

Throws:

IllegalArgumentException - if the channelName is the empty string.

NullPointerException - if the channelName, the operationId, the operationType, or the serverId is null.

Method Detail

getChannelName

public String getChannelName()

Returns the name of the channel that is affected by this operation. The name is a textual identifier that uniquely identifies the channel within the archive.

Returns:

name of the channel affected by this operation.

getOperationData

public String getOperationData()

Returns the data associated with this operation. The interpretation of the data depends on the type of the operation (see getOperationType()). May be null.

Returns:

data associated with this operation or null if no data has been stored for this operation.

getOperationId

public UUID getOperationId()

Returns the unique ID identifying this operation. The ID is mainly used to allow updates or deletes of the operation in a way that ensures that no other operation is modified accidentally.

Returns:

unique ID identifying this operation.

getOperationType

public String getOperationType()

Returns the textual identifier defining the type of this operation. The operation type also defines which kind of data is expected for the data returned by getOperationData() (if any). The definition of types is left to the code using this object.

Returns:

type of this operation.

getServerId

public UUID getServerId()

Returns the ID of the server that is affected by this operation. Most likely, this is the server that is responsible for the channel, but for some operations, a different server might be involved.

Returns:

ID of the server that is affected by this operation.

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