Package org.opendaylight.mdsal.dom.api
Interface DOMActionAvailabilityExtension
-
- All Superinterfaces:
DOMActionServiceExtension
,DOMServiceExtension<DOMActionService,DOMActionServiceExtension>
@Beta @NonNullByDefault public interface DOMActionAvailabilityExtension extends DOMActionServiceExtension
AnDOMActionServiceExtension
exposed byDOMActionService
s which allow their users to listen for actions are becoming available.- Author:
- Robert Varga
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
DOMActionAvailabilityExtension.AvailabilityListener
AnEventListener
used to track Operation implementations becoming (un)available to aDOMActionService
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <T extends DOMActionAvailabilityExtension.AvailabilityListener>
org.opendaylight.yangtools.concepts.ListenerRegistration<T>registerAvailabilityListener(T listener)
Register aDOMActionAvailabilityExtension.AvailabilityListener
with this service to receive notifications about operation implementations becoming (un)available.
-
-
-
Method Detail
-
registerAvailabilityListener
<T extends DOMActionAvailabilityExtension.AvailabilityListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T> registerAvailabilityListener(T listener)
Register aDOMActionAvailabilityExtension.AvailabilityListener
with this service to receive notifications about operation implementations becoming (un)available. The listener will be invoked with the current implementations reported and will be kept uptodate as implementations come and go.Users should note that using a listener does not necessarily mean that
DOMActionService.invokeAction(SchemaPath, DOMDataTreeIdentifier, ContainerNode)
will not report a failure due toDOMActionNotAvailableException
and need to be ready to handle it.Implementations are encouraged to take reasonable precautions to prevent this scenario from occurring.
- Parameters:
listener
-DOMActionAvailabilityExtension.AvailabilityListener
instance to register- Returns:
- A
ListenerRegistration
representing this registration. Performing aListenerRegistration.close()
will cancel it. - Throws:
NullPointerException
- iflistener
is null
-
-