FM GUI as an NPM library for GUI 2
* added dynamic loading of external modules
* new commands on Alarm to allow create/updating/delete
* new fields in alarm gui
Change-Id: I9a7f4d665618a7949bb02039374974dabf6e5363
diff --git a/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/CreateAlarm.java b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/CreateAlarm.java
new file mode 100644
index 0000000..e6bc0bc
--- /dev/null
+++ b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/CreateAlarm.java
@@ -0,0 +1,76 @@
+/*
+ * Copyright 2018-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.faultmanagement.alarms.cli;
+
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.faultmanagement.api.AlarmStore;
+import org.onosproject.incubator.net.faultmanagement.alarm.Alarm;
+import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId;
+import org.onosproject.incubator.net.faultmanagement.alarm.DefaultAlarm;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.device.DeviceService;
+
+import java.time.Instant;
+
+/**
+ * Creates a default alarm on a device.
+ */
+@Command(scope = "onos", name = "alarm-create",
+ description = "Creates an alarm")
+public class CreateAlarm extends AbstractShellCommand {
+
+ @Argument(index = 0, name = "deviceId", description = "Device identity",
+ required = true, multiValued = false)
+ String deviceIdStr = null;
+
+ @Argument(index = 1, name = "severity", description = "Severity level",
+ required = true, multiValued = false)
+ String severityStr = null;
+
+ @Argument(index = 2, name = "alarmId", description = "Unique alarm id",
+ required = true, multiValued = false)
+ String alarmId = null;
+
+ @Argument(index = 3, name = "desc", description = "Alarm description",
+ required = true, multiValued = false)
+ String desc = null;
+
+ private AlarmStore alarmStore = AbstractShellCommand.get(AlarmStore.class);
+
+ private DeviceService deviceManager = AbstractShellCommand.get(DeviceService.class);
+
+ @Override
+ protected void execute() {
+ DeviceId deviceId = DeviceId.deviceId(deviceIdStr);
+ if (!deviceManager.isAvailable(deviceId)) {
+ throw new IllegalArgumentException("Device " + deviceIdStr + " is not available");
+ }
+
+ Alarm.SeverityLevel severityLevel = Alarm.SeverityLevel.valueOf(severityStr);
+
+ Alarm newAlarm = new DefaultAlarm.Builder(
+ AlarmId.alarmId(deviceId, alarmId),
+ deviceId,
+ desc,
+ severityLevel,
+ Instant.now().toEpochMilli())
+ .build();
+ alarmStore.createOrUpdateAlarm(newAlarm);
+ }
+}
diff --git a/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/RemoveAlarm.java b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/RemoveAlarm.java
new file mode 100644
index 0000000..600e057
--- /dev/null
+++ b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/RemoveAlarm.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2018-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.faultmanagement.alarms.cli;
+
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.faultmanagement.api.AlarmStore;
+import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId;
+
+/**
+ * Remove an alarm from the Alarm Store.
+ */
+@Command(scope = "onos", name = "alarm-remove",
+ description = "Removes an alarm")
+public class RemoveAlarm extends AbstractShellCommand {
+ @Argument(index = 0, name = "alarmId", description = "Unique alarm id",
+ required = true, multiValued = false)
+ String alarmId = null;
+
+ private AlarmStore alarmStore = AbstractShellCommand.get(AlarmStore.class);
+
+ @Override
+ protected void execute() {
+ alarmStore.removeAlarm(AlarmId.alarmId(alarmId));
+ }
+}
diff --git a/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/UpdateAlarm.java b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/UpdateAlarm.java
new file mode 100644
index 0000000..5766ed7
--- /dev/null
+++ b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/UpdateAlarm.java
@@ -0,0 +1,95 @@
+/*
+ * Copyright 2018-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.faultmanagement.alarms.cli;
+
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.faultmanagement.api.AlarmStore;
+import org.onosproject.incubator.net.faultmanagement.alarm.Alarm;
+import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEntityId;
+import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId;
+import org.onosproject.incubator.net.faultmanagement.alarm.DefaultAlarm;
+
+import java.time.Instant;
+
+/**
+ * Updates an existing alarm.
+ */
+@Command(scope = "onos", name = "alarm-update",
+ description = "Updates an alarm")
+public class UpdateAlarm extends AbstractShellCommand {
+
+ @Argument(index = 0, name = "alarmId", description = "Unique alarm id",
+ required = true, multiValued = false)
+ String alarmId = null;
+
+ @Argument(index = 1, name = "desc", description = "Alarm field",
+ required = true, multiValued = false)
+ String alarmField = null;
+
+ @Argument(index = 2, name = "value", description = "The new value of the chosen Alarm field.",
+ required = true, multiValued = false)
+ String alarmFieldValue = null;
+
+ private AlarmStore alarmStore = AbstractShellCommand.get(AlarmStore.class);
+
+ @Override
+ protected void execute() {
+ Alarm existing = alarmStore.getAlarm(AlarmId.alarmId(alarmId));
+
+ DefaultAlarm.Builder newAlarmBuilder = new DefaultAlarm.Builder(existing);
+ UpdateAlarm.AlarmField field = UpdateAlarm.AlarmField.valueOf(alarmField);
+ switch (field) {
+ case SOURCE:
+ AlarmEntityId sourceId = AlarmEntityId.alarmEntityId(alarmFieldValue);
+ newAlarmBuilder.forSource(sourceId);
+ break;
+ case ASSIGNED_USER:
+ newAlarmBuilder.withAssignedUser(alarmFieldValue);
+ break;
+ case ACKNOWLEDGED:
+ newAlarmBuilder.withAcknowledged("TRUE".equalsIgnoreCase(alarmFieldValue));
+ break;
+ case MANUALLY_CLEARABLE:
+ newAlarmBuilder.withManuallyClearable("TRUE".equalsIgnoreCase(alarmFieldValue));
+ break;
+ case SERVICE_AFFECTING:
+ newAlarmBuilder.withServiceAffecting("TRUE".equalsIgnoreCase(alarmFieldValue));
+ break;
+ case TIME_CLEARED:
+ newAlarmBuilder.clear();
+ newAlarmBuilder.withTimeCleared(Instant.parse(alarmFieldValue).toEpochMilli());
+ break;
+ case TIME_UPDATED:
+ default:
+ newAlarmBuilder.withTimeUpdated(Instant.parse(alarmFieldValue).toEpochMilli());
+ break;
+ }
+ alarmStore.createOrUpdateAlarm(newAlarmBuilder.build());
+ }
+
+ public enum AlarmField {
+ SOURCE,
+ ASSIGNED_USER,
+ ACKNOWLEDGED,
+ MANUALLY_CLEARABLE,
+ SERVICE_AFFECTING,
+ TIME_CLEARED,
+ TIME_UPDATED
+ }
+}
diff --git a/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmFieldCompleter.java b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmFieldCompleter.java
new file mode 100644
index 0000000..3af51a0
--- /dev/null
+++ b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmFieldCompleter.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2018-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.faultmanagement.alarms.cli.completer;
+
+import org.onosproject.cli.AbstractChoicesCompleter;
+import org.onosproject.faultmanagement.alarms.cli.UpdateAlarm;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * CLI completer for Alarm Severity.
+ */
+public class AlarmFieldCompleter extends AbstractChoicesCompleter {
+ @Override
+ public List<String> choices() {
+ List<String> choices = new ArrayList<>();
+
+ Arrays.asList(UpdateAlarm.AlarmField.values()).forEach(field -> choices.add(field.toString()));
+
+ return choices;
+ }
+
+}
diff --git a/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmFieldValueCompleter.java b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmFieldValueCompleter.java
new file mode 100644
index 0000000..e1dcb64
--- /dev/null
+++ b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmFieldValueCompleter.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2018-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.faultmanagement.alarms.cli.completer;
+
+import org.apache.felix.service.command.CommandSession;
+import org.apache.karaf.shell.console.CommandSessionHolder;
+import org.apache.karaf.shell.console.completer.ArgumentCompleter;
+import org.onosproject.cli.AbstractChoicesCompleter;
+import org.onosproject.faultmanagement.alarms.cli.UpdateAlarm;
+
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * CLI completer for Alarm Field values.
+ */
+public class AlarmFieldValueCompleter extends AbstractChoicesCompleter {
+ @Override
+ protected List<String> choices() {
+
+ List<String> choices = new ArrayList<>();
+ CommandSession session = CommandSessionHolder.getSession();
+
+ ArgumentCompleter.ArgumentList list =
+ (ArgumentCompleter.ArgumentList) session.get(ArgumentCompleter.ARGUMENTS_LIST);
+ UpdateAlarm.AlarmField field = UpdateAlarm.AlarmField.valueOf(list.getArguments()[2]);
+
+ switch (field) {
+ case ACKNOWLEDGED:
+ case MANUALLY_CLEARABLE:
+ case SERVICE_AFFECTING:
+ choices.add("TRUE");
+ choices.add("FALSE");
+ return choices;
+ case TIME_CLEARED:
+ case TIME_UPDATED:
+ choices.add(Instant.now().toString());
+ default:
+ return choices;
+ }
+ }
+}
diff --git a/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmIdCompleter.java b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmIdCompleter.java
new file mode 100644
index 0000000..fa67d61
--- /dev/null
+++ b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmIdCompleter.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2018-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.faultmanagement.alarms.cli.completer;
+
+import org.onosproject.cli.AbstractChoicesCompleter;
+import static org.onosproject.cli.AbstractShellCommand.get;
+import org.onosproject.faultmanagement.api.AlarmStore;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * CLI completer for Alarm Id.
+ */
+public class AlarmIdCompleter extends AbstractChoicesCompleter {
+ @Override
+ public List<String> choices() {
+ List<String> choices = new ArrayList<>();
+
+ AlarmStore alarmStore = get(AlarmStore.class);
+ alarmStore.getAlarms().forEach((alarm -> choices.add(alarm.id().toString())));
+
+ return choices;
+ }
+
+}
diff --git a/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmSeverityCompleter.java b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmSeverityCompleter.java
new file mode 100644
index 0000000..9322b07
--- /dev/null
+++ b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/AlarmSeverityCompleter.java
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2018-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.faultmanagement.alarms.cli.completer;
+
+import org.onosproject.cli.AbstractChoicesCompleter;
+import org.onosproject.incubator.net.faultmanagement.alarm.Alarm;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * CLI completer for Alarm Severity.
+ */
+public class AlarmSeverityCompleter extends AbstractChoicesCompleter {
+ @Override
+ public List<String> choices() {
+ List<String> severityList = new ArrayList<>();
+
+ Arrays.asList(Alarm.SeverityLevel.values()).forEach(s -> severityList.add(s.toString()));
+
+ return severityList;
+ }
+}
diff --git a/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/package-info.java b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/package-info.java
new file mode 100644
index 0000000..bcd3f9d
--- /dev/null
+++ b/apps/faultmanagement/fmcli/src/main/java/org/onosproject/faultmanagement/alarms/cli/completer/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-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.
+ */
+
+/**
+ * CLI completers for alarms.
+ */
+package org.onosproject.faultmanagement.alarms.cli.completer;
\ No newline at end of file