Java tutorial
/* * Copyright 2016-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.faultmanagement.impl; import com.google.common.collect.ImmutableSet; import org.apache.commons.collections.CollectionUtils; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; import org.apache.felix.scr.annotations.Modified; import org.apache.felix.scr.annotations.Reference; import org.apache.felix.scr.annotations.ReferenceCardinality; import org.apache.felix.scr.annotations.Service; import org.onlab.util.ItemNotFoundException; import org.onosproject.faultmanagement.api.AlarmStore; import org.onosproject.faultmanagement.api.AlarmStoreDelegate; import org.onosproject.incubator.net.faultmanagement.alarm.Alarm; import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEntityId; import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEvent; import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId; import org.onosproject.incubator.net.faultmanagement.alarm.AlarmListener; import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProvider; import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderRegistry; import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderService; import org.onosproject.incubator.net.faultmanagement.alarm.AlarmService; import org.onosproject.incubator.net.faultmanagement.alarm.DefaultAlarm; import org.onosproject.net.ConnectPoint; import org.onosproject.net.DeviceId; import org.onosproject.net.provider.AbstractListenerProviderRegistry; import org.onosproject.net.provider.AbstractProviderService; import org.slf4j.Logger; import java.util.Collection; import java.util.Map; import java.util.Set; import java.util.concurrent.atomic.AtomicLong; import java.util.stream.Collectors; import static com.google.common.base.Preconditions.checkNotNull; import static org.onlab.util.Tools.nullIsNotFound; import static org.slf4j.LoggerFactory.getLogger; /** * Implementation of the Alarm service. */ @Component(immediate = true) @Service public class AlarmManager extends AbstractListenerProviderRegistry<AlarmEvent, AlarmListener, AlarmProvider, AlarmProviderService> implements AlarmService, AlarmProviderRegistry { private final Logger log = getLogger(getClass()); @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) protected AlarmStore store; protected AlarmStoreDelegate delegate = this::post; //TODO improve implementation of AlarmId private final AtomicLong alarmIdGenerator = new AtomicLong(0); private static final String NOT_SUPPORTED_YET = "Not supported yet."; @Activate public void activate() { store.setDelegate(delegate); eventDispatcher.addSink(AlarmEvent.class, listenerRegistry); log.info("Started"); } @Deactivate public void deactivate() { store.unsetDelegate(delegate); eventDispatcher.removeSink(AlarmEvent.class); log.info("Stopped"); } @Modified public boolean modified() { log.info("Modified"); return true; } @Override public Alarm updateBookkeepingFields(AlarmId id, boolean isAcknowledged, String assignedUser) { Alarm found = store.getAlarm(id); if (found == null) { throw new ItemNotFoundException("Alarm with id " + id + " found"); } Alarm updated = new DefaultAlarm.Builder(found).withId(found.id()).withAcknowledged(isAcknowledged) .withAssignedUser(assignedUser).build(); store.setAlarm(updated); return updated; } public Alarm clear(AlarmId id) { Alarm found = store.getAlarm(id); if (found == null) { log.warn("Alarm {} is not present", id); return null; } Alarm updated = new DefaultAlarm.Builder(found).withId(id).clear().build(); store.setAlarm(updated); return updated; } @Override public Map<Alarm.SeverityLevel, Long> getAlarmCounts(DeviceId deviceId) { return getAlarms(deviceId).stream().collect(Collectors.groupingBy(Alarm::severity, Collectors.counting())); } @Override public Map<Alarm.SeverityLevel, Long> getAlarmCounts() { return getAlarms().stream().collect(Collectors.groupingBy(Alarm::severity, Collectors.counting())); } @Override public Alarm getAlarm(AlarmId alarmId) { return nullIsNotFound(store.getAlarm(checkNotNull(alarmId, "Alarm Id cannot be null")), "Alarm is not found"); } @Override public Set<Alarm> getAlarms() { return ImmutableSet.copyOf(store.getAlarms()); } @Override public Set<Alarm> getActiveAlarms() { return ImmutableSet.copyOf(store.getAlarms().stream() .filter(a -> !a.severity().equals(Alarm.SeverityLevel.CLEARED)).collect(Collectors.toSet())); } @Override public Set<Alarm> getAlarms(Alarm.SeverityLevel severity) { return ImmutableSet.copyOf( store.getAlarms().stream().filter(a -> a.severity().equals(severity)).collect(Collectors.toSet())); } @Override public Set<Alarm> getAlarms(DeviceId deviceId) { return ImmutableSet.copyOf(store.getAlarms(deviceId)); } private Set<Alarm> getActiveAlarms(DeviceId deviceId) { return ImmutableSet.copyOf( getActiveAlarms().stream().filter(a -> deviceId.equals(a.deviceId())).collect(Collectors.toSet())); } @Override public Set<Alarm> getAlarms(DeviceId deviceId, AlarmEntityId source) { return ImmutableSet.copyOf( getAlarms(deviceId).stream().filter(a -> source.equals(a.source())).collect(Collectors.toSet())); } @Override public Set<Alarm> getAlarmsForLink(ConnectPoint src, ConnectPoint dst) { throw new UnsupportedOperationException(NOT_SUPPORTED_YET); } @Override public Set<Alarm> getAlarmsForFlow(DeviceId deviceId, long flowId) { throw new UnsupportedOperationException(NOT_SUPPORTED_YET); } @Override protected AlarmProviderService createProviderService(AlarmProvider provider) { return new InternalAlarmProviderService(provider); } // Synchronised to prevent duplicate NE alarms being raised protected synchronized void updateAlarms(DeviceId deviceId, Set<Alarm> discoveredSet) { Set<Alarm> storedSet = getActiveAlarms(deviceId); log.debug("CurrentNeAlarms={}. DiscoveredAlarms={}", storedSet, discoveredSet); if (CollectionUtils.isEqualCollection(storedSet, discoveredSet)) { log.debug("No update for {}.", deviceId); return; } //TODO implement distinction between UPDATED and CLEARED ALARMS storedSet.stream().filter((stored) -> (!discoveredSet.contains(stored))).forEach((stored) -> { log.debug("Alarm will be Cleared as it is not on the device. Cleared alarm: {}.", stored); clear(stored.id()); }); discoveredSet.stream().filter((discovered) -> (!storedSet.contains(discovered))).forEach((discovered) -> { log.info("New alarm raised {}", discovered); AlarmId id = generateAlarmId(); store.setAlarm(new DefaultAlarm.Builder(discovered).withId(id).build()); }); } //TODO improve implementation of AlarmId private AlarmId generateAlarmId() { return AlarmId.alarmId(alarmIdGenerator.incrementAndGet()); } private class InternalAlarmProviderService extends AbstractProviderService<AlarmProvider> implements AlarmProviderService { InternalAlarmProviderService(AlarmProvider provider) { super(provider); } @Override public void updateAlarmList(DeviceId deviceId, Collection<Alarm> alarms) { updateAlarms(deviceId, ImmutableSet.copyOf(alarms)); } } }