org.rvpf.store.server

Class Replicator.Abstract

Object

Replicator.Abstract

All Implemented Interfaces:

Replicator

Direct Known Subclasses:

SOMReplicator

Enclosing interface:

Replicator

public abstract static class Replicator.Abstract
extends Object
implements Replicator

Abstract replicator.

Nested Class Summary

Nested classes/interfaces inherited from interface Replicator

Replicator.Abstract, Replicator.Partner, Replicator.Target

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARTNER_PROPERTIES Partner properties.
static String	REPLICATE_CONVERTS_PROPERTY Replicate converts property.
static String	REPLICATED_DEFAULTS_PROPERTY Replicated defaults property.
static String	REPLICATED_TRACES Traces subdirectory for replicated values.
static String	REPLICATOR_PROPERTIES Replicator group properties.
static String	STORE_NAME_PROPERTY The store name of a partner.

Constructor Summary

Constructors

Constructor and Description
Abstract()

Method Summary

Modifier and Type	Method and Description
void	close() Closes.
protected abstract void	close(Replicator.Partner partner) Closes the connection with a partner.
void	commit() Commits the pending replicates.
protected abstract void	commit(Replicator.Partner partner) Commits.
protected PointValue[]	filter(PointValue pointValue) Filters a point value.
protected Collection<Replicator.Partner>	getAnonymousPartners() Gets the anonymous partners.
protected Metadata	getMetadata() Gets the metadata.
Collection<String>	getPartnerNames() Gets the partner names.
protected Collection<Replicator.Partner>	getPartners() Gets the partners.
protected Service	getService() Gets the service.
protected StoreStats	getStats() Gets the stats.
protected Collection<Replicator.Target>	getTargets(UUID pointUUID) Gets the targets for a point.
protected Logger	getThisLogger() Gets the logger.
protected boolean	isEnabled() Asks if replication is enabled.
protected boolean	isReplicated(PointValue pointValue) Asks if a point value is replicated.
boolean	join() Joins whatever thread set up by this replicator.
protected abstract Replicator.Partner	newPartner(KeyedGroups partnerProperties) Returns a new partner informations object.
protected abstract boolean	open(Replicator.Partner partner) Opens a connection with a partner.
void	replicate(PointValue pointValue) Replicates of a point value.
protected abstract void	replicate(ReplicatedValue pointValue, Replicator.Partner partner) Replicates a point value to a partner.
boolean	setUp(StoreServiceAppImpl storeAppImpl) Sets up for processing.
boolean	setUpImpl() Sets up the implementation for processing.
void	start() Starts this replicator.
void	tearDown() Tears down what has been set up.
void	useNewMetadata() Uses new metadata.

Methods inherited from class Object

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

Field Detail

PARTNER_PROPERTIES

public static final String PARTNER_PROPERTIES

Partner properties.

See Also:

Constant Field Values

REPLICATED_DEFAULTS_PROPERTY

public static final String REPLICATED_DEFAULTS_PROPERTY

Replicated defaults property.

See Also:

Constant Field Values

REPLICATED_TRACES

public static final String REPLICATED_TRACES

Traces subdirectory for replicated values.

See Also:

Constant Field Values

REPLICATE_CONVERTS_PROPERTY

public static final String REPLICATE_CONVERTS_PROPERTY

Replicate converts property.

See Also:

Constant Field Values

REPLICATOR_PROPERTIES

public static final String REPLICATOR_PROPERTIES

Replicator group properties.

See Also:

Constant Field Values

STORE_NAME_PROPERTY

public static final String STORE_NAME_PROPERTY

The store name of a partner.

See Also:

Constant Field Values

Constructor Detail

Abstract

public Abstract()

Method Detail

close

public final void close()

Closes.

Specified by:

close in interface Replicator

commit

public final void commit()
                  throws InterruptedException

Commits the pending replicates.

Specified by:

commit in interface Replicator

Throws:

InterruptedException - When the service is stopped.

getPartnerNames

public final Collection<String> getPartnerNames()

Gets the partner names.

Specified by:

getPartnerNames in interface Replicator

Returns:

The partner names.

join

public boolean join()

Joins whatever thread set up by this replicator.

Specified by:

join in interface Replicator

Returns:

True value on success.

replicate

public final void replicate(PointValue pointValue)
                     throws InterruptedException

Replicates of a point value.

Specified by:

replicate in interface Replicator

Parameters:

pointValue - The point value.

Throws:

InterruptedException - When the Service is stopped.

setUp

public final boolean setUp(StoreServiceAppImpl storeAppImpl)

Sets up for processing.

Specified by:

setUp in interface Replicator

Parameters:

storeAppImpl - The store application implementation.

Returns:

True if successful.

setUpImpl

public boolean setUpImpl()

Sets up the implementation for processing.

Specified by:

setUpImpl in interface Replicator

Returns:

True if successful.

start

public void start()

Starts this replicator.

Specified by:

start in interface Replicator

tearDown

public final void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface Replicator

useNewMetadata

public final void useNewMetadata()

Uses new metadata.

Specified by:

useNewMetadata in interface Replicator

close

protected abstract void close(@Nonnull
                              Replicator.Partner partner)

Closes the connection with a partner.

Parameters:

partner - The partner.

commit

protected abstract void commit(@Nonnull
                               Replicator.Partner partner)
                        throws InterruptedException

Commits.

Parameters:

partner - The partner.

Throws:

InterruptedException - When interrupted.

filter

@Nonnull
 @CheckReturnValue
protected final PointValue[] filter(@Nonnull
                                                                  PointValue pointValue)

Filters a point value.

Parameters:

pointValue - The point value.

Returns:

The point value (empty when filtered).

getAnonymousPartners

@Nonnull
 @CheckReturnValue
protected final Collection<Replicator.Partner> getAnonymousPartners()

Gets the anonymous partners.

Returns:

The anonymous partners.

getMetadata

@Nonnull
 @CheckReturnValue
protected final Metadata getMetadata()

Gets the metadata.

Returns:

The metadata.

getPartners

@Nonnull
 @CheckReturnValue
protected final Collection<Replicator.Partner> getPartners()

Gets the partners.

Returns:

The partners.

getService

@Nonnull
 @CheckReturnValue
protected final Service getService()

Gets the service.

Returns:

The service.

getStats

@Nonnull
 @CheckReturnValue
protected final StoreStats getStats()

Gets the stats.

Returns:

The stats.

getTargets

@Nonnull
 @CheckReturnValue
protected final Collection<Replicator.Target> getTargets(@Nonnull
                                                                                       UUID pointUUID)

Gets the targets for a point.

Parameters:

pointUUID - The point's UUID.

Returns:

The targets.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

isEnabled

@CheckReturnValue
protected final boolean isEnabled()

Asks if replication is enabled.

Returns:

True if enabled.

isReplicated

@CheckReturnValue
protected final boolean isReplicated(@Nonnull
                                                        PointValue pointValue)

Asks if a point value is replicated.

Parameters:

pointValue - The point value.

Returns:

True if replicated.

newPartner

@Nonnull
 @CheckReturnValue
protected abstract Replicator.Partner newPartner(@Nonnull
                                                                               KeyedGroups partnerProperties)

Returns a new partner informations object.

Parameters:

partnerProperties - The partner configuration properties.

Returns:

The new partner informations object.

open

@CheckReturnValue
protected abstract boolean open(@Nonnull
                                                   Replicator.Partner partner)

Opens a connection with a partner.

Parameters:

partner - The partner.

Returns:

True on success.

replicate

protected abstract void replicate(@Nonnull
                                  ReplicatedValue pointValue,
                                  @Nonnull
                                  Replicator.Partner partner)
                           throws InterruptedException

Replicates a point value to a partner.

Parameters:

pointValue - The point value.

partner - The partner.

Throws:

InterruptedException - When interrupted.