f762b889a99f0e910b6353e12292c819e87ceacb
[netconf.git] / netconf / sal-netconf-connector / src / main / java / org / opendaylight / netconf / sal / connect / api / RemoteDeviceHandler.java
1 /*
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.netconf.sal.connect.api;
9
10 import org.opendaylight.mdsal.dom.api.DOMActionService;
11 import org.opendaylight.mdsal.dom.api.DOMNotification;
12 import org.opendaylight.mdsal.dom.api.DOMRpcService;
13 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
14
15 public interface RemoteDeviceHandler<PREF> extends AutoCloseable {
16
17     /**
18      * When device connected, init new mount point with specific schema context and DOM services.
19      *
20      * @param remoteSchemaContext - schema context of connected device
21      * @param netconfSessionPreferences - session of device
22      * @param deviceRpc - {@link DOMRpcService} of device
23      */
24     default void onDeviceConnected(final SchemaContext remoteSchemaContext, final PREF netconfSessionPreferences,
25             final DOMRpcService deviceRpc) {
26         // DO NOTHING
27     }
28
29     /**
30      * When device connected, init new mount point with specific schema context and DOM services.
31      *
32      * @param remoteSchemaContext - schema context of connected device
33      * @param netconfSessionPreferences - session of device
34      * @param deviceRpc - {@link DOMRpcService} of device
35      * @param deviceAction - {@link DOMActionService} of device
36      */
37     default void onDeviceConnected(final SchemaContext remoteSchemaContext, final PREF netconfSessionPreferences,
38             final DOMRpcService deviceRpc, final DOMActionService deviceAction) {
39         // DO NOTHING
40     }
41
42     void onDeviceDisconnected();
43
44     void onDeviceFailed(Throwable throwable);
45
46     void onNotification(DOMNotification domNotification);
47
48     @Override
49     void close();
50 }