summaryrefslogtreecommitdiffstats
path: root/proxy/code/src/org/fedoraproject/candlepin/model/ConsumerInfo.java
blob: 2394bd48bc31e6bb4b8592af63775ce1958734e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/**
 * Copyright (c) 2009 Red Hat, Inc.
 *
 * This software is licensed to you under the GNU General Public License,
 * version 2 (GPLv2). There is NO WARRANTY for this software, express or
 * implied, including the implied warranties of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv2
 * along with this software; if not, see
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 * Red Hat trademarks are not licensed under GPLv2. No permission is
 * granted to use or replicate Red Hat trademarks that are incorporated
 * in this software or its documentation.
 */
package org.fedoraproject.candlepin.model;

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

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;

/**
 * ConsumerInfo contains the metadata about a given Consumer (parent). It is 
 * a series of (name,value) pairs which allows for a more flexible model of
 * defining attributes about a Consumer.
 * 
 * For example, for a system we might capture CPU type and architecture.
 */
@XmlRootElement
@XmlAccessorType(XmlAccessType.PROPERTY)
public class ConsumerInfo {
    
    private Consumer parent;
    private Map<String, String> metadata;
    
    /**
     * @return Returns the parent.
     */
    @XmlTransient
    public Consumer getParent() {
        return parent;
    }

    /**
     * @param parentIn The parent to set.
     */
    public void setParent(Consumer parentIn) {
        parent = parentIn;
    }
    
    /**
     * @return Returns the metadata.
     */
    public Map<String, String> getMetadata() {
        return metadata;
    }

    
    /**
     * @param metadataIn The metadata to set.
     */
    public void setMetadata(Map<String, String> metadataIn) {
        metadata = metadataIn;
    }
    
    /**
     * Set a metadata field
     * @param name to set
     * @param value to set
     */
    public void setMetadataField(String name, String value) {
        if (this.metadata == null) {
            metadata = new HashMap<String, String>();
        }
        metadata.put(name, value);
        
    }
    
    /**
     * Get a metadata field value
     * @param name of field to fetch
     * @return String field value.
     */
    public String getMetadataField(String name) {
       if (this.metadata != null) {
           return metadata.get(name);
       }
       return null;
    }
}