openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceState.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.openflowplugin.api.openflow.device;
  10
  11 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  15 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  16
  17 /**
  18  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  19  */
  20 public interface DeviceState {
  21
  22     /**
  23      * @return id of encapsulated node
  24      */
  25     NodeId getNodeId();
  26
  27     /**
  28      * @return {@link Node} instance identifier
  29      */
  30     KeyedInstanceIdentifier<Node, NodeKey> getNodeInstanceIdentifier();
  31
  32     /**
  33      * @return the features of corresponding switch
  34      */
  35     GetFeaturesOutput getFeatures();
  36
  37     /**
  38      * @return true if this session is valid
  39      */
  40     boolean isValid();
  41
  42     /**
  43      * @param valid the valid to set
  44      */
  45     void setValid(boolean valid);
  46
  47     /**
  48      * Return node current OF protocol version
  49      *
  50      * @return
  51      */
  52     short getVersion();
  53
  54     /**
  55      * Return true if we have relevant meter information
  56      * from device
  57      *
  58      * @return
  59      */
  60     boolean isMetersAvailable();
  61
  62     /**
  63      * Set information about meter statistics availability.
  64      */
  65     void setMeterAvailable(boolean available);
  66
  67     /**
  68      * Return true if we have relevant group information
  69      * from device
  70      *
  71      * @return
  72      */
  73     boolean isGroupAvailable();
  74
  75     /**
  76      * Set information about group statistics availability.
  77      */
  78     void setGroupAvailable(boolean available);
  79
  80     /**
  81      * Method returns true if initial statistics data were collected and written to DS.
  82      *
  83      * @return
  84      */
  85     boolean deviceSynchronized();
  86
  87     /**
  88      * Method returns true, if device capabilities provides flow statistics.
  89      *
  90      * @return
  91      */
  92     boolean isFlowStatisticsAvailable();
  93
  94     void setFlowStatisticsAvailable(boolean available);
  95
  96     /**
  97      * Method returns true, if device capabilities provides table statistics.
  98      *
  99      * @return
 100      */
 101     boolean isTableStatisticsAvailable();
 102
 103     void setTableStatisticsAvailable(boolean available);
 104
 105     /**
 106      * Method returns true, if device capabilities provides flow statistics.
 107      *
 108      * @return
 109      */
 110     boolean isPortStatisticsAvailable();
 111
 112     void setPortStatisticsAvailable(boolean available);
 113
 114     /**
 115      * Method returns true, if device capabilities provides queue statistics.
 116      *
 117      * @return
 118      */
 119     boolean isQueueStatisticsAvailable();
 120
 121     void setQueueStatisticsAvailable(boolean available);
 122
 123     void setDeviceSynchronized(boolean deviceSynchronized);
 124
 125     boolean isStatisticsPollingEnabled();
 126
 127     void setStatisticsPollingEnabledProp(boolean statPollEnabled);
 128
 129 }