view storage/core/src/main/java/com/redhat/thermostat/storage/model/VmInfo.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 8757e35030f2
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.model;

import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import com.redhat.thermostat.storage.core.Entity;
import com.redhat.thermostat.storage.core.Persist;

@Entity
public class VmInfo extends BasePojo {

    @Entity
    public static class KeyValuePair implements Pojo {
    
        private String key;
        private String value;

        public KeyValuePair() {
            this(null, null);
        }

        public KeyValuePair(String key, String value) {
            this.key = key;
            this.value = value;
        }

        @Persist
        public String getKey() {
            return key;
        }

        @Persist
        public void setKey(String key) {
            this.key = key;
        }

        @Persist
        public String getValue() {
            return value;
        }

        @Persist
        public void setValue(String value) {
            this.value = value;
        }

        
    }

    private String vmId;
    private int vmPid = 0;
    private long startTime = System.currentTimeMillis();
    private long stopTime = Long.MIN_VALUE;
    private String javaVersion = "unknown";
    private String javaHome = "unknown";
    private String javaCommandLine = "unknown";
    private String mainClass = "unknown";
    private String vmName = "unknown";
    private String vmInfo = "unknown";
    private String vmVersion = "unknown";
    private String vmArguments = "unknown";
    private Map<String, String> properties = new HashMap<String, String>();
    private Map<String, String> environment = new HashMap<String, String>();
    private String[] loadedNativeLibraries;
    private long uid;
    private String username;

    public VmInfo() {
        /* use defaults */
    }

    public VmInfo(String vmId, int vmPid, long startTime, long stopTime,
            String javaVersion, String javaHome,
            String mainClass, String commandLine,
            String vmName, String vmInfo, String vmVersion, String vmArguments,
            Map<String, String> properties, Map<String, String> environment, String[] loadedNativeLibraries,
            long uid, String username) {
        this.vmId = vmId;
        this.vmPid = vmPid;
        this.startTime = startTime;
        this.stopTime = stopTime;
        this.javaVersion = javaVersion;
        this.javaHome = javaHome;
        this.mainClass = mainClass;
        this.javaCommandLine = commandLine;
        this.vmName = vmName;
        this.vmInfo = vmInfo;
        this.vmVersion = vmVersion;
        this.vmArguments = vmArguments;
        this.properties = properties;
        this.environment = environment;
        this.loadedNativeLibraries = loadedNativeLibraries;
        this.uid = uid;
        this.username = username;
    }

    @Persist
    public String getVmId() {
        return vmId;
    }

    @Persist
    public void setVmId(String vmId) {
        this.vmId = vmId;
    }

    @Persist
    public int getVmPid() {
        return vmPid;
    }

    @Persist
    public void setVmPid(int vmPid) {
        this.vmPid = vmPid;
    }

    @Persist
    public long getStartTimeStamp() {
        return startTime;
    }

    @Persist
    public void setStartTimeStamp(long startTime) {
        this.startTime = startTime;
    }

    @Persist
    public long getStopTimeStamp() {
        return stopTime;
    }

    @Persist
    public void setStopTimeStamp(long stopTime) {
        this.stopTime = stopTime;
    }

    @Persist
    public String getJavaVersion() {
        return javaVersion;
    }

    @Persist
    public void setJavaVersion(String javaVersion) {
        this.javaVersion = javaVersion;
    }

    @Persist
    public String getJavaHome() {
        return javaHome;
    }

    @Persist
    public void setJavaHome(String javaHome) {
        this.javaHome = javaHome;
    }

    @Persist
    public String getMainClass() {
        return mainClass;
    }

    @Persist
    public void setMainClass(String mainClass) {
        this.mainClass = mainClass;
    }

    @Persist
    public String getJavaCommandLine() {
        return javaCommandLine;
    }

    @Persist
    public void setJavaCommandLine(String javaCommandLine) {
        this.javaCommandLine = javaCommandLine;
    }

    @Persist
    public String getVmName() {
        return vmName;
    }

    @Persist
    public void setVmName(String vmName) {
        this.vmName = vmName;
    }

    @Persist
    public String getVmArguments() {
        return vmArguments;
    }

    @Persist
    public void setVmArguments(String vmArguments) {
        this.vmArguments = vmArguments;
    }

    @Persist
    public String getVmInfo() {
        return vmInfo;
    }

    @Persist
    public void setVmInfo(String vmInfo) {
        this.vmInfo = vmInfo;
    }

    @Persist
    public String getVmVersion() {
        return vmVersion;
    }

    @Persist
    public void setVmVersion(String vmVersion) {
        this.vmVersion = vmVersion;
    }

    public boolean isAlive() {
        return getStartTimeStamp() > getStopTimeStamp();
    }
    
    public Map<String, String> getProperties() {
        return properties;
    }

    public void setProperties(Map<String, String> properties) {
        this.properties = properties;
    }

    @Persist
    public KeyValuePair[] getPropertiesAsArray() {
        return getMapAsArray(properties);
    }

    @Persist
    public void setPropertiesAsArray(KeyValuePair[] properties) {
        this.properties = getArrayAsMap(properties);
    }

    public Map<String, String> getEnvironment() {
        return environment;
    }

    public void setEnvironment(Map<String, String> environment) {
        this.environment = environment;
    }

    @Persist
    public KeyValuePair[] getEnvironmentAsArray() {
        return getMapAsArray(environment);
    }

    @Persist
    public void setEnvironmentAsArray(KeyValuePair[] environment) {
        this.environment = getArrayAsMap(environment);
    }

    private KeyValuePair[] getMapAsArray(Map<String, String> map) {
        if (map == null) {
            return null;
        }
        Set<String> keys = map.keySet();
        KeyValuePair[] tuples = new KeyValuePair[keys.size()];
        int i = 0;
        for (String key: keys) {
            tuples[i] = new KeyValuePair(key, map.get(key));
            i++;
        }
        return tuples;
    }

    private Map<String,String> getArrayAsMap(KeyValuePair[] tuples) {
        if (tuples == null) {
            return null;
        }
        Map<String,String> map = new HashMap<>();
        for (KeyValuePair tuple : tuples) {
            map.put(tuple.getKey(), tuple.getValue());
        }
        return map;
    }

    @Persist
    public String[] getLoadedNativeLibraries() {
        return loadedNativeLibraries;
    }

    @Persist
    public void setLoadedNativeLibraries(String[] loadedNativeLibraries) {
        this.loadedNativeLibraries = loadedNativeLibraries;
    }
    
    /**
     * Returns the system user id for the owner of this JVM process,
     * or -1 if an owner could not be found.
     */
    @Persist
    public long getUid() {
        return uid;
    }
    
    @Persist
    public void setUid(long uid) {
        this.uid = uid;
    }
    
    /**
     * Returns the system user name for the owner of this JVM process,
     * or null if an owner could not be found.
     */
    @Persist
    public String getUsername() {
        return username;
    }
    
    @Persist
    public void setUsername(String username) {
        this.username = username;
    }
}