ILinkDiscovery.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.linkdiscovery;

import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;

import org.projectfloodlight.openflow.types.DatapathId;
import org.projectfloodlight.openflow.types.OFPort;
import org.projectfloodlight.openflow.types.U64;

public interface ILinkDiscovery {

    @JsonSerialize(using=ToStringSerializer.class)
    public enum UpdateOperation {
        LINK_UPDATED("Link Updated"),
        LINK_REMOVED("Link Removed"),
        SWITCH_UPDATED("Switch Updated"),
        SWITCH_REMOVED("Switch Removed"),
        PORT_UP("Port Up"),
        PORT_DOWN("Port Down"),
        TUNNEL_PORT_ADDED("Tunnel Port Added"),
        TUNNEL_PORT_REMOVED("Tunnel Port Removed");

        private String value;
        UpdateOperation(String v) {
            value = v;
        }

        @Override
        public String toString() {
            return value;
        }
    }

    public class LDUpdate {
        protected DatapathId src;
        protected OFPort srcPort;
        protected DatapathId dst;
        protected OFPort dstPort;
        protected SwitchType srcType;
        protected U64 latency;
        protected LinkType type;
        protected UpdateOperation operation;

        public LDUpdate(DatapathId src, OFPort srcPort,
        		DatapathId dst, OFPort dstPort, U64 latency,
                      ILinkDiscovery.LinkType type,
                      UpdateOperation operation) {
            this.src = src;
            this.srcPort = srcPort;
            this.dst = dst;
            this.dstPort = dstPort;
            this.latency = latency;
            this.type = type;
            this.operation = operation;
        }

        public LDUpdate(LDUpdate old) {
            this.src = old.src;
            this.srcPort = old.srcPort;
            this.dst = old.dst;
            this.dstPort = old.dstPort;
            this.srcType = old.srcType;
            this.latency = old.latency;
            this.type = old.type;
            this.operation = old.operation;
        }

        // For updtedSwitch(sw)
        public LDUpdate(DatapathId switchId, SwitchType stype, UpdateOperation oper){
            this.operation = oper;
            this.src = switchId;
            this.srcType = stype;
            this.latency = U64.ZERO;
        }

        // For port up or port down; and tunnel port added and removed.
        public LDUpdate(DatapathId sw, OFPort port, UpdateOperation operation) {
            this.src = sw;
            this.srcPort = port;
            this.operation = operation;
            this.latency = U64.ZERO;
        }

        public DatapathId getSrc() {
            return src;
        }

        public OFPort getSrcPort() {
            return srcPort;
        }

        public DatapathId getDst() {
            return dst;
        }

        public OFPort getDstPort() {
            return dstPort;
        }
        
        public U64 getLatency() {
        	return latency;
        }

        public SwitchType getSrcType() {
            return srcType;
        }

        public LinkType getType() {
            return type;
        }

        public UpdateOperation getOperation() {
            return operation;
        }

        public void setOperation(UpdateOperation operation) {
            this.operation = operation;
        }
        
        @Override
        public String toString() {
            switch (operation) {
            case LINK_REMOVED:
            case LINK_UPDATED:
                return "LDUpdate [operation=" + operation +
                        ", src=" + src.toString()
                        + ", srcPort=" + srcPort.toString()
                        + ", dst=" + dst.toString()
                        + ", dstPort=" + dstPort.toString()
                        + ", latency=" + latency.toString()
                        + ", type=" + type + "]";
            case PORT_DOWN:
            case PORT_UP:
                return "LDUpdate [operation=" + operation +
                        ", src=" + src.toString()
                        + ", srcPort=" + srcPort.toString() + "]";
            case SWITCH_REMOVED:
            case SWITCH_UPDATED:
                return "LDUpdate [operation=" + operation +
                        ", src=" + src.toString() + "]";
            default:
                return "LDUpdate: Unknown update.";
            }
        }
    }

    public enum SwitchType {
        BASIC_SWITCH, CORE_SWITCH
    };

    public enum LinkType {
        INVALID_LINK {
        	@Override
        	public String toString() {
        		return "invalid";
        	}
        }, 
        DIRECT_LINK{
        	@Override
        	public String toString() {
        		return "internal";
        	}
        }, 
        MULTIHOP_LINK {
        	@Override
        	public String toString() {
        		return "external";
        	}
        }, 
        TUNNEL {
        	@Override
        	public String toString() {
        		return "tunnel";
        	}
        }
    };

    public enum LinkDirection {
        UNIDIRECTIONAL {
            @Override
            public String toString() {
                return "unidirectional";
            }
        },
        BIDIRECTIONAL {
            @Override
            public String toString() {
                return "bidirectional";
            }
        }
    }
}