public class

HelixConfigScope

extends Object
java.lang.Object
   ↳ org.apache.helix.model.HelixConfigScope

Class Overview

config-scope that replaces @link ConfigScope

Summary

Nested Classes
enum HelixConfigScope.ConfigScopeProperty Defines the various scopes of configs, and how they are represented on Zookeeper  
Public Constructors
HelixConfigScope(HelixConfigScope.ConfigScopeProperty type, List<String> zkPathKeys, String mapKey)
Initialize with a type of scope and unique identifiers
Public Methods
String getClusterName()
Get the cluster name
String getMapKey()
Get the lookup key within the ZNode if it exists
String getParticipantName()
Get the participant name if it exists
HelixConfigScope.ConfigScopeProperty getType()
Get the scope
String getZkPath()
Get the path to the corresponding ZNode
boolean isFullKey()
Determine if the key gets a config key or the actual config
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public HelixConfigScope (HelixConfigScope.ConfigScopeProperty type, List<String> zkPathKeys, String mapKey)

Initialize with a type of scope and unique identifiers

Parameters
type the scope
zkPathKeys keys identifying a ZNode location
mapKey a key for an additional lookup within a ZNode

Public Methods

public String getClusterName ()

Get the cluster name

Returns
  • the name of the associated cluster

public String getMapKey ()

Get the lookup key within the ZNode if it exists

Returns
  • the lookup key, or null

public String getParticipantName ()

Get the participant name if it exists

Returns
  • the participant name if the type is PARTICIPANT, or null

public HelixConfigScope.ConfigScopeProperty getType ()

Get the scope

Returns
  • the type of scope

public String getZkPath ()

Get the path to the corresponding ZNode

Returns
  • a Zookeeper path

public boolean isFullKey ()

Determine if the key gets a config key or the actual config

Returns
  • true if the key corresponds to a config, false if it corresponds to a config key