Convert neutron service base classes to unix line delimiters.
[controller.git] / opendaylight / networkconfiguration / neutron / src / main / java / org / opendaylight / controller / networkconfig / neutron / INeutronRouterAware.java
index 040bdd87c4cdfd0fddbe39dae95dd67a4e956f04..3c9e83d490c0e0d561077f42ad3903b1c11e93b9 100644 (file)
-/*\r
- * Copyright IBM Corporation, 2013.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-\r
-package org.opendaylight.controller.networkconfig.neutron;\r
-\r
-/**\r
- * This interface defines the methods a service that wishes to be aware of Neutron Routers needs to implement\r
- *\r
- */\r
-\r
-public interface INeutronRouterAware {\r
-\r
-    /**\r
-     * Services provide this interface method to indicate if the specified router can be created\r
-     *\r
-     * @param router\r
-     *            instance of proposed new Neutron Router object\r
-     * @return integer\r
-     *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299\r
-     *            results in the create operation being interrupted and the returned status value reflected in the\r
-     *            HTTP response.\r
-     */\r
-    public int canCreateRouter(NeutronRouter router);\r
-\r
-    /**\r
-     * Services provide this interface method for taking action after a router has been created\r
-     *\r
-     * @param router\r
-     *            instance of new Neutron Router object\r
-     * @return void\r
-     */\r
-    public void neutronRouterCreated(NeutronRouter router);\r
-\r
-    /**\r
-     * Services provide this interface method to indicate if the specified router can be changed using the specified\r
-     * delta\r
-     *\r
-     * @param delta\r
-     *            updates to the router object using patch semantics\r
-     * @param router\r
-     *            instance of the Neutron Router object to be updated\r
-     * @return integer\r
-     *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299\r
-     *            results in the update operation being interrupted and the returned status value reflected in the\r
-     *            HTTP response.\r
-     */\r
-    public int canUpdateRouter(NeutronRouter delta, NeutronRouter original);\r
-\r
-    /**\r
-     * Services provide this interface method for taking action after a router has been updated\r
-     *\r
-     * @param router\r
-     *            instance of modified Neutron Router object\r
-     * @return void\r
-     */\r
-    public void neutronRouterUpdated(NeutronRouter router);\r
-\r
-    /**\r
-     * Services provide this interface method to indicate if the specified router can be deleted\r
-     *\r
-     * @param router\r
-     *            instance of the Neutron Router object to be deleted\r
-     * @return integer\r
-     *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299\r
-     *            results in the delete operation being interrupted and the returned status value reflected in the\r
-     *            HTTP response.\r
-     */\r
-    public int canDeleteRouter(NeutronRouter router);\r
-\r
-    /**\r
-     * Services provide this interface method for taking action after a router has been deleted\r
-     *\r
-     * @param router\r
-     *            instance of deleted Router Network object\r
-     * @return void\r
-     */\r
-    public void neutronRouterDeleted(NeutronRouter router);\r
-\r
-    /**\r
-     * Services provide this interface method to indicate if the specified interface can be attached to the specified route\r
-     *\r
-     * @param router\r
-     *            instance of the base Neutron Router object\r
-     * @param routerInterface\r
-     *            instance of the NeutronRouter_Interface to be attached to the router\r
-     * @return integer\r
-     *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299\r
-     *            results in the attach operation being interrupted and the returned status value reflected in the\r
-     *            HTTP response.\r
-     */\r
-    public int canAttachInterface(NeutronRouter router, NeutronRouter_Interface routerInterface);\r
-\r
-    /**\r
-     * Services provide this interface method for taking action after an interface has been added to a router\r
-     *\r
-     * @param router\r
-     *            instance of the base Neutron Router object\r
-     * @param routerInterface\r
-     *            instance of the NeutronRouter_Interface being attached to the router\r
-     * @return void\r
-     */\r
-    public void neutronRouterInterfaceAttached(NeutronRouter router, NeutronRouter_Interface routerInterface);\r
-\r
-    /**\r
-     * Services provide this interface method to indicate if the specified interface can be detached from the specified router\r
-     *\r
-     * @param router\r
-     *            instance of the base Neutron Router object\r
-     * @param routerInterface\r
-     *            instance of the NeutronRouter_Interface to be detached to the router\r
-     * @return integer\r
-     *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299\r
-     *            results in the detach operation being interrupted and the returned status value reflected in the\r
-     *            HTTP response.\r
-     */\r
-    public int canDetachInterface(NeutronRouter router, NeutronRouter_Interface routerInterface);\r
-\r
-    /**\r
-     * Services provide this interface method for taking action after an interface has been removed from a router\r
-     *\r
-     * @param router\r
-     *            instance of the base Neutron Router object\r
-     * @param routerInterface\r
-     *            instance of the NeutronRouter_Interface being detached from the router\r
-     * @return void\r
-     */\r
-    public void neutronRouterInterfaceDetached(NeutronRouter router, NeutronRouter_Interface routerInterface);\r
-}\r
+/*
+ * 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);
+}