Gaurav Agrawal | f576642 | 2016-03-23 19:04:17 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0f7908b | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Gaurav Agrawal | f576642 | 2016-03-23 19:04:17 +0530 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.yangutils.datamodel; |
| 18 | |
| 19 | import java.util.LinkedList; |
| 20 | import java.util.List; |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 21 | |
Gaurav Agrawal | f576642 | 2016-03-23 19:04:17 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
| 23 | import org.onosproject.yangutils.parser.Parsable; |
| 24 | import org.onosproject.yangutils.utils.YangConstructType; |
| 25 | |
| 26 | import static org.onosproject.yangutils.datamodel.utils.DataModelUtils.detectCollidingChildUtil; |
| 27 | |
| 28 | /* |
| 29 | * Reference RFC 6020. |
| 30 | * |
| 31 | * YANG allows the definition of notifications suitable for NETCONF. |
| 32 | * YANG data definition statements are used to model the content of the |
| 33 | * notification. |
| 34 | * |
| 35 | * The "notification" statement is used to define a NETCONF |
| 36 | * notification. It takes one argument, which is an identifier, |
| 37 | * followed by a block of substatements that holds detailed notification |
| 38 | * information. The "notification" statement defines a notification |
| 39 | * node in the schema tree. |
| 40 | * |
| 41 | * If a leaf in the notification tree has a "mandatory" statement with |
| 42 | * the value "true", the leaf MUST be present in a NETCONF notification. |
| 43 | * |
| 44 | * If a leaf in the notification tree has a default value, the NETCONF |
| 45 | * client MUST use this value in the same cases as described in |
| 46 | * Section 7.6.1. In these cases, the client MUST operationally behave |
| 47 | * as if the leaf was present in the NETCONF notification with the |
| 48 | * default value as its value. |
| 49 | * |
| 50 | * If a "config" statement is present for any node in the notification |
| 51 | * tree, the "config" statement is ignored. |
| 52 | * |
| 53 | * The notification's substatements |
| 54 | * |
| 55 | * +--------------+---------+-------------+------------------+ |
| 56 | * | substatement | section | cardinality |data model mapping| |
| 57 | * +--------------+---------+-------------+------------------+ |
| 58 | * | anyxml | 7.10 | 0..n | -not supported | |
| 59 | * | choice | 7.9 | 0..n | -child nodes | |
| 60 | * | container | 7.5 | 0..n | -child nodes | |
| 61 | * | description | 7.19.3 | 0..1 | -string | |
| 62 | * | grouping | 7.11 | 0..n | -child nodes | |
| 63 | * | if-feature | 7.18.2 | 0..n | -TODO | |
| 64 | * | leaf | 7.6 | 0..n | -YangLeaf | |
| 65 | * | leaf-list | 7.7 | 0..n | -YangLeafList | |
| 66 | * | list | 7.8 | 0..n | -child nodes | |
| 67 | * | reference | 7.19.4 | 0..1 | -string | |
| 68 | * | status | 7.19.2 | 0..1 | -YangStatus | |
| 69 | * | typedef | 7.3 | 0..n | -child nodes | |
| 70 | * | uses | 7.12 | 0..n | -child nodes | |
| 71 | * +--------------+---------+-------------+------------------+ |
| 72 | */ |
| 73 | |
| 74 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 75 | * Represents data model node to maintain information defined in YANG notification. |
Gaurav Agrawal | f576642 | 2016-03-23 19:04:17 +0530 | [diff] [blame] | 76 | */ |
| 77 | public class YangNotification extends YangNode implements YangLeavesHolder, YangCommonInfo, Parsable, |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 78 | CollisionDetector { |
Gaurav Agrawal | f576642 | 2016-03-23 19:04:17 +0530 | [diff] [blame] | 79 | |
| 80 | /** |
| 81 | * Name of the notification. |
| 82 | */ |
| 83 | private String name; |
| 84 | |
| 85 | /** |
| 86 | * Description of notification. |
| 87 | */ |
| 88 | private String description; |
| 89 | |
| 90 | /** |
| 91 | * List of leaves contained. |
| 92 | */ |
| 93 | private List<YangLeaf> listOfLeaf; |
| 94 | |
| 95 | /** |
| 96 | * List of leaf-lists contained. |
| 97 | */ |
| 98 | private List<YangLeafList> listOfLeafList; |
| 99 | |
| 100 | /** |
| 101 | * Reference of the module. |
| 102 | */ |
| 103 | private String reference; |
| 104 | |
| 105 | /** |
| 106 | * Status of the node. |
| 107 | */ |
| 108 | private YangStatusType status = YangStatusType.CURRENT; |
| 109 | |
| 110 | /** |
| 111 | * Create a notification node. |
| 112 | */ |
| 113 | public YangNotification() { |
| 114 | super(YangNodeType.NOTIFICATION_NODE); |
| 115 | listOfLeaf = new LinkedList<YangLeaf>(); |
| 116 | listOfLeafList = new LinkedList<YangLeafList>(); |
| 117 | } |
| 118 | |
| 119 | @Override |
| 120 | public void detectCollidingChild(String identifierName, YangConstructType dataType) throws DataModelException { |
| 121 | // Detect colliding child. |
| 122 | detectCollidingChildUtil(identifierName, dataType, this); |
| 123 | } |
| 124 | |
| 125 | @Override |
| 126 | public void detectSelfCollision(String identifierName, YangConstructType dataType) throws DataModelException { |
| 127 | if (this.getName().equals(identifierName)) { |
| 128 | throw new DataModelException("YANG file error: Duplicate input identifier detected, same as notification \"" |
| 129 | + this.getName() + "\""); |
| 130 | } |
| 131 | } |
| 132 | |
| 133 | @Override |
| 134 | public YangConstructType getYangConstructType() { |
| 135 | return YangConstructType.NOTIFICATION_DATA; |
| 136 | } |
| 137 | |
| 138 | @Override |
| 139 | public void validateDataOnEntry() throws DataModelException { |
| 140 | //TODO: implement the method. |
| 141 | } |
| 142 | |
| 143 | @Override |
| 144 | public void validateDataOnExit() throws DataModelException { |
| 145 | //TODO: implement the method. |
| 146 | } |
| 147 | |
| 148 | @Override |
| 149 | public String getDescription() { |
| 150 | return description; |
| 151 | } |
| 152 | |
| 153 | @Override |
| 154 | public void setDescription(String description) { |
| 155 | this.description = description; |
| 156 | } |
| 157 | |
| 158 | @Override |
| 159 | public List<YangLeaf> getListOfLeaf() { |
| 160 | return listOfLeaf; |
| 161 | } |
| 162 | |
| 163 | @Override |
| 164 | public void addLeaf(YangLeaf leaf) { |
| 165 | getListOfLeaf().add(leaf); |
| 166 | } |
| 167 | |
| 168 | @Override |
| 169 | public List<YangLeafList> getListOfLeafList() { |
| 170 | return listOfLeafList; |
| 171 | } |
| 172 | |
| 173 | @Override |
| 174 | public void addLeafList(YangLeafList leafList) { |
| 175 | getListOfLeafList().add(leafList); |
| 176 | } |
| 177 | |
| 178 | @Override |
| 179 | public String getName() { |
| 180 | return name; |
| 181 | } |
| 182 | |
| 183 | @Override |
| 184 | public void setName(String name) { |
| 185 | this.name = name; |
| 186 | } |
| 187 | |
| 188 | @Override |
| 189 | public String getReference() { |
| 190 | return reference; |
| 191 | } |
| 192 | |
| 193 | @Override |
| 194 | public void setReference(String reference) { |
| 195 | this.reference = reference; |
| 196 | } |
| 197 | |
| 198 | @Override |
| 199 | public YangStatusType getStatus() { |
| 200 | return status; |
| 201 | } |
| 202 | |
| 203 | @Override |
| 204 | public void setStatus(YangStatusType status) { |
| 205 | this.status = status; |
| 206 | } |
| 207 | } |