org.opendaylight.lispflowmapping.lisp.serializer.address.LispAddressSerializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mappingservice.lisp-proto Show documentation
There is a newer version: 1.19.1
Show newest version
/*
 * Copyright (c) 2014 Contextream, 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.lispflowmapping.lisp.serializer.address;

import java.nio.ByteBuffer;
import org.opendaylight.lispflowmapping.lisp.serializer.address.factory.LispAddressSerializerFactory;
import org.opendaylight.lispflowmapping.lisp.serializer.exception.LispSerializationException;
import org.opendaylight.lispflowmapping.lisp.util.AddressTypeMap;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana.afn.safi.rev130704.AddressFamily;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.InstanceIdType;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Lcaf;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.LispAddress;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.LispAddressFamily;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.SimpleAddress;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.Rloc;
import org.opendaylight.yangtools.yang.common.Uint32;

public class LispAddressSerializer {

    private static final LispAddressSerializer INSTANCE = new LispAddressSerializer();
    public static final InstanceIdType DEFAULT_VNI = new InstanceIdType(Uint32.ZERO);

    // Private constructor prevents instantiation from other classes
    protected LispAddressSerializer() {
    }

    public static LispAddressSerializer getInstance() {
        return INSTANCE;
    }

    protected void serializeData(ByteBuffer buffer, LispAddress lispAddress) {
        throw new LispSerializationException("Unimplemented method");
    }

    protected void serializeData(ByteBuffer buffer, SimpleAddress lispAddress) {
        throw new LispSerializationException("Unimplemented method");
    }

    protected void serializeData(ByteBuffer buffer, IpPrefix lispAddress) {
        throw new LispSerializationException("Unimplemented method");
    }

    protected Eid deserializeEidData(ByteBuffer buffer, LispAddressSerializerContext ctx) {
        throw new LispSerializationException("Unimplemented method");
    }

    protected SimpleAddress deserializeSimpleAddressData(ByteBuffer buffer, LispAddressSerializerContext ctx) {
        throw new LispSerializationException("Unimplemented method");
    }

    protected Eid deserializeLcafEidData(ByteBuffer buffer, byte res2, short length,
            LispAddressSerializerContext ctx) {
        throw new LispSerializationException("Unimplemented method");
    }

    protected Rloc deserializeRlocData(ByteBuffer buffer) {
        throw new LispSerializationException("Unimplemented method");
    }

    protected Rloc deserializeLcafRlocData(ByteBuffer buffer, byte res2, short length,
            LispAddressSerializerContext ctx) {
        throw new LispSerializationException("Unimplemented method");
    }

    protected short getAfi() {
        throw new LispSerializationException("Unimplemented method");
    }

    protected byte getLcafType() {
        throw new LispSerializationException("Unimplemented method");
    }

    protected short getLcafLength(LispAddress lispAddress) {
        throw new LispSerializationException("Unimplemented method");
    }

    protected int getAddressSize(SimpleAddress address) {
        throw new LispSerializationException("Unimplemented method");
    }

    public int getAddressSize(LispAddress lispAddress) {
        int size = Length.AFI;
        if (lispAddress.getVirtualNetworkId() != null) {
            size += getInstanceIdExtraSize();
        }
        LispAddressSerializer serializer = LispAddressSerializerFactory.getSerializer(lispAddress.getAddressType());
        if (serializer == null) {
            throw new LispSerializationException("Unknown address type: "
                    + lispAddress.getAddressType().getSimpleName());
        }
        return size + serializer.getAddressSize(lispAddress);
    }

    protected InstanceIdType getVni(LispAddressSerializerContext ctx) {
        if (ctx != null) {
            return ctx.getVni();
        }
        return null;
    }

    public void serialize(ByteBuffer buffer, LispAddress lispAddress) {
        if (lispAddress.getVirtualNetworkId() != null) {
            serializeInstanceIdExtra(buffer, lispAddress);
        }
        LispAddressSerializer serializer = LispAddressSerializerFactory.getSerializer(lispAddress.getAddressType());
        if (serializer == null) {
            throw new LispSerializationException("Unknown address type: "
                    + lispAddress.getAddressType().getSimpleName());
        }
        short afi = serializer.getAfi();
        if (afi == (short) AddressFamily.LispCanonicalAddressFormat.getIntValue()) {
            serializer =  LispAddressSerializerFactory.getSerializer(Lcaf.class);
        }
        buffer.putShort(afi);
        serializer.serializeData(buffer, lispAddress);
    }

    private void serializeInstanceIdExtra(ByteBuffer buffer, LispAddress lispAddress) {
        buffer.putShort((short) AddressFamily.LispCanonicalAddressFormat.getIntValue());
        LcafSerializer.getInstance().serializeLCAFAddressHeaderForInstanceId(buffer, lispAddress);
        InstanceIdSerializer.getInstance().serializeNonLcafAddress(buffer, lispAddress);
    }

    int getInstanceIdExtraSize() {
        return LcafSerializer.getInstance().getLcafHeaderSize()
                + InstanceIdSerializer.getInstance().getInstanceIdSize()
                + Length.AFI;
    }

    @SuppressWarnings("checkstyle:IllegalCatch")
    public Eid deserializeEid(ByteBuffer buffer, LispAddressSerializerContext ctx) {
        short afi = buffer.getShort();
        // AddressTypeMap indexes IPv4 and IPv6 prefixes (vs simple addresses) with the negative AFI values -1 and -2
        if ((afi == 1 || afi == 2) && ctx.getMaskLen() != LispAddressSerializerContext.MASK_LEN_MISSING) {
            afi *= -1;
        }
        Class addressType = AddressTypeMap.getAddressType(afi);
        LispAddressSerializer serializer = LispAddressSerializerFactory.getSerializer(addressType);
        if (serializer == null) {
            throw new LispSerializationException("Unknown AFI: " + afi);
        }
        try {
            return serializer.deserializeEidData(buffer, ctx);
        } catch (RuntimeException e) {
            throw new LispSerializationException("Problem deserializing AFI " + afi + " in EID context", e);
        }
    }

    @SuppressWarnings("checkstyle:IllegalCatch")
    public Rloc deserializeRloc(ByteBuffer buffer) {
        short afi = buffer.getShort();
        Class addressType = AddressTypeMap.getAddressType(afi);
        LispAddressSerializer serializer = LispAddressSerializerFactory.getSerializer(addressType);
        if (serializer == null) {
            throw new LispSerializationException("Unknown AFI: " + afi);
        }
        try {
            return serializer.deserializeRlocData(buffer);
        } catch (RuntimeException e) {
            throw new LispSerializationException("Problem deserializing AFI " + afi + " in RLOC context", e);
        }
    }

    private interface Length {
        int AFI = 2;
    }
}