2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.protocol.pcep.spi;
10 import java.util.Arrays;
11 import java.util.BitSet;
12 import java.util.List;
14 import org.opendaylight.protocol.util.ByteArray;
15 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcerrBuilder;
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.ObjectHeader;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcep.error.object.ErrorObjectBuilder;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.PcerrMessageBuilder;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.ErrorsBuilder;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.RequestCaseBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.request._case.RequestBuilder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.request._case.request.RpsBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
27 import com.google.common.base.Preconditions;
28 import com.google.common.collect.Lists;
29 import com.google.common.primitives.UnsignedBytes;
31 public abstract class AbstractMessageParser implements MessageParser, MessageSerializer {
33 private static final int COMMON_OBJECT_HEADER_LENGTH = 4;
35 private static final int OC_F_LENGTH = 1;
36 private static final int OT_FLAGS_MF_LENGTH = 1;
37 private static final int OBJ_LENGTH_F_LENGTH = 2;
39 private static final int OT_SF_LENGTH = 4;
40 private static final int FLAGS_SF_LENGTH = 4;
42 * offsets of fields inside of multi-field in bits
44 private static final int OT_SF_OFFSET = 0;
45 private static final int FLAGS_SF_OFFSET = OT_SF_OFFSET + OT_SF_LENGTH;
47 * flags offsets inside multi-filed
49 private static final int P_FLAG_OFFSET = 6;
50 private static final int I_FLAG_OFFSET = 7;
52 private final ObjectHandlerRegistry registry;
54 protected AbstractMessageParser(final ObjectHandlerRegistry registry) {
55 this.registry = Preconditions.checkNotNull(registry);
58 protected byte[] serializeObject(final Object object) {
62 final ObjectSerializer serializer = this.registry.getObjectSerializer(object);
63 return serializer.serializeObject(object);
66 private List<Object> parseObjects(final byte[] bytes) throws PCEPDeserializerException {
68 final List<Object> objs = Lists.newArrayList();
69 while (bytes.length - offset > 0) {
70 if (bytes.length - offset < COMMON_OBJECT_HEADER_LENGTH) {
71 throw new PCEPDeserializerException("Too few bytes in passed array. Passed: " + (bytes.length - offset) + " Expected: >= "
72 + COMMON_OBJECT_HEADER_LENGTH + ".");
75 final int objClass = UnsignedBytes.toInt(bytes[offset]);
77 offset += OC_F_LENGTH;
79 final int objType = UnsignedBytes.toInt(ByteArray.copyBitsRange(bytes[offset], OT_SF_OFFSET, OT_SF_LENGTH));
81 final byte[] flagsBytes = { ByteArray.copyBitsRange(bytes[offset], FLAGS_SF_OFFSET, FLAGS_SF_LENGTH) };
83 final BitSet flags = ByteArray.bytesToBitSet(flagsBytes);
85 offset += OT_FLAGS_MF_LENGTH;
87 final int objLength = ByteArray.bytesToInt(ByteArray.subByte(bytes, offset, OBJ_LENGTH_F_LENGTH));
89 if (bytes.length - offset < objLength - COMMON_OBJECT_HEADER_LENGTH) {
90 throw new PCEPDeserializerException("Too few bytes in passed array. Passed: " + (bytes.length - offset) + " Expected: >= "
94 offset += OBJ_LENGTH_F_LENGTH;
96 // copy bytes for deeper parsing
97 final byte[] bytesToPass = ByteArray.subByte(bytes, offset, objLength - COMMON_OBJECT_HEADER_LENGTH);
99 offset += objLength - COMMON_OBJECT_HEADER_LENGTH;
101 final ObjectParser parser = Preconditions.checkNotNull(this.registry.getObjectParser(objClass, objType));
102 final ObjectHeader header = new ObjectHeaderImpl(flags.get(P_FLAG_OFFSET), flags.get(I_FLAG_OFFSET));
104 // parseObject is required to return null for P=0 errored objects
105 final Object o = parser.parseObject(header, bytesToPass);
114 public static Message createErrorMsg(final PCEPErrors e) {
115 final PCEPErrorMapping maping = PCEPErrorMapping.getInstance();
116 return new PcerrBuilder().setPcerrMessage(
117 new PcerrMessageBuilder().setErrors(
118 Arrays.asList(new ErrorsBuilder().setErrorObject(
119 new ErrorObjectBuilder().setType(maping.getFromErrorsEnum(e).type).setValue(
120 maping.getFromErrorsEnum(e).value).build()).build())).build()).build();
123 public static Message createErrorMsg(final PCEPErrors e, final Rp rp) {
124 final PCEPErrorMapping maping = PCEPErrorMapping.getInstance();
125 return new PcerrBuilder().setPcerrMessage(
126 new PcerrMessageBuilder().setErrorType(
127 new RequestCaseBuilder().setRequest(
128 new RequestBuilder().setRps(Lists.newArrayList(new RpsBuilder().setRp(rp).build())).build()).build()).setErrors(
129 Arrays.asList(new ErrorsBuilder().setErrorObject(
130 new ErrorObjectBuilder().setType(maping.getFromErrorsEnum(e).type).setValue(
131 maping.getFromErrorsEnum(e).value).build()).build())).build()).build();
134 protected abstract Message validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException;
137 public final Message parseMessage(final byte[] buffer, final List<Message> errors) throws PCEPDeserializerException {
138 Preconditions.checkNotNull(buffer, "Buffer may not be null");
140 // Parse objects first
141 final List<Object> objs = parseObjects(buffer);
144 return validate(objs, errors);