neutron-spi/src/main/java/org/opendaylight/neutron/spi/INeutronPortAware.java

   1 /*
   2  * Copyright (c) 2013, 2015 IBM Corporation 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
   9 package org.opendaylight.neutron.spi;
  10
  11 /**
  12  * This interface defines the methods a service that wishes to be aware of Neutron Ports needs to implement
  13  *
  14  */
  15 @Deprecated
  16 public interface INeutronPortAware {
  17
  18     /**
  19      * Services provide this interface method to indicate if the specified port can be created
  20      *
  21      * @param port
  22      *            instance of proposed new Neutron Port object
  23      * @return integer
  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
  26      *            HTTP response.
  27      */
  28     int canCreatePort(NeutronPort port);
  29
  30     /**
  31      * Services provide this interface method for taking action after a port has been created
  32      *
  33      * @param port
  34      *            instance of new Neutron Port object
  35      */
  36     void neutronPortCreated(NeutronPort port);
  37
  38     /**
  39      * Services provide this interface method to indicate if the specified port can be changed using the specified
  40      * delta
  41      *
  42      * @param delta
  43      *            updates to the port object using patch semantics
  44      * @param original
  45      *            instance of the Neutron Port object to be updated
  46      * @return integer
  47      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  48      *            results in the update operation being interrupted and the returned status value reflected in the
  49      *            HTTP response.
  50      */
  51     int canUpdatePort(NeutronPort delta, NeutronPort original);
  52
  53     /**
  54      * Services provide this interface method for taking action after a port has been updated
  55      *
  56      * @param port
  57      *            instance of modified Neutron Port object
  58      */
  59     void neutronPortUpdated(NeutronPort port);
  60
  61     /**
  62      * Services provide this interface method to indicate if the specified port can be deleted
  63      *
  64      * @param port
  65      *            instance of the Neutron Port object to be deleted
  66      * @return integer
  67      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  68      *            results in the delete operation being interrupted and the returned status value reflected in the
  69      *            HTTP response.
  70      */
  71     int canDeletePort(NeutronPort port);
  72
  73     /**
  74      * Services provide this interface method for taking action after a port has been deleted
  75      *
  76      * @param port
  77      *            instance of deleted Port Network object
  78      */
  79     void neutronPortDeleted(NeutronPort port);
  80 }