FlowReconcileQuery.java

/**
 *    Copyright 2013, Big Switch Networks, Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License"); you may
 *    not use this file except in compliance with the License. You may obtain
 *    a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 *    License for the specific language governing permissions and limitations
 *    under the License.
 **/

package net.floodlightcontroller.flowcache;

import java.lang.ref.SoftReference;

import net.floodlightcontroller.debugevent.IDebugEventService.EventColumn;
import net.floodlightcontroller.debugevent.IDebugEventService.EventFieldType;
import net.floodlightcontroller.debugevent.IDebugEventService.EventType;
import net.floodlightcontroller.debugevent.IDebugEventService.MaxEventsRegistered;
import net.floodlightcontroller.debugevent.IDebugEventService;
import net.floodlightcontroller.debugevent.IEventUpdater;
import net.floodlightcontroller.flowcache.PriorityPendingQueue.EventPriority;

/**
 * The base Class for FlowReconcileQuery.
 */
public class FlowReconcileQuery {
    public ReconcileQueryEvType evType;
    public EventPriority evPriority;
    public static class FlowReconcileQueryDebugEvent {
        @EventColumn(name = "Event Info",
                     description = EventFieldType.SREF_OBJECT)
        private final SoftReference<FlowReconcileQuery> eventInfo;
        @EventColumn(name = "Stage",
                     description = EventFieldType.STRING)
        private final String stage;
        @EventColumn(name = "Stage Info",
                     description = EventFieldType.SREF_OBJECT)
        private final SoftReference<Object> stageInfo;
        public FlowReconcileQueryDebugEvent(FlowReconcileQuery eventInfo,
                                            String stage,
                                            Object stageInfo) {
            super();
            this.eventInfo = new SoftReference<FlowReconcileQuery>(eventInfo);
            this.stage = stage;
            if (stageInfo != null) {
                this.stageInfo = new SoftReference<Object>(stageInfo);
            } else {
                this.stageInfo = null;
            }
        }
    }
    public static enum ReconcileQueryEvType {
        /* Interface rule of a bvs was modified */
        BVS_INTERFACE_RULE_CHANGED(EventPriority.LOW,
            "Flow Reconcile Events triggered by BVS Interface Rule Changes"),
        BVS_INTERFACE_RULE_CHANGED_MATCH_SWITCH_PORT(EventPriority.LOW,
            "Flow Reconcile Events triggered by Switch-Port based BVS Interface Rule Changes"),
        BVS_INTERFACE_RULE_CHANGED_MATCH_MAC(EventPriority.LOW,
            "Flow Reconcile Events triggered by MAC based BVS Interface Rule Changes"),
        BVS_INTERFACE_RULE_CHANGED_MATCH_VLAN(EventPriority.LOW,
            "Flow Reconcile Events triggered by VLAN based BVS Interface Rule Changes"),
        BVS_INTERFACE_RULE_CHANGED_MATCH_IPSUBNET(EventPriority.LOW,
            "Flow Reconcile Events triggered by IP Subnet based BVS Interface Rule Changes"),
        BVS_INTERFACE_RULE_CHANGED_MATCH_TAG(EventPriority.LOW,
            "Flow Reconcile Events triggered by Tag based BVS Interface Rule Changes"),
        /* Some bvs configuration was changed */
        BVS_PRIORITY_CHANGED(EventPriority.LOW,
            "Flow Reconcile Events triggered by BVS Priority Changes"),
        /* ACL configuration was changed */
        ACL_CONFIG_CHANGED(EventPriority.LOW,
            "Flow Reconcile Events triggered by ACL Config Changes"),
        /* VRS routing rule was changed */
        VRS_ROUTING_RULE_CHANGED(EventPriority.LOW,
            "Flow Reconcile Events triggered by VRS Routing Rule Changes"),
        /* VRS static ARP table was changed*/
        VRS_STATIC_ARP_CHANGED(EventPriority.LOW,
            "Flow Reconcile Events triggered by VRS Static ARP Config Changes"),
        /* device had moved to a different port in the network */
        DEVICE_MOVED(EventPriority.HIGH,
            "Flow Reconcile Events triggered by Host moves"),
        /* device's property had changed, such as tag assignment */
        DEVICE_PROPERTY_CHANGED(EventPriority.LOW,
            "Flow Reconcile Events triggered by Host Property Changes"),
        /* Link down */
        LINK_DOWN(EventPriority.MEDIUM,
            "Flow Reconcile Events triggered by Link Down Events");

        private String description;
        private EventPriority priority;
        private IEventUpdater<FlowReconcileQueryDebugEvent>
                evReconcileQueryDebugEvent;

        private ReconcileQueryEvType(EventPriority priority,
                                     String description) {
            this.priority = priority;
            this.description = description;
        }
        public EventPriority getPriority() {
             return this.priority;
        }
        public String getDescription() {
            return description;
        }
        public void registerDebugEvent(String packageName,
                                       IDebugEventService debugEvents)
                                       throws MaxEventsRegistered {
            try {
                evReconcileQueryDebugEvent =
                    debugEvents.registerEvent(
                        packageName,
                        this.toString().toLowerCase().replace("_", "-"),
                        this.getDescription(),
                        EventType.ALWAYS_LOG,
                        FlowReconcileQueryDebugEvent.class,
                        500);
            } catch (MaxEventsRegistered e) {
                throw e;
            }
        }
        public IEventUpdater<FlowReconcileQueryDebugEvent> getDebugEvent() {
            return evReconcileQueryDebugEvent;
        }
    }
    public FlowReconcileQuery(ReconcileQueryEvType evType) {
        this.evType = evType;
        this.evPriority = evType.getPriority();
    }

    @Override
    public String toString() {
        return "FlowReconcileQuery [evType="
                + evType + "]";
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
                result = prime * result + ((evType == null) ? 0 : evType.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null) return false;
        if (getClass() != obj.getClass()) return false;
        FlowReconcileQuery other = (FlowReconcileQuery) obj;
        if (evType != other.evType) return false;
                return true;
    }
}