2 * Copyright IBM Corporation, 2013. All rights reserved.
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
9 package org.opendaylight.controller.networkconfig.neutron;
12 * This interface defines the methods a service that wishes to be aware of Neutron Routers needs to implement
16 public interface INeutronRouterAware {
19 * Services provide this interface method to indicate if the specified router can be created
22 * instance of proposed new Neutron Router object
24 * the return value is understood to be a HTTP status code. A return value outside of 200 through 299
25 * results in the create operation being interrupted and the returned status value reflected in the
28 public int canCreateRouter(NeutronRouter router);
31 * Services provide this interface method for taking action after a router has been created
34 * instance of new Neutron Router object
37 public void neutronRouterCreated(NeutronRouter router);
40 * Services provide this interface method to indicate if the specified router can be changed using the specified
44 * updates to the router object using patch semantics
46 * instance of the Neutron Router object to be updated
48 * the return value is understood to be a HTTP status code. A return value outside of 200 through 299
49 * results in the update operation being interrupted and the returned status value reflected in the
52 public int canUpdateRouter(NeutronRouter delta, NeutronRouter original);
55 * Services provide this interface method for taking action after a router has been updated
58 * instance of modified Neutron Router object
61 public void neutronRouterUpdated(NeutronRouter router);
64 * Services provide this interface method to indicate if the specified router can be deleted
67 * instance of the Neutron Router object to be deleted
69 * the return value is understood to be a HTTP status code. A return value outside of 200 through 299
70 * results in the delete operation being interrupted and the returned status value reflected in the
73 public int canDeleteRouter(NeutronRouter router);
76 * Services provide this interface method for taking action after a router has been deleted
79 * instance of deleted Router Network object
82 public void neutronRouterDeleted(NeutronRouter router);
85 * Services provide this interface method to indicate if the specified interface can be attached to the specified route
88 * instance of the base Neutron Router object
89 * @param routerInterface
90 * instance of the NeutronRouter_Interface to be attached to the router
92 * the return value is understood to be a HTTP status code. A return value outside of 200 through 299
93 * results in the attach operation being interrupted and the returned status value reflected in the
96 public int canAttachInterface(NeutronRouter router, NeutronRouter_Interface routerInterface);
99 * Services provide this interface method for taking action after an interface has been added to a router
102 * instance of the base Neutron Router object
103 * @param routerInterface
104 * instance of the NeutronRouter_Interface being attached to the router
107 public void neutronRouterInterfaceAttached(NeutronRouter router, NeutronRouter_Interface routerInterface);
110 * Services provide this interface method to indicate if the specified interface can be detached from the specified router
113 * instance of the base Neutron Router object
114 * @param routerInterface
115 * instance of the NeutronRouter_Interface to be detached to the router
117 * the return value is understood to be a HTTP status code. A return value outside of 200 through 299
118 * results in the detach operation being interrupted and the returned status value reflected in the
121 public int canDetachInterface(NeutronRouter router, NeutronRouter_Interface routerInterface);
124 * Services provide this interface method for taking action after an interface has been removed from a router
127 * instance of the base Neutron Router object
128 * @param routerInterface
129 * instance of the NeutronRouter_Interface being detached from the router
132 public void neutronRouterInterfaceDetached(NeutronRouter router, NeutronRouter_Interface routerInterface);