apps/demo/cord-gui/src/main/java/org/onosproject/cord/gui/model/SubscriberUser.java

/*
 * Copyright 2015-present 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 + "}";
    }
}