[ONOS-6410] flexible configuration datastore specifier.
- added completer to netconf-config-get
Change-Id: I7cc88637bd51d9f4bea7d906346ffacfbd8706a6
diff --git a/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/NetconfConfigGetCommand.java b/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/NetconfConfigGetCommand.java
index fe1d9f9..4a53fb3 100644
--- a/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/NetconfConfigGetCommand.java
+++ b/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/NetconfConfigGetCommand.java
@@ -16,6 +16,7 @@
package org.onosproject.netconf.cli.impl;
import static com.google.common.base.Preconditions.checkNotNull;
+import static org.onosproject.netconf.DatastoreId.datastore;
import java.io.IOException;
@@ -26,7 +27,6 @@
import org.onosproject.netconf.NetconfController;
import org.onosproject.netconf.NetconfDevice;
import org.onosproject.netconf.NetconfSession;
-import org.onosproject.netconf.TargetConfig;
/**
* Command that gets the configuration of the specified type from the specified
@@ -42,7 +42,7 @@
String uri = null;
@Argument(index = 1, name = "cfgType",
- description = "Configuration datastore name (RUNNING, etc.)",
+ description = "Configuration datastore name (running, etc.)",
required = true, multiValued = false)
String cfgType = null;
@@ -69,7 +69,7 @@
}
try {
- String res = session.getConfig(TargetConfig.toTargetConfig(cfgType));
+ String res = session.getConfig(datastore(cfgType.toLowerCase()));
print("%s", res);
} catch (IOException e) {
log.error("Configuration could not be retrieved", e);
diff --git a/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/completers/DatastoreIdCompleter.java b/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/completers/DatastoreIdCompleter.java
new file mode 100644
index 0000000..3981bed
--- /dev/null
+++ b/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/completers/DatastoreIdCompleter.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * 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.netconf.cli.impl.completers;
+
+import java.lang.reflect.Modifier;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Objects;
+import java.util.stream.Collectors;
+
+import org.onosproject.cli.AbstractChoicesCompleter;
+import org.onosproject.netconf.DatastoreId;
+
+/**
+ * Completer for predefined {@link DatastoreId}.
+ *
+ */
+public class DatastoreIdCompleter extends AbstractChoicesCompleter {
+
+ @Override
+ protected List<String> choices() {
+ // TODO: Ideally candidates should be chosen based on Device capability
+ return Arrays.asList(DatastoreId.class.getFields())
+ .stream()
+ .filter(f -> f.getType() == DatastoreId.class)
+ .filter(f -> Modifier.isStatic(f.getModifiers()))
+ .map(f -> {
+ try {
+ return (DatastoreId) f.get(null);
+ } catch (IllegalArgumentException | IllegalAccessException e) {
+ return null;
+ }
+ })
+ .filter(Objects::nonNull)
+ .map(DatastoreId::id)
+ .collect(Collectors.toList());
+ }
+
+}
diff --git a/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/completers/package-info.java b/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/completers/package-info.java
new file mode 100644
index 0000000..1a8d488
--- /dev/null
+++ b/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/cli/impl/completers/package-info.java
@@ -0,0 +1,19 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * 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.
+ */
+/**
+ * CLI Completers for NETCONF related commands.
+ */
+package org.onosproject.netconf.cli.impl.completers;
diff --git a/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/ctl/impl/NetconfSessionImpl.java b/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/ctl/impl/NetconfSessionImpl.java
index b808612..00fe4dc 100644
--- a/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/ctl/impl/NetconfSessionImpl.java
+++ b/protocols/netconf/ctl/src/main/java/org/onosproject/netconf/ctl/impl/NetconfSessionImpl.java
@@ -25,7 +25,7 @@
import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import org.onosproject.netconf.NetconfSessionFactory;
-import org.onosproject.netconf.TargetConfig;
+import org.onosproject.netconf.DatastoreId;
import org.onosproject.netconf.FilteringNetconfDeviceOutputEventListener;
import org.onosproject.netconf.NetconfDeviceInfo;
import org.onosproject.netconf.NetconfDeviceOutputEvent;
@@ -465,22 +465,13 @@
}
@Override
- public String getConfig(TargetConfig netconfTargetConfig) throws NetconfException {
+ public String getConfig(DatastoreId netconfTargetConfig) throws NetconfException {
return getConfig(netconfTargetConfig, null);
}
@Override
- public String getConfig(String netconfTargetConfig) throws NetconfException {
- return getConfig(TargetConfig.toTargetConfig(netconfTargetConfig));
- }
-
- @Override
- public String getConfig(String netconfTargetConfig, String configurationFilterSchema) throws NetconfException {
- return getConfig(TargetConfig.toTargetConfig(netconfTargetConfig), configurationFilterSchema);
- }
-
- @Override
- public String getConfig(TargetConfig netconfTargetConfig, String configurationSchema) throws NetconfException {
+ public String getConfig(DatastoreId netconfTargetConfig,
+ String configurationSchema) throws NetconfException {
StringBuilder rpc = new StringBuilder(XML_HEADER);
rpc.append("<rpc ");
rpc.append(MESSAGE_ID_STRING);
@@ -512,13 +503,7 @@
}
@Override
- public boolean editConfig(String netconfTargetConfig, String mode, String newConfiguration)
- throws NetconfException {
- return editConfig(TargetConfig.toTargetConfig(netconfTargetConfig), mode, newConfiguration);
- }
-
- @Override
- public boolean editConfig(TargetConfig netconfTargetConfig, String mode, String newConfiguration)
+ public boolean editConfig(DatastoreId netconfTargetConfig, String mode, String newConfiguration)
throws NetconfException {
newConfiguration = newConfiguration.trim();
StringBuilder rpc = new StringBuilder(XML_HEADER);
@@ -550,27 +535,61 @@
}
@Override
- public boolean copyConfig(String netconfTargetConfig, String newConfiguration) throws NetconfException {
- return copyConfig(TargetConfig.toTargetConfig(netconfTargetConfig), newConfiguration);
+ public boolean copyConfig(DatastoreId destination,
+ DatastoreId source)
+ throws NetconfException {
+ return bareCopyConfig(destination.asXml(), source.asXml());
}
@Override
- public boolean copyConfig(TargetConfig netconfTargetConfig, String newConfiguration)
+ public boolean copyConfig(DatastoreId netconfTargetConfig,
+ String newConfiguration)
throws NetconfException {
- newConfiguration = newConfiguration.trim();
- if (!newConfiguration.startsWith("<config>")) {
- newConfiguration = "<config>" + newConfiguration
- + "</config>";
+ return bareCopyConfig(netconfTargetConfig.asXml(),
+ normalizeCopyConfigParam(newConfiguration));
+ }
+
+ @Override
+ public boolean copyConfig(String netconfTargetConfig,
+ String newConfiguration) throws NetconfException {
+ return bareCopyConfig(normalizeCopyConfigParam(netconfTargetConfig),
+ normalizeCopyConfigParam(newConfiguration));
+ }
+
+ /**
+ * Normalize String parameter passed to copy-config API.
+ * <p>
+ * Provided for backward compatibility purpose
+ *
+ * @param input passed to copyConfig API
+ * @return XML likely to be suitable for copy-config source or target
+ */
+ private static CharSequence normalizeCopyConfigParam(String input) {
+ input = input.trim();
+ if (input.startsWith("<url")) {
+ return input;
+ } else if (!input.startsWith("<")) {
+ // assume it is a datastore name
+ return DatastoreId.datastore(input).asXml();
+ } else if (!input.startsWith("<config>")) {
+ return "<config>" + input + "</config>";
}
+ return input;
+ }
+
+ private boolean bareCopyConfig(CharSequence target,
+ CharSequence source)
+ throws NetconfException {
+
StringBuilder rpc = new StringBuilder(XML_HEADER);
rpc.append(RPC_OPEN);
rpc.append(NETCONF_BASE_NAMESPACE).append(">\n");
rpc.append("<copy-config>");
rpc.append("<target>");
- rpc.append("<").append(netconfTargetConfig).append("/>");
+ rpc.append(target);
rpc.append("</target>");
rpc.append("<source>");
- rpc.append(newConfiguration);
+ rpc.append(source);
rpc.append("</source>");
rpc.append("</copy-config>");
rpc.append("</rpc>");
@@ -579,13 +598,8 @@
}
@Override
- public boolean deleteConfig(String netconfTargetConfig) throws NetconfException {
- return deleteConfig(TargetConfig.toTargetConfig(netconfTargetConfig));
- }
-
- @Override
- public boolean deleteConfig(TargetConfig netconfTargetConfig) throws NetconfException {
- if (netconfTargetConfig.equals(TargetConfig.RUNNING)) {
+ public boolean deleteConfig(DatastoreId netconfTargetConfig) throws NetconfException {
+ if (netconfTargetConfig.equals(DatastoreId.RUNNING)) {
log.warn("Target configuration for delete operation can't be \"running\"",
netconfTargetConfig);
return false;
@@ -603,13 +617,13 @@
}
@Override
- public boolean lock(String configType) throws NetconfException {
+ public boolean lock(DatastoreId configType) throws NetconfException {
StringBuilder rpc = new StringBuilder(XML_HEADER);
rpc.append("<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n");
rpc.append("<lock>");
rpc.append("<target>");
rpc.append("<");
- rpc.append(configType);
+ rpc.append(configType.id());
rpc.append("/>");
rpc.append("</target>");
rpc.append("</lock>");
@@ -620,13 +634,13 @@
}
@Override
- public boolean unlock(String configType) throws NetconfException {
+ public boolean unlock(DatastoreId configType) throws NetconfException {
StringBuilder rpc = new StringBuilder(XML_HEADER);
rpc.append("<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n");
rpc.append("<unlock>");
rpc.append("<target>");
rpc.append("<");
- rpc.append(configType);
+ rpc.append(configType.id());
rpc.append("/>");
rpc.append("</target>");
rpc.append("</unlock>");
@@ -637,16 +651,6 @@
}
@Override
- public boolean lock() throws NetconfException {
- return lock("running");
- }
-
- @Override
- public boolean unlock() throws NetconfException {
- return unlock("running");
- }
-
- @Override
public boolean close() throws NetconfException {
return close(false);
}
diff --git a/protocols/netconf/ctl/src/main/resources/OSGI-INF/blueprint/shell-config.xml b/protocols/netconf/ctl/src/main/resources/OSGI-INF/blueprint/shell-config.xml
index 72e3087..f40d464 100644
--- a/protocols/netconf/ctl/src/main/resources/OSGI-INF/blueprint/shell-config.xml
+++ b/protocols/netconf/ctl/src/main/resources/OSGI-INF/blueprint/shell-config.xml
@@ -29,6 +29,7 @@
<action class="org.onosproject.netconf.cli.impl.NetconfConfigGetCommand"/>
<completers>
<ref component-id="deviceIdCompleter"/>
+ <ref component-id="targetConfigurationsCompleter"/>
<null/>
</completers>
</command>
@@ -44,5 +45,6 @@
</command-bundle>
<bean id="deviceIdCompleter" class="org.onosproject.cli.net.DeviceIdCompleter"/>
+ <bean id="targetConfigurationsCompleter" class="org.onosproject.netconf.cli.impl.completers.DatastoreIdCompleter"/>
</blueprint>