infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/NotificationProducer.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   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 io.fd.honeycomb.v3po.notification;
  17
  18 import com.google.common.annotations.Beta;
  19 import java.util.Collection;
  20 import javax.annotation.Nonnull;
  21 import org.opendaylight.yangtools.yang.binding.Notification;
  22
  23 /**
  24  * Produces notification of exposed notification types
  25  */
  26 @Beta
  27 public interface NotificationProducer extends AutoCloseable {
  28
  29     /**
  30      * Return collection of notification types that will be emitted by this producer.
  31      * Other types of notifications should not be emitted, since they can be rejected.
  32      *
  33      * @return collection of all notification types emitted by this producer
  34      */
  35     @Nonnull
  36     Collection<Class<? extends Notification>> getNotificationTypes();
  37 }