openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/AbstractTableMultipartService.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. 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
   9 package org.opendaylight.openflowplugin.impl.services;
  10
  11 import java.util.Collections;
  12 import java.util.List;
  13 import java.util.Optional;
  14 import java.util.concurrent.Future;
  15 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  16 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  17 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  18 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
  19 import org.opendaylight.openflowplugin.impl.services.util.RequestInputUtils;
  20 import org.opendaylight.openflowplugin.impl.services.util.ServiceException;
  21 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  22 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.VersionConvertorData;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestTableFeaturesCaseBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.table.features._case.MultipartRequestTableFeaturesBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.table.features._case.multipart.request.table.features.TableFeatures;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.TableUpdatedBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.UpdateTableInput;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.UpdateTableOutput;
  31 import org.opendaylight.yangtools.yang.common.RpcResult;
  32
  33 public abstract class AbstractTableMultipartService<T extends OfHeader> extends AbstractMultipartService<UpdateTableInput, T> {
  34
  35     private final ConvertorExecutor convertorExecutor;
  36     private final MultipartWriterProvider multipartWriterProvider;
  37     private final VersionConvertorData data;
  38
  39     protected AbstractTableMultipartService(final RequestContextStack requestContextStack,
  40                                             final DeviceContext deviceContext,
  41                                             final ConvertorExecutor convertorExecutor,
  42                                             final MultipartWriterProvider multipartWriterProvider) {
  43         super(requestContextStack, deviceContext);
  44         this.convertorExecutor = convertorExecutor;
  45         this.multipartWriterProvider = multipartWriterProvider;
  46         data = new VersionConvertorData(getVersion());
  47     }
  48
  49     @Override
  50     protected OfHeader buildRequest(final Xid xid, final UpdateTableInput input) throws ServiceException {
  51         final Optional<List<TableFeatures>> tableFeatures = getConvertorExecutor().convert(input.getUpdatedTable(), data);
  52
  53         return RequestInputUtils.createMultipartHeader(MultipartType.OFPMPTABLEFEATURES, xid.getValue(), getVersion())
  54             .setMultipartRequestBody(new MultipartRequestTableFeaturesCaseBuilder()
  55                 .setMultipartRequestTableFeatures(new MultipartRequestTableFeaturesBuilder()
  56                     .setTableFeatures(tableFeatures
  57                         .orElseGet(Collections::emptyList))
  58                     .build())
  59                 .build())
  60             .build();
  61     }
  62
  63     /**
  64      * Get convertor executor
  65      * @return convertor executor
  66      */
  67     protected ConvertorExecutor getConvertorExecutor() {
  68         return convertorExecutor;
  69     }
  70
  71     /**
  72      * Get data
  73      * @return data
  74      */
  75     protected VersionConvertorData getData() {
  76         return data;
  77     }
  78
  79     /**
  80      * Stores table features to operational datastore
  81      */
  82     protected void storeStatistics(List<org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures> result) {
  83         multipartWriterProvider
  84             .lookup(MultipartType.OFPMPTABLEFEATURES)
  85             .ifPresent(writer -> {
  86                 writer.write(
  87                     new TableUpdatedBuilder()
  88                         .setTableFeatures(result)
  89                         .build(),
  90                     false);
  91
  92                 getTxFacade().submitTransaction();
  93             });
  94     }
  95
  96     /**
  97      * Process experimenter input and result experimenter output
  98      * @param input experimenter input
  99      * @return experimenter output
 100      */
 101     public abstract Future<RpcResult<UpdateTableOutput>> handleAndReply(UpdateTableInput input);
 102
 103 }