com.netflix.hollow.core.read.engine

Class HollowBlobReader

java.lang.Object

com.netflix.hollow.core.read.engine.HollowBlobReader

public class HollowBlobReader
extends java.lang.Object

A HollowBlobReader is used to populate and update data in a HollowReadStateEngine, via the consumption of snapshot and delta blobs. Caller can choose between on-heap or shared-memory mode; defaults to (and for backwards compatibility) on-heap mode.

Constructor Summary

Constructors

Constructor and Description
HollowBlobReader(HollowReadStateEngine stateEngine)
HollowBlobReader(HollowReadStateEngine stateEngine, HollowBlobHeaderReader headerReader)
HollowBlobReader(HollowReadStateEngine stateEngine, HollowBlobHeaderReader headerReader, MemoryMode memoryMode)
HollowBlobReader(HollowReadStateEngine stateEngine, MemoryMode memoryMode)

Method Summary

Modifier and Type	Method and Description
void	applyDelta(HollowBlobInput in) Update the state engine using a delta (or reverse delta) blob from the provided HollowBlobInput.
void	applyDelta(HollowBlobInput in, OptionalBlobPartInput optionalParts)
void	applyDelta(java.io.InputStream in) Update the state engine using a delta (or reverse delta) blob from the provided input stream.
void	readSnapshot(HollowBlobInput in) Initialize the state engine using a snapshot blob from the provided HollowBlobInput.
void	readSnapshot(HollowBlobInput in, OptionalBlobPartInput optionalParts)
void	readSnapshot(HollowBlobInput in, OptionalBlobPartInput optionalParts, TypeFilter filter)
void	readSnapshot(HollowBlobInput in, TypeFilter filter) Initialize the file engine using a snapshot from the provided Hollow Blob Input.
void	readSnapshot(java.io.InputStream is) Initialize the state engine using a snapshot blob from the provided input stream.
void	readSnapshot(java.io.InputStream is, HollowFilterConfig filter) Deprecated. use readSnapshot(InputStream, TypeFilter)
void	readSnapshot(java.io.InputStream is, TypeFilter filter) Initialize the file engine using a snapshot from the provided input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

HollowBlobReader

public HollowBlobReader(HollowReadStateEngine stateEngine)

HollowBlobReader

public HollowBlobReader(HollowReadStateEngine stateEngine,
                        HollowBlobHeaderReader headerReader)

HollowBlobReader

public HollowBlobReader(HollowReadStateEngine stateEngine,
                        MemoryMode memoryMode)

HollowBlobReader

public HollowBlobReader(HollowReadStateEngine stateEngine,
                        HollowBlobHeaderReader headerReader,
                        MemoryMode memoryMode)

Method Detail

readSnapshot

public void readSnapshot(java.io.InputStream is)
                  throws java.io.IOException

Initialize the state engine using a snapshot blob from the provided input stream.

Parameters:

is - the input stream to read the snapshot from

Throws:

java.io.IOException - if the snapshot could not be read

readSnapshot

public void readSnapshot(HollowBlobInput in)
                  throws java.io.IOException

Initialize the state engine using a snapshot blob from the provided HollowBlobInput.

Parameters:

in - the Hollow blob input to read the snapshot from

Throws:

java.io.IOException - if the snapshot could not be read

readSnapshot

@Deprecated
public void readSnapshot(java.io.InputStream is,
                                     HollowFilterConfig filter)
                              throws java.io.IOException

Deprecated. use readSnapshot(InputStream, TypeFilter)

Initialize the file engine using a snapshot from the provided RandomAccessFile.

Apply the provided HollowFilterConfig to the state.

Parameters:

is - the input stream to read the snapshot from

filter - the filtering configuration to filter the snapshot

Throws:

java.io.IOException - if the snapshot could not be read

readSnapshot

public void readSnapshot(java.io.InputStream is,
                         TypeFilter filter)
                  throws java.io.IOException

Initialize the file engine using a snapshot from the provided input stream.

Apply the provided TypeFilter to the state.

Parameters:

is - the input stream to read the snapshot from

filter - the filtering configuration to filter the snapshot

Throws:

java.io.IOException - if the snapshot could not be read

readSnapshot

public void readSnapshot(HollowBlobInput in,
                         TypeFilter filter)
                  throws java.io.IOException

Initialize the file engine using a snapshot from the provided Hollow Blob Input.

Apply the provided TypeFilter to the state.

Parameters:

in - the Hollow blob input to read the snapshot from

filter - the filtering configuration to filter the snapshot

Throws:

java.io.IOException - if the snapshot could not be read

readSnapshot

public void readSnapshot(HollowBlobInput in,
                         OptionalBlobPartInput optionalParts)
                  throws java.io.IOException

Throws:

java.io.IOException

readSnapshot

public void readSnapshot(HollowBlobInput in,
                         OptionalBlobPartInput optionalParts,
                         TypeFilter filter)
                  throws java.io.IOException

Throws:

java.io.IOException

applyDelta

public void applyDelta(java.io.InputStream in)
                throws java.io.IOException

Update the state engine using a delta (or reverse delta) blob from the provided input stream.

If a HollowFilterConfig was applied at the time the HollowReadStateEngine was initialized with a snapshot, it will continue to be in effect after the state is updated.

Parameters:

in - the input stream to read the delta from

Throws:

java.io.IOException - if the delta could not be applied

applyDelta

public void applyDelta(HollowBlobInput in)
                throws java.io.IOException

Update the state engine using a delta (or reverse delta) blob from the provided HollowBlobInput.

If a HollowFilterConfig was applied at the time the HollowReadStateEngine was initialized with a snapshot, it will continue to be in effect after the state is updated.

Parameters:

in - the Hollow blob input to read the delta from

Throws:

java.io.IOException - if the delta could not be applied

applyDelta

public void applyDelta(HollowBlobInput in,
                       OptionalBlobPartInput optionalParts)
                throws java.io.IOException

Throws:

java.io.IOException