org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChain Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openflowplugin-api Show documentation
The newest version!
/*
 * Copyright (c) 2016 Pantheon Technologies s.r.o. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.openflowplugin.api.openflow.lifecycle;

import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.mdsal.singleton.api.ClusterSingletonService;
import org.opendaylight.mdsal.singleton.api.ClusterSingletonServiceProvider;
import org.opendaylight.openflowplugin.api.openflow.OFPContext;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceRemovedHandler;

/**
 * Chain of contexts, hold references to the contexts.
 * @since 0.4.0 Carbon
 */
public interface ContextChain extends ClusterSingletonService, AutoCloseable, ReconciliationFrameworkStep,
        DeviceInitializationContext {

    /**
     * Add context to the chain, if reference already exist ignore it.
     * @param context child of OFPContext
     */
     void addContext(@NonNull T context);

    @Override
    void close();

    /**
     * Slave was successfully set.
     */
    void makeContextChainStateSlave();

    /**
     * Registers context chain into cluster singleton service.
     * @param clusterSingletonServiceProvider provider
     */
    void registerServices(ClusterSingletonServiceProvider clusterSingletonServiceProvider);

    /**
     * Check all needed to be master.
     * @param mastershipState state master on device, initial gather, initial submit, initial registry fill
     * @param inReconciliationFrameworkStep if true, check all needed to be master except the device is written
     *                                      into data store. Using by reconciliation framework. Used only if
     *                                      {@link OwnershipChangeListener#isReconciliationFrameworkRegistered()} is
     *                                      set to true.
     * @return true if everything done fine
     * @see org.opendaylight.openflowplugin.api.openflow.mastership.MastershipChangeService
     */
    boolean isMastered(@NonNull ContextChainMastershipState mastershipState,
                       boolean inReconciliationFrameworkStep);

    /**
     * Checks if context chain is currently closing.
     * @return true if context chain is closing
     */
    boolean isClosing();

    /**
     * Add new auxiliary connection if primary is ok.
     * @param connectionContext new connection to the device.
     * @return false if primary connection is broken
     */
    boolean addAuxiliaryConnection(@NonNull ConnectionContext connectionContext);

    /**
     * Check if connection is auxiliary and if yes then continue working.
     * @param connectionContext connection to the device
     * @return false if this is primary connection
     */
    boolean auxiliaryConnectionDropped(@NonNull ConnectionContext connectionContext);

    /**
     * This method registers device removed handler what will be executed when device should be removed.
     * @param deviceRemovedHandler device removed handler
     */
    void registerDeviceRemovedHandler(@NonNull DeviceRemovedHandler deviceRemovedHandler);
}