com.netflix.hollow.api.client

Class HollowUpdatePlanner

java.lang.Object

com.netflix.hollow.api.client.HollowUpdatePlanner

public class HollowUpdatePlanner
extends java.lang.Object

The HollowUpdatePlanner defines the logic responsible for interacting with a HollowBlobRetriever to create a HollowUpdatePlan.

Constructor Summary

Constructors

Constructor and Description
HollowUpdatePlanner(HollowBlobRetriever blobRetriever) Deprecated.
HollowUpdatePlanner(HollowConsumer.BlobRetriever blobRetriever)
HollowUpdatePlanner(HollowConsumer.BlobRetriever transitionCreator, HollowConsumer.DoubleSnapshotConfig doubleSnapshotConfig)

Method Summary

Modifier and Type	Method and Description
HollowUpdatePlan	planInitializingUpdate(long desiredVersion)
HollowUpdatePlan	planUpdate(long currentVersion, long desiredVersion, boolean allowSnapshot)

Methods inherited from class java.lang.Object

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

Constructor Detail

HollowUpdatePlanner

@Deprecated
public HollowUpdatePlanner(HollowBlobRetriever blobRetriever)

Deprecated.

HollowUpdatePlanner

public HollowUpdatePlanner(HollowConsumer.BlobRetriever blobRetriever)

HollowUpdatePlanner

public HollowUpdatePlanner(HollowConsumer.BlobRetriever transitionCreator,
                           HollowConsumer.DoubleSnapshotConfig doubleSnapshotConfig)

Method Detail

planInitializingUpdate

public HollowUpdatePlan planInitializingUpdate(long desiredVersion)
                                        throws java.lang.Exception

Parameters:

desiredVersion - - The version to which the hollow state engine should be updated once the resultant steps are applied.

Returns:

the sequence of steps necessary to initialize a hollow state engine to a given state.

Throws:

java.lang.Exception - if the plan cannot be initialized

planUpdate

public HollowUpdatePlan planUpdate(long currentVersion,
                                   long desiredVersion,
                                   boolean allowSnapshot)
                            throws java.lang.Exception

Parameters:

currentVersion - - The current version of the hollow state engine, or HollowConstants.VERSION_NONE if not yet initialized

desiredVersion - - The version to which the hollow state engine should be updated once the resultant steps are applied.

allowSnapshot - - Allow a snapshot plan to be created if the destination version is not reachable

Returns:

the sequence of steps necessary to bring a hollow state engine up to date.

Throws:

java.lang.Exception - if the plan cannot be updated