alto-core/standard-service-models/model-endpointcost/impl/src/main/java/org/opendaylight/alto/core/impl/endpointcost/test/AltoEndpointCostProvider.java

   1 /*
   2  * Copyright © 2015 Yale University 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.alto.core.impl.endpointcost.test;
   9
  10 import java.math.BigDecimal;
  11 import java.util.Arrays;
  12 import java.util.LinkedList;
  13 import java.util.List;
  14 import java.util.concurrent.ExecutionException;
  15 import java.util.concurrent.Future;
  16
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  19 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  20
  21 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  24
  25 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
  26 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
  27 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
  28
  29 import org.opendaylight.alto.core.resourcepool.ResourcepoolUtils;
  30 import org.opendaylight.alto.core.resourcepool.ResourcepoolUtils.ContextTagListener;
  31 import org.opendaylight.alto.core.service.model.endpointcost.EndpointcostUtils;
  32
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.core.types.rev150921.CostMetric;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.core.types.rev150921.ResourceId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.core.types.rev150921.CostTypeData;
  36
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.core.resourcepool.rev150921.context.Resource;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.core.resourcepool.rev150921.context.resource.CapabilitiesBuilder;
  39
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.AltoModelEndpointcostService;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.CapabilitiesCostType;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.CapabilitiesCostTypeBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.QueryInput;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.QueryOutput;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.QueryOutputBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.ResourceTypeEndpointcost;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.alto.request.endpointcost.request.EndpointcostRequest;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.alto.response.endpointcost.response.EndpointcostResponseBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rev151021.endpointcost.request.data.EndpointcostParams;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.Ipv4AddressData;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.Ipv6AddressData;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.TypedAddressData;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.endpoint.filter.data.EndpointFilter;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.endpointcostmap.response.data.EndpointCostMapBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.endpointcostmap.response.data.endpoint.cost.map.EndpointCost;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.endpointcostmap.response.data.endpoint.cost.map.EndpointCostBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.endpointcostmap.response.data.endpoint.cost.map.endpoint.cost.Cost;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.endpointcostmap.response.data.endpoint.cost.map.endpoint.cost.DestinationBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.endpointcostmap.response.data.endpoint.cost.map.endpoint.cost.SourceBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.input.request.endpointcost.request.endpointcost.params.filter.EndpointFilterData;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.EndpointCostmapDataBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.cost.NumericalBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.cost.OrdinalBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.typed.address.data.Address;
  65
  66 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  68 import org.opendaylight.yangtools.yang.common.RpcResult;
  69 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  70
  71 import org.slf4j.Logger;
  72 import org.slf4j.LoggerFactory;
  73
  74 public class AltoEndpointCostProvider implements BindingAwareProvider, AutoCloseable, AltoModelEndpointcostService {
  75
  76     private static final Logger LOG = LoggerFactory.getLogger(AltoEndpointCostProvider.class);
  77
  78     private DataBroker m_dataBroker = null;
  79     private RoutedRpcRegistration<AltoModelEndpointcostService> m_serviceReg = null;
  80     private ListenerRegistration<DataChangeListener> m_listener = null;
  81
  82     private static final String TEST_ENDPOINTCOST_NAME = "test-model-endpointcost";
  83     private static final ResourceId TEST_ENDPOINTCOST_RID = new ResourceId(TEST_ENDPOINTCOST_NAME);
  84     private static final CostMetric COST_METRIC_ROUTINGCOST = new CostMetric("routingcost");
  85     private static final String COST_MODE_ORDINAL = "ordinal";
  86     private InstanceIdentifier<Resource> m_testIID = null;
  87
  88     protected void createContextTag()
  89             throws InterruptedException, ExecutionException, TransactionCommitFailedException  {
  90         WriteTransaction wx = m_dataBroker.newWriteOnlyTransaction();
  91
  92         CapabilitiesCostTypeBuilder cctBuilder = new CapabilitiesCostTypeBuilder();
  93         cctBuilder.setCostType(Arrays.asList(
  94                 EndpointcostUtils.createCostTypeCapability(COST_METRIC_ROUTINGCOST,
  95                                                             COST_MODE_ORDINAL)
  96         ));
  97         CapabilitiesBuilder builder = new CapabilitiesBuilder();
  98         builder.addAugmentation(CapabilitiesCostType.class, cctBuilder.build());
  99
 100         ResourcepoolUtils.createResourceWithCapabilities(ResourcepoolUtils.DEFAULT_CONTEXT,
 101                                             TEST_ENDPOINTCOST_NAME,
 102                                             ResourceTypeEndpointcost.class,
 103                                             builder.build(), wx);
 104
 105         ResourcepoolUtils.lazyUpdateResource(ResourcepoolUtils.DEFAULT_CONTEXT,
 106                                             TEST_ENDPOINTCOST_NAME, wx);
 107
 108         wx.submit().get();
 109     }
 110
 111     protected void removeContextTag()
 112             throws InterruptedException, ExecutionException, TransactionCommitFailedException  {
 113         WriteTransaction wx = m_dataBroker.newWriteOnlyTransaction();
 114
 115         ResourcepoolUtils.deleteResource(ResourcepoolUtils.DEFAULT_CONTEXT,
 116                                             TEST_ENDPOINTCOST_NAME, wx);
 117
 118         wx.submit().get();
 119     }
 120
 121     protected void setupListener() {
 122         ContextTagListener listener = new ContextTagListener(m_testIID, m_serviceReg);
 123         m_listener = m_dataBroker.registerDataChangeListener(LogicalDatastoreType.OPERATIONAL,
 124                                         m_testIID,listener, DataChangeScope.SUBTREE);
 125
 126         assert m_listener != null;
 127     }
 128
 129     @Override
 130     public void onSessionInitiated(ProviderContext session) {
 131         LOG.info("AltoModelEndpointCostProvider Session Initiated");
 132
 133         m_dataBroker = session.getSALService(DataBroker.class);
 134         m_testIID = ResourcepoolUtils.getResourceIID(ResourcepoolUtils.DEFAULT_CONTEXT,
 135                                                         TEST_ENDPOINTCOST_NAME);
 136         m_serviceReg = session.addRoutedRpcImplementation(AltoModelEndpointcostService.class, this);
 137
 138         try {
 139             setupListener();
 140             createContextTag();
 141         } catch (Exception e) {
 142         }
 143     }
 144
 145     @Override
 146     public void close() throws Exception {
 147         LOG.info("AltoModelBaseProvider Closed");
 148
 149         if (m_serviceReg != null) {
 150             m_serviceReg.close();
 151         }
 152
 153         try {
 154             removeContextTag();
 155         } catch (Exception e) {
 156         }
 157     }
 158
 159     protected Cost createNumericalCost(double cost) {
 160         NumericalBuilder builder;
 161         builder = new NumericalBuilder();
 162
 163         builder.setCost(new BigDecimal(cost));
 164         return builder.build();
 165     }
 166
 167     protected Cost createOrdinalCost(int order) {
 168         OrdinalBuilder builder;
 169         builder = new OrdinalBuilder();
 170
 171         builder.setCost(order);
 172         return builder.build();
 173     }
 174
 175     protected Address createSourceAddress(Address from) {
 176         if (from instanceof Ipv4AddressData) {
 177             org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.source.address.Ipv4Builder builder;
 178             builder = new org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.source.address.Ipv4Builder();
 179
 180             builder.fieldsFrom((Ipv4AddressData)from);
 181             return builder.build();
 182         } else if (from instanceof Ipv6AddressData) {
 183             org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.source.address.Ipv6Builder builder;
 184             builder = new org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.source.address.Ipv6Builder();
 185
 186             builder.fieldsFrom((Ipv6AddressData)from);
 187             return builder.build();
 188 }
 189         return null;
 190     }
 191
 192     protected Address createDestinationAddress(Address from) {
 193         if (from instanceof Ipv4AddressData) {
 194             org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.destination.address.Ipv4Builder builder;
 195             builder = new org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.destination.address.Ipv4Builder();
 196
 197             builder.fieldsFrom((Ipv4AddressData)from);
 198             return builder.build();
 199         } else if (from instanceof Ipv6AddressData) {
 200             org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.destination.address.Ipv6Builder builder;
 201             builder = new org.opendaylight.yang.gen.v1.urn.opendaylight.alto.service.model.endpointcost.rfc7285.rev151021.query.output.response.endpointcost.response.endpointcost.data.endpoint.costmap.data.endpoint.cost.map.endpoint.cost.destination.address.Ipv6Builder();
 202
 203             builder.fieldsFrom((Ipv6AddressData)from);
 204             return builder.build();
 205 }
 206         return null;
 207     }
 208
 209     @Override
 210     public Future<RpcResult<QueryOutput>> query(QueryInput input) {
 211         if (!input.getType().equals(ResourceTypeEndpointcost.class)) {
 212             return RpcResultBuilder.<QueryOutput>failed().buildFuture();
 213         }
 214         EndpointcostRequest request = (EndpointcostRequest)input.getRequest();
 215         EndpointcostParams params = request.getEndpointcostParams();
 216
 217         CostTypeData costType = params.getCostType();
 218         if (!costType.getCostMode().equals(COST_MODE_ORDINAL)) {
 219             LOG.warn(costType.getCostMode().toString());
 220             return RpcResultBuilder.<QueryOutput>failed().buildFuture();
 221         }
 222         if (!costType.getCostMetric().equals(COST_METRIC_ROUTINGCOST)) {
 223             LOG.warn(costType.getCostMetric().toString());
 224             return RpcResultBuilder.<QueryOutput>failed().buildFuture();
 225         }
 226
 227         if (!(params.getFilter() instanceof EndpointFilterData)) {
 228             return RpcResultBuilder.<QueryOutput>failed().buildFuture();
 229         }
 230
 231         EndpointFilter filter = ((EndpointFilterData)params.getFilter()).getEndpointFilter();
 232         List<? extends TypedAddressData> source = filter.getSource();
 233         List<? extends TypedAddressData> destination = filter.getDestination();
 234
 235         int order = 0;
 236         LinkedList<EndpointCost> ecList = new LinkedList<EndpointCost>();
 237         for (TypedAddressData src: source) {
 238             for (TypedAddressData dst: destination) {
 239                 SourceBuilder srcBuilder = new SourceBuilder();
 240                 srcBuilder.setAddress(createSourceAddress(src.getAddress()));
 241
 242                 DestinationBuilder dstBuilder = new DestinationBuilder();
 243                 dstBuilder.setAddress(createDestinationAddress(dst.getAddress()));
 244
 245
 246                 EndpointCostBuilder ecBuilder = new EndpointCostBuilder();
 247                 ecBuilder.setSource(srcBuilder.build());
 248                 ecBuilder.setDestination(dstBuilder.build());
 249                 ecBuilder.setCost(createOrdinalCost(++order));
 250
 251                 ecList.add(ecBuilder.build());
 252             }
 253         }
 254
 255         EndpointCostMapBuilder ecmBuilder = new EndpointCostMapBuilder();
 256         ecmBuilder.setEndpointCost(ecList);
 257
 258         EndpointCostmapDataBuilder ecmdBuilder = new EndpointCostmapDataBuilder();
 259         ecmdBuilder.setEndpointCostMap(ecmBuilder.build());
 260
 261         EndpointcostResponseBuilder ecrBuilder = new EndpointcostResponseBuilder();
 262         ecrBuilder.setEndpointcostData(ecmdBuilder.build());
 263
 264         QueryOutputBuilder builder = new QueryOutputBuilder();
 265         builder.setType(ResourceTypeEndpointcost.class).setResponse(ecrBuilder.build());
 266         return RpcResultBuilder.<QueryOutput>success(builder.build()).buildFuture();
 267     }
 268
 269 }