import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
+import org.opendaylight.controller.sal.rest.doc.model.builder.OperationBuilder;
import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
*/
public class ModelGenerator {
- private static final Logger _logger = LoggerFactory.getLogger(ModelGenerator.class);
+ private static Logger _logger = LoggerFactory.getLogger(ModelGenerator.class);
private static final String BASE_64 = "base64";
private static final String BINARY_ENCODING_KEY = "binaryEncoding";
private static final Map<Class<? extends TypeDefinition<?>>, String> YANG_TYPE_TO_JSON_TYPE_MAPPING;
static {
- Map<Class<? extends TypeDefinition<?>>, String> tempMap1 = new HashMap<Class<? extends TypeDefinition<?>>, String>(10);
- tempMap1.put(StringType.class , STRING);
- tempMap1.put(BooleanType.class , BOOLEAN);
- tempMap1.put(Int8.class , INTEGER);
- tempMap1.put(Int16.class , INTEGER);
- tempMap1.put(Int32.class , INTEGER);
- tempMap1.put(Int64.class , INTEGER);
- tempMap1.put(Uint16.class , INTEGER);
- tempMap1.put(Uint32.class , INTEGER);
- tempMap1.put(Uint64.class , INTEGER);
- tempMap1.put(Uint8.class , INTEGER);
- tempMap1.put(Decimal64.class , NUMBER);
- tempMap1.put(EnumerationType.class , ENUM);
- //TODO: Binary type
+ Map<Class<? extends TypeDefinition<?>>, String> tempMap1 = new HashMap<Class<? extends TypeDefinition<?>>, String>(
+ 10);
+ tempMap1.put(StringType.class, STRING);
+ tempMap1.put(BooleanType.class, BOOLEAN);
+ tempMap1.put(Int8.class, INTEGER);
+ tempMap1.put(Int16.class, INTEGER);
+ tempMap1.put(Int32.class, INTEGER);
+ tempMap1.put(Int64.class, INTEGER);
+ tempMap1.put(Uint16.class, INTEGER);
+ tempMap1.put(Uint32.class, INTEGER);
+ tempMap1.put(Uint64.class, INTEGER);
+ tempMap1.put(Uint8.class, INTEGER);
+ tempMap1.put(Decimal64.class, NUMBER);
+ tempMap1.put(EnumerationType.class, ENUM);
+ // TODO: Binary type
YANG_TYPE_TO_JSON_TYPE_MAPPING = Collections.unmodifiableMap(tempMap1);
}
- public ModelGenerator(){
+ public ModelGenerator() {
}
- public JSONObject convertToJsonSchema(final Module module) throws IOException, JSONException {
+ public JSONObject convertToJsonSchema(Module module) throws IOException, JSONException {
JSONObject models = new JSONObject();
processContainers(module, models);
processRPCs(module, models);
-
return models;
}
-
-
- private void processContainers(final Module module, final JSONObject models) throws IOException, JSONException {
+ private void processContainers(Module module, JSONObject models) throws IOException,
+ JSONException {
String moduleName = module.getName();
- Set<DataSchemaNode> childNodes = module.getChildNodes();
+ Set<DataSchemaNode> childNodes = module.getChildNodes();
- for(DataSchemaNode childNode : childNodes){
- JSONObject moduleJSON=null;
- String filename = childNode.getQName().getLocalName();
+ for (DataSchemaNode childNode : childNodes) {
+ JSONObject configModuleJSON = null;
+ JSONObject operationalModuleJSON = null;
+
+ String childNodeName = childNode.getQName().getLocalName();
/*
* For every container in the module
*/
- if(childNode instanceof ContainerSchemaNode) {
- moduleJSON = processContainer((ContainerSchemaNode)childNode, moduleName, true, models);
+ if (childNode instanceof ContainerSchemaNode) {
+ configModuleJSON = processContainer((ContainerSchemaNode) childNode, moduleName,
+ true, models, true);
+ operationalModuleJSON = processContainer((ContainerSchemaNode) childNode,
+ moduleName, true, models, false);
}
- if(moduleJSON!=null) {
- _logger.debug("Adding model for [{}]", filename);
- moduleJSON.put("id", filename);
- models.put(filename, moduleJSON);
+ if (configModuleJSON != null) {
+ _logger.debug("Adding model for [{}]", OperationBuilder.CONFIG + childNodeName);
+ configModuleJSON.put("id", OperationBuilder.CONFIG + childNodeName);
+ models.put(OperationBuilder.CONFIG + childNodeName, configModuleJSON);
+ }
+ if (operationalModuleJSON != null) {
+ _logger.debug("Adding model for [{}]", OperationBuilder.OPERATIONAL + childNodeName);
+ operationalModuleJSON.put("id", OperationBuilder.OPERATIONAL + childNodeName);
+ models.put(OperationBuilder.OPERATIONAL + childNodeName, operationalModuleJSON);
}
}
}
-
/**
- * Process the RPCs for a Module
- * Spits out a file each of the name <rpcName>-input.json
- * and <rpcName>-output.json for each RPC that contains
+ * Process the RPCs for a Module Spits out a file each of the name
+ * <rpcName>-input.json and <rpcName>-output.json for each RPC that contains
* input & output elements
*
* @param module
* @throws JSONException
* @throws IOException
*/
- private void processRPCs(final Module module, final JSONObject models) throws JSONException, IOException {
+ private void processRPCs(Module module, JSONObject models) throws JSONException, IOException {
- Set<RpcDefinition> rpcs = module.getRpcs();
+ Set<RpcDefinition> rpcs = module.getRpcs();
String moduleName = module.getName();
- for(RpcDefinition rpc: rpcs) {
+ for (RpcDefinition rpc : rpcs) {
ContainerSchemaNode input = rpc.getInput();
- if(input!=null) {
+ if (input != null) {
JSONObject inputJSON = processContainer(input, moduleName, true, models);
- String filename = rpc.getQName().getLocalName() + "-input";
+ String filename = "(" + rpc.getQName().getLocalName() + ")input";
inputJSON.put("id", filename);
- //writeToFile(filename, inputJSON.toString(2), moduleName);
+ // writeToFile(filename, inputJSON.toString(2), moduleName);
models.put(filename, inputJSON);
}
ContainerSchemaNode output = rpc.getOutput();
- if(output!=null) {
+ if (output != null) {
JSONObject outputJSON = processContainer(output, moduleName, true, models);
- String filename = rpc.getQName().getLocalName() + "-output";
+ String filename = "(" + rpc.getQName().getLocalName() + ")output";
outputJSON.put("id", filename);
models.put(filename, outputJSON);
}
}
}
-
/**
* Processes the container node and populates the moduleJSON
*
* @param container
* @param moduleName
+ * @param isConfig
* @throws JSONException
* @throws IOException
*/
- private JSONObject processContainer(final ContainerSchemaNode container, final String moduleName, final boolean addSchemaStmt, final JSONObject models) throws JSONException, IOException{
+ private JSONObject processContainer(ContainerSchemaNode container, String moduleName,
+ boolean addSchemaStmt, JSONObject models) throws JSONException, IOException {
+ return processContainer(container, moduleName, addSchemaStmt, models, (Boolean) null);
+ }
+
+ private JSONObject processContainer(ContainerSchemaNode container, String moduleName,
+ boolean addSchemaStmt, JSONObject models, Boolean isConfig) throws JSONException,
+ IOException {
JSONObject moduleJSON = getSchemaTemplate();
- if(addSchemaStmt) {
+ if (addSchemaStmt) {
moduleJSON = getSchemaTemplate();
} else {
moduleJSON = new JSONObject();
moduleJSON.put(DESCRIPTION_KEY, containerDescription);
Set<DataSchemaNode> containerChildren = container.getChildNodes();
- JSONObject properties = processChildren(containerChildren, moduleName, models);
+ JSONObject properties = processChildren(containerChildren, moduleName, models, isConfig);
moduleJSON.put(PROPERTIES_KEY, properties);
return moduleJSON;
}
+ private JSONObject processChildren(Set<DataSchemaNode> nodes, String moduleName,
+ JSONObject models) throws JSONException, IOException {
+ return processChildren(nodes, moduleName, models, null);
+ }
+
/**
* Processes the nodes
+ *
* @param nodes
* @param moduleName
+ * @param isConfig
* @return
* @throws JSONException
* @throws IOException
*/
- private JSONObject processChildren(final Set<DataSchemaNode> nodes, final String moduleName, final JSONObject models) throws JSONException, IOException {
+ private JSONObject processChildren(Set<DataSchemaNode> nodes, String moduleName,
+ JSONObject models, Boolean isConfig) throws JSONException, IOException {
JSONObject properties = new JSONObject();
- for(DataSchemaNode node : nodes){
- String name = node.getQName().getLocalName();
- JSONObject property = null;
- if(node instanceof LeafSchemaNode) {
- property = processLeafNode((LeafSchemaNode)node);
- } else if (node instanceof ListSchemaNode) {
- property = processListSchemaNode((ListSchemaNode)node, moduleName, models);
+ for (DataSchemaNode node : nodes) {
+ if (isConfig == null || node.isConfiguration() == isConfig) {
- } else if (node instanceof LeafListSchemaNode) {
- property = processLeafListNode((LeafListSchemaNode)node);
+ String name = node.getQName().getLocalName();
+ JSONObject property = null;
+ if (node instanceof LeafSchemaNode) {
+ property = processLeafNode((LeafSchemaNode) node);
+ } else if (node instanceof ListSchemaNode) {
+ property = processListSchemaNode((ListSchemaNode) node, moduleName, models);
- } else if (node instanceof ChoiceNode) {
- property = processChoiceNode((ChoiceNode)node, moduleName, models);
+ } else if (node instanceof LeafListSchemaNode) {
+ property = processLeafListNode((LeafListSchemaNode) node);
- } else if (node instanceof AnyXmlSchemaNode) {
- property = processAnyXMLNode((AnyXmlSchemaNode)node);
+ } else if (node instanceof ChoiceNode) {
+ property = processChoiceNode((ChoiceNode) node, moduleName, models);
- } else if (node instanceof ContainerSchemaNode) {
- property = processContainer((ContainerSchemaNode)node, moduleName, false, models);
+ } else if (node instanceof AnyXmlSchemaNode) {
+ property = processAnyXMLNode((AnyXmlSchemaNode) node);
- } else {
- throw new IllegalArgumentException("Unknown DataSchemaNode type: " + node.getClass());
- }
+ } else if (node instanceof ContainerSchemaNode) {
+ property = processContainer((ContainerSchemaNode) node, moduleName, false,
+ models, isConfig);
+
+ } else {
+ throw new IllegalArgumentException("Unknown DataSchemaNode type: "
+ + node.getClass());
+ }
- property.putOpt(DESCRIPTION_KEY, node.getDescription());
- properties.put(name, property);
+ property.putOpt(DESCRIPTION_KEY, node.getDescription());
+ properties.put(name, property);
+ }
}
return properties;
}
* @param listNode
* @throws JSONException
*/
- private JSONObject processLeafListNode(final LeafListSchemaNode listNode) throws JSONException {
+ private JSONObject processLeafListNode(LeafListSchemaNode listNode) throws JSONException {
JSONObject props = new JSONObject();
props.put(TYPE_KEY, ARRAY_TYPE);
* @throws JSONException
* @throws IOException
*/
- private JSONObject processChoiceNode(final ChoiceNode choiceNode, final String moduleName, final JSONObject models) throws JSONException, IOException {
+ private JSONObject processChoiceNode(ChoiceNode choiceNode, String moduleName, JSONObject models)
+ throws JSONException, IOException {
Set<ChoiceCaseNode> cases = choiceNode.getCases();
JSONArray choiceProps = new JSONArray();
- for(ChoiceCaseNode choiceCase: cases) {
+ for (ChoiceCaseNode choiceCase : cases) {
String choiceName = choiceCase.getQName().getLocalName();
JSONObject choiceProp = processChildren(choiceCase.getChildNodes(), moduleName, models);
JSONObject choiceObj = new JSONObject();
return oneOfProps;
}
-
/**
*
* @param constraints
* @param props
* @throws JSONException
*/
- private void processConstraints(final ConstraintDefinition constraints, final JSONObject props) throws JSONException {
+ private void processConstraints(ConstraintDefinition constraints, JSONObject props)
+ throws JSONException {
boolean isMandatory = constraints.isMandatory();
props.put(REQUIRED_KEY, isMandatory);
Integer minElements = constraints.getMinElements();
Integer maxElements = constraints.getMaxElements();
- if(minElements !=null) {
+ if (minElements != null) {
props.put(MIN_ITEMS, minElements);
}
- if(maxElements !=null) {
+ if (maxElements != null) {
props.put(MAX_ITEMS, maxElements);
}
}
/**
* Parses a ListSchema node.
*
- * Due to a limitation of the RAML--->JAX-RS tool, sub-properties
- * must be in a separate JSON schema file. Hence, we have to write
- * some properties to a new file, while continuing to process the rest.
+ * Due to a limitation of the RAML--->JAX-RS tool, sub-properties must be in
+ * a separate JSON schema file. Hence, we have to write some properties to a
+ * new file, while continuing to process the rest.
*
* @param listNode
* @param moduleName
* @throws JSONException
* @throws IOException
*/
- private JSONObject processListSchemaNode(final ListSchemaNode listNode, final String moduleName, final JSONObject models) throws JSONException, IOException {
+ private JSONObject processListSchemaNode(ListSchemaNode listNode, String moduleName,
+ JSONObject models) throws JSONException, IOException {
Set<DataSchemaNode> listChildren = listNode.getChildNodes();
String fileName = listNode.getQName().getLocalName();
childSchema.put(PROPERTIES_KEY, childSchemaProperties);
/*
- * Due to a limitation of the RAML--->JAX-RS tool, sub-properties
- * must be in a separate JSON schema file. Hence, we have to write
- * some properties to a new file, while continuing to process the rest.
+ * Due to a limitation of the RAML--->JAX-RS tool, sub-properties must
+ * be in a separate JSON schema file. Hence, we have to write some
+ * properties to a new file, while continuing to process the rest.
*/
- //writeToFile(fileName, childSchema.toString(2), moduleName);
+ // writeToFile(fileName, childSchema.toString(2), moduleName);
childSchema.put("id", fileName);
models.put(fileName, childSchema);
-
JSONObject listNodeProperties = new JSONObject();
listNodeProperties.put(TYPE_KEY, ARRAY_TYPE);
JSONObject items = new JSONObject();
- items.put(REF_KEY,fileName );
+ items.put(REF_KEY, fileName);
listNodeProperties.put(ITEMS_KEY, items);
return listNodeProperties;
* @return
* @throws JSONException
*/
- private JSONObject processLeafNode(final LeafSchemaNode leafNode) throws JSONException {
+ private JSONObject processLeafNode(LeafSchemaNode leafNode) throws JSONException {
JSONObject property = new JSONObject();
String leafDescription = leafNode.getDescription();
* @return
* @throws JSONException
*/
- private JSONObject processAnyXMLNode(final AnyXmlSchemaNode leafNode) throws JSONException {
+ private JSONObject processAnyXMLNode(AnyXmlSchemaNode leafNode) throws JSONException {
JSONObject property = new JSONObject();
String leafDescription = leafNode.getDescription();
* @param property
* @throws JSONException
*/
- private void processTypeDef(final TypeDefinition<?> leafTypeDef, final JSONObject property) throws JSONException {
+ private void processTypeDef(TypeDefinition<?> leafTypeDef, JSONObject property)
+ throws JSONException {
- if(leafTypeDef instanceof ExtendedType){
+ if (leafTypeDef instanceof ExtendedType) {
processExtendedType(leafTypeDef, property);
} else if (leafTypeDef instanceof EnumerationType) {
- processEnumType((EnumerationType)leafTypeDef, property);
+ processEnumType((EnumerationType) leafTypeDef, property);
} else if (leafTypeDef instanceof BitsTypeDefinition) {
- processBitsType((BitsTypeDefinition)leafTypeDef, property);
+ processBitsType((BitsTypeDefinition) leafTypeDef, property);
} else if (leafTypeDef instanceof UnionTypeDefinition) {
- processUnionType((UnionTypeDefinition)leafTypeDef, property);
+ processUnionType((UnionTypeDefinition) leafTypeDef, property);
} else if (leafTypeDef instanceof IdentityrefTypeDefinition) {
property.putOpt(TYPE_KEY, "object");
} else if (leafTypeDef instanceof BinaryTypeDefinition) {
- processBinaryType((BinaryTypeDefinition)leafTypeDef, property);
+ processBinaryType((BinaryTypeDefinition) leafTypeDef, property);
} else {
- //System.out.println("In else: " + leafTypeDef.getClass());
+ // System.out.println("In else: " + leafTypeDef.getClass());
String jsonType = YANG_TYPE_TO_JSON_TYPE_MAPPING.get(leafTypeDef.getClass());
- if(jsonType==null) {
+ if (jsonType == null) {
jsonType = "object";
}
property.putOpt(TYPE_KEY, jsonType);
* @param property
* @throws JSONException
*/
- private void processExtendedType(final TypeDefinition<?> leafTypeDef, final JSONObject property) throws JSONException {
+ private void processExtendedType(TypeDefinition<?> leafTypeDef, JSONObject property)
+ throws JSONException {
Object leafBaseType = leafTypeDef.getBaseType();
- if(leafBaseType instanceof ExtendedType){
- //recursively process an extended type until we hit a base type
- processExtendedType((TypeDefinition<?>)leafBaseType, property);
+ if (leafBaseType instanceof ExtendedType) {
+ // recursively process an extended type until we hit a base type
+ processExtendedType((TypeDefinition<?>) leafBaseType, property);
} else {
- List<LengthConstraint> lengthConstraints = ((ExtendedType) leafTypeDef).getLengthConstraints();
- for(LengthConstraint lengthConstraint: lengthConstraints) {
+ List<LengthConstraint> lengthConstraints = ((ExtendedType) leafTypeDef)
+ .getLengthConstraints();
+ for (LengthConstraint lengthConstraint : lengthConstraints) {
Number min = lengthConstraint.getMin();
Number max = lengthConstraint.getMax();
property.putOpt(MIN_LENGTH_KEY, min);
property.putOpt(MAX_LENGTH_KEY, max);
}
String jsonType = YANG_TYPE_TO_JSON_TYPE_MAPPING.get(leafBaseType.getClass());
- property.putOpt(TYPE_KEY,jsonType );
+ property.putOpt(TYPE_KEY, jsonType);
}
}
/*
- *
- */
- private void processBinaryType(final BinaryTypeDefinition binaryType, final JSONObject property) throws JSONException {
+ *
+ */
+ private void processBinaryType(BinaryTypeDefinition binaryType, JSONObject property)
+ throws JSONException {
property.put(TYPE_KEY, STRING);
JSONObject media = new JSONObject();
media.put(BINARY_ENCODING_KEY, BASE_64);
* @param property
* @throws JSONException
*/
- private void processEnumType(final EnumerationType enumLeafType, final JSONObject property) throws JSONException {
+ private void processEnumType(EnumerationType enumLeafType, JSONObject property)
+ throws JSONException {
List<EnumPair> enumPairs = enumLeafType.getValues();
List<String> enumNames = new ArrayList<String>();
- for(EnumPair enumPair: enumPairs) {
+ for (EnumPair enumPair : enumPairs) {
enumNames.add(enumPair.getName());
}
property.putOpt(ENUM, new JSONArray(enumNames));
* @param property
* @throws JSONException
*/
- private void processBitsType(final BitsTypeDefinition bitsType, final JSONObject property) throws JSONException{
+ private void processBitsType(BitsTypeDefinition bitsType, JSONObject property)
+ throws JSONException {
property.put(TYPE_KEY, ARRAY_TYPE);
property.put(MIN_ITEMS, 0);
property.put(UNIQUE_ITEMS_KEY, true);
JSONArray enumValues = new JSONArray();
List<Bit> bits = bitsType.getBits();
- for(Bit bit: bits) {
+ for (Bit bit : bits) {
enumValues.put(bit.getName());
}
JSONObject itemsValue = new JSONObject();
property.put(ITEMS_KEY, itemsValue);
}
-
/**
*
* @param unionType
* @param property
* @throws JSONException
*/
- private void processUnionType(final UnionTypeDefinition unionType, final JSONObject property) throws JSONException{
+ private void processUnionType(UnionTypeDefinition unionType, JSONObject property)
+ throws JSONException {
List<TypeDefinition<?>> unionTypes = unionType.getTypes();
JSONArray unionArray = new JSONArray();
- for(TypeDefinition<?> typeDef: unionTypes) {
+ for (TypeDefinition<?> typeDef : unionTypes) {
unionArray.put(YANG_TYPE_TO_JSON_TYPE_MAPPING.get(typeDef.getClass()));
}
property.put(TYPE_KEY, unionArray);
}
-
/**
- * Helper method to generate a pre-filled
- * JSON schema object.
+ * Helper method to generate a pre-filled JSON schema object.
+ *
* @return
* @throws JSONException
*/
Code Review / controller.git / blobdiff