gerrit.opnfv Code Review - onosfw.git/blob

   1 /*
   2  * Copyright 2015 Open Networking Laboratory
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.onosproject.openflow.controller;
  17
  18 import java.util.List;
  19 import java.util.Set;
  20
  21 import org.projectfloodlight.openflow.protocol.OFObject;
  22
  23 /**
  24  * An interface implemented by OpenFlow devices that enables providers to
  25  * retrieve ports based on port property.
  26  */
  27 public interface WithTypedPorts {
  28
  29     /**
  30      * Return a list of interfaces (ports) of the type associated with this
  31      * OpenFlow switch.
  32      *
  33      * @param type The port description property type of requested ports
  34      * @return A potentially empty list of ports.
  35      */
  36     List<? extends OFObject> getPortsOf(PortDescPropertyType type);
  37
  38     /**
  39      * Returns the port property types supported by the driver implementing this
  40      * interface.
  41      *
  42      * @return A set of port property types
  43      */
  44     Set<PortDescPropertyType> getPortTypes();
  45 }