opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/Entity.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.md.sal.common.api.clustering;
  10
  11 import com.google.common.base.Preconditions;
  12 import java.io.Serializable;
  13 import javax.annotation.Nonnull;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16
  17 /**
  18  * A clustered Entity is something which is shared by multiple applications across a cluster. An Entity has a type
  19  * and an identifier.
  20  *
  21  * <p>
  22  * The type describes the type of the Entity where examples of a type maybe "openflow" or "netconf"
  23  * etc. An Entity type could be tied to how exactly an application shares and "owns" an entity. For example we may want
  24  * an application which deals with the openflow entity to be assigned ownership of that entity based on a first come
  25  * first served basis. On the other hand for netconf entity types we may want applications to gain ownership based on
  26  * a load balancing approach. While this mechanism of assigning a ownership acquisition strategy is not finalized the
  27  * intention is that the entity type will play a role in determining the strategy and thus should be put in place.
  28  *
  29  * <p>
  30  * The identifier is a YangInstanceIdentifier. The reason for the choice of YangInstanceIdentifier is because it
  31  * can easily be used to represent a data node. For example an inventory node represents a shared entity and it is best
  32  * referenced by the YangInstanceIdentifier if the inventory node is stored in the data store.
  33  *
  34  * <p>
  35  * Note that an entity identifier must conform to a valid yang schema. If there is no existing yang schema to
  36  * represent an entity, the general-entity yang model can be used.
  37  */
  38 public final class Entity implements Serializable {
  39     private static final long serialVersionUID = 1L;
  40
  41     private static final QName ENTITY_QNAME =
  42         org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.core.general.entity.rev150820.Entity.QNAME;
  43     private static final QName ENTITY_NAME = QName.create(ENTITY_QNAME, "name");
  44
  45     private final String type;
  46     private final YangInstanceIdentifier id;
  47
  48     /**
  49      * Construct an Entity with a YangInstanceIdentifier.
  50      *
  51      * @param type the type of the entity
  52      * @param id the identifier of the entity
  53      */
  54     public Entity(@Nonnull String type, @Nonnull YangInstanceIdentifier id) {
  55         this.type = Preconditions.checkNotNull(type, "type should not be null");
  56         this.id = Preconditions.checkNotNull(id, "id should not be null");
  57     }
  58
  59     /**
  60      * Construct an Entity with an with a name. The general-entity schema is used to construct the
  61      * YangInstanceIdentifier.
  62      *
  63      * @param type the type of the entity
  64      * @param entityName the name of the entity used to construct a general-entity YangInstanceIdentifier
  65      */
  66     public Entity(@Nonnull String type, @Nonnull String entityName) {
  67         this.type = Preconditions.checkNotNull(type, "type should not be null");
  68         this.id = YangInstanceIdentifier.builder().node(ENTITY_QNAME).nodeWithKey(ENTITY_QNAME, ENTITY_NAME,
  69                         Preconditions.checkNotNull(entityName, "entityName should not be null")).build();
  70     }
  71
  72     /**
  73      *
  74      * @return id of entity
  75      */
  76     @Nonnull
  77     public YangInstanceIdentifier getId(){
  78         return id;
  79     }
  80
  81     /**
  82      *
  83      * @return type of entity
  84      */
  85     @Nonnull
  86     public String getType(){
  87         return type;
  88     }
  89
  90     @Override
  91     public boolean equals(Object o) {
  92         if (this == o) {
  93             return true;
  94         }
  95
  96         if (o == null || getClass() != o.getClass()) {
  97             return false;
  98         }
  99
 100         Entity entity = (Entity) o;
 101
 102         if (!id.equals(entity.id)) {
 103             return false;
 104         }
 105
 106         if (!type.equals(entity.type)) {
 107             return false;
 108         }
 109
 110         return true;
 111     }
 112
 113     @Override
 114     public int hashCode() {
 115         return 31 * type.hashCode() + id.hashCode();
 116     }
 117
 118     @Override
 119     public String toString() {
 120         final StringBuilder sb = new StringBuilder("Entity{");
 121         sb.append("type='").append(type).append('\'');
 122         sb.append(", id=").append(id);
 123         sb.append('}');
 124         return sb.toString();
 125     }
 126 }