2 * Copyright (c) 2013 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
8 package org.opendaylight.controller.config.yangjmxgenerator;
10 import static com.google.common.base.Preconditions.checkNotNull;
11 import static java.lang.String.format;
12 import static org.opendaylight.controller.config.yangjmxgenerator.ConfigConstants.SERVICE_TYPE_Q_NAME;
14 import java.util.ArrayList;
15 import java.util.HashMap;
16 import java.util.HashSet;
17 import java.util.Iterator;
18 import java.util.List;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
24 import org.opendaylight.yangtools.yang.model.api.Module;
25 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
26 import org.slf4j.Logger;
27 import org.slf4j.LoggerFactory;
29 import com.google.common.base.Optional;
32 * Represents identity derived from {@link ConfigConstants#SERVICE_TYPE_Q_NAME}.
40 * "Service representing an event bus. The service acts as message
41 * router between event producers and event consumers";
43 * base "config:service-type";
44 * config:java-class "com.google.common.eventbus.EventBus";
51 public class ServiceInterfaceEntry extends AbstractEntry {
52 private static final Logger logger = LoggerFactory
53 .getLogger(ServiceInterfaceEntry.class);
55 private static final String CLASS_NAME_SUFFIX = "ServiceInterface";
56 private final Optional<ServiceInterfaceEntry> maybeBaseCache;
57 private final String exportedOsgiClassName;
58 private final QName qName;
59 private final String nullableDescription, packageName, typeName;
60 private final QName yangModuleQName;
62 private ServiceInterfaceEntry(IdentitySchemaNode id, String packageName, QName yangModuleQName) {
63 this(Optional.<ServiceInterfaceEntry> absent(), id, packageName, yangModuleQName);
66 private ServiceInterfaceEntry(Optional<ServiceInterfaceEntry> base,
67 IdentitySchemaNode id, String packageName, QName yangModuleQName) {
69 this.maybeBaseCache = base;
70 List<UnknownSchemaNode> unknownSchemaNodes = id.getUnknownSchemaNodes();
71 List<String> exportedOsgiClassNames = new ArrayList<>(
72 unknownSchemaNodes.size());
73 for (UnknownSchemaNode usn : unknownSchemaNodes) {
74 if (ConfigConstants.JAVA_CLASS_EXTENSION_QNAME.equals(usn
76 String localName = usn.getNodeParameter();
77 exportedOsgiClassNames.add(localName);
79 throw new IllegalStateException(format(
80 "Unexpected unknown schema node. Expected %s, got %s",
81 ConfigConstants.JAVA_CLASS_EXTENSION_QNAME,
85 if (exportedOsgiClassNames.size() != 1) {
86 throw new IllegalArgumentException(
87 format("Cannot find one to one mapping from %s to "
88 + "java class defined by %s language extension in %s",
90 ConfigConstants.JAVA_CLASS_EXTENSION_QNAME, id));
92 this.exportedOsgiClassName = exportedOsgiClassNames.get(0);
93 qName = id.getQName();
94 nullableDescription = id.getDescription();
95 typeName = getSimpleName(exportedOsgiClassName) + CLASS_NAME_SUFFIX;
96 this.packageName = packageName;
97 this.yangModuleQName = yangModuleQName;
100 private static final String getSimpleName(String fullyQualifiedName) {
101 int lastDotPosition = fullyQualifiedName.lastIndexOf(".");
102 return fullyQualifiedName.substring(lastDotPosition + 1);
105 public String getNullableDescription() {
106 return nullableDescription;
109 public Optional<ServiceInterfaceEntry> getBase() {
110 return maybeBaseCache;
113 public String getExportedOsgiClassName() {
114 return exportedOsgiClassName;
117 public QName getQName() {
122 * @return Map of QNames as keys and ServiceInterfaceEntry instances as
125 public static Map<QName, ServiceInterfaceEntry> create(Module currentModule,
126 String packageName) {
127 logger.debug("Generating ServiceInterfaces from {} to package {}",
128 currentModule.getNamespace(), packageName);
130 Map<IdentitySchemaNode, ServiceInterfaceEntry> identitiesToSIs = new HashMap<>();
131 Set<IdentitySchemaNode> notVisited = new HashSet<>(
132 currentModule.getIdentities());
133 int lastSize = notVisited.size() + 1;
134 while (notVisited.size() > 0) {
135 if (notVisited.size() == lastSize) {
137 "Following identities will be ignored while generating ServiceInterfaces, as they are not derived from {} : {}",
138 SERVICE_TYPE_Q_NAME, notVisited);
141 lastSize = notVisited.size();
142 for (Iterator<IdentitySchemaNode> iterator = notVisited.iterator(); iterator
144 IdentitySchemaNode identity = iterator.next();
145 ServiceInterfaceEntry created = null;
146 if (identity.getBaseIdentity() == null) {
147 // this can happen while loading config module, just skip
150 } else if (identity.getBaseIdentity().getQName()
151 .equals(SERVICE_TYPE_Q_NAME)) {
152 // this is a base type
153 created = new ServiceInterfaceEntry(identity, packageName, ModuleUtil.getQName(currentModule));
155 ServiceInterfaceEntry foundBase = identitiesToSIs
156 .get(identity.getBaseIdentity());
157 // derived type, did we convert the parent?
158 if (foundBase != null) {
159 created = new ServiceInterfaceEntry(
160 Optional.of(foundBase), identity, packageName, ModuleUtil.getQName(currentModule));
163 if (created != null) {
164 created.setYangModuleName(currentModule.getName());
165 // TODO how to get local name
166 created.setYangModuleLocalname(identity.getQName()
168 identitiesToSIs.put(identity, created);
174 Map<QName, ServiceInterfaceEntry> resultMap = new HashMap<>();
175 for (ServiceInterfaceEntry sie : identitiesToSIs.values()) {
176 resultMap.put(sie.getQName(), sie);
178 logger.debug("Number of ServiceInterfaces to be generated: {}",
183 public String getFullyQualifiedName() {
184 return packageName + "." + typeName;
187 public String getPackageName() {
191 public String getTypeName() {
195 public QName getYangModuleQName() {
196 return yangModuleQName;
200 public boolean equals(Object o) {
203 if (o == null || getClass() != o.getClass())
206 ServiceInterfaceEntry that = (ServiceInterfaceEntry) o;
208 if (!maybeBaseCache.equals(that.maybeBaseCache))
210 if (!nullableDescription.equals(that.nullableDescription))
212 if (!exportedOsgiClassName.equals(that.exportedOsgiClassName))
214 if (!qName.equals(that.qName))
216 if (!packageName.equals(that.packageName))
218 if (!typeName.equals(that.typeName))
225 public int hashCode() {
226 int result = maybeBaseCache.hashCode();
227 result = 31 * result + exportedOsgiClassName.hashCode();
228 result = 31 * result + nullableDescription.hashCode();
229 result = 31 * result + typeName.hashCode();
230 result = 31 * result + packageName.hashCode();
231 result = 31 * result + qName.hashCode();
236 public String toString() {
237 return "ServiceInterfaceEntry{" + "maybeBaseCache=" + maybeBaseCache
238 + ", qName='" + qName + '\'' + ", fullyQualifiedName='"
239 + getFullyQualifiedName() + '\'' + ", exportedOsgiClassName="
240 + exportedOsgiClassName + ", nullableDescription='"
241 + nullableDescription + '\'' + '}';