org.apache.brooklyn.rest.domain.AdjunctSummary Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.brooklyn.rest.domain;

import java.io.Serializable;
import java.net.URI;
import java.util.Map;
import java.util.Objects;

import org.apache.brooklyn.api.entity.Entity;
import org.apache.brooklyn.api.objs.BrooklynObjectType;
import org.apache.brooklyn.api.objs.EntityAdjunct;
import org.apache.brooklyn.api.objs.HighlightTuple;
import org.apache.brooklyn.api.objs.Identifiable;
import org.apache.brooklyn.api.typereg.RegisteredType;
import org.apache.brooklyn.core.objs.AbstractEntityAdjunct;
import org.apache.brooklyn.core.typereg.RegisteredTypes;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.google.common.collect.ImmutableMap;

public class AdjunctSummary implements HasName, Serializable, Identifiable {

    private static final long serialVersionUID = -8106551648118942612L;
    
    private String id;
    private String name;
    private BrooklynObjectType adjunctType;
    @JsonInclude(Include.NON_EMPTY)
    private String catalogItemId;
    @JsonInclude(Include.NON_EMPTY)
    private String description;
    @JsonInclude(Include.NON_EMPTY)
    private String iconUrl;
    private Status state;
    @JsonInclude(Include.NON_EMPTY)
    private Map highlights;
    
    private Map links;

    // for json
    protected AdjunctSummary() {}
    
    public AdjunctSummary(EntityAdjunct a) {
        id = a.getId();
        name = a.getDisplayName();
        adjunctType = BrooklynObjectType.of(a);
        catalogItemId = a.getCatalogItemId();
        highlights = a.getHighlights();
        if (a instanceof AbstractEntityAdjunct && catalogItemId!=null) {
            RegisteredType type = ((AbstractEntityAdjunct)a).getManagementContext().getTypeRegistry().get(catalogItemId);
            if (notObviouslyInvalidForAdjunct(a, type)) {
                iconUrl = RegisteredTypes.getIconUrl(a);
                description = type.getDescription();
            }
        }
    }
    
    // temporary method while catalogItemId is still allowed to contain a context entity - exclude such items for now
    private boolean notObviouslyInvalidForAdjunct(EntityAdjunct a, RegisteredType type) {
        if (type==null) return false;
        if (type.getSuperTypes().isEmpty()) return true;
        for (Object t: type.getSuperTypes()) {
            if (t instanceof Class && EntityAdjunct.class.isAssignableFrom((Class)t)) return true;
            if (t instanceof Class && Entity.class.isAssignableFrom((Class)t)) return false;
        }
        return true;
    }

    protected AdjunctSummary(
            String id,
            String name,
            BrooklynObjectType adjunctType,
            String catalogItemId,
            Status state,
            Map highlights,
            Map links) {
        this.id = id;
        this.name = name;
        this.adjunctType = adjunctType;
        this.catalogItemId = catalogItemId;
        this.state = state;
        this.highlights = (highlights == null) ? ImmutableMap.of() : ImmutableMap.copyOf(highlights);
        this.links = (links == null) ? ImmutableMap. of() : ImmutableMap.copyOf(links);
    }

    @Override
    public String getId() {
        return id;
    }

    @Override
    public String getName() {
        return name;
    }

    public BrooklynObjectType getAdjunctType() {
        return adjunctType;
    }
    
    public String getCatalogItemId() {
        return catalogItemId;
    }

    public String getDescription() {
        return description;
    }
    
    public String getIconUrl() {
        return iconUrl;
    }
    
    public Status getState() {
        return state;
    }

    public Map getHighlights() {
        return highlights;
    }

    public Map getLinks() {
        return links;
    }
    
    public AdjunctSummary iconUrl(String iconUrl) {
        this.iconUrl = iconUrl; return this;
    }
    
    public AdjunctSummary state(Status state) {
        this.state = state; return this;
    }
    
    public AdjunctSummary links(Map links) {
        this.links = links; return this;
    }

    
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof AdjunctSummary)) return false;
        AdjunctSummary that = (AdjunctSummary) o;
        return Objects.equals(id, that.id) &&
                Objects.equals(name, that.name) &&
                Objects.equals(adjunctType, that.adjunctType) &&
                Objects.equals(catalogItemId, that.catalogItemId) &&
                Objects.equals(state, that.state) &&
                Objects.equals(highlights, that.highlights) &&
                Objects.equals(links, that.links) ;
    }

    @Override
    public int hashCode() {
        return Objects.hash(id, name, adjunctType, catalogItemId, state, highlights, links);
    }

    @Override
    public String toString() {
        return (adjunctType!=null ? adjunctType.name() : "AdjunctSummary")+"{" +
                "id='" + id + '\'' +
                ", name='" + name + '\'' +
                ", catalogItemId='" + catalogItemId + '\'' +
                ", state='" + state + '\'' +
                ", highlights=" + highlights +
                ", links=" + links +
                '}';
    }

}