pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/ObjectRegistry.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 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader;
  14
  15 public interface ObjectRegistry extends VendorInformationObjectRegistry {
  16     /**
  17      * Finds parser for given object type and class in the registry. Delegates parsing to found parser.
  18      *
  19      * @param objectClass object class
  20      * @param objectType object type
  21      * @param header ObjectHeader
  22      * @param buffer object wrapped in ByteBuf
  23      * @return null if the parser for this object could not be found
  24      * @throws PCEPDeserializerException if the parsing did not succeed
  25      */
  26     Object parseObject(int objectClass, int objectType, ObjectHeader header, ByteBuf buffer)
  27             throws PCEPDeserializerException;
  28
  29     /**
  30      * Find serializer for given object. Delegates parsing to found serializer.
  31      *
  32      * @param object to be parsed
  33      * @param buffer ByteBuf wrapped around bytes representing given object
  34      */
  35     void serializeObject(Object object, ByteBuf buffer);
  36 }