/*
* Copyright 2014 the original author or authors.
*
* Licensed 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.springframework.xd.dirt.cluster;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.Function;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
/**
* Metadata for a Container instance.
*
* @author Mark Fisher
* @author David Turanski
* @author Ilayaperumal Gopinathan
*/
public class ContainerAttributes implements Map<String, String>, Comparable<ContainerAttributes> {
public final static String CONTAINER_ID_KEY = "id";
public final static String HOST_KEY = "host";
public final static String PROCESS_ID_KEY = "pid";
public final static String GROUPS_KEY = "groups";
public final static String IP_ADDRESS_KEY = "ip";
private final List<String> commonAttributeKeys = Arrays.asList(new String[] { CONTAINER_ID_KEY, PROCESS_ID_KEY,
HOST_KEY,
IP_ADDRESS_KEY, GROUPS_KEY });
/**
* The underlying map.
*/
private final Map<String, String> map = new HashMap<String, String>();
/**
* Default constructor generates a random id.
*/
public ContainerAttributes() {
this(UUID.randomUUID().toString());
}
/**
* Constructor to be called when the id is already known.
*
* @param id the container's id
*/
public ContainerAttributes(String id) {
Assert.hasText(id, "id is required");
this.put(CONTAINER_ID_KEY, id);
}
/**
* Constructor to be called when the attributes are already known. If an id is not present in the map, one will be
* generated.
*
* @param attributes the container's attributes
*/
public ContainerAttributes(Map<? extends String, ? extends String> attributes) {
Assert.notNull(attributes, "attributes must not be null");
if (!attributes.containsKey(CONTAINER_ID_KEY)) {
this.put(CONTAINER_ID_KEY, UUID.randomUUID().toString());
}
this.putAll(attributes);
}
public String getId() {
return this.get(CONTAINER_ID_KEY);
}
public String getHost() {
return this.get(HOST_KEY);
}
public String getIp() {
return this.get(IP_ADDRESS_KEY);
}
public int getPid() {
return Integer.parseInt(this.get(PROCESS_ID_KEY));
}
public Set<String> getGroups() {
Set<String> groupSet = new HashSet<String>();
String groups = this.get(GROUPS_KEY);
groupSet = StringUtils.hasText(groups) ? StringUtils.commaDelimitedListToSet(groups) : new HashSet<String>();
return Collections.unmodifiableSet(groupSet);
}
public ContainerAttributes setPid(Integer pid) {
this.put(PROCESS_ID_KEY, String.valueOf(pid));
return this;
}
public ContainerAttributes setHost(String host) {
this.put(HOST_KEY, host);
return this;
}
public ContainerAttributes setIp(String ip) {
this.put(IP_ADDRESS_KEY, ip);
return this;
}
/**
* Retrieve the custom attributes for this container. This will not include the values for common keys:
* {@value #CONTAINER_ID_KEY}, {@value #PROCESS_ID_KEY}, {@value #HOST_KEY}, {@value #IP_ADDRESS_KEY} and
* {@value #GROUPS_KEY}
*
* @return the map of custom attributes
*/
public Map<String, String> getCustomAttributes() {
Map<String, String> customAttributes = new HashMap<String, String>();
for (String key : this.keySet()) {
if (!commonAttributeKeys.contains(key)) {
customAttributes.put(key, this.get(key));
}
}
return customAttributes;
}
/**
* {@inheritDoc}
*/
@Override
public int size() {
return map.size();
}
/**
* {@inheritDoc}
*/
@Override
public boolean isEmpty() {
return map.isEmpty();
}
/**
* {@inheritDoc}
*/
@Override
public boolean containsKey(Object key) {
return map.containsKey(key);
}
/**
* {@inheritDoc}
*/
@Override
public boolean containsValue(Object value) {
return map.containsValue(value);
}
/**
* {@inheritDoc}
*/
@Override
public String get(Object key) {
return map.get(key);
}
/**
* {@inheritDoc}
*/
@Override
public String put(String key, String value) {
return map.put(key, value);
}
/**
* {@inheritDoc}
*/
@Override
public String remove(Object key) {
return map.remove(key);
}
/**
* {@inheritDoc}
*/
@Override
public void putAll(Map<? extends String, ? extends String> m) {
map.putAll(m);
}
/**
* {@inheritDoc}
*/
@Override
public void clear() {
this.map.clear();
}
/**
* {@inheritDoc}
*/
@Override
public Set<String> keySet() {
return Collections.unmodifiableSet(map.keySet());
}
/**
* {@inheritDoc}
*/
@Override
public Collection<String> values() {
return Collections.unmodifiableCollection(map.values());
}
/**
* {@inheritDoc}
*/
@Override
public Set<java.util.Map.Entry<String, String>> entrySet() {
return Collections.unmodifiableSet(map.entrySet());
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return map.toString();
}
/**
* Compares using the containerId.
*/
@Override
public int compareTo(ContainerAttributes other) {
return this.getId().compareTo(other.getId());
}
@Override
public String getOrDefault(Object key, String defaultValue) {
// TODO Auto-generated method stub
return null;
}
@Override
public void forEach(BiConsumer<? super String, ? super String> action) {
// TODO Auto-generated method stub
}
@Override
public void replaceAll(
BiFunction<? super String, ? super String, ? extends String> function) {
// TODO Auto-generated method stub
}
@Override
public String putIfAbsent(String key, String value) {
// TODO Auto-generated method stub
return null;
}
@Override
public boolean remove(Object key, Object value) {
// TODO Auto-generated method stub
return false;
}
@Override
public boolean replace(String key, String oldValue, String newValue) {
// TODO Auto-generated method stub
return false;
}
@Override
public String replace(String key, String value) {
// TODO Auto-generated method stub
return null;
}
@Override
public String computeIfAbsent(String key,
Function<? super String, ? extends String> mappingFunction) {
// TODO Auto-generated method stub
return null;
}
@Override
public String computeIfPresent(
String key,
BiFunction<? super String, ? super String, ? extends String> remappingFunction) {
// TODO Auto-generated method stub
return null;
}
@Override
public String compute(
String key,
BiFunction<? super String, ? super String, ? extends String> remappingFunction) {
// TODO Auto-generated method stub
return null;
}
@Override
public String merge(
String key,
String value,
BiFunction<? super String, ? super String, ? extends String> remappingFunction) {
// TODO Auto-generated method stub
return null;
}
}