com.hazelcast.ringbuffer.impl.operations

Class AbstractRingBufferOperation

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.ringbuffer.impl.operations.AbstractRingBufferOperation

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, NamedOperation, PartitionAwareOperation, ServiceNamespaceAware

Direct Known Subclasses:

AddAllBackupOperation, AddAllOperation, AddBackupOperation, AddOperation, GenericOperation, MergeBackupOperation, ReadManyOperation, ReadOneOperation

public abstract class AbstractRingBufferOperation
extends Operation
implements NamedOperation, IdentifiedDataSerializable, PartitionAwareOperation, ServiceNamespaceAware

Common logic for all ring buffer operations :

• getting the ring buffer container or creating a new one if necessary
• serialization/deserialization of ring buffer name
• defines the factory ID for the IdentifiedDataSerializable

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Fields inherited from class com.hazelcast.spi.Operation

GENERIC_PARTITION_ID

Constructor Summary

Constructors

Constructor and Description
AbstractRingBufferOperation()
AbstractRingBufferOperation(String name)

Method Summary

Modifier and Type	Method and Description
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
String	getName() Returns the name of the distributed data structure.
String	getServiceName()
ObjectNamespace	getServiceNamespace() Returns the ServiceNamespace which this object belongs to.
void	logError(Throwable e) Logs Exception/Error thrown during operation execution.
protected void	readInternal(ObjectDataInput in)
protected void	toString(StringBuilder sb) A template method allows for additional information to be passed into the Operation.toString() method.
protected void	writeInternal(ObjectDataOutput out)

Methods inherited from class com.hazelcast.spi.Operation

afterRun, beforeRun, call, executedLocally, getCallerAddress, getCallerUuid, getCallId, getCallTimeout, getConnection, getInvocationTime, getLogger, getNodeEngine, getOperationResponseHandler, getPartitionId, getReplicaIndex, getResponse, getService, getWaitTimeout, isUrgent, onExecutionFailure, onInvocationException, onSetCallId, readData, requiresExplicitServiceName, returnsResponse, run, sendResponse, setCallerUuid, setNodeEngine, setOperationResponseHandler, setPartitionId, setReplicaIndex, setService, setServiceName, setValidateTarget, setWaitTimeout, toString, validatesTarget, writeData

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.nio.serialization.IdentifiedDataSerializable

getId

Methods inherited from interface com.hazelcast.nio.serialization.DataSerializable

readData, writeData

Methods inherited from interface com.hazelcast.spi.PartitionAwareOperation

getPartitionId

Field Detail

name

protected String name

Constructor Detail

AbstractRingBufferOperation

public AbstractRingBufferOperation()

AbstractRingBufferOperation

public AbstractRingBufferOperation(String name)

Method Detail

getServiceName

public String getServiceName()

Overrides:

getServiceName in class Operation

getName

public String getName()

Description copied from interface: NamedOperation

Returns the name of the distributed data structure.

Specified by:

getName in interface NamedOperation

Returns:

String name of the distributed data structure.

logError

public void logError(Throwable e)

Description copied from class: Operation

Logs Exception/Error thrown during operation execution. Operation implementations can override this behaviour according to their needs.

This method is called on node & thread that's executing the operation.

Overrides:

logError in class Operation

Parameters:

e - Exception/Error thrown during operation execution

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

writeInternal

protected void writeInternal(ObjectDataOutput out)
                      throws IOException

Overrides:

writeInternal in class Operation

Throws:

IOException

readInternal

protected void readInternal(ObjectDataInput in)
                     throws IOException

Overrides:

readInternal in class Operation

Throws:

IOException

toString

protected void toString(StringBuilder sb)

Description copied from class: Operation

A template method allows for additional information to be passed into the Operation.toString() method. So an Operation subclass can override this method and add additional debugging content. The default implementation does nothing so one is not forced to provide an empty implementation. It is a good practice to always call the super.toString(stringBuffer) when implementing this method to make sure that the super class can inject content if needed.

Overrides:

toString in class Operation

Parameters:

sb - the StringBuilder to add the debug info to.

getServiceNamespace

public ObjectNamespace getServiceNamespace()

Description copied from interface: ServiceNamespaceAware

Returns the ServiceNamespace which this object belongs to.

Specified by:

getServiceNamespace in interface ServiceNamespaceAware

Returns:

service namespace