/*
 * Copyright (c) 2015 Cisco Systems, Inc. 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.device;

import com.google.common.util.concurrent.ListenableFuture;
import io.netty.util.Timeout;
import java.math.BigInteger;
import java.util.List;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;

/**
 * <p>
 * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
 * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
 * These attach to a particular Device Context in such a way, that there is at most one primary
 * session associated with a Device Context. Whenever the controller needs to interact with a
 * particular switch, it will do so in the context of the calling thread, obtaining a lock on
 * the corresponding Device Context – thus the Device Context becomes the fine-grained point
 * of synchronization. The only two entities allowed to send requests towards the switch are
 * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
 * with a particular Device Context. The Request Contexts are the basic units of fairness,
 * which is enforced by keeping a cap on the number of outstanding requests a particular Request
 * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
 * a request to the switch will fail immediately, with proper error indication.
 * </p>
 */
public interface DeviceContext extends AutoCloseable,
        DeviceReplyProcessor,
        PortNumberCache,
        TxFacade,
        XidSequencer {

    void setStatisticsRpcEnabled(boolean isStatisticsRpcEnabled);

    /**
     * distinguished device context states
     */
    enum DEVICE_CONTEXT_STATE {
        /**
         * initial phase of talking to switch
         */
        INITIALIZATION,
        /**
         * standard phase - interacting with switch
         */
        WORKING,
        /**
         * termination phase of talking to switch
         */
        TERMINATION
    }

    /**
     * Method returns current device context state.
     *
     * @return {@link DeviceContext.DEVICE_CONTEXT_STATE}
     */
    DEVICE_CONTEXT_STATE getDeviceContextState();

    /**
     * Method close all auxiliary connections and primary connection.
     */
    void shutdownConnection();

    /**
     * Method add auxiliary connection contexts to this context representing single device connection.
     *
     * @param connectionContext
     */
    void addAuxiliaryConnectionContext(ConnectionContext connectionContext);

    /**
     * Method removes auxiliary connection context from this context representing single device connection.
     *
     * @param connectionContext
     */
    void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);

    /**
     * Method provides state of device represented by this device context.
     *
     * @return {@link DeviceState}
     */
    DeviceState getDeviceState();

    DeviceInfo getDeviceInfo();

    /**
     * Method has to activate (MASTER) or deactivate (SLAVE) TransactionChainManager.
     * TransactionChainManager represents possibility to write or delete Node subtree data
     * for actual Controller Cluster Node. We are able to have an active TxManager only if
     * newRole is {@link OfpRole#BECOMESLAVE}.
     * Parameters are used as marker to be sure it is change to SLAVE from MASTER or from
     * MASTER to SLAVE and the last parameter "cleanDataStore" is used for validation only.
     * @param oldRole - old role for quick validation for needed processing
     * @param role - NewRole expect to be {@link OfpRole#BECOMESLAVE} or {@link OfpRole#BECOMEMASTER}
     * @return RoleChangeTxChainManager future for activation/deactivation
     * @deprecated replaced by method onDeviceTakeClusterLeadership and onDevicLostClusterLeadership
     */
    @Deprecated
    ListenableFuture<Void> onClusterRoleChange(@Nullable OfpRole oldRole, @CheckForNull OfpRole role);

    /**
     * Method has to activate TransactionChainManager and prepare all Contexts from Device Contects suite
     * to Taking ClusterLeadership role {@link OfpRole#BECOMEMASTER} (e.g. Routed RPC registration, StatPolling ...)
     * @return DeviceInitialization furure
     */
    ListenableFuture<Void> onDeviceTakeClusterLeadership();

    /**
     * Method has to deactivate TransactionChainManager and prepare all Contexts from Device Contects suite
     * to Lost ClusterLeadership role {@link OfpRole#BECOMESLAVE} (e.g. Stop RPC rounting, stop StatPolling ...)
     * @return RoleChangeTxChainManager future for deactivation
     */
    ListenableFuture<Void> onDeviceLostClusterLeadership();

    /**
     * Method has to close TxManager ASAP we are notified about Closed Connection
     * @return sync. future for Slave and MD-SAL completition for Master
     */
    ListenableFuture<Void> shuttingDownDataStoreTransactions();

    /**
     * Method provides current devices connection context.
     *
     * @return
     */
    ConnectionContext getPrimaryConnectionContext();

    /**
     * Method provides current devices auxiliary connection contexts.
     *
     * @return
     */
    ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);

    /**
     * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
     *
     * @return
     */
    DeviceFlowRegistry getDeviceFlowRegistry();

    /**
     * Method exposes device group registry used for storing group ids.
     *
     * @return
     */
    DeviceGroupRegistry getDeviceGroupRegistry();

    /**
     * Method exposes device meter registry used for storing meter ids.
     *
     * @return
     */
    DeviceMeterRegistry getDeviceMeterRegistry();


    /**
     * @return translator library
     */
    TranslatorLibrary oook();

    /**
     * store cancellable timeout handler of currently running barrier task
     */
    void setCurrentBarrierTimeout(Timeout timeout);

    /**
     * @return cancellable timeout handle of currently running barrier task
     */
    Timeout getBarrierTaskTimeout();

    void setNotificationPublishService(NotificationPublishService notificationPublishService);

    MessageSpy getMessageSpy();

    MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);

    /**
     * indicates that device context is fully published (e.g.: packetIn messages should be passed)
     */
    void onPublished();

    /**
     * change packetIn rate limiter borders
     *
     * @param upperBound max amount of outstanding packetIns
     */
    void updatePacketInRateLimit(long upperBound);

    /**
     * @return registry point for item life cycle sources of device
     */
    ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();

    void setRpcContext(RpcContext rpcContext);

    RpcContext getRpcContext();

    void setStatisticsContext(StatisticsContext statisticsContext);

    StatisticsContext getStatisticsContext();

    @Override
    void close();
}