2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.md.sal.common.api.clustering;
11 import com.google.common.base.Preconditions;
12 import javax.annotation.Nonnull;
13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
17 * A clustered Entity is something which is shared by multiple applications across a cluster. An Entity has a type
21 * The type describes the type of the Entity where examples of a type maybe "openflow" or "netconf"
22 * etc. An Entity type could be tied to how exactly an application shares and "owns" an entity. For example we may want
23 * an application which deals with the openflow entity to be assigned ownership of that entity based on a first come
24 * first served basis. On the other hand for netconf entity types we may want applications to gain ownership based on
25 * a load balancing approach. While this mechanism of assigning a ownership acquisition strategy is not finalized the
26 * intention is that the entity type will play a role in determining the strategy and thus should be put in place.
29 * The identifier is a YangInstanceIdentifier. The reason for the choice of YangInstanceIdentifier is because it
30 * can easily be used to represent a data node. For example an inventory node represents a shared entity and it is best
31 * referenced by the YangInstanceIdentifier if the inventory node stored in the data store.
34 public final class Entity {
36 private final String type;
37 private final YangInstanceIdentifier id;
40 * Construct a new Entity
42 * @param type the type of the entity
43 * @param id the identifier of the entity
45 public Entity(@Nonnull String type, @Nonnull YangInstanceIdentifier id) {
46 this.type = Preconditions.checkNotNull(type, "type should not be null");
47 this.id = Preconditions.checkNotNull(id, "id should not be null");
52 * @return id of entity
55 public YangInstanceIdentifier getId(){
61 * @return type of entity
64 public String getType(){
69 public boolean equals(Object o) {
74 if (o == null || getClass() != o.getClass()) {
78 Entity entity = (Entity) o;
80 if (!id.equals(entity.id)) {
84 if (!type.equals(entity.type)) {
92 public int hashCode() {
93 int result = type != null ? type.hashCode() : 0;
94 result = 31 * result + (id != null ? id.hashCode() : 0);
99 public String toString() {
100 final StringBuilder sb = new StringBuilder("Entity{");
101 sb.append("type='").append(type).append('\'');
102 sb.append(", id=").append(id);
104 return sb.toString();