Package com.linkedin.venice.controller

Class AdminTopicMetadataAccessor

java.lang.Object

com.linkedin.venice.controller.AdminTopicMetadataAccessor

Direct Known Subclasses:

InMemoryAdminTopicMetadataAccessor, ZkAdminTopicMetadataAccessor

public abstract class AdminTopicMetadataAccessor
extends Object

This class provides a set of methods to access and update metadata for admin topics.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMIN_OPERATION_PROTOCOL_VERSION_KEY
static final String	EXECUTION_ID_KEY
static final String	OFFSET_KEY
static final String	POSITION_KEY
static final Long	UNDEFINED_VALUE
static final String	UPSTREAM_OFFSET_KEY	When remote consumption is enabled, child controller will consume directly from the source admin topic; an extra metadata called upstream offset will be maintained, which indicate the last offset in the source admin topic that gets processed successfully.
static final String	UPSTREAM_POSITION_KEY

Constructor Summary

Constructors

Constructor	Description
AdminTopicMetadataAccessor()

Method Summary

Modifier and Type	Method	Description
static Map<String,Long>	generateMetadataMap(Optional<Long> localOffset, Optional<Long> upstreamOffset, Optional<Long> executionId, Optional<Long> adminOperationProtocolVersion)
static long	getAdminOperationProtocolVersion(Map<String,Long> metadata)
static long	getExecutionId(AdminMetadata metadata)
static long	getExecutionId(Map<String,Long> metadata)
abstract AdminMetadata	getMetadata(String clusterName)	Retrieve the latest metadata.
static Pair<Long,Long>	getOffsets(AdminMetadata metadata)
static Pair<Long,Long>	getOffsets(Map<String,Long> metadata)
Pair<PubSubPosition,PubSubPosition>	getPositions(AdminMetadata metadata)
abstract void	updateMetadata(String clusterName, AdminMetadata metadata)	Update specific metadata for a given cluster in a single transaction with information provided in metadata.

Methods inherited from class java.lang.Object

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

Field Details

OFFSET_KEY

public static final String OFFSET_KEY

See Also:

• Constant Field Values

POSITION_KEY

public static final String POSITION_KEY

See Also:

• Constant Field Values

UPSTREAM_OFFSET_KEY

public static final String UPSTREAM_OFFSET_KEY

When remote consumption is enabled, child controller will consume directly from the source admin topic; an extra metadata called upstream offset will be maintained, which indicate the last offset in the source admin topic that gets processed successfully.

See Also:

• Constant Field Values

UPSTREAM_POSITION_KEY

public static final String UPSTREAM_POSITION_KEY

See Also:

• Constant Field Values

EXECUTION_ID_KEY

public static final String EXECUTION_ID_KEY

See Also:

• Constant Field Values

ADMIN_OPERATION_PROTOCOL_VERSION_KEY

public static final String ADMIN_OPERATION_PROTOCOL_VERSION_KEY

See Also:

• Constant Field Values

UNDEFINED_VALUE

public static final Long UNDEFINED_VALUE

Constructor Details

AdminTopicMetadataAccessor

public AdminTopicMetadataAccessor()

Method Details

generateMetadataMap

public static Map<String,Long> generateMetadataMap(Optional<Long> localOffset,
 Optional<Long> upstreamOffset,
 Optional<Long> executionId,
 Optional<Long> adminOperationProtocolVersion)

Returns:

a map with OFFSET_KEY, UPSTREAM_OFFSET_KEY, EXECUTION_ID_KEY, ADMIN_OPERATION_PROTOCOL_VERSION_KEY specified to input values.

getOffsets

public static Pair<Long,Long> getOffsets(Map<String,Long> metadata)

Returns:

a pair of values to which the specified keys are mapped to OFFSET_KEY and UPSTREAM_OFFSET_KEY.

getPositions

public Pair<PubSubPosition,PubSubPosition> getPositions(AdminMetadata metadata)

getExecutionId

public static long getExecutionId(Map<String,Long> metadata)

Returns:

the value to which the specified key is mapped to EXECUTION_ID_KEY.

getAdminOperationProtocolVersion

public static long getAdminOperationProtocolVersion(Map<String,Long> metadata)

Returns:

the value to which the specified key is mapped to ADMIN_OPERATION_PROTOCOL_VERSION_KEY.

getOffsets

public static Pair<Long,Long> getOffsets(AdminMetadata metadata)

Returns:

a pair of values representing local and upstream offsets

getExecutionId

public static long getExecutionId(AdminMetadata metadata)

Returns:

the execution ID from the metadata

updateMetadata

public abstract void updateMetadata(String clusterName,
 AdminMetadata metadata)

Update specific metadata for a given cluster in a single transaction with information provided in metadata.

Parameters:

clusterName - of the cluster at interest.

metadata - AdminMetadata containing relevant information.

getMetadata

public abstract AdminMetadata getMetadata(String clusterName)

Retrieve the latest metadata.

Parameters:

clusterName - of the cluster at interest.

Returns:

AdminMetadata containing all metadata information