Package org.opendaylight.openflowplugin.applications.frm

Interface ForwardingRulesManager

    • Method Detail

      • start

        void start()

      • isNodeActive

        boolean isNodeActive​(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowCapableNode> ident)
        Method returns information : "is Node with send InstanceIdentifier connected"?.
        Parameters:
        ident - - the key of the node
        Returns:
        boolean - true if device is connected

      • checkNodeInOperationalDataStore

        boolean checkNodeInOperationalDataStore​(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowCapableNode> ident)
        Method returns information : "is Node with send InstanceIdentifier present in operational data store"?.
        Parameters:
        ident - - the key of the node
        Returns:
        boolean - true if device is present in operational data store

      • getNewTransactionId

        String getNewTransactionId()
        Method returns generated transaction ID, which is unique for every transaction. ID is composite from prefix ("DOM") and unique number.
        Returns:
        String transactionID for RPC transaction identification

      • getReadTransaction

        org.opendaylight.mdsal.binding.api.ReadTransaction getReadTransaction()
        Method returns Read Transaction. It is need for Node reconciliation only.
        Returns:
        ReadOnlyTransaction

      • getSalFlowService

        SalFlowService getSalFlowService()
        Flow RPC service.

      • getSalGroupService

        SalGroupService getSalGroupService()
        Group RPC service.

      • getSalMeterService

        SalMeterService getSalMeterService()
        Meter RPC service.

      • getSalTableService

        SalTableService getSalTableService()
        Table RPC service.

      • getDevicesGroupRegistry

        DevicesGroupRegistry getDevicesGroupRegistry()
        Return Devices Group Registry which can be used to track the groups present in a device.
        Returns:
        devicesGroupRegistry

      • getSalBundleService

        SalBundleService getSalBundleService()
        Bundle RPC service.
        Returns:
        salBundleService

      • getFlowCommiter

        ForwardingRulesCommiter<Flow> getFlowCommiter()
        Content definition method and prevent code duplicity in Reconcil.
        Returns:
        ForwardingRulesCommiter<Flow>.

      • getGroupCommiter

        ForwardingRulesCommiter<Group> getGroupCommiter()
        Content definition method and prevent code duplicity in Reconcil.
        Returns:
        ForwardingRulesCommiter<Group>

      • getMeterCommiter

        ForwardingRulesCommiter<Meter> getMeterCommiter()
        Content definition method and prevent code duplicity.
        Returns:
        ForwardingRulesCommiter<Meter>

      • getTableFeaturesCommiter

        ForwardingRulesCommiter<TableFeatures> getTableFeaturesCommiter()
        Content definition method and prevent code duplicity.
        Returns:
        ForwardingRulesCommiter<Table>

      • getBundleFlowListener

        BundleMessagesCommiter<Flow> getBundleFlowListener()
        Return BundleFlowListener instance.
        Returns:
        BundleFlowListener

      • getBundleGroupListener

        BundleMessagesCommiter<Group> getBundleGroupListener()
        Return BundleGroupListener instance.
        Returns:
        BundleGroupListener

      • isReconciliationDisabled

        boolean isReconciliationDisabled()
        Check if reconciliation is disabled by user.
        Returns:
        true if reconciliation is disabled, else false

      • isStaleMarkingEnabled

        boolean isStaleMarkingEnabled()
        Check if stale marking is enabled for switch reconciliation.
        Returns:
        true if stale marking is enabled, else false

      • getReconciliationRetryCount

        int getReconciliationRetryCount()
        Return number of reconciliation retry are allowed.
        Returns:
        number of retries.

      • isNodeOwner

        boolean isNodeOwner​(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<FlowCapableNode> ident)
        Method checks if *this* instance of openflowplugin is owner of the given openflow node.
        Returns:
        True if owner, else false

      • getFlowNodeConnectorInventoryTranslatorImpl

        FlowNodeConnectorInventoryTranslatorImpl getFlowNodeConnectorInventoryTranslatorImpl()
        Content definition method and prevent code duplicity.
        Returns:
        FlowNodeConnectorInventoryTranslatorImpl

      • isBundleBasedReconciliationEnabled

        boolean isBundleBasedReconciliationEnabled()
        holds the value read from the configuration file openflowplugin.cfg file.
        Returns:
        True if user enables bundle-based-reconciliation-enabled field in config file or False

      • getNodeConfigurator

        NodeConfigurator getNodeConfigurator()
        Return the NodeConfigurator which could be used to serialize jobs.
        Returns:
        modeConfigurator.

      • addRecoverableListener

        void addRecoverableListener​(org.opendaylight.serviceutils.srm.RecoverableListener recoverableListener)
        Method for register RecoverableListener.

      • getArbitratorReconciliationManager

        ArbitratorReconcileService getArbitratorReconciliationManager()
        Method exposes the ArbitratorReconciliationManager service used for performing Arbitrator Based Reconciliation.
        Returns:
        ArbitratorReconciliationManager