/**
* 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.
*/
package org.apache.ambari.server.controller.utilities;
import org.apache.ambari.server.controller.internal.PropertyInfo;
import org.apache.ambari.server.controller.internal.RequestImpl;
import org.apache.ambari.server.controller.spi.Request;
import org.apache.ambari.server.controller.spi.Resource;
import org.apache.ambari.server.controller.spi.TemporalInfo;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.type.TypeReference;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Utility class that provides Property helper methods.
*/
public class PropertyHelper {
private static final String PROPERTIES_FILE = "properties.json";
private static final String GANGLIA_PROPERTIES_FILE = "ganglia_properties.json";
private static final String JMX_PROPERTIES_FILE = "jmx_properties.json";
private static final String KEY_PROPERTIES_FILE = "key_properties.json";
private static final char EXTERNAL_PATH_SEP = '/';
private static final Map<Resource.InternalType, Set<String>> PROPERTY_IDS = readPropertyIds(PROPERTIES_FILE);
private static final Map<Resource.InternalType, Map<String, Map<String, PropertyInfo>>> JMX_PROPERTY_IDS = readPropertyProviderIds(JMX_PROPERTIES_FILE);
private static final Map<Resource.InternalType, Map<String, Map<String, PropertyInfo>>> GANGLIA_PROPERTY_IDS = readPropertyProviderIds(GANGLIA_PROPERTIES_FILE);
private static final Map<Resource.InternalType, Map<Resource.Type, String>> KEY_PROPERTY_IDS = readKeyPropertyIds(KEY_PROPERTIES_FILE);
/**
* Regular expression to check for replacement arguments (e.g. $1) in a property id.
*/
private static final Pattern CHECK_FOR_METRIC_ARGUMENTS_REGEX = Pattern.compile(".*\\$\\d+.*");
public static String getPropertyId(String category, String name) {
String propertyId = (category == null || category.isEmpty())? name :
(name == null || name.isEmpty()) ? category : category + EXTERNAL_PATH_SEP + name;
if (propertyId.endsWith("/")) {
propertyId = propertyId.substring(0, propertyId.length() - 1);
}
return propertyId;
}
public static Set<String> getPropertyIds(Resource.Type resourceType) {
Set<String> propertyIds = PROPERTY_IDS.get(resourceType.getInternalType());
return propertyIds == null ? Collections.<String>emptySet() : propertyIds;
}
/**
* Extract the set of property ids from a component PropertyInfo map.
*
* @param componentPropertyInfoMap the map
*
* @return the set of property ids
*/
public static Set<String> getPropertyIds(Map<String, Map<String, PropertyInfo>> componentPropertyInfoMap ) {
Set<String> propertyIds = new HashSet<String>();
for (Map.Entry<String, Map<String, PropertyInfo>> entry : componentPropertyInfoMap.entrySet()) {
propertyIds.addAll(entry.getValue().keySet());
}
return propertyIds;
}
public static Map<String, Map<String, PropertyInfo>> getGangliaPropertyIds(Resource.Type resourceType) {
return GANGLIA_PROPERTY_IDS.get(resourceType.getInternalType());
}
public static Map<String, Map<String, PropertyInfo>> getJMXPropertyIds(Resource.Type resourceType) {
return JMX_PROPERTY_IDS.get(resourceType.getInternalType());
}
public static Map<Resource.Type, String> getKeyPropertyIds(Resource.Type resourceType) {
return KEY_PROPERTY_IDS.get(resourceType.getInternalType());
}
/**
* Helper to get a property name from a string.
*
* @param absProperty the fully qualified property
*
* @return the property name
*/
public static String getPropertyName(String absProperty) {
int lastPathSep = absProperty.lastIndexOf(EXTERNAL_PATH_SEP);
return lastPathSep == -1 ? absProperty : absProperty.substring(lastPathSep + 1);
}
/**
* Helper to get a property category from a string.
*
* @param absProperty the fully qualified property
*
* @return the property category; null if there is no category
*/
public static String getPropertyCategory(String absProperty) {
int lastPathSep;
if (containsArguments(absProperty)) {
boolean inString = false;
for (lastPathSep = absProperty.length() - 1; lastPathSep > 0; --lastPathSep) {
char c = absProperty.charAt(lastPathSep);
if (c == '"') {
inString = !inString;
} else if (c == EXTERNAL_PATH_SEP && !inString) {
break;
}
}
} else {
lastPathSep = absProperty.lastIndexOf(EXTERNAL_PATH_SEP);
}
return lastPathSep == -1 ? null : absProperty.substring(0, lastPathSep);
}
/**
* Get the set of categories for the given property ids.
*
* @param propertyIds the property ids
*
* @return the set of categories
*/
public static Set<String> getCategories(Set<String> propertyIds) {
Set<String> categories = new HashSet<String>();
for (String property : propertyIds) {
String category = PropertyHelper.getPropertyCategory(property);
while (category != null) {
categories.add(category);
category = PropertyHelper.getPropertyCategory(category);
}
}
return categories;
}
/**
* Check if the given property id or one of its parent category ids is contained
* in the given set of property ids.
*
* @param propertyIds the set of property ids
* @param propertyId the property id
*
* @return true if the given property id of one of its parent category ids is
* contained in the given set of property ids
*/
public static boolean containsProperty(Set<String> propertyIds, String propertyId) {
if (propertyIds.contains(propertyId)){
return true;
}
String category = PropertyHelper.getPropertyCategory(propertyId);
while (category != null) {
if ( propertyIds.contains(category)) {
return true;
}
category = PropertyHelper.getPropertyCategory(category);
}
return false;
}
/**
* Check to see if the given property id contains replacement arguments (e.g. $1)
*
* @param propertyId the property id to check
*
* @return true if the given property id contains any replacement arguments
*/
public static boolean containsArguments(String propertyId) {
if (!propertyId.contains("$")) {
return false;
}
Matcher matcher = CHECK_FOR_METRIC_ARGUMENTS_REGEX.matcher(propertyId);
return matcher.find();
}
/**
* Get all of the property ids associated with the given request.
*
* @param request the request
*
* @return the associated properties
*/
public static Set<String> getAssociatedPropertyIds(Request request) {
Set<String> ids = request.getPropertyIds();
if (ids != null) {
ids = new HashSet<String>(ids);
} else {
ids = new HashSet<String>();
}
Set<Map<String, Object>> properties = request.getProperties();
if (properties != null) {
for (Map<String, Object> propertyMap : properties) {
ids.addAll(propertyMap.keySet());
}
}
return ids;
}
/**
* Get a map of all the property values keyed by property id for the given resource.
*
* @param resource the resource
*
* @return the map of properties for the given resource
*/
public static Map<String, Object> getProperties(Resource resource) {
Map<String, Object> properties = new HashMap<String, Object>();
Map<String, Map<String, Object>> categories = resource.getPropertiesMap();
for (Map.Entry<String, Map<String, Object>> categoryEntry : categories.entrySet()) {
for (Map.Entry<String, Object> propertyEntry : categoryEntry.getValue().entrySet()) {
properties.put(getPropertyId(categoryEntry.getKey(), propertyEntry.getKey()), propertyEntry.getValue());
}
}
return properties;
}
/**
* Factory method to create a create request from the given set of property maps.
* Each map contains the properties to be used to create a resource. Multiple maps in the
* set should result in multiple creates.
*
* @param properties resource properties associated with the request; may be null
* @param requestInfoProperties request specific properties; may be null
*/
public static Request getCreateRequest(Set<Map<String, Object>> properties,
Map<String, String> requestInfoProperties) {
return new RequestImpl(null, properties, requestInfoProperties, null);
}
/**
* Factory method to create a read request from the given set of property ids. The set of
* property ids represents the properties of interest for the query.
*
* @param propertyIds the property ids associated with the request; may be null
*/
public static Request getReadRequest(Set<String> propertyIds) {
return new RequestImpl(propertyIds, null, null, null);
}
/**
* Factory method to create a read request from the given set of property ids. The set of
* property ids represents the properties of interest for the query.
*
* @param propertyIds the property ids associated with the request; may be null
* @param mapTemporalInfo the temporal info
*/
public static Request getReadRequest(Set<String> propertyIds, Map<String,
TemporalInfo> mapTemporalInfo) {
return new RequestImpl(propertyIds, null, null, mapTemporalInfo);
}
/**
* Factory method to create a read request from the given set of property ids. The set of
* property ids represents the properties of interest for the query.
*
* @param propertyIds the property ids associated with the request; may be null
*/
public static Request getReadRequest(String ... propertyIds) {
return new RequestImpl(new HashSet<String>(Arrays.asList(propertyIds)), null, null, null);
}
/**
* Factory method to create an update request from the given map of properties.
* The properties values in the given map are used to update the resource.
*
* @param properties resource properties associated with the request; may be null
* @param requestInfoProperties request specific properties; may be null
*/
public static Request getUpdateRequest(Map<String, Object> properties,
Map<String, String> requestInfoProperties) {
return new RequestImpl(null, Collections.singleton(properties), requestInfoProperties, null);
}
private static Map<Resource.InternalType, Map<String, Map<String, PropertyInfo>>> readPropertyProviderIds(String filename) {
ObjectMapper mapper = new ObjectMapper();
try {
Map<Resource.InternalType, Map<String, Map<String, Metric>>> resourceMetricMap =
mapper.readValue(ClassLoader.getSystemResourceAsStream(filename),
new TypeReference<Map<Resource.InternalType, Map<String, Map<String, Metric>>>>() {});
Map<Resource.InternalType, Map<String, Map<String, PropertyInfo>>> resourceMetrics =
new HashMap<Resource.InternalType, Map<String, Map<String, PropertyInfo>>>();
for (Map.Entry<Resource.InternalType, Map<String, Map<String, Metric>>> resourceEntry : resourceMetricMap.entrySet()) {
Map<String, Map<String, PropertyInfo>> componentMetrics = new HashMap<String, Map<String, PropertyInfo>>();
for (Map.Entry<String, Map<String, Metric>> componentEntry : resourceEntry.getValue().entrySet()) {
Map<String, PropertyInfo> metrics = new HashMap<String, PropertyInfo>();
for (Map.Entry<String, Metric> metricEntry : componentEntry.getValue().entrySet()) {
String property = metricEntry.getKey();
Metric metric = metricEntry.getValue();
metrics.put(property, new PropertyInfo(metric.getMetric(), metric.isTemporal(), metric.isPointInTime()));
}
componentMetrics.put(componentEntry.getKey(), metrics);
}
resourceMetrics.put(resourceEntry.getKey(), componentMetrics);
}
return resourceMetrics;
} catch (IOException e) {
throw new IllegalStateException("Can't read properties file " + filename, e);
}
}
private static Map<Resource.InternalType, Set<String>> readPropertyIds(String filename) {
ObjectMapper mapper = new ObjectMapper();
try {
return mapper.readValue(ClassLoader.getSystemResourceAsStream(filename), new TypeReference<Map<Resource.InternalType, Set<String>>>() {
});
} catch (IOException e) {
throw new IllegalStateException("Can't read properties file " + filename, e);
}
}
private static Map<Resource.InternalType, Map<Resource.Type, String>> readKeyPropertyIds(String filename) {
ObjectMapper mapper = new ObjectMapper();
try {
Map<Resource.InternalType, Map<Resource.InternalType, String>> map =
mapper.readValue(ClassLoader.getSystemResourceAsStream(filename),
new TypeReference<Map<Resource.InternalType, Map<Resource.InternalType, String>>>() {});
Map<Resource.InternalType, Map<Resource.Type, String>> returnMap =
new HashMap<Resource.InternalType, Map<Resource.Type, String>>();
// convert inner maps from InternalType to Type
for (Map.Entry<Resource.InternalType, Map<Resource.InternalType, String>> entry : map.entrySet()) {
Map<Resource.Type, String> innerMap = new HashMap<Resource.Type, String>();
for (Map.Entry<Resource.InternalType, String> entry1 : entry.getValue().entrySet()) {
innerMap.put(Resource.Type.values()[entry1.getKey().ordinal()], entry1.getValue());
}
returnMap.put(entry.getKey(), innerMap);
}
return returnMap;
} catch (IOException e) {
throw new IllegalStateException("Can't read properties file " + filename, e);
}
}
protected static class Metric {
private String metric;
private boolean pointInTime;
private boolean temporal;
private Metric() {
}
protected Metric(String metric, boolean pointInTime, boolean temporal) {
this.metric = metric;
this.pointInTime = pointInTime;
this.temporal = temporal;
}
public String getMetric() {
return metric;
}
public void setMetric(String metric) {
this.metric = metric;
}
public boolean isPointInTime() {
return pointInTime;
}
public void setPointInTime(boolean pointInTime) {
this.pointInTime = pointInTime;
}
public boolean isTemporal() {
return temporal;
}
public void setTemporal(boolean temporal) {
this.temporal = temporal;
}
}
}