kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.faultmanagement.web; |
| 17 | |
| 18 | import com.fasterxml.jackson.databind.ObjectMapper; |
| 19 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 20 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 21 | import java.io.IOException; |
| 22 | import java.io.InputStream; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 23 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 24 | import org.onosproject.rest.AbstractWebResource; |
| 25 | |
| 26 | import javax.ws.rs.core.Response; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 27 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 28 | import org.onosproject.incubator.net.faultmanagement.alarm.Alarm; |
| 29 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId; |
| 30 | |
| 31 | import javax.ws.rs.Consumes; |
| 32 | import javax.ws.rs.DefaultValue; |
| 33 | import javax.ws.rs.GET; |
| 34 | import javax.ws.rs.PUT; |
| 35 | import javax.ws.rs.Path; |
| 36 | import javax.ws.rs.PathParam; |
| 37 | import javax.ws.rs.Produces; |
| 38 | import javax.ws.rs.QueryParam; |
| 39 | import javax.ws.rs.core.MediaType; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 40 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 41 | import org.apache.commons.lang.StringUtils; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 42 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmService; |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 43 | import org.onosproject.net.DeviceId; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 44 | import org.slf4j.Logger; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 45 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 46 | import static org.slf4j.LoggerFactory.getLogger; |
| 47 | |
| 48 | /** |
| 49 | * Alarms on devices or ONOS. |
| 50 | */ |
| 51 | @Path("alarms") |
| 52 | public class AlarmsWebResource extends AbstractWebResource { |
| 53 | |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 54 | private static final String ALARM_NOT_FOUND = "Alarm is not found"; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 55 | |
| 56 | private final Logger log = getLogger(getClass()); |
| 57 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 58 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 59 | * Get alarms. Returns a list of alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 60 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 61 | * @param includeCleared (optional) include recently cleared alarms in response |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 62 | * @param devId (optional) include only for specified device |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 63 | * @return JSON encoded set of alarms |
| 64 | */ |
| 65 | @GET |
| 66 | @Produces(MediaType.APPLICATION_JSON) |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 67 | public Response getAlarms(@DefaultValue("false") @QueryParam("includeCleared") boolean includeCleared, |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 68 | @DefaultValue("") @QueryParam("devId") String devId |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 69 | ) { |
| 70 | |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 71 | log.debug("Requesting all alarms, includeCleared={}", includeCleared); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 72 | AlarmService service = get(AlarmService.class); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 73 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 74 | Iterable<Alarm> alarms; |
| 75 | if (StringUtils.isBlank(devId)) { |
| 76 | alarms = includeCleared |
| 77 | ? service.getAlarms() |
| 78 | : service.getActiveAlarms(); |
| 79 | } else { |
| 80 | alarms = service.getAlarms(DeviceId.deviceId(devId)); |
| 81 | } |
| 82 | ObjectNode result = new ObjectMapper().createObjectNode(); |
| 83 | result.set("alarms", new AlarmCodec().encode(alarms, this)); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 84 | return ok(result.toString()).build(); |
| 85 | |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Get specified alarm. Returns details of the specified alarm. |
| 90 | * |
| 91 | * @param id ONOS allocated identifier |
| 92 | * @return JSON encoded alarm |
| 93 | */ |
| 94 | @GET |
| 95 | @Path("{id}") |
| 96 | @Produces(MediaType.APPLICATION_JSON) |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 97 | public Response getAlarm(@PathParam("id") String id) { |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 98 | log.debug("HTTP GET alarm for id={}", id); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 99 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 100 | AlarmId alarmId = AlarmId.alarmId(id); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 101 | Alarm alarm = get(AlarmService.class).getAlarm(alarmId); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 102 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 103 | ObjectNode result = new ObjectMapper().createObjectNode(); |
| 104 | result.set("alarm", new AlarmCodec().encode(alarm, this)); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 105 | return ok(result.toString()).build(); |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Update book-keeping fields on the alarm. Returns an up-to-date version of the alarm. Some of its fields may have |
| 110 | * been updated since the REST client last retrieved the alarm being updated. |
| 111 | * |
Brian O'Connor | 08eb1ac | 2015-12-07 00:11:32 -0800 | [diff] [blame] | 112 | * @param alarmIdPath alarm id path |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 113 | * @param stream input JSON |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 114 | * @return updated JSON encoded alarm |
| 115 | */ |
| 116 | @PUT |
| 117 | @Path("{alarm_id}") |
| 118 | @Consumes(MediaType.APPLICATION_JSON) |
| 119 | @Produces(MediaType.APPLICATION_JSON) |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 120 | public Response update(@PathParam("alarm_id") String alarmIdPath, InputStream stream) { |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 121 | log.debug("PUT NEW ALARM at /{}", alarmIdPath); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 122 | |
| 123 | try { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 124 | ObjectNode jsonTree = (ObjectNode) mapper().readTree(stream); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 125 | log.debug("jsonTree={}", jsonTree); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 126 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 127 | Alarm alarm = new AlarmCodec().decode(jsonTree, this); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 128 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 129 | AlarmService service = get(AlarmService.class); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 130 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 131 | if (!alarmIdPath.equals(alarm.id().toString())) { |
| 132 | throw new IllegalArgumentException("id in path is " + alarmIdPath |
| 133 | + " but payload uses id=" + alarm.id().toString()); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 134 | |
| 135 | } |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 136 | Alarm updated = service.updateBookkeepingFields( |
Ray Milkey | 9c7c369 | 2018-02-09 16:29:09 -0800 | [diff] [blame^] | 137 | alarm.id(), alarm.cleared(), alarm.acknowledged(), alarm.assignedUser() |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 138 | ); |
| 139 | ObjectNode encoded = new AlarmCodec().encode(updated, this); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 140 | return ok(encoded.toString()).build(); |
| 141 | |
| 142 | } catch (IOException ioe) { |
| 143 | throw new IllegalArgumentException(ioe); |
| 144 | } |
| 145 | } |
| 146 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 147 | } |