org.opennms.netmgt.model.OnmsResource Maven / Gradle / Ivy

Go to download
/*
 * Licensed to The OpenNMS Group, Inc (TOG) under one or more
 * contributor license agreements.  See the LICENSE.md file
 * distributed with this work for additional information
 * regarding copyright ownership.
 *
 * TOG licenses this file to You under the GNU Affero General
 * Public License Version 3 (the "License") or (at your option)
 * any later version.  You may not use this file except in
 * compliance with the License.  You may obtain a copy of the
 * License at:
 *
 *      https://www.gnu.org/licenses/agpl-3.0.txt
 *
 * 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.opennms.netmgt.model;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.springframework.util.Assert;

/**
 * OnmsResource class.
 */
public class OnmsResource implements Comparable {

    private final String m_name;
    private final Set m_attributes;
    private final OnmsResourceType m_resourceType;
    private final List m_resources;
    private final ResourcePath m_path;

    private String m_label;
    private String m_link;
    private OnmsEntity m_entity;
    private OnmsResource m_parent = null;
    private boolean m_attributesUpdatedWithResource = false;

    /**
     * Constructor for OnmsResource.
     *
     * @param name         a {@link java.lang.String} object.
     * @param label        a {@link java.lang.String} object.
     * @param resourceType a {@link org.opennms.netmgt.model.OnmsResourceType} object.
     * @param attributes   a {@link java.util.Set} object.
     */
    public OnmsResource(String name, String label,
                        OnmsResourceType resourceType, Set attributes, ResourcePath path) {
        this(name, label, resourceType, attributes, new ArrayList(0), path);
    }

    /**
     * Constructor for OnmsResource.
     *
     * @param name         a {@link java.lang.String} object.
     * @param label        a {@link java.lang.String} object.
     * @param resourceType a {@link org.opennms.netmgt.model.OnmsResourceType} object.
     * @param attributes   a {@link java.util.Set} object.
     * @param resources    a {@link java.util.List} object.
     */
    public OnmsResource(String name, String label,
                        OnmsResourceType resourceType, Set attributes,
                        List resources, ResourcePath path) {
        Assert.notNull(name, "name argument must not be null");
        Assert.notNull(label, "label argument must not be null");
        Assert.notNull(resourceType, "resourceType argument must not be null");
        Assert.notNull(attributes, "attributes argument must not be null");
        Assert.notNull(resources, "resources argument must not be null");
        Assert.notNull(path, "path argument must not be null");

        m_name = name;
        m_label = label;
        m_resourceType = resourceType;
        m_attributes = attributes;
        m_resources = resources;
        m_path = path;
    }

    /**
     * getName
     *
     * @return a {@link java.lang.String} object.
     */
    public String getName() {
        return m_name;
    }

    /**
     * getLabel
     *
     * @return a {@link java.lang.String} object.
     */
    public String getLabel() {
        return m_label;
    }

    /**
     * setLabel
     *
     * @param label a {@link java.lang.String} object.
     */
    public void setLabel(String label) {
        m_label = label;
    }

    /**
     * getResourceType
     *
     * @return a {@link org.opennms.netmgt.model.OnmsResourceType} object.
     */
    public OnmsResourceType getResourceType() {
        return m_resourceType;
    }

    /**
     * getAttributes
     *
     * @return a {@link java.util.Set} object.
     */
    public Set getAttributes() {
        // Only update the attribute with the resource on the first get
        // In some cases the attributes will be stored in a lazy set
        // so we don't want to preemptively load it
        if (!m_attributesUpdatedWithResource) {
            for (OnmsAttribute attribute : m_attributes) {
                attribute.setResource(this);
            }
            m_attributesUpdatedWithResource = true;
        }
        return m_attributes;
    }

    /**
     * getChildResources
     *
     * @return a {@link java.util.List} object.
     */
    public List getChildResources() {
        return m_resources;
    }

    /**
     * compareTo
     *
     * @param o a {@link org.opennms.netmgt.model.OnmsResource} object.
     * @return a int.
     */
    @Override
    // FIXME This doesn't seem to be correct, for example Fa0_1 could exist on multiple devices, so it should include the nodeId or the parent resource
    public int compareTo(OnmsResource o) {
        return getLabel().compareTo(o.getLabel());
    }

    /**
     * Sorts the List of Resources and returns a new List of the
     * generic type Resource.
     *
     * @param resources list of Resource objects.  This will be
     *                  sorted using Collections.sort, and note that this will modify
     *                  the provided list.
     * @return a sorted list
     */
    public static List sortIntoResourceList(List resources) {
        Collections.sort(resources);

        ArrayList outputResources =
                new ArrayList(resources.size());
        for (OnmsResource resource : resources) {
            outputResources.add(resource);
        }

        return outputResources;
    }

    /**
     * setParent
     *
     * @param parent a {@link org.opennms.netmgt.model.OnmsResource} object.
     */
    public void setParent(OnmsResource parent) {
        m_parent = parent;
    }

    /**
     * getParent
     *
     * @return a {@link org.opennms.netmgt.model.OnmsResource} object.
     */
    public OnmsResource getParent() {
        return m_parent;
    }

    /**
     * getId
     *
     * @return a {@link java.lang.String} object.
     */
    public ResourceId getId() {
        if (this.getParent() != null) {
            return getParent().getId().resolve(getResourceType().getName(), getName());
        } else {
            return ResourceId.get(getResourceType().getName(), getName());
        }
    }

    /**
     * getLink
     *
     * @return a {@link java.lang.String} object.
     */
    public String getLink() {
        if (m_link != null) {
            return m_link;
        } else {
            return m_resourceType.getLinkForResource(this);
        }
    }

    /**
     * setLink
     *
     * @param link a {@link java.lang.String} object.
     */
    public void setLink(String link) {
        m_link = link;
    }

    /**
     * Get the RRD graph attributes for this resource, if any.
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getRrdGraphAttributes() {
        Map attributes = new HashMap();
        for (OnmsAttribute attribute : getAttributes()) {
            if (RrdGraphAttribute.class.isAssignableFrom(attribute.getClass())) {
                RrdGraphAttribute graphAttribute = (RrdGraphAttribute) attribute;
                attributes.put(graphAttribute.getName(), graphAttribute);
            }
        }

        return attributes;
    }

    /**
     * Get the string property attributes for this resource, if any.
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getStringPropertyAttributes() {
        Map properties = new HashMap();
        for (OnmsAttribute attribute : getAttributes()) {
            if (StringPropertyAttribute.class.isAssignableFrom(attribute.getClass())) {
                StringPropertyAttribute stringAttribute = (StringPropertyAttribute) attribute;
                properties.put(stringAttribute.getName(), stringAttribute.getValue());
            }
        }

        return properties;
    }

    /**
     * Get the external value attributes for this resource, if any.
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getExternalValueAttributes() {
        Map properties = new HashMap();
        for (OnmsAttribute attribute : getAttributes()) {
            if (ExternalValueAttribute.class.isAssignableFrom(attribute.getClass())) {
                ExternalValueAttribute externalValueAttribute = (ExternalValueAttribute) attribute;
                properties.put(externalValueAttribute.getName(), externalValueAttribute.getValue());
            }
        }

        return properties;
    }

    /**
     * toString
     *
     * @return a {@link java.lang.String} object.
     */
    @Override
    public String toString() {
        return getId().toString();
    }

    /**
     * getEntity
     *
     * @return a {@link org.opennms.netmgt.model.OnmsEntity} object.
     */
    public OnmsEntity getEntity() {
        return m_entity;
    }

    /**
     * setEntity
     *
     * @param entity a {@link org.opennms.netmgt.model.OnmsEntity} object.
     */
    public void setEntity(OnmsEntity entity) {
        m_entity = entity;
    }

    public ResourcePath getPath() {
        return m_path;
    }

}