org.onosproject.yang.runtime.RuntimeHelper Maven / Gradle / Ivy
/*
* Copyright 2017-present Open Networking Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.yang.runtime;
import org.onosproject.yang.compiler.datamodel.YangDeviationHolder;
import org.onosproject.yang.compiler.datamodel.YangNode;
import org.onosproject.yang.compiler.datamodel.YangSchemaNode;
import org.onosproject.yang.compiler.linker.YangLinker;
import org.onosproject.yang.compiler.linker.impl.YangLinkerManager;
import org.onosproject.yang.compiler.tool.YangModuleExtendedInfo;
import org.onosproject.yang.compiler.utils.io.YangPluginConfig;
import org.onosproject.yang.model.YangModel;
import org.onosproject.yang.model.YangModule;
import org.slf4j.Logger;
import java.io.IOException;
import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.ConcurrentMap;
import static com.google.common.base.Preconditions.checkNotNull;
import static org.onosproject.yang.compiler.datamodel.utils.DataModelUtils.getDateInStringFormat;
import static org.onosproject.yang.compiler.translator.tojava.JavaCodeGeneratorUtil.translate;
import static org.onosproject.yang.runtime.helperutils.YangApacheUtils.getYangModel;
import static org.slf4j.LoggerFactory.getLogger;
/**
* Represents utility for runtime. These utilities can be used by application
* to get YANG model for their application and also it can be used by runtime
* to get the YANG node for given YANG model.
*/
public final class RuntimeHelper {
public static final String PERIOD = ".";
public static final String DEFAULT_CAPS = "Default";
public static final String UNDER_SCORE = "_";
private static final String SERVICE = "Service";
private static final Logger log = getLogger(RuntimeHelper.class);
// Forbid construction.
private RuntimeHelper() {
}
/**
* Returns YANG model for given generated class.
*
* @param aClass generated class for module node
* @return YANG model
*/
public static YangModel getModel(Class aClass) {
return getYangModel(aClass);
}
/**
* Returns YANG node for given YANG model.
*
* @param model YANG model
* @param yangSchemaStore YANG schema store
* @return YANG nodes for given model
*/
public static Set getNodes(
YangModel model,
ConcurrentMap> yangSchemaStore) {
Set selfNodes = new HashSet<>();
Set nodes = new HashSet<>();
for (YangModule info : model.getYangModules()) {
YangModuleExtendedInfo ex = (YangModuleExtendedInfo) info;
YangNode node = ex.getSchema();
if (ex.isInterJar()) {
String name = node.getName();
String date = getDateInStringFormat(node);
String revName = name;
if (date != null) {
revName = name + "@" + date;
}
ConcurrentMap ss = yangSchemaStore.get(name);
checkNotNull(ss, "schema %s not found", name);
node = (YangNode) ss.get(revName);
} else {
selfNodes.add(node);
}
nodes.add(node);
}
//Target linking.
addLinkerAndJavaInfo(nodes);
return selfNodes;
}
/**
* Returns self YANG node for given YANG model.
*
* @param model YANG model
* @param yangSchemaStore YANG schema store
* @return YANG nodes for given model
*/
public static Set getSelfNodes(
YangModel model,
ConcurrentMap> yangSchemaStore) {
Set nodes = new HashSet<>();
for (YangModule info : model.getYangModules()) {
YangModuleExtendedInfo ex = (YangModuleExtendedInfo) info;
if (!ex.isInterJar()) {
nodes.add(ex.getSchema());
}
}
return nodes;
}
/**
* Adds linker and translator info for each data model tree.
*
* @param nodes YANG node
* @return YANG nodes for given model
*/
public static Set addLinkerAndJavaInfo(Set nodes) {
YangLinker yangLinker = new YangLinkerManager();
//Do the linking.
yangLinker.resolveDependencies(nodes);
//add the java info.
for (YangNode node : nodes) {
if (!((YangDeviationHolder) node).isModuleForDeviation()) {
try {
translate(node, new YangPluginConfig(), false);
} catch (IOException e) {
log.error("failed to target link node {},", node.getName());
}
}
}
return nodes;
}
/**
* Returns schema node's generated interface class name.
*
* @param schemaNode schema node
* @return schema node's generated interface class name
*/
public static String getInterfaceClassName(YangSchemaNode schemaNode) {
return schemaNode.getJavaPackage() + PERIOD +
getCapitalCase(schemaNode.getJavaClassNameOrBuiltInType());
}
/**
* Returns schema node's generated service class name.
*
* @param schemaNode schema node
* @return schema node's generated service class name
*/
public static String getServiceName(YangSchemaNode schemaNode) {
return getInterfaceClassName(schemaNode) + SERVICE;
}
/**
* Returns the YANG identifier name as java identifier with first letter
* in capital.
*
* @param yangIdentifier identifier in YANG file
* @return corresponding java identifier
*/
public static String getCapitalCase(String yangIdentifier) {
yangIdentifier = yangIdentifier.substring(0, 1).toUpperCase() + yangIdentifier.substring(1);
return restrictConsecutiveCapitalCase(yangIdentifier);
}
/**
* Restricts consecutive capital cased string as a rule in camel case.
*
* @param consecCapitalCaseRemover which requires the restriction of consecutive capital case
* @return string without consecutive capital case
*/
private static String restrictConsecutiveCapitalCase(String consecCapitalCaseRemover) {
for (int k = 0; k < consecCapitalCaseRemover.length(); k++) {
if (k + 1 < consecCapitalCaseRemover.length()) {
if (Character.isUpperCase(consecCapitalCaseRemover.charAt(k))) {
if (Character.isUpperCase(consecCapitalCaseRemover.charAt(k + 1))) {
consecCapitalCaseRemover = consecCapitalCaseRemover.substring(0, k + 1)
+ consecCapitalCaseRemover.substring(k + 1, k + 2).toLowerCase()
+ consecCapitalCaseRemover.substring(k + 2);
}
}
}
}
return consecCapitalCaseRemover;
}
}