summaryrefslogtreecommitdiffstats
path: root/framework/src/onos/apps/demo/cord-gui/src/main/java/org/onosproject/cord/gui/model/SubscriberUser.java
blob: 812618217065f719a8c7cd255e55b1bba3fe89c4 (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
 * Copyright 2015 Open Networking Laboratory
 *
 * 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.onosproject.cord.gui.model;

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

/**
 * Designates a user of a subscriber's account.
 */
public class SubscriberUser {
    private final int id;
    private final String name;
    private final String mac;

    // this is "duplicated" in the URL_FILTER memento, but, oh well...
    // -- the level, as returned from XOS, when we create this user object.
    private String level;

    private final Map<XosFunctionDescriptor, XosFunction.Memento> mementos =
            new HashMap<XosFunctionDescriptor, XosFunction.Memento>();

    /**
     * Constructs a subscriber user from the given parameters.
     *
     * @param id internal identifier
     * @param name display name
     * @param mac MAC address of the associated device
     * @param level URL filter level
     */
    public SubscriberUser(int id, String name, String mac, String level) {
        this.id = id;
        this.name = name;
        this.mac = mac;
        this.level = level;
    }

    /**
     * Returns the internal identifier.
     *
     * @return the identifier
     */
    public int id() {
        return id;
    }

    /**
     * Returns the display name.
     *
     * @return display name
     */
    public String name() {
        return name;
    }

    /**
     * Returns the MAC address of the associated device.
     *
     * @return MAC address
     */
    public String mac() {
        return mac;
    }

    /**
     * Returns the URL filter level.
     *
     * @return URL filter level
     */
    public String urlFilterLevel() {
        return level;
    }

    /**
     * Sets the URL filter level.
     *
     * @param level URL filter level
     */
    public void setUrlFilterLevel(String level) {
        this.level = level;
    }

    /**
     * Stores a memento for the given XOS function.
     *
     * @param f XOS function
     * @param m memento
     */
    public void setMemento(XosFunctionDescriptor f, XosFunction.Memento m) {
        if (m != null) {
            mementos.put(f, m);
        }
    }

    /**
     * Returns the memento stored on this user, for the given XOS function.
     *
     * @param f XOS function
     * @return memento
     */
    public XosFunction.Memento getMemento(XosFunctionDescriptor f) {
        return mementos.get(f);
    }

    /**
     * Clears the memento map.
     */
    public void clearMementos() {
        mementos.clear();
    }

    @Override
    public String toString() {
        return "{User: " + name + "}";
    }
}