opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronFirewallAware.java

   1 /*
   2  * Copyright (C) 2014 Red Hat, Inc.
   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.controller.networkconfig.neutron;
  10
  11 /**
  12  * This interface defines the methods a service that wishes to be aware of Firewall Rules needs to implement
  13  *
  14  * @deprecated Replaced by {@link org.opendaylight.neutron.neutron.spi.INeutronFirewallAware}
  15  */
  16
  17 @Deprecated
  18 public interface INeutronFirewallAware {
  19
  20     /**
  21      * Services provide this interface method to indicate if the specified firewall can be created
  22      *
  23      * @param firewall
  24      *            instance of proposed new Firewall object
  25      * @return integer
  26      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  27      *            results in the create operation being interrupted and the returned status value reflected in the
  28      *            HTTP response.
  29      */
  30     public int canCreateNeutronFirewall(NeutronFirewall firewall);
  31
  32     /**
  33      * Services provide this interface method for taking action after a firewall has been created
  34      *
  35      * @param firewall
  36      *            instance of new Firewall object
  37      * @return void
  38      */
  39     public void neutronFirewallCreated(NeutronFirewall firewall);
  40
  41     /**
  42      * Services provide this interface method to indicate if the specified firewall can be changed using the specified
  43      * delta
  44      *
  45      * @param delta
  46      *            updates to the firewall object using patch semantics
  47      * @param original
  48      *            instance of the Firewall object to be updated
  49      * @return integer
  50      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  51      *            results in the update operation being interrupted and the returned status value reflected in the
  52      *            HTTP response.
  53      */
  54     public int canUpdateNeutronFirewall(NeutronFirewall delta, NeutronFirewall original);
  55
  56     /**
  57      * Services provide this interface method for taking action after a firewall has been updated
  58      *
  59      * @param firewall
  60      *            instance of modified Firewall object
  61      * @return void
  62      */
  63     public void neutronFirewallUpdated(NeutronFirewall firewall);
  64
  65     /**
  66      * Services provide this interface method to indicate if the specified firewall can be deleted
  67      *
  68      * @param firewall
  69      *            instance of the Firewall object to be deleted
  70      * @return integer
  71      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  72      *            results in the delete operation being interrupted and the returned status value reflected in the
  73      *            HTTP response.
  74      */
  75     public int canDeleteNeutronFirewall(NeutronFirewall firewall);
  76
  77     /**
  78      * Services provide this interface method for taking action after a firewall has been deleted
  79      *
  80      * @param firewall
  81      *            instance of deleted Firewall object
  82      * @return void
  83      */
  84     public void neutronFirewallDeleted(NeutronFirewall firewall);
  85 }