pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/XROSubobjectRegistry.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.protocol.pcep.spi;
   9
  10 import io.netty.buffer.ByteBuf;
  11
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.exclude.route.object.xro.Subobject;
  13
  14 public interface XROSubobjectRegistry {
  15     /**
  16      * Finds parser for given subobject type in the registry. Delegates parsing to found parser.
  17      *
  18      * @param type subobject type, key in parser registry
  19      * @param buffer subobject wrapped in ByteBuf
  20      * @param mandatory XRO specific common field
  21      * @return null if the parser for this subobject could not be found
  22      * @throws PCEPDeserializerException if the parsing did not succeed
  23      */
  24     Subobject parseSubobject(final int type, final ByteBuf buffer, final boolean mandatory) throws PCEPDeserializerException;
  25
  26     /**
  27      * Find serializer for given subobject. Delegates parsing to found serializer.
  28      *
  29      * @param subobject to be parsed
  30      * @param buffer buffer where the serialized subobject will be parsed
  31      */
  32     void serializeSubobject(final Subobject subobject, final ByteBuf buffer);
  33 }