Bug 4105: Add EntityOwnerDataChangeListener
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / entityownership / EntityOwnersModel.java
1 /*
2  * Copyright (c) 2015 Brocade Communications 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 package org.opendaylight.controller.cluster.datastore.entityownership;
9
10 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.EntityOwners;
11 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.EntityType;
12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.entity.type.entity.Candidate;
13 import org.opendaylight.yangtools.yang.common.QName;
14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
16 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
17 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
18 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
20 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
21 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
22
23 /**
24  * Utility methods for entity-owners yang model.
25  *
26  * @author Thomas Pantelis
27  */
28 final class EntityOwnersModel {
29     static final  QName ENTITY_QNAME = org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.
30             md.sal.clustering.entity.owners.rev150804.entity.owners.entity.type.Entity.QNAME;
31     static final QName CANDIDATE_NAME_QNAME = QName.create(Candidate.QNAME, "name");
32     static final QName ENTITY_ID_QNAME = QName.create(ENTITY_QNAME, "id");
33     static final QName ENTITY_OWNER_QNAME = QName.create(ENTITY_QNAME, "owner");
34     static final QName ENTITY_TYPE_QNAME = QName.create(EntityType.QNAME, "type");
35
36     static final NodeIdentifier ENTITY_OWNERS_NODE_ID = new NodeIdentifier(EntityOwners.QNAME);
37     static final NodeIdentifier ENTITY_OWNER_NODE_ID = new NodeIdentifier(ENTITY_OWNER_QNAME);
38     static final YangInstanceIdentifier ENTITY_OWNERS_PATH = YangInstanceIdentifier.of(EntityOwners.QNAME);
39
40     static YangInstanceIdentifier entityPath(String entityType, YangInstanceIdentifier entityId) {
41         return YangInstanceIdentifier.builder(ENTITY_OWNERS_PATH).node(EntityType.QNAME).
42                 nodeWithKey(EntityType.QNAME, ENTITY_TYPE_QNAME, entityType).node(ENTITY_QNAME).
43                         nodeWithKey(ENTITY_QNAME, ENTITY_ID_QNAME, entityId).build();
44
45     }
46
47     static NormalizedNode<?, ?> entityOwnersWithCandidate(String entityType, YangInstanceIdentifier entityId,
48             String candidateName) {
49         return entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entityType,
50                 entityEntryWithCandidateEntry(entityId, candidateName)));
51     }
52
53     static ContainerNode entityOwnersWithEntityTypeEntry(MapEntryNode entityTypeNode) {
54         return ImmutableContainerNodeBuilder.create().withNodeIdentifier(
55                 ENTITY_OWNERS_NODE_ID).addChild(ImmutableNodes.mapNodeBuilder(EntityType.QNAME).
56                         addChild(entityTypeNode).build()).build();
57     }
58
59     static MapEntryNode entityTypeEntryWithEntityEntry(String entityType, MapEntryNode entityNode) {
60         return ImmutableNodes.mapEntryBuilder(EntityType.QNAME,
61                 ENTITY_TYPE_QNAME, entityType).addChild(ImmutableNodes.mapNodeBuilder(
62                         ENTITY_QNAME).addChild(entityNode).build()).build();
63     }
64
65     static MapEntryNode entityEntryWithCandidateEntry(YangInstanceIdentifier entityId, String candidateName) {
66         return ImmutableNodes.mapEntryBuilder(ENTITY_QNAME, ENTITY_ID_QNAME, entityId).addChild(
67                 candidateEntry(candidateName)).build();
68     }
69
70     static MapNode candidateEntry(String candidateName) {
71         return ImmutableNodes.mapNodeBuilder(Candidate.QNAME).addChild(ImmutableNodes.mapEntry(
72                 Candidate.QNAME, CANDIDATE_NAME_QNAME, candidateName)).build();
73     }
74
75     static NormalizedNode<?, ?> entityEntryWithOwner(YangInstanceIdentifier entityId, String owner) {
76         return ImmutableNodes.mapEntryBuilder(ENTITY_QNAME, ENTITY_ID_QNAME, entityId).addChild(
77                 ImmutableNodes.leafNode(ENTITY_OWNER_QNAME, owner)).build();
78     }
79 }