generic-resource-api/provider/src/test/java/org/onap/sdnc/northbound/util/MDSALUtil.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : SDN-C
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                             reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.sdnc.northbound.util;
  23
  24 import java.util.concurrent.Future;
  25 import java.util.function.Consumer;
  26 import java.util.function.Function;
  27 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.BrgTopologyOperationInputBuilder;
  28 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.BrgTopologyOperationOutputBuilder;
  29 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ConnectionAttachmentTopologyOperationInputBuilder;
  30 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ConnectionAttachmentTopologyOperationOutputBuilder;
  31 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ContrailRouteTopologyOperationInputBuilder;
  32 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ContrailRouteTopologyOperationOutputBuilder;
  33 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.NetworkTopologyOperationInputBuilder;
  34 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.NetworkTopologyOperationOutputBuilder;
  35 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PreloadNetworkTopologyOperationInputBuilder;
  36 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PreloadNetworkTopologyOperationOutputBuilder;
  37 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PreloadVfModuleTopologyOperationInputBuilder;
  38 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PreloadVfModuleTopologyOperationOutputBuilder;
  39 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.SecurityZoneTopologyOperationInputBuilder;
  40 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.SecurityZoneTopologyOperationOutputBuilder;
  41 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ServiceTopologyOperationInputBuilder;
  42 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ServiceTopologyOperationOutputBuilder;
  43 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.TunnelxconnTopologyOperationInputBuilder;
  44 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.TunnelxconnTopologyOperationOutputBuilder;
  45 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VfModuleTopologyOperationInputBuilder;
  46 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VfModuleTopologyOperationOutputBuilder;
  47 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VnfTopologyOperationInputBuilder;
  48 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VnfTopologyOperationOutputBuilder;
  49 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PnfTopologyOperationInputBuilder;
  50 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.PnfTopologyOperationOutputBuilder;
  51 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.brg.response.information.BrgResponseInformationBuilder;
  52 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.connection.attachment.response.information.ConnectionAttachmentResponseInformationBuilder;
  53 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.contrail.route.response.information.ContrailRouteResponseInformationBuilder;
  54 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.network.information.NetworkInformationBuilder;
  55 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.network.response.information.NetworkResponseInformationBuilder;
  56 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.network.topology.identifier.structure.NetworkTopologyIdentifierStructureBuilder;
  57 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.preload.network.topology.information.PreloadNetworkTopologyInformationBuilder;
  58 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.preload.vf.module.topology.information.PreloadVfModuleTopologyInformationBuilder;
  59 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.request.information.RequestInformationBuilder;
  60 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.sdnc.request.header.SdncRequestHeaderBuilder;
  61 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.security.zone.response.information.SecurityZoneResponseInformationBuilder;
  62 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.data.ServiceDataBuilder;
  63 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.information.ServiceInformationBuilder;
  64 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.level.oper.status.ServiceLevelOperStatusBuilder;
  65 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.model.infrastructure.ServiceBuilder;
  66 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.response.information.ServiceResponseInformationBuilder;
  67 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.status.ServiceStatusBuilder;
  68 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.tunnelxconn.response.information.TunnelxconnResponseInformationBuilder;
  69 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vf.module.information.VfModuleInformationBuilder;
  70 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vf.module.response.information.VfModuleResponseInformationBuilder;
  71 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vf.module.topology.VfModuleTopologyBuilder;
  72 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vf.module.topology.identifier.VfModuleTopologyIdentifierBuilder;
  73 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vnf.information.VnfInformationBuilder;
  74 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vnf.response.information.VnfResponseInformationBuilder;
  75 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vnf.topology.identifier.structure.VnfTopologyIdentifierStructureBuilder;
  76 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.pnf.details.PnfDetailsBuilder;
  77 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.pnf.response.information.PnfResponseInformationBuilder;
  78 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.pnf.topology.identifier.structure.PnfTopologyIdentifierStructureBuilder;
  79 import org.opendaylight.yangtools.concepts.Builder;
  80 import org.opendaylight.yangtools.yang.common.RpcResult;
  81
  82
  83 /**
  84  * This uill class provides utility to build yang objects using a recursive syntax that resembles the tree structure
  85  * when defining the same yang object in json format.
  86  *
  87  * For Example
  88  * <pre>
  89  * {@code
  90  * import static org.onap.sdnc.northbound.util.MDSALUtil.*;
  91  * ServiceTopologyOperationInput input = build(
  92  *         serviceTopologyOperationInput()
  93  *                 .setSdncRequestHeader(build(sdncRequestHeader()
  94  *                         .setSvcRequestId("svc-request-id: xyz")
  95  *                         .setSvcAction(SvcAction.Assign)
  96  *                 ))
  97  *                 .setRequestInformation(build(requestInformation()
  98  *                         .setRequestId("request-id: xyz")
  99  *                        .setRequestAction(RequestInformation.RequestAction.CreateServiceInstance)
 100  *                 ))
 101  *                .setServiceInformation(build(serviceInformationBuilder()
 102  *                         .setServiceInstanceId("service-instance-id: xyz")
 103  *                ))
 104  * );
 105  * }
 106  * </pre>
 107  */
 108 public class MDSALUtil {
 109
 110     public static PreloadVfModuleTopologyOperationInputBuilder preloadVfModuleTopologyOperationInput() {
 111         return new PreloadVfModuleTopologyOperationInputBuilder();
 112     }
 113
 114     public static PreloadVfModuleTopologyOperationOutputBuilder preloadVfModuleTopologyOperationOutput() {
 115         return new PreloadVfModuleTopologyOperationOutputBuilder();
 116     }
 117
 118     public static PreloadNetworkTopologyOperationInputBuilder preloadNetworkTopologyOperationInput() {
 119         return new PreloadNetworkTopologyOperationInputBuilder();
 120     }
 121
 122     public static PreloadNetworkTopologyOperationOutputBuilder preloadNetworkTopologyOperationOutput() {
 123         return new PreloadNetworkTopologyOperationOutputBuilder();
 124     }
 125
 126     public static BrgTopologyOperationInputBuilder brgTopologyOperationInput() {
 127         return new BrgTopologyOperationInputBuilder();
 128     }
 129
 130     public static BrgTopologyOperationOutputBuilder brgTopologyOperationOutput() {
 131         return new BrgTopologyOperationOutputBuilder();
 132     }
 133
 134     public static TunnelxconnTopologyOperationInputBuilder tunnelxconnTopologyOperationInput() {
 135         return new TunnelxconnTopologyOperationInputBuilder();
 136     }
 137
 138     public static TunnelxconnTopologyOperationOutputBuilder tunnelxconnTopologyOperationOutput() {
 139         return new TunnelxconnTopologyOperationOutputBuilder();
 140     }
 141
 142     public static SecurityZoneTopologyOperationInputBuilder securityZoneTopologyOperationInput() {
 143         return new SecurityZoneTopologyOperationInputBuilder();
 144     }
 145
 146     public static SecurityZoneTopologyOperationOutputBuilder securityZoneTopologyOperationOutput() {
 147         return new SecurityZoneTopologyOperationOutputBuilder();
 148     }
 149
 150     public static ContrailRouteTopologyOperationInputBuilder contrailRouteTopologyOperationInput() {
 151         return new ContrailRouteTopologyOperationInputBuilder();
 152     }
 153
 154     public static ContrailRouteTopologyOperationOutputBuilder contrailRouteTopologyOperationOutput() {
 155         return new ContrailRouteTopologyOperationOutputBuilder();
 156     }
 157
 158     public static VfModuleTopologyOperationInputBuilder vfModuleTopologyOperationInput() {
 159         return new VfModuleTopologyOperationInputBuilder();
 160     }
 161
 162     public static VfModuleTopologyOperationOutputBuilder vfModuleTopologyOperationOutput() {
 163         return new VfModuleTopologyOperationOutputBuilder();
 164     }
 165
 166     public static PnfTopologyOperationInputBuilder pnfTopologyOperationInput() {
 167         return new PnfTopologyOperationInputBuilder();
 168     }
 169
 170     public static PnfTopologyOperationOutputBuilder pnfTopologyOperationOutput() {
 171         return new PnfTopologyOperationOutputBuilder();
 172     }
 173
 174     public static VnfTopologyOperationInputBuilder vnfTopologyOperationInput() {
 175         return new VnfTopologyOperationInputBuilder();
 176     }
 177
 178     public static VnfTopologyOperationOutputBuilder vnfTopologyOperationOutput() {
 179         return new VnfTopologyOperationOutputBuilder();
 180     }
 181
 182     public static ServiceTopologyOperationInputBuilder serviceTopologyOperationInput() {
 183         return new ServiceTopologyOperationInputBuilder();
 184     }
 185
 186     public static ServiceTopologyOperationOutputBuilder serviceTopologyOperationOutput() {
 187         return new ServiceTopologyOperationOutputBuilder();
 188     }
 189
 190
 191     public static SdncRequestHeaderBuilder sdncRequestHeader() {
 192         return new SdncRequestHeaderBuilder();
 193     }
 194
 195
 196     public static RequestInformationBuilder requestInformation() {
 197         return new RequestInformationBuilder();
 198     }
 199
 200     public static ServiceResponseInformationBuilder serviceResponseInformation() {
 201         return new ServiceResponseInformationBuilder();
 202     }
 203
 204     public static SecurityZoneResponseInformationBuilder securityZoneResponseInformation() {
 205         return new SecurityZoneResponseInformationBuilder();
 206     }
 207
 208     public static TunnelxconnResponseInformationBuilder tunnelxconnResponseInformation() {
 209         return new TunnelxconnResponseInformationBuilder();
 210     }
 211
 212     public static BrgResponseInformationBuilder brgResponseInformation() {
 213         return new BrgResponseInformationBuilder();
 214     }
 215
 216     public static ContrailRouteResponseInformationBuilder contrailRouteResponseInformation() {
 217         return new ContrailRouteResponseInformationBuilder();
 218     }
 219
 220     public static PnfResponseInformationBuilder pnfResponseInformation() {
 221         return new PnfResponseInformationBuilder();
 222     }
 223
 224     public static VnfResponseInformationBuilder vnfResponseInformation() {
 225         return new VnfResponseInformationBuilder();
 226     }
 227
 228     public static VfModuleResponseInformationBuilder vfModuleResponseInformation() {
 229         return new VfModuleResponseInformationBuilder();
 230     }
 231
 232     public static ServiceInformationBuilder serviceInformationBuilder() {
 233         return new ServiceInformationBuilder();
 234     }
 235
 236     public static PreloadNetworkTopologyInformationBuilder preloadNetworkTopologyInformationBuilder() {
 237         return new PreloadNetworkTopologyInformationBuilder();
 238     }
 239
 240     public static NetworkTopologyIdentifierStructureBuilder networkTopologyIdentifierStructureBuilder(){
 241         return new NetworkTopologyIdentifierStructureBuilder();
 242     }
 243
 244     public static PnfDetailsBuilder pnfDetailsBuilder() {
 245         return new PnfDetailsBuilder();
 246     }
 247
 248     public static VnfInformationBuilder vnfInformationBuilder() {
 249         return new VnfInformationBuilder();
 250     }
 251
 252     public static VfModuleInformationBuilder vfModuleInformationBuilder() {
 253         return new VfModuleInformationBuilder();
 254     }
 255
 256     public static ServiceBuilder service() {
 257         return new ServiceBuilder();
 258     }
 259
 260     public static ServiceDataBuilder serviceData() {
 261         return new ServiceDataBuilder();
 262     }
 263
 264     public static ServiceStatusBuilder serviceStatus() {
 265         return new ServiceStatusBuilder();
 266     }
 267
 268     public static NetworkInformationBuilder networkInformation() {
 269         return new NetworkInformationBuilder();
 270     }
 271
 272     public static NetworkTopologyOperationInputBuilder networkTopologyOperationInput() {
 273         return new NetworkTopologyOperationInputBuilder();
 274     }
 275
 276     public static NetworkTopologyOperationOutputBuilder networkTopologyOperationOutput() {
 277         return new NetworkTopologyOperationOutputBuilder();
 278     }
 279
 280     public static PnfTopologyIdentifierStructureBuilder pnfTopologyIdentifierStructureBuilder() {
 281         return new PnfTopologyIdentifierStructureBuilder();
 282     }
 283
 284     public static VnfTopologyIdentifierStructureBuilder vnfTopologyIdentifierStructureBuilder() {
 285         return new VnfTopologyIdentifierStructureBuilder();
 286     }
 287
 288     public static PreloadVfModuleTopologyInformationBuilder preloadVfModuleTopologyInformationBuilder() {
 289         return new PreloadVfModuleTopologyInformationBuilder();
 290     }
 291
 292     public static VfModuleTopologyBuilder vfModuleTopologyBuilder() {
 293         return new VfModuleTopologyBuilder();
 294     }
 295
 296     public static VfModuleTopologyIdentifierBuilder vfModuleTopologyIdentifierBuilder() {
 297         return new VfModuleTopologyIdentifierBuilder();
 298     }
 299
 300     public static NetworkResponseInformationBuilder networkResponseInformation() {
 301         return new NetworkResponseInformationBuilder();
 302     }
 303
 304     public static ConnectionAttachmentTopologyOperationInputBuilder connectionAttachmentTopologyOperationInput() {
 305         return new ConnectionAttachmentTopologyOperationInputBuilder();
 306     }
 307
 308     public static ConnectionAttachmentTopologyOperationOutputBuilder connectionAttachmentTopologyOperationOutput() {
 309         return new ConnectionAttachmentTopologyOperationOutputBuilder();
 310     }
 311
 312     public static ConnectionAttachmentResponseInformationBuilder connectionAttachmentResponseInformation() {
 313         return new ConnectionAttachmentResponseInformationBuilder();
 314     }
 315
 316     public static ServiceLevelOperStatusBuilder serviceLevelOperStatus() {
 317         return new ServiceLevelOperStatusBuilder();
 318     }
 319
 320     public static <P> P build(Builder<P> b) {
 321         return b == null ? null : b.build();
 322     }
 323
 324     public static <P, B extends Builder<P>> P build(Function<P, B> builderConstructor, P sourceDataObject) {
 325         if (sourceDataObject == null) {
 326             return null;
 327         }
 328         B bp = builderConstructor.apply(sourceDataObject);
 329         return bp.build();
 330     }
 331
 332     public static <P, B extends Builder<P>> P build(Function<P, B> builderConstructor, P sourceDataObject,
 333         Consumer<B> builder) {
 334         if (sourceDataObject == null) {
 335             return null;
 336         }
 337         B bp = builderConstructor.apply(sourceDataObject);
 338         builder.accept(bp);
 339         return bp.build();
 340     }
 341
 342     public static <I, O> O exec(Function<I, Future<RpcResult<O>>> rpc, I rpcParameter,
 343         Function<RpcResult<O>, O> rpcResult) throws Exception {
 344         Future<RpcResult<O>> future = rpc.apply(rpcParameter);
 345         return rpcResult.apply(future.get());
 346     }
 347
 348 }