org.apache.helix.PropertyKey Maven / Gradle / Ivy
The newest version!
package org.apache.helix;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Arrays;
import java.util.Objects;
import org.apache.helix.model.CloudConfig;
import org.apache.helix.model.ClusterConfig;
import org.apache.helix.model.ClusterConstraints;
import org.apache.helix.model.ClusterStatus;
import org.apache.helix.model.ControllerHistory;
import org.apache.helix.model.CurrentState;
import org.apache.helix.model.CustomizedState;
import org.apache.helix.model.CustomizedStateConfig;
import org.apache.helix.model.CustomizedView;
import org.apache.helix.model.Error;
import org.apache.helix.model.ExternalView;
import org.apache.helix.model.HealthStat;
import org.apache.helix.model.HelixConfigScope.ConfigScopeProperty;
import org.apache.helix.model.IdealState;
import org.apache.helix.model.InstanceConfig;
import org.apache.helix.model.LiveInstance;
import org.apache.helix.model.MaintenanceSignal;
import org.apache.helix.model.Message;
import org.apache.helix.model.ParticipantHistory;
import org.apache.helix.model.PauseSignal;
import org.apache.helix.model.RESTConfig;
import org.apache.helix.model.ResourceConfig;
import org.apache.helix.model.StateModelDefinition;
import org.apache.helix.model.StatusUpdate;
import org.apache.helix.task.JobConfig;
import org.apache.helix.task.JobContext;
import org.apache.helix.task.WorkflowConfig;
import org.apache.helix.task.WorkflowContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import static org.apache.helix.PropertyType.CONFIGS;
import static org.apache.helix.PropertyType.CONTROLLER;
import static org.apache.helix.PropertyType.CURRENTSTATES;
import static org.apache.helix.PropertyType.CUSTOMIZEDSTATES;
import static org.apache.helix.PropertyType.CUSTOMIZEDVIEW;
import static org.apache.helix.PropertyType.ERRORS;
import static org.apache.helix.PropertyType.ERRORS_CONTROLLER;
import static org.apache.helix.PropertyType.EXTERNALVIEW;
import static org.apache.helix.PropertyType.HISTORY;
import static org.apache.helix.PropertyType.IDEALSTATES;
import static org.apache.helix.PropertyType.INSTANCE_HISTORY;
import static org.apache.helix.PropertyType.LEADER;
import static org.apache.helix.PropertyType.LIVEINSTANCES;
import static org.apache.helix.PropertyType.MAINTENANCE;
import static org.apache.helix.PropertyType.MESSAGES;
import static org.apache.helix.PropertyType.MESSAGES_CONTROLLER;
import static org.apache.helix.PropertyType.PAUSE;
import static org.apache.helix.PropertyType.RESTCONFIGS;
import static org.apache.helix.PropertyType.STATEMODELDEFS;
import static org.apache.helix.PropertyType.STATUSUPDATES;
import static org.apache.helix.PropertyType.STATUSUPDATES_CONTROLLER;
import static org.apache.helix.PropertyType.TARGETEXTERNALVIEW;
import static org.apache.helix.PropertyType.TASKCURRENTSTATES;
/**
* Key allowing for type-safe lookups of and conversions to {@link HelixProperty} objects.
*/
public class PropertyKey {
private static Logger LOG = LoggerFactory.getLogger(PropertyKey.class);
public PropertyType _type;
private final String[] _params;
Class _typeClazz;
// if type is CONFIGS, set configScope; otherwise null
ConfigScopeProperty _configScope;
/**
* Instantiate with a type, associated class, and parameters
* @param type
* @param typeClazz
* @param params parameters associated with the key, the first of which is the cluster name
*/
public PropertyKey(PropertyType type, Class typeClazz,
String... params) {
this(type, null, typeClazz, params);
}
/**
* Instantiate with a type, scope, associated class, and parameters
* @param type
* @param configScope
* @param typeClazz
* @param params parameters associated with the key, the first of which is the cluster name
*/
public PropertyKey(PropertyType type, ConfigScopeProperty configScope,
Class typeClazz, String... params) {
_type = type;
if (params == null || params.length == 0 || Arrays.asList(params).contains(null)) {
throw new IllegalArgumentException("params cannot be null");
}
_params = params;
_typeClazz = typeClazz;
_configScope = configScope;
}
@Override
public int hashCode() {
int result = (_type != null ? _type.hashCode() : 0);
result = 31 * result + Arrays.hashCode(_params);
result = 31 * result + (_typeClazz != null ? _typeClazz.hashCode() : 0);
result = 31 * result + (_configScope != null ? _configScope.hashCode() : 0);
return result;
}
@Override
public String toString() {
return getPath();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || !(o instanceof PropertyKey)) {
return false;
}
PropertyKey key = (PropertyKey) o;
if (_type != key._type) {
return false;
}
// Probably incorrect - comparing Object[] arrays with Arrays.equals
if (!Arrays.equals(_params, key._params)) {
return false;
}
// Avoid NPE when one typeClazz is null
if (!Objects.equals(_typeClazz, key._typeClazz)) {
return false;
}
return _configScope == key._configScope;
}
/**
* Get the path associated with this property
* @return absolute path to the property
*/
public String getPath() {
String clusterName = _params[0];
String[] subKeys = Arrays.copyOfRange(_params, 1, _params.length);
String path = PropertyPathBuilder.getPath(_type, clusterName, subKeys);
if (path == null) {
LOG.error("Invalid property key with type:" + _type + "subKeys:" + Arrays.toString(_params));
}
return path;
}
/**
* PropertyKey builder for a cluster
*/
public static class Builder {
private final String _clusterName;
/**
* Instantiate with a cluster name
* @param clusterName
*/
public Builder(String clusterName) {
_clusterName = clusterName;
}
/**
* Get a property key associated with {@link IdealState}
* @return {@link PropertyKey}
*/
public PropertyKey idealStates() {
return new PropertyKey(IDEALSTATES, IdealState.class, _clusterName);
}
/**
* Get a property key associated with {@link IdealState} and a resource
* @param resourceName
* @return {@link PropertyKey}
*/
public PropertyKey idealStates(String resourceName) {
return new PropertyKey(IDEALSTATES, IdealState.class, _clusterName, resourceName);
}
/**
* Get a property key associated with {@link StateModelDefinition}
* @return {@link PropertyKey}
*/
public PropertyKey stateModelDefs() {
return new PropertyKey(STATEMODELDEFS, StateModelDefinition.class, _clusterName);
}
/**
* Get a property key associated with {@link StateModelDefinition} for a given state model name
* @param stateModelName
* @return {@link PropertyKey}
*/
public PropertyKey stateModelDef(String stateModelName) {
return new PropertyKey(STATEMODELDEFS, StateModelDefinition.class, _clusterName,
stateModelName);
}
/**
* Get a property key associated with all cluster configurations
* @return {@link PropertyKey}
*/
public PropertyKey clusterConfigs() {
return new PropertyKey(CONFIGS, ConfigScopeProperty.CLUSTER, ClusterConfig.class,
_clusterName, ConfigScopeProperty.CLUSTER.toString());
}
/**
* Get a property key associated with this cluster configuration
* @return {@link PropertyKey}
*/
public PropertyKey clusterConfig() {
return new PropertyKey(CONFIGS, ConfigScopeProperty.CLUSTER, ClusterConfig.class,
_clusterName, ConfigScopeProperty.CLUSTER.toString(), _clusterName);
}
/**
* Get a property key associated with this cluster status
* @return {@link PropertyKey}
*/
public PropertyKey clusterStatus() {
return new PropertyKey(PropertyType.STATUS, ClusterStatus.class, _clusterName, _clusterName);
}
/**
* Get a property key associated with this Cloud configuration
* @return {@link PropertyKey}
*/
public PropertyKey cloudConfig() {
return new PropertyKey(CONFIGS, ConfigScopeProperty.CLOUD, CloudConfig.class,
_clusterName, ConfigScopeProperty.CLOUD.name(), _clusterName);
}
/**
* Get a property key associated with this customized state aggregation configuration
* @return {@link PropertyKey}
*/
public PropertyKey customizedStateConfig() {
return new PropertyKey(CONFIGS, ConfigScopeProperty.CUSTOMIZED_STATE,
CustomizedStateConfig.class, _clusterName,
ConfigScopeProperty.CUSTOMIZED_STATE.name(), _clusterName);
}
/**
* Get a property key associated with {@link InstanceConfig}
* @return {@link PropertyKey}
*/
public PropertyKey instanceConfigs() {
return new PropertyKey(CONFIGS, ConfigScopeProperty.PARTICIPANT, InstanceConfig.class,
_clusterName, ConfigScopeProperty.PARTICIPANT.toString());
}
/**
* Get a property key associated with {@link InstanceConfig} for a specific instance
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey instanceConfig(String instanceName) {
return new PropertyKey(CONFIGS, ConfigScopeProperty.PARTICIPANT, InstanceConfig.class,
_clusterName, ConfigScopeProperty.PARTICIPANT.toString(), instanceName);
}
/**
* Get a property key associated with resource configurations.
* @return {@link PropertyKey}
*/
public PropertyKey resourceConfigs() {
return new PropertyKey(CONFIGS, ConfigScopeProperty.RESOURCE, ResourceConfig.class,
_clusterName, ConfigScopeProperty.RESOURCE.toString());
}
/**
* Get a property key associated with a specific resource configuration.
* @param resourceName
* @return {@link PropertyKey}
*/
public PropertyKey resourceConfig(String resourceName) {
return new PropertyKey(CONFIGS, ConfigScopeProperty.RESOURCE, ResourceConfig.class,
_clusterName, ConfigScopeProperty.RESOURCE.toString(), resourceName);
}
/**
* Get a property key associated with a partition
* @param resourceName
* @param partitionName
* @return {@link PropertyKey}
*/
public PropertyKey partitionConfig(String resourceName, String partitionName) {
return new PropertyKey(CONFIGS, ConfigScopeProperty.RESOURCE, HelixProperty.class,
_clusterName, ConfigScopeProperty.RESOURCE.toString(), resourceName);
}
/**
* Get a property key associated with a partition configuration
* @param instanceName
* @param resourceName
* @param partitionName
* @return {@link PropertyKey}
*/
public PropertyKey partitionConfig(String instanceName, String resourceName,
String partitionName) {
return new PropertyKey(CONFIGS, ConfigScopeProperty.RESOURCE, HelixProperty.class,
_clusterName, ConfigScopeProperty.RESOURCE.toString(), resourceName);
}
/**
* Get a property key associated with {@link ClusterConstraints}
* @return {@link PropertyKey}
*/
public PropertyKey constraints() {
return new PropertyKey(CONFIGS, ClusterConstraints.class, _clusterName,
ConfigScopeProperty.CONSTRAINT.toString());
}
/**
* Get a property key associated with a specific {@link ClusterConstraints}
* @param constraintType
* @return {@link PropertyKey}
*/
public PropertyKey constraint(String constraintType) {
return new PropertyKey(CONFIGS, ClusterConstraints.class, _clusterName,
ConfigScopeProperty.CONSTRAINT.toString(), constraintType);
}
/**
* Get a property key associated with {@link LiveInstance}
* @return {@link PropertyKey}
*/
public PropertyKey liveInstances() {
return new PropertyKey(LIVEINSTANCES, LiveInstance.class, _clusterName);
}
/**
* Get a property key associated with a specific {@link LiveInstance}
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey liveInstance(String instanceName) {
return new PropertyKey(LIVEINSTANCES, LiveInstance.class, _clusterName, instanceName);
}
/**
* Get a property key associated with all instances
* @return {@link PropertyKey}
*/
public PropertyKey instances() {
return new PropertyKey(PropertyType.INSTANCES, null, _clusterName);
}
/**
* Get a property key associated with specified instance
* @return {@link PropertyKey}
*/
public PropertyKey instance(String instanceName) {
return new PropertyKey(PropertyType.INSTANCES, null, _clusterName, instanceName);
}
/**
* Get a property key associated with {@link Message} for an instance
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey messages(String instanceName) {
return new PropertyKey(MESSAGES, Message.class, _clusterName, instanceName);
}
/**
* Get a property key associated with {@link Error} for an instance
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey errors(String instanceName) {
return new PropertyKey(ERRORS, Error.class, _clusterName, instanceName);
}
/**
* Get a property key associated with {@link Error} for an instance under a session
* @param instanceName
* @param sessionId
* @return {@link PropertyKey}
*/
public PropertyKey errors(String instanceName, String sessionId) {
return new PropertyKey(ERRORS, Error.class, _clusterName, instanceName, sessionId);
}
/**
* Get a property key associated with {@link Error} for an instance under a session of
* specified resource
* @param instanceName
* @param sessionId
* @param resourceName
* @return {@link PropertyKey}
*/
public PropertyKey errors(String instanceName, String sessionId, String resourceName) {
return new PropertyKey(ERRORS, Error.class, _clusterName, instanceName, sessionId,
resourceName);
}
public PropertyKey participantHistory(String instanceName) {
return new PropertyKey(INSTANCE_HISTORY, ParticipantHistory.class, _clusterName,
instanceName);
}
/**
* Get a property key associated with a specific {@link Message} on an instance
* @param instanceName
* @param messageId
* @return {@link PropertyKey}
*/
public PropertyKey message(String instanceName, String messageId) {
return new PropertyKey(MESSAGES, Message.class, _clusterName, instanceName, messageId);
}
/**
* Get a property key associated with {@link CurrentState} of an instance
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey sessions(String instanceName) {
return new PropertyKey(CURRENTSTATES, CurrentState.class, _clusterName, instanceName);
}
/**
* Get a property key associated with {@link CurrentState} of an instance and session
* @param instanceName
* @param sessionId
* @return {@link PropertyKey}
*/
public PropertyKey currentStates(String instanceName, String sessionId) {
return new PropertyKey(CURRENTSTATES, CurrentState.class, _clusterName, instanceName,
sessionId);
}
/**
* Get a property key associated with {@link CurrentState} of an instance, session, and
* resource
* @param instanceName
* @param sessionId
* @param resourceName
* @return {@link PropertyKey}
*/
public PropertyKey currentState(String instanceName, String sessionId, String resourceName) {
return new PropertyKey(CURRENTSTATES, CurrentState.class, _clusterName, instanceName,
sessionId, resourceName);
}
/**
* Get a property key associated with {@link CurrentState} of an instance, session, resource,
* and bucket name
* @param instanceName
* @param sessionId
* @param resourceName
* @param bucketName
* @return {@link PropertyKey}
*/
public PropertyKey currentState(String instanceName, String sessionId, String resourceName,
String bucketName) {
if (bucketName == null) {
return new PropertyKey(CURRENTSTATES, CurrentState.class, _clusterName, instanceName,
sessionId, resourceName);
} else {
return new PropertyKey(CURRENTSTATES, CurrentState.class, _clusterName, instanceName,
sessionId, resourceName, bucketName);
}
}
/**
* Get a property key associated with {@link CurrentState} of an instance. This key is for
* TaskCurrentState specifically.
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey taskCurrentStateSessions(String instanceName) {
return new PropertyKey(TASKCURRENTSTATES, CurrentState.class, _clusterName, instanceName);
}
/**
* Get a property key associated with {@link CurrentState} of an instance and session. This key
* is for TaskCurrentState specifically.
* @param instanceName
* @param sessionId
* @return {@link PropertyKey}
*/
public PropertyKey taskCurrentStates(String instanceName, String sessionId) {
return new PropertyKey(TASKCURRENTSTATES, CurrentState.class, _clusterName, instanceName,
sessionId);
}
/**
* Get a property key associated with {@link CurrentState} of an instance, session, and
* job. This key is for TaskCurrentState specifically.
* @param instanceName
* @param sessionId
* @param jobName
* @return {@link PropertyKey}
*/
public PropertyKey taskCurrentState(String instanceName, String sessionId, String jobName) {
return new PropertyKey(TASKCURRENTSTATES, CurrentState.class, _clusterName, instanceName,
sessionId, jobName);
}
/**
* Get a property key associated with {@link CurrentState} of an instance, session, job,
* and bucket name. This key is for TaskCurrentState specifically.
* @param instanceName
* @param sessionId
* @param jobName
* @param bucketName
* @return {@link PropertyKey}
*/
public PropertyKey taskCurrentState(String instanceName, String sessionId, String jobName,
String bucketName) {
if (bucketName == null) {
return new PropertyKey(TASKCURRENTSTATES, CurrentState.class, _clusterName, instanceName,
sessionId, jobName);
}
return new PropertyKey(TASKCURRENTSTATES, CurrentState.class, _clusterName, instanceName,
sessionId, jobName, bucketName);
}
/**
* Get a property key associated with the root of {@link CustomizedState} of an instance
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey customizedStatesRoot(String instanceName) {
return new PropertyKey(CUSTOMIZEDSTATES, CustomizedState.class, _clusterName, instanceName);
}
/**
* Get a property key associated with {@link CustomizedState} of an instance and customized state
* @param instanceName
* @param customizedStateName
* @return {@link PropertyKey}
*/
public PropertyKey customizedStates(String instanceName, String customizedStateName) {
return new PropertyKey(CUSTOMIZEDSTATES, CustomizedState.class, _clusterName, instanceName,
customizedStateName);
}
/**
* Get a property key associated with {@link CustomizedState} of an instance, customized state, and resource
* @param instanceName
* @param customizedStateName
* @param resourceName
* @return {@link PropertyKey}
*/
public PropertyKey customizedState(String instanceName, String customizedStateName,
String resourceName) {
return new PropertyKey(CUSTOMIZEDSTATES, CustomizedState.class, _clusterName, instanceName,
customizedStateName, resourceName);
}
/**
* Get a property key associated with {@link StatusUpdate} of an instance, session, resource,
* and partition
* @param instanceName
* @param sessionId
* @param resourceName
* @param partitionName
* @return {@link PropertyKey}
*/
public PropertyKey stateTransitionStatus(String instanceName, String sessionId,
String resourceName, String partitionName) {
return new PropertyKey(STATUSUPDATES, StatusUpdate.class, _clusterName, instanceName,
sessionId, resourceName, partitionName);
}
/**
* Get a property key associated with {@link StatusUpdate} of an instance, session, and
* resource
* @param instanceName
* @param sessionId
* @param resourceName
* @return {@link PropertyKey}
*/
public PropertyKey stateTransitionStatus(String instanceName, String sessionId,
String resourceName) {
return new PropertyKey(STATUSUPDATES, StatusUpdate.class, _clusterName, instanceName,
sessionId, resourceName);
}
/**
* Get a property key associated with {@link StatusUpdate} of an instance and session
* @param instanceName
* @param sessionId
* @return {@link PropertyKey}
*/
public PropertyKey stateTransitionStatus(String instanceName, String sessionId) {
return new PropertyKey(STATUSUPDATES, StatusUpdate.class, _clusterName, instanceName,
sessionId);
}
/**
* Get a property key associated with {@link StatusUpdate} of an instance
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey stateTransitionStatus(String instanceName) {
return new PropertyKey(STATUSUPDATES, StatusUpdate.class, _clusterName, instanceName);
}
/**
* Used to get status update for a NON STATE TRANSITION type
* @param instanceName
* @param sessionId
* @param msgType
* @param msgId
* @return {@link PropertyKey}
*/
public PropertyKey taskStatus(String instanceName, String sessionId, String msgType,
String msgId) {
return new PropertyKey(STATUSUPDATES, StatusUpdate.class, _clusterName, instanceName,
sessionId, msgType, msgId);
}
/**
* Get a property key associated with {@link Error} of an instance, session, resource,
* and partition
* @param instanceName
* @param sessionId
* @param resourceName
* @param partitionName
* @return {@link PropertyKey}
*/
public PropertyKey stateTransitionError(String instanceName, String sessionId,
String resourceName, String partitionName) {
return new PropertyKey(ERRORS, Error.class, _clusterName, instanceName, sessionId,
resourceName, partitionName);
}
/**
* Get a property key associated with {@link Error} of an instance, session, and
* resource
* @param instanceName
* @param sessionId
* @param resourceName
* @return {@link PropertyKey}
*/
public PropertyKey stateTransitionErrors(String instanceName, String sessionId,
String resourceName) {
return new PropertyKey(ERRORS, Error.class, _clusterName, instanceName, sessionId,
resourceName);
}
/**
* Get a property key associated with {@link Error} of an instance, session, and
* resource
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey stateTransitionErrors(String instanceName) {
return new PropertyKey(ERRORS, Error.class, _clusterName, instanceName);
}
/**
* Used to get status update for a NON STATE TRANSITION type
* @param instanceName
* @param sessionId
* @param msgType
* @param msgId
* @return {@link PropertyKey}
*/
public PropertyKey taskError(String instanceName, String sessionId, String msgType,
String msgId) {
return new PropertyKey(ERRORS, null, _clusterName, instanceName, sessionId, msgType, msgId);
}
/**
* Get a property key associated with all {@link ExternalView}
* @return {@link PropertyKey}
*/
public PropertyKey externalViews() {
return new PropertyKey(EXTERNALVIEW, ExternalView.class, _clusterName);
}
/**
* Get a property key associated with an {@link ExternalView} of a resource
* @param resourceName
* @return {@link PropertyKey}
*/
public PropertyKey externalView(String resourceName) {
return new PropertyKey(EXTERNALVIEW, ExternalView.class, _clusterName, resourceName);
}
/**
* Get a property key associated with all {@link CustomizedView}
* @return {@link PropertyKey}
*/
public PropertyKey customizedViews() {
return new PropertyKey(CUSTOMIZEDVIEW, CustomizedView.class, _clusterName);
}
/**
* Get a property key associated with an {@link CustomizedView} of a type
* @param customizedStateType
* @return {@link PropertyKey}
*/
public PropertyKey customizedView(String customizedStateType) {
return new PropertyKey(CUSTOMIZEDVIEW, CustomizedView.class, _clusterName, customizedStateType);
}
/**
* Get a property key associated with an {@link CustomizedView} of a type and resource
* @param customizedStateType
* @return {@link PropertyKey}
*/
public PropertyKey customizedView(String customizedStateType, String resourceName) {
return new PropertyKey(CUSTOMIZEDVIEW, CustomizedView.class, _clusterName, customizedStateType,
resourceName);
}
/**
* Get a property key associated with all target external view
* @return {@link PropertyKey}
*/
public PropertyKey targetExternalViews() {
return new PropertyKey(TARGETEXTERNALVIEW, ExternalView.class, _clusterName);
}
/**
* Get a property key associated with an target external view of a resource
* @param resourceName
* @return {@link PropertyKey}
*/
public PropertyKey targetExternalView(String resourceName) {
return new PropertyKey(TARGETEXTERNALVIEW, ExternalView.class, _clusterName, resourceName);
}
/**
* Get a property key associated with a controller
* @return {@link PropertyKey}
*/
public PropertyKey controller() {
return new PropertyKey(CONTROLLER, null, _clusterName);
}
/**
* Get a property key associated with {@link Error} of controller errors
* @return {@link PropertyKey}
*/
public PropertyKey controllerTaskErrors() {
return new PropertyKey(ERRORS_CONTROLLER, Error.class, _clusterName);
}
/**
* Get a property key associated with {@link Error} of a controller error
* @param errorId
* @return {@link PropertyKey}
*/
public PropertyKey controllerTaskError(String errorId) {
return new PropertyKey(ERRORS_CONTROLLER, Error.class, _clusterName, errorId);
}
/**
* Get a property key associated with {@link StatusUpdate} of controller status updates
* @param subPath
* @return {@link PropertyKey}
*/
public PropertyKey controllerTaskStatuses(String subPath) {
return new PropertyKey(STATUSUPDATES_CONTROLLER, StatusUpdate.class, _clusterName, subPath);
}
/**
* Get a property key associated with {@link StatusUpdate} of a controller status update
* @param subPath
* @param recordName
* @return {@link PropertyKey}
*/
public PropertyKey controllerTaskStatus(String subPath, String recordName) {
return new PropertyKey(STATUSUPDATES_CONTROLLER, StatusUpdate.class, _clusterName, subPath,
recordName);
}
/**
* Get a property key associated with {@link StatusUpdate} of controller status updates
* @return {@link PropertyKey}
*/
public PropertyKey controllerTaskStatuses() {
return new PropertyKey(STATUSUPDATES_CONTROLLER, StatusUpdate.class, _clusterName);
}
/**
* Get a property key associated with all {@link Message}s for the controller
* @return {@link PropertyKey}
*/
public PropertyKey controllerMessages() {
return new PropertyKey(MESSAGES_CONTROLLER, Message.class, _clusterName);
}
/**
* Get a property key associated with a {@link Message} for the controller
* @param msgId
* @return {@link PropertyKey}
*/
public PropertyKey controllerMessage(String msgId) {
return new PropertyKey(MESSAGES_CONTROLLER, Message.class, _clusterName, msgId);
}
/**
* Get a property key associated with {@link ControllerHistory}
* @return {@link PropertyKey}
*/
public PropertyKey controllerLeaderHistory() {
return new PropertyKey(HISTORY, ControllerHistory.class, _clusterName);
}
/**
* Get a property key associated with a {@link LiveInstance} leader
* @return {@link PropertyKey}
*/
public PropertyKey controllerLeader() {
return new PropertyKey(LEADER, LiveInstance.class, _clusterName);
}
/**
* Get a property key associated with {@link PauseSignal}
* @return {@link PropertyKey}
*/
public PropertyKey pause() {
return new PropertyKey(PAUSE, PauseSignal.class, _clusterName);
}
/**
* Get a property key associated with {@link MaintenanceSignal}
* @return {@link PropertyKey}
*/
public PropertyKey maintenance() {
return new PropertyKey(MAINTENANCE, MaintenanceSignal.class, _clusterName);
}
/**
* Get a property key associated with a {@link HealthStat} for an instance
* @param instanceName
* @param id identifies the statistics
* @return {@link PropertyKey}
*/
public PropertyKey healthReport(String instanceName, String id) {
return new PropertyKey(PropertyType.HEALTHREPORT, HealthStat.class, _clusterName,
instanceName, id);
}
/**
* Get a property key associated with {@link HealthStat}s for an instance
* @param instanceName
* @return {@link PropertyKey}
*/
public PropertyKey healthReports(String instanceName) {
return new PropertyKey(PropertyType.HEALTHREPORT, HealthStat.class, _clusterName,
instanceName);
}
/**
* Get a PropertyKey associated with root path for Task Framework-related resources' configs.
* @return {@link PropertyKey}
*/
public PropertyKey workflowConfigZNodes() {
return new PropertyKey(PropertyType.TASK_CONFIG_ROOT, null, _clusterName);
}
/**
* Get a PropertyKey associated with root path for Task Framework-related resources' contexts.
* @return {@link PropertyKey}
*/
public PropertyKey workflowContextZNodes() {
return new PropertyKey(PropertyType.TASK_CONTEXT_ROOT, null, _clusterName);
}
/**
* Get a PropertyKey associated with {@link WorkflowConfig} for easier path generation.
* @param workflowName
* @return {@link PropertyKey}
*/
public PropertyKey workflowConfigZNode(String workflowName) {
return new PropertyKey(PropertyType.WORKFLOW_CONFIG, WorkflowConfig.class, _clusterName,
workflowName);
}
/**
* Get a PropertyKey associated with {@link WorkflowContext} for easier path generation.
* @param workflowName
* @return {@link PropertyKey}
*/
public PropertyKey workflowContextZNode(String workflowName) {
return new PropertyKey(PropertyType.WORKFLOW_CONTEXT, WorkflowContext.class, _clusterName,
workflowName);
}
/**
* Get a PropertyKey associated with {@link JobConfig} for easier path generation.
* @param workflowName
* @param jobName
* @return
*/
public PropertyKey jobConfigZNode(String workflowName, String jobName) {
return new PropertyKey(PropertyType.JOB_CONFIG, JobConfig.class, _clusterName, workflowName,
jobName);
}
/**
* Get a PropertyKey associated with {@link JobContext} for easier path generation.
* @param workflowName
* @param jobName
* @return
*/
public PropertyKey jobContextZNode(String workflowName, String jobName) {
return new PropertyKey(PropertyType.JOB_CONTEXT, JobContext.class, _clusterName,
workflowName, jobName);
}
/**
* Get a property key associated with {@link WorkflowContext} for easier path generation.
* TODO: Below returns the old path for WorkflowContexts
* @param workflowName
* @return {@link PropertyKey}
*/
@Deprecated
public PropertyKey workflowContext(String workflowName) {
return new PropertyKey(PropertyType.WORKFLOWCONTEXT, WorkflowContext.class, _clusterName,
workflowName);
}
/**
* Get a property key associated with {@link ResourceConfig}
* @return {@link PropertyKey}
*/
public PropertyKey restConfig() {
return new PropertyKey(RESTCONFIGS, RESTConfig.class, _clusterName);
}
}
/**
* Get the associated property type
* @return {@link PropertyType}
*/
public PropertyType getType() {
return _type;
}
/**
* Get parameters associated with the key
* @return the parameters in the same order they were provided
*/
public String[] getParams() {
return _params;
}
/**
* Get the associated class of this property
* @return subclass of {@link HelixProperty}
*/
public Class getTypeClass() {
return _typeClazz;
}
/**
* Get the scope of this property
* @return {@link ConfigScopeProperty}
*/
public ConfigScopeProperty getConfigScope() {
return _configScope;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy