com.netflix.hollow.api.producer.enforcer

Class AbstractSingleProducerEnforcer

java.lang.Object

com.netflix.hollow.api.producer.AbstractHollowProducerListener

com.netflix.hollow.api.producer.enforcer.AbstractSingleProducerEnforcer

All Implemented Interfaces:

SingleProducerEnforcer, HollowProducerListener, AnnouncementListener, CycleListener, DataModelInitializationListener, HollowProducerEventListener, IntegrityCheckListener, PopulateListener, PublishListener, RestoreListener

Direct Known Subclasses:

BasicSingleProducerEnforcer

public abstract class AbstractSingleProducerEnforcer
extends AbstractHollowProducerListener
implements SingleProducerEnforcer

Nested Class Summary

Nested classes/interfaces inherited from interface com.netflix.hollow.api.producer.HollowProducerListener

HollowProducerListener.ProducerStatus, HollowProducerListener.PublishStatus, HollowProducerListener.RestoreStatus, HollowProducerListener.Status

Nested classes/interfaces inherited from interface com.netflix.hollow.api.producer.listener.CycleListener

CycleListener.CycleSkipReason

Constructor Summary

Constructors

Constructor and Description
AbstractSingleProducerEnforcer()

Method Summary

Modifier and Type	Method and Description
protected abstract void	_disable()
protected abstract void	_enable()
protected void	_force()
protected abstract boolean	_isPrimary()
void	disable() Relinquish the primary producer status.
void	enable() Mark producer to enable processing cycles.
void	force() Force marking producer to enable processing cycles.
protected boolean	getWasPrimary()
boolean	isPrimary() runCycle() is executed only if isPrimary() is true
void	onCycleComplete(HollowProducerListener.ProducerStatus status, long elapsed, java.util.concurrent.TimeUnit unit) Called after HollowProducer has completed a cycle normally or abnormally.
void	onCycleStart(long version) Called when the HollowProducer has begun a new cycle.

Methods inherited from class com.netflix.hollow.api.producer.AbstractHollowProducerListener

onAnnouncementComplete, onAnnouncementStart, onArtifactPublish, onCycleSkip, onIntegrityCheckComplete, onIntegrityCheckStart, onNewDeltaChain, onNoDeltaAvailable, onPopulateComplete, onPopulateStart, onProducerInit, onProducerRestoreComplete, onProducerRestoreStart, onPublishComplete, onPublishStart, onValidationComplete, onValidationStart

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netflix.hollow.api.producer.HollowProducerListener

onAnnouncementComplete, onBlobPublish, onCycleComplete, onIntegrityCheckComplete, onPopulateComplete, onProducerInit, onProducerRestoreComplete, onPublishComplete

Methods inherited from interface com.netflix.hollow.api.producer.listener.PublishListener

onBlobPublishAsync, onBlobStage

Constructor Detail

AbstractSingleProducerEnforcer

public AbstractSingleProducerEnforcer()

Method Detail

_enable

protected abstract void _enable()

_disable

protected abstract void _disable()

_isPrimary

protected abstract boolean _isPrimary()

_force

protected void _force()

enable

public void enable()

Description copied from interface: SingleProducerEnforcer

Mark producer to enable processing cycles. Default implementation (BasicSingleProducerEnforcer) is enabled by default.

Specified by:

enable in interface SingleProducerEnforcer

disable

public void disable()

Description copied from interface: SingleProducerEnforcer

Relinquish the primary producer status. disable() can be invoked any time, but takes affect only after current cycle is completed (or if no cycle is running).

Specified by:

disable in interface SingleProducerEnforcer

isPrimary

public boolean isPrimary()

Description copied from interface: SingleProducerEnforcer

runCycle() is executed only if isPrimary() is true

Specified by:

isPrimary in interface SingleProducerEnforcer

Returns:

boolean

force

public void force()

Description copied from interface: SingleProducerEnforcer

Force marking producer to enable processing cycles.

Specified by:

force in interface SingleProducerEnforcer

onCycleStart

public void onCycleStart(long version)

Description copied from interface: HollowProducerListener

Called when the HollowProducer has begun a new cycle.

Specified by:

onCycleStart in interface HollowProducerListener

Specified by:

onCycleStart in interface CycleListener

Overrides:

onCycleStart in class AbstractHollowProducerListener

Parameters:

version - Version produced by the HollowProducer for new cycle about to start.

onCycleComplete

public void onCycleComplete(HollowProducerListener.ProducerStatus status,
                            long elapsed,
                            java.util.concurrent.TimeUnit unit)

Description copied from interface: HollowProducerListener

Called after HollowProducer has completed a cycle normally or abnormally. A SUCCESS status indicates that the entire cycle was successful and the producer is available to begin another cycle.

Specified by:

onCycleComplete in interface HollowProducerListener

Overrides:

onCycleComplete in class AbstractHollowProducerListener

Parameters:

status - ProducerStatus of this cycle. HollowProducerListener.ProducerStatus.getStatus() will return SUCCESS when the a new data state has been announced to consumers or when there were no changes to the data; it will return @{code FAIL} when any stage failed or any other failure occured during the cycle.

elapsed - duration of the cycle in unit units

unit - units of the elapsed duration

getWasPrimary

protected boolean getWasPrimary()