pkuwm commented on a change in pull request #653: add Helix properties factory and class URL: https://github.com/apache/helix/pull/653#discussion_r367799825
########## File path: helix-core/src/main/java/org/apache/helix/HelixCloudProperty.java ########## @@ -0,0 +1,179 @@ +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.io.InputStream; +import java.util.Collections; +import java.util.List; +import java.util.Properties; +import org.apache.helix.cloud.constants.CloudProvider; +import org.apache.helix.model.CloudConfig; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +/** + * Hold helix cloud properties read from CloudConfig and user defined files. Clients may override the fields from their application. + */ +public class HelixCloudProperty { + private static final Logger LOG = LoggerFactory.getLogger(HelixCloudProperty.class.getName()); + private static final String AZURE_CLOUD_PROPERTY_FILE = SystemPropertyKeys.AZURE_CLOUD_PROPERTIES; + private static final String CLOUD_INFO_SOURCE = "cloud_info_source"; + private static final String CLOUD_INFO_PROCESSFOR_NAME = "cloud_info_processor_name"; + private static final String CLOUD_MAX_RETRY = "cloud_max_retry"; + private static final String CONNECTION_TIMEOUT_MS = "connection_timeout_ms"; + private static final String REQUEST_TIMEOUT_MS = "request_timeout_ms"; + + // Denote whether the instance is considered as in a cloud environment. + private boolean _isCloudEnabled; + + // Unique id of the cloud environment where the instance is in. + private String _cloudId; + + // Cloud environment provider, e.g. Azure, AWS, GCP, etc. + private String _cloudProvider; + + // The sources where the cloud instance information can be retrieved from. + private List<String> _cloudInfoSources; + + // The name of the function that will fetch and parse cloud instance information. + private String _cloudInfoProcessorName; + + // Http max retry times when querying the cloud instance information from cloud environment. + private int _cloudMaxRetry; + + // Http connection time when querying the cloud instance information from cloud environment. + private long _cloudConnectionTimeout; + + // Http request timeout when querying the cloud instance information from cloud environment. + private long _cloudRequestTimeout; + + // Other customized properties that may be used. + private Properties _customizedCloudProperties = new Properties(); + + /** + * Initialize Helix Cloud Property based on the provider + * @param + */ + public HelixCloudProperty(CloudConfig cloudConfig) { + setCloudEndabled(cloudConfig.isCloudEnabled()); + if (cloudConfig.isCloudEnabled() == true) { + setCloudId(cloudConfig.getCloudID()); + setCloudProvider(cloudConfig.getCloudProvider()); + switch (CloudProvider.valueOf(cloudConfig.getCloudProvider())) { + case AZURE: + Properties azureProperties = new Properties(); + try { + InputStream stream = Thread.currentThread().getContextClassLoader().getResourceAsStream(AZURE_CLOUD_PROPERTY_FILE); + azureProperties.load(stream); + } catch (Exception e) { + String errMsg = "failed to open Helix Azure cloud properties file: " + AZURE_CLOUD_PROPERTY_FILE; + throw new IllegalArgumentException(errMsg, e); + } + LOG.info("Successfully loaded Helix Azure cloud properties: " + azureProperties); + setCloudInfoSources(Collections.singletonList(azureProperties.getProperty(CLOUD_INFO_SOURCE))); + setCloudInfoProcessorName(azureProperties.getProperty(CLOUD_INFO_PROCESSFOR_NAME)); + setCloudMaxRetry(azureProperties.getProperty(CLOUD_MAX_RETRY)); + setCloudConnectionTimeout(azureProperties.getProperty(CONNECTION_TIMEOUT_MS)); + setCloudRequestTimeout(azureProperties.getProperty(REQUEST_TIMEOUT_MS)); + break; + case CUSTOMIZED: + setCloudInfoSources(cloudConfig.getCloudInfoSources()); + setCloudInfoProcessorName(cloudConfig.getCloudInfoProcessorName()); + break; + default: + LOG.info("Unsupported cloud provider: " + cloudConfig.getCloudProvider()); + throw new HelixException(String.format("Unsupported cloud provider: %s", cloudConfig.getCloudProvider())); + } + } + } + + public boolean getCloudEnabled() { + return _isCloudEnabled; + } + + public String getCloudId() { + return _cloudId; + } + + public String getCloudProvider() { + return _cloudProvider; + } + + public List<String> getCloudInfoSources() { + return _cloudInfoSources; + } + + public String getCloudInfoProcessorName() { + return _cloudInfoProcessorName; + } + + public int getCloudMaxRetry() { + return _cloudMaxRetry; + } + + public long getCloudConnectionTimeout() { + return _cloudConnectionTimeout; + } + + public long getCloudRequestTimeout() { + return _cloudRequestTimeout; + } + + public Properties getCustomizedCloudProperties() { + return _customizedCloudProperties; + } + + public void setCloudEndabled(boolean isCloudEnabled) { + _isCloudEnabled = isCloudEnabled; + } + + public void setCloudId(String cloudId) { + _cloudId = cloudId; + } + + public void setCloudProvider(String cloudProvider) { + _cloudProvider = cloudProvider; + } + + public void setCloudInfoSources(List<String> sources) { + _cloudInfoSources = sources; + } + + public void setCloudInfoProcessorName(String cloudInfoProcessorName) { + _cloudInfoProcessorName = cloudInfoProcessorName; + } + + public void setCloudMaxRetry(String cloudMaxRetry) { + _cloudMaxRetry = Integer.valueOf(cloudMaxRetry); + } + + public void setCloudConnectionTimeout(String cloudConnectionTimeout) { + _cloudConnectionTimeout = Long.valueOf(cloudConnectionTimeout); + } + + public void setCloudRequestTimeout(String cloudRequestTimeout) { Review comment: From the comment of the class: the fields could be changed by clients. So I think the parameter type could be `long` so it is consistent with the field type. And clients don't have to convert a long type timeout to a string. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
