org.nuxeo.ecm.core.pubsub

Class AbstractPubSubInvalidator<T extends SerializableInvalidations>

java.lang.Object

org.nuxeo.ecm.core.pubsub.AbstractPubSubInvalidator<T>

Direct Known Subclasses:

DBSPubSubInvalidator, VCSPubSubInvalidator

public abstract class AbstractPubSubInvalidator<T extends SerializableInvalidations>
extends Object

Encapsulates invalidations management through the PubSubService.

All nodes that use the same topic will share the same invalidations.

The discriminator is used to distinguish nodes between one another, and to avoid that a node receives the invalidations it send itself.

Since:

9.1

Field Summary

Fields

Modifier and Type	Field and Description
protected T	bufferedInvalidations
protected static byte	DISCRIMINATOR_SEP
protected byte[]	discriminatorBytes
protected String	topic

Constructor Summary

Constructors

Constructor and Description
AbstractPubSubInvalidator()

Method Summary

Modifier and Type	Method and Description
void	close() Closes this invalidator and releases resources.
abstract T	deserialize(InputStream in) Deserializes an InputStream into invalidations, or null.
void	initialize(String topic, String discriminator) Initializes the invalidator.
abstract T	newInvalidations() Constructs new empty invalidations, of type T.
T	receiveInvalidations() Receives invalidations from other nodes.
protected int	scanDiscriminator(byte[] message) Scans for the discriminator and returns the payload start offset.
void	sendInvalidations(T invalidations) Sends invalidations to other nodes.
protected void	subscriber(String topic, byte[] message) PubSubService subscriber, called from a separate thread.

Methods inherited from class java.lang.Object

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

Field Detail

topic

protected String topic

discriminatorBytes

protected byte[] discriminatorBytes

bufferedInvalidations

protected volatile T extends SerializableInvalidations bufferedInvalidations

DISCRIMINATOR_SEP

protected static final byte DISCRIMINATOR_SEP

See Also:

Constant Field Values

Constructor Detail

AbstractPubSubInvalidator

public AbstractPubSubInvalidator()

Method Detail

newInvalidations

public abstract T newInvalidations()

Constructs new empty invalidations, of type T.

deserialize

public abstract T deserialize(InputStream in)
                       throws IOException

Deserializes an InputStream into invalidations, or null.

Throws:

IOException

initialize

public void initialize(String topic,
                       String discriminator)

Initializes the invalidator.

Parameters:

topic - the topic

discriminator - the discriminator

close

public void close()

Closes this invalidator and releases resources.

sendInvalidations

public void sendInvalidations(T invalidations)

Sends invalidations to other nodes.

subscriber

protected void subscriber(String topic,
                          byte[] message)

PubSubService subscriber, called from a separate thread.

scanDiscriminator

protected int scanDiscriminator(byte[] message)

Scans for the discriminator and returns the payload start offset.

Returns:

payload start offset, or -1 if the discriminator is local or if the message is invalid

receiveInvalidations

public T receiveInvalidations()

Receives invalidations from other nodes.