openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceInfo.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 java.math.BigInteger;
  12 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  16 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  17
  18 /**
  19  * API defining basic device information
  20  */
  21 public interface DeviceInfo extends XidSequencer {
  22
  23     /**
  24      * @return id of encapsulated node
  25      */
  26     NodeId getNodeId();
  27
  28     /**
  29      * @return {@link Node} instance identifier
  30      */
  31     KeyedInstanceIdentifier<Node, NodeKey> getNodeInstanceIdentifier();
  32
  33     /**
  34      * @return version
  35      */
  36     Short getVersion();
  37
  38     /**
  39      * @return datapathId
  40      */
  41     BigInteger getDatapathId();
  42
  43     /**
  44      * @return clustering service identifier
  45      */
  46     ServiceGroupIdentifier getServiceIdentifier();
  47
  48     /**
  49      * Many uses in log, this will make code more readable
  50      * @return string representation of nodeId
  51      */
  52     default String getLOGValue() {
  53         return getNodeId().getValue();
  54     }
  55
  56 }