X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fnetworkconfiguration%2Fneutron%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fnetworkconfig%2Fneutron%2FINeutronRouterAware.java;h=3c9e83d490c0e0d561077f42ad3903b1c11e93b9;hp=16a9aec2397ac51a4ea98dc3ac07f5bb4b3beffb;hb=c222e37f2a0f0f3f6266242fbea2d3b018f4e6e3;hpb=e40d69673c2529d99069a8a0bafb152a1c11c41a;ds=sidebyside diff --git a/opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronRouterAware.java b/opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronRouterAware.java index 16a9aec239..3c9e83d490 100644 --- a/opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronRouterAware.java +++ b/opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronRouterAware.java @@ -1,105 +1,133 @@ -/* - * Copyright IBM Corporation, 2013. All rights reserved. - * - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/epl-v10.html - */ - -package org.opendaylight.controller.networkconfig.neutron; - -/** - * This interface defines the methods a service that wishes to be aware of Neutron Routers needs to implement - * - */ - -public interface INeutronRouterAware { - - /** - * Services provide this interface method to indicate if the specified router can be created - * - * @param router - * instance of proposed new Neutron Router object - * @return integer - * the return value is understood to be a HTTP status code. A return value outside of 200 through 299 - * results in the create operation being interrupted and the returned status value reflected in the - * HTTP response. - */ - public int canCreateRouter(NeutronRouter router); - - /** - * Services provide this interface method for taking action after a router has been created - * - * @param router - * instance of new Neutron Router object - * @return void - */ - public void neutronRouterCreated(NeutronRouter router); - - /** - * Services provide this interface method to indicate if the specified router can be changed using the specified - * delta - * - * @param delta - * updates to the router object using patch semantics - * @param router - * instance of the Neutron Router object to be updated - * @return integer - * the return value is understood to be a HTTP status code. A return value outside of 200 through 299 - * results in the update operation being interrupted and the returned status value reflected in the - * HTTP response. - */ - public int canUpdateRouter(NeutronRouter delta, NeutronRouter original); - - /** - * Services provide this interface method for taking action after a router has been updated - * - * @param router - * instance of modified Neutron Router object - * @return void - */ - public void neutronRouterUpdated(NeutronRouter router); - - /** - * Services provide this interface method to indicate if the specified router can be deleted - * - * @param router - * instance of the Neutron Router object to be deleted - * @return integer - * the return value is understood to be a HTTP status code. A return value outside of 200 through 299 - * results in the delete operation being interrupted and the returned status value reflected in the - * HTTP response. - */ - public int canDeleteRouter(NeutronRouter router); - - /** - * Services provide this interface method for taking action after a router has been deleted - * - * @param router - * instance of deleted Router Network object - * @return void - */ - public void neutronRouterDeleted(NeutronRouter router); - - /** - * Services provide this interface method for taking action after an interface has been added to a router - * - * @param router - * instance of the base Neutron Router object - * @param routerInterface - * instance of the NeutronRouter_Interface being attached to the router - * @return void - */ - public void neutronRouterInterfaceAttached(NeutronRouter router, NeutronRouter_Interface routerInterface); - - /** - * Services provide this interface method for taking action after an interface has been removed from a router - * - * @param router - * instance of the base Neutron Router object - * @param routerInterface - * instance of the NeutronRouter_Interface being detached from the router - * @return void - */ - public void neutronRouterInterfaceDetached(NeutronRouter router, NeutronRouter_Interface routerInterface); -} +/* + * Copyright IBM Corporation, 2013. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ + +package org.opendaylight.controller.networkconfig.neutron; + +/** + * This interface defines the methods a service that wishes to be aware of Neutron Routers needs to implement + * + */ + +public interface INeutronRouterAware { + + /** + * Services provide this interface method to indicate if the specified router can be created + * + * @param router + * instance of proposed new Neutron Router object + * @return integer + * the return value is understood to be a HTTP status code. A return value outside of 200 through 299 + * results in the create operation being interrupted and the returned status value reflected in the + * HTTP response. + */ + public int canCreateRouter(NeutronRouter router); + + /** + * Services provide this interface method for taking action after a router has been created + * + * @param router + * instance of new Neutron Router object + * @return void + */ + public void neutronRouterCreated(NeutronRouter router); + + /** + * Services provide this interface method to indicate if the specified router can be changed using the specified + * delta + * + * @param delta + * updates to the router object using patch semantics + * @param router + * instance of the Neutron Router object to be updated + * @return integer + * the return value is understood to be a HTTP status code. A return value outside of 200 through 299 + * results in the update operation being interrupted and the returned status value reflected in the + * HTTP response. + */ + public int canUpdateRouter(NeutronRouter delta, NeutronRouter original); + + /** + * Services provide this interface method for taking action after a router has been updated + * + * @param router + * instance of modified Neutron Router object + * @return void + */ + public void neutronRouterUpdated(NeutronRouter router); + + /** + * Services provide this interface method to indicate if the specified router can be deleted + * + * @param router + * instance of the Neutron Router object to be deleted + * @return integer + * the return value is understood to be a HTTP status code. A return value outside of 200 through 299 + * results in the delete operation being interrupted and the returned status value reflected in the + * HTTP response. + */ + public int canDeleteRouter(NeutronRouter router); + + /** + * Services provide this interface method for taking action after a router has been deleted + * + * @param router + * instance of deleted Router Network object + * @return void + */ + public void neutronRouterDeleted(NeutronRouter router); + + /** + * Services provide this interface method to indicate if the specified interface can be attached to the specified route + * + * @param router + * instance of the base Neutron Router object + * @param routerInterface + * instance of the NeutronRouter_Interface to be attached to the router + * @return integer + * the return value is understood to be a HTTP status code. A return value outside of 200 through 299 + * results in the attach operation being interrupted and the returned status value reflected in the + * HTTP response. + */ + public int canAttachInterface(NeutronRouter router, NeutronRouter_Interface routerInterface); + + /** + * Services provide this interface method for taking action after an interface has been added to a router + * + * @param router + * instance of the base Neutron Router object + * @param routerInterface + * instance of the NeutronRouter_Interface being attached to the router + * @return void + */ + public void neutronRouterInterfaceAttached(NeutronRouter router, NeutronRouter_Interface routerInterface); + + /** + * Services provide this interface method to indicate if the specified interface can be detached from the specified router + * + * @param router + * instance of the base Neutron Router object + * @param routerInterface + * instance of the NeutronRouter_Interface to be detached to the router + * @return integer + * the return value is understood to be a HTTP status code. A return value outside of 200 through 299 + * results in the detach operation being interrupted and the returned status value reflected in the + * HTTP response. + */ + public int canDetachInterface(NeutronRouter router, NeutronRouter_Interface routerInterface); + + /** + * Services provide this interface method for taking action after an interface has been removed from a router + * + * @param router + * instance of the base Neutron Router object + * @param routerInterface + * instance of the NeutronRouter_Interface being detached from the router + * @return void + */ + public void neutronRouterInterfaceDetached(NeutronRouter router, NeutronRouter_Interface routerInterface); +}