kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 1 | /* |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 2 | * Copyright 2015 Open Networking Laboratory |
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; |
| 20 | import java.io.IOException; |
| 21 | import java.io.InputStream; |
| 22 | import org.onosproject.rest.AbstractWebResource; |
| 23 | |
| 24 | import javax.ws.rs.core.Response; |
| 25 | import org.onosproject.incubator.net.faultmanagement.alarm.Alarm; |
| 26 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId; |
| 27 | |
| 28 | import javax.ws.rs.Consumes; |
| 29 | import javax.ws.rs.DefaultValue; |
| 30 | import javax.ws.rs.GET; |
| 31 | import javax.ws.rs.PUT; |
| 32 | import javax.ws.rs.Path; |
| 33 | import javax.ws.rs.PathParam; |
| 34 | import javax.ws.rs.Produces; |
| 35 | import javax.ws.rs.QueryParam; |
| 36 | import javax.ws.rs.core.MediaType; |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 37 | import org.apache.commons.lang.StringUtils; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 38 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmService; |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 39 | import org.onosproject.net.DeviceId; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 40 | import org.slf4j.Logger; |
| 41 | import static org.slf4j.LoggerFactory.getLogger; |
| 42 | |
| 43 | /** |
| 44 | * Alarms on devices or ONOS. |
| 45 | */ |
| 46 | @Path("alarms") |
| 47 | public class AlarmsWebResource extends AbstractWebResource { |
| 48 | |
| 49 | public static final String ALARM_NOT_FOUND = "Alarm is not found"; |
| 50 | |
| 51 | private final Logger log = getLogger(getClass()); |
| 52 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 53 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 54 | * Get alarms. Returns a list of alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 55 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 56 | * @param includeCleared (optional) include recently cleared alarms in response |
| 57 | * @param devId (optional) include only for specified device |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 58 | * @return JSON encoded set of alarms |
| 59 | */ |
| 60 | @GET |
| 61 | @Produces(MediaType.APPLICATION_JSON) |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 62 | public Response getAlarms(@DefaultValue("false") @QueryParam("includeCleared") boolean includeCleared, |
| 63 | @DefaultValue("") @QueryParam("devId") String devId |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 64 | ) { |
| 65 | |
| 66 | log.info("Requesting all alarms, includeCleared={}", includeCleared); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 67 | AlarmService service = get(AlarmService.class); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 68 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 69 | Iterable<Alarm> alarms; |
| 70 | if (StringUtils.isBlank(devId)) { |
| 71 | alarms = includeCleared |
| 72 | ? service.getAlarms() |
| 73 | : service.getActiveAlarms(); |
| 74 | } else { |
| 75 | alarms = service.getAlarms(DeviceId.deviceId(devId)); |
| 76 | } |
| 77 | ObjectNode result = new ObjectMapper().createObjectNode(); |
| 78 | result.set("alarms", new AlarmCodec().encode(alarms, this)); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 79 | return ok(result.toString()).build(); |
| 80 | |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Get specified alarm. Returns details of the specified alarm. |
| 85 | * |
| 86 | * @param id ONOS allocated identifier |
| 87 | * @return JSON encoded alarm |
| 88 | */ |
| 89 | @GET |
| 90 | @Path("{id}") |
| 91 | @Produces(MediaType.APPLICATION_JSON) |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 92 | public Response getAlarm(@PathParam("id") String id) { |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 93 | log.info("HTTP GET alarm for id={}", id); |
| 94 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 95 | AlarmId alarmId = toAlarmId(id); |
| 96 | Alarm alarm = get(AlarmService.class).getAlarm(alarmId); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 97 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 98 | ObjectNode result = new ObjectMapper().createObjectNode(); |
| 99 | result.set("alarm", new AlarmCodec().encode(alarm, this)); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 100 | return ok(result.toString()).build(); |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Update book-keeping fields on the alarm. Returns an up-to-date version of the alarm. Some of its fields may have |
| 105 | * been updated since the REST client last retrieved the alarm being updated. |
| 106 | * |
Brian O'Connor | 08eb1ac | 2015-12-07 00:11:32 -0800 | [diff] [blame] | 107 | * @param alarmIdPath alarm id path |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 108 | * @param stream input JSON |
| 109 | * @return updated JSON encoded alarm |
| 110 | */ |
| 111 | @PUT |
| 112 | @Path("{alarm_id}") |
| 113 | @Consumes(MediaType.APPLICATION_JSON) |
| 114 | @Produces(MediaType.APPLICATION_JSON) |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 115 | public Response update(@PathParam("alarm_id") String alarmIdPath, InputStream stream) { |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 116 | log.info("PUT NEW ALARM at /{}", alarmIdPath); |
| 117 | |
| 118 | try { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 119 | ObjectNode jsonTree = (ObjectNode) mapper().readTree(stream); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 120 | log.info("jsonTree={}", jsonTree); |
| 121 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 122 | Alarm alarm = new AlarmCodec().decode(jsonTree, this); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 123 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 124 | AlarmService service = get(AlarmService.class); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 125 | |
| 126 | if (Long.parseLong(alarmIdPath) != alarm.id().fingerprint()) { |
| 127 | throw new IllegalArgumentException("id in path is " + Long.parseLong(alarmIdPath) |
| 128 | + " but payload uses id=" + alarm.id().fingerprint()); |
| 129 | |
| 130 | } |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 131 | Alarm updated = service.updateBookkeepingFields( |
| 132 | alarm.id(), alarm.acknowledged(), alarm.assignedUser() |
| 133 | ); |
| 134 | ObjectNode encoded = new AlarmCodec().encode(updated, this); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 135 | return ok(encoded.toString()).build(); |
| 136 | |
| 137 | } catch (IOException ioe) { |
| 138 | throw new IllegalArgumentException(ioe); |
| 139 | } |
| 140 | } |
| 141 | |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 142 | private static AlarmId toAlarmId(String id) { |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 143 | try { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 144 | return AlarmId.alarmId(Long.parseLong(id)); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 145 | } catch (NumberFormatException ex) { |
| 146 | throw new IllegalArgumentException("Alarm id should be numeric", ex); |
| 147 | } |
| 148 | |
| 149 | } |
| 150 | |
| 151 | } |