summaryrefslogtreecommitdiffstats
path: root/common/yang-whitelist/yang-whitelist-api
diff options
context:
space:
mode:
Diffstat (limited to 'common/yang-whitelist/yang-whitelist-api')
-rw-r--r--common/yang-whitelist/yang-whitelist-api/asciidoc/Readme.adoc4
-rw-r--r--common/yang-whitelist/yang-whitelist-api/pom.xml40
-rw-r--r--common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/Module.java78
-rw-r--r--common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelist.java49
4 files changed, 171 insertions, 0 deletions
diff --git a/common/yang-whitelist/yang-whitelist-api/asciidoc/Readme.adoc b/common/yang-whitelist/yang-whitelist-api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..d6047617c
--- /dev/null
+++ b/common/yang-whitelist/yang-whitelist-api/asciidoc/Readme.adoc
@@ -0,0 +1,4 @@
+= whitelist-api
+
+Defines general api to whitelist list of yang modules that will be loaded to SchemaContext
+per maven module \ No newline at end of file
diff --git a/common/yang-whitelist/yang-whitelist-api/pom.xml b/common/yang-whitelist/yang-whitelist-api/pom.xml
new file mode 100644
index 000000000..6d72a766d
--- /dev/null
+++ b/common/yang-whitelist/yang-whitelist-api/pom.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Copyright (c) 2017 Cisco and/or its affiliates.
+ ~
+ ~ 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.
+ -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <!-- Cannot have parent , to break cycle, its used in build -->
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>io.fd.honeycomb.yang</groupId>
+ <artifactId>yang-whitelist-api</artifactId>
+ <version>1.17.10-SNAPSHOT</version>
+
+ <properties>
+ <jaxb-api.version>2.2.12</jaxb-api.version>
+ </properties>
+
+ <dependencies>
+ <dependency>
+ <groupId>javax.xml.bind</groupId>
+ <artifactId>jaxb-api</artifactId>
+ <version>${jaxb-api.version}</version>
+ </dependency>
+ </dependencies>
+
+</project> \ No newline at end of file
diff --git a/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/Module.java b/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/Module.java
new file mode 100644
index 000000000..0bedde8da
--- /dev/null
+++ b/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/Module.java
@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ *
+ * 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 io.fd.honeycomb.yang;
+
+import java.util.Objects;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlTransient;
+
+public class Module {
+
+ private String pckg;
+ private String description;
+
+ @XmlElement(name = "package", required = true)
+ public String getPckg() {
+ return pckg;
+ }
+
+ public void setPckg(final String pckg) {
+ // trims input name to eliminate formatted input
+ this.pckg = pckg.trim();
+ }
+
+ @XmlElement
+ public String getDescription() {
+ return description;
+ }
+
+ public void setDescription(final String description) {
+ this.description = description;
+ }
+
+ @XmlTransient
+ public String getBindingProviderName() {
+ return pckg + ".$YangModelBindingProvider";
+ }
+
+ @Override
+ public String toString() {
+ return "Module{" +
+ "pckg='" + pckg + '\'' +
+ ", description='" + description + '\'' +
+ '}';
+ }
+
+ @Override
+ public boolean equals(final Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+
+ final Module that = (Module) o;
+
+ return Objects.equals(this.pckg, that.pckg) && Objects.equals(this.description, that.description);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(pckg, description);
+ }
+}
diff --git a/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelist.java b/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelist.java
new file mode 100644
index 000000000..fee6c396d
--- /dev/null
+++ b/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelist.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ *
+ * 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 io.fd.honeycomb.yang;
+
+import java.util.List;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlElementWrapper;
+import javax.xml.bind.annotation.XmlRootElement;
+
+/**
+ * <yang-modules-whitelist> <modules> <module> <package>io.fd.aaa.bbb.ccc</package> <description>XYZ</description>
+ * </module> </modules> </yang-modules-whitelist>
+ */
+@XmlRootElement
+public class YangModuleWhitelist {
+
+ private List<Module> modules;
+
+ public List<Module> getModules() {
+ return modules;
+ }
+
+ @XmlElementWrapper(name = "modules")
+ @XmlElement(name = "module")
+ public void setModules(final List<Module> modules) {
+ this.modules = modules;
+ }
+
+ @Override
+ public String toString() {
+ return "YangModuleWhitelist{" +
+ "modules=" + modules +
+ '}';
+ }
+}