Mercurial > hg > release > thermostat-0.13
view storage/core/src/main/java/com/redhat/thermostat/storage/core/Key.java @ 1176:f7961cf1e440
Convert VM IDs to UUIDs
This commit changes VM IDs used in VmRef and VmInfo to a randomly
generated UUID string. The VM PIDs are still stored, but are not used to
identify a specific VM. The motivation behind this change is that PIDs
can be reused by the OS, thus there is a chance we could have a PID that
refers to two different VMs (one alive, one dead). There are then
security implications if we return the wrong VM, which the client user
may not have access to. The VM's PID is still required when dealing with
external interfaces like /proc and JMX, but the data collected is placed
in storage using the VM's UUID.
Additionally, I have cleaned up the API in VmRef. I have removed
getIdString from VmRef since we already have a getStringID that does the
same thing. I've also changed VmRef.getAgent to getHostRef to more
accurately reflect what is returned.
Reviewed-by: jerboaa
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-July/007242.html
author | Elliott Baron <ebaron@redhat.com> |
---|---|
date | Thu, 18 Jul 2013 18:33:49 -0400 |
parents | ccac9bcabaa0 |
children |
line wrap: on
line source
/* * Copyright 2012, 2013 Red Hat, Inc. * * This file is part of Thermostat. * * Thermostat is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published * by the Free Software Foundation; either version 2, or (at your * option) any later version. * * Thermostat is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Thermostat; see the file COPYING. If not see * <http://www.gnu.org/licenses/>. * * Linking this code with other modules is making a combined work * based on this code. Thus, the terms and conditions of the GNU * General Public License cover the whole combination. * * As a special exception, the copyright holders of this code give * you permission to link this code with independent modules to * produce an executable, regardless of the license terms of these * independent modules, and to copy and distribute the resulting * executable under terms of your choice, provided that you also * meet, for each linked independent module, the terms and conditions * of the license of that module. An independent module is a module * which is not derived from or based on this code. If you modify * this code, you may extend this exception to your version of the * library, but you are not obligated to do so. If you do not wish * to do so, delete this exception statement from your version. */ package com.redhat.thermostat.storage.core; /** * A Key is used to refer to data in a {@link Chunk}. It may also be a partial key to the * set of data represented by a {@link Chunk} in a category. */ public class Key<T> { // Keys used by most Categories. public static final Key<Long> TIMESTAMP = new Key<>("timeStamp", false); public static final Key<String> AGENT_ID = new Key<>("agentId", true); public static final Key<String> VM_ID = new Key<>("vmId", true); public static final Key<String> ID = new Key<>("_id", false); private String name; private boolean isPartialCategoryKey; public Key() { // This is used only in de-serialization, e.g. using Gson, and therefore // we do not check the name for null or empty. super(); } public Key(String name, boolean isPartialCategoryKey) { if (name == null || name.length() == 0) { throw new IllegalArgumentException("A Key must have a non-null name of length >= 1."); } this.name = name; this.isPartialCategoryKey = isPartialCategoryKey; } public String getName() { return name; } public void setName(String name) { this.name = name; } public boolean isPartialCategoryKey() { return isPartialCategoryKey; } public void setPartialCategoryKey(boolean partialCategoryKey) { this.isPartialCategoryKey = partialCategoryKey; } @Override public boolean equals(Object o) { if (this == o) { return true; } if ((o == null) || (o.getClass() != this.getClass())) { return false; } Key<?> e = (Key<?>) o; return (isPartialCategoryKey == e.isPartialCategoryKey()) && name.equals(e.getName()); } @Override public int hashCode() { int hash = 1867; hash = hash * 37 + (isPartialCategoryKey ? 0 : 1); hash = hash * 37 + (name == null ? 0 : name.hashCode()); return hash; } @Override public String toString() { return "Key: " + name; } }