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.ContrailRouteTopologyOperationInputBuilder;
  30 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ContrailRouteTopologyOperationOutputBuilder;
  31 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.NetworkTopologyOperationInputBuilder;
  32 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.NetworkTopologyOperationOutputBuilder;
  33 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.SecurityZoneTopologyOperationInputBuilder;
  34 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.SecurityZoneTopologyOperationOutputBuilder;
  35 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ServiceTopologyOperationInputBuilder;
  36 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ServiceTopologyOperationOutputBuilder;
  37 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.TunnelxconnTopologyOperationInputBuilder;
  38 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.TunnelxconnTopologyOperationOutputBuilder;
  39 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VfModuleTopologyOperationInputBuilder;
  40 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VfModuleTopologyOperationOutputBuilder;
  41 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VnfTopologyOperationInputBuilder;
  42 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.VnfTopologyOperationOutputBuilder;
  43 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.brg.response.information.BrgResponseInformationBuilder;
  44 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.contrail.route.response.information.ContrailRouteResponseInformationBuilder;
  45 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.network.information.NetworkInformationBuilder;
  46 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.network.response.information.NetworkResponseInformationBuilder;
  47 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.request.information.RequestInformationBuilder;
  48 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.sdnc.request.header.SdncRequestHeaderBuilder;
  49 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.security.zone.response.information.SecurityZoneResponseInformationBuilder;
  50 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.data.ServiceDataBuilder;
  51 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.information.ServiceInformationBuilder;
  52 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.level.oper.status.ServiceLevelOperStatusBuilder;
  53 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.model.infrastructure.ServiceBuilder;
  54 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.response.information.ServiceResponseInformationBuilder;
  55 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.status.ServiceStatusBuilder;
  56 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.tunnelxconn.response.information.TunnelxconnResponseInformationBuilder;
  57 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vf.module.information.VfModuleInformationBuilder;
  58 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vnf.information.VnfInformationBuilder;
  59 import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.vnf.response.information.VnfResponseInformationBuilder;
  60 import org.opendaylight.yangtools.concepts.Builder;
  61 import org.opendaylight.yangtools.yang.common.RpcResult;
  62
  63
  64 /**
  65  * This uill class provides utility to build yang objects using a recursive syntax that resembles the tree structure
  66  * when defining the same yang object in json format.
  67  *
  68  * For Example
  69  * <pre>
  70  * {@code
  71  * import static org.onap.sdnc.northbound.util.MDSALUtil.*;
  72  * ServiceTopologyOperationInput input = build(
  73  *         serviceTopologyOperationInput()
  74  *                 .setSdncRequestHeader(build(sdncRequestHeader()
  75  *                         .setSvcRequestId("svc-request-id: xyz")
  76  *                         .setSvcAction(SvcAction.Assign)
  77  *                 ))
  78  *                 .setRequestInformation(build(requestInformation()
  79  *                         .setRequestId("request-id: xyz")
  80  *                        .setRequestAction(RequestInformation.RequestAction.CreateServiceInstance)
  81  *                 ))
  82  *                .setServiceInformation(build(serviceInformationBuilder()
  83  *                         .setServiceInstanceId("service-instance-id: xyz")
  84  *                ))
  85  * );
  86  * }
  87  * </pre>
  88  */
  89 public class MDSALUtil {
  90
  91     public static BrgTopologyOperationInputBuilder brgTopologyOperationInput() {
  92         return new BrgTopologyOperationInputBuilder();
  93     }
  94
  95     public static BrgTopologyOperationOutputBuilder brgTopologyOperationOutput() {
  96         return new BrgTopologyOperationOutputBuilder();
  97     }
  98
  99     public static TunnelxconnTopologyOperationInputBuilder tunnelxconnTopologyOperationInput() {
 100         return new TunnelxconnTopologyOperationInputBuilder();
 101     }
 102
 103     public static TunnelxconnTopologyOperationOutputBuilder tunnelxconnTopologyOperationOutput() {
 104         return new TunnelxconnTopologyOperationOutputBuilder();
 105     }
 106
 107     public static SecurityZoneTopologyOperationInputBuilder securityZoneTopologyOperationInput() {
 108         return new SecurityZoneTopologyOperationInputBuilder();
 109     }
 110
 111     public static SecurityZoneTopologyOperationOutputBuilder securityZoneTopologyOperationOutput() {
 112         return new SecurityZoneTopologyOperationOutputBuilder();
 113     }
 114
 115     public static ContrailRouteTopologyOperationInputBuilder contrailRouteTopologyOperationInput() {
 116         return new ContrailRouteTopologyOperationInputBuilder();
 117     }
 118
 119     public static ContrailRouteTopologyOperationOutputBuilder contrailRouteTopologyOperationOutput() {
 120         return new ContrailRouteTopologyOperationOutputBuilder();
 121     }
 122
 123     public static VfModuleTopologyOperationInputBuilder vfModuleTopologyOperationInput() {
 124         return new VfModuleTopologyOperationInputBuilder();
 125     }
 126
 127     public static VfModuleTopologyOperationOutputBuilder vfModuleTopologyOperationOutput() {
 128         return new VfModuleTopologyOperationOutputBuilder();
 129     }
 130
 131     public static VnfTopologyOperationInputBuilder vnfTopologyOperationInput() {
 132         return new VnfTopologyOperationInputBuilder();
 133     }
 134
 135     public static VnfTopologyOperationOutputBuilder vnfTopologyOperationOutput() {
 136         return new VnfTopologyOperationOutputBuilder();
 137     }
 138
 139     public static ServiceTopologyOperationInputBuilder serviceTopologyOperationInput() {
 140         return new ServiceTopologyOperationInputBuilder();
 141     }
 142
 143     public static ServiceTopologyOperationOutputBuilder serviceTopologyOperationOutput() {
 144         return new ServiceTopologyOperationOutputBuilder();
 145     }
 146
 147
 148     public static SdncRequestHeaderBuilder sdncRequestHeader() {
 149         return new SdncRequestHeaderBuilder();
 150     }
 151
 152
 153     public static RequestInformationBuilder requestInformation() {
 154         return new RequestInformationBuilder();
 155     }
 156
 157     public static ServiceResponseInformationBuilder serviceResponseInformation() {
 158         return new ServiceResponseInformationBuilder();
 159     }
 160
 161     public static SecurityZoneResponseInformationBuilder securityZoneResponseInformation() {
 162         return new SecurityZoneResponseInformationBuilder();
 163     }
 164
 165     public static TunnelxconnResponseInformationBuilder tunnelxconnResponseInformation() {
 166         return new TunnelxconnResponseInformationBuilder();
 167     }
 168
 169     public static BrgResponseInformationBuilder brgResponseInformation() {
 170         return new BrgResponseInformationBuilder();
 171     }
 172
 173     public static ContrailRouteResponseInformationBuilder contrailRouteResponseInformation() {
 174         return new ContrailRouteResponseInformationBuilder();
 175     }
 176
 177     public static VnfResponseInformationBuilder vnfResponseInformation() {
 178         return new VnfResponseInformationBuilder();
 179     }
 180
 181     public static ServiceInformationBuilder serviceInformationBuilder() {
 182         return new ServiceInformationBuilder();
 183     }
 184
 185     public static VnfInformationBuilder vnfInformationBuilder() {
 186         return new VnfInformationBuilder();
 187     }
 188
 189     public static VfModuleInformationBuilder vfModuleInformationBuilder() {
 190         return new VfModuleInformationBuilder();
 191     }
 192
 193     public static ServiceBuilder service() {
 194         return new ServiceBuilder();
 195     }
 196
 197
 198     public static ServiceDataBuilder serviceData() {
 199         return new ServiceDataBuilder();
 200     }
 201
 202
 203     public static ServiceStatusBuilder serviceStatus() {
 204         return new ServiceStatusBuilder();
 205     }
 206
 207     public static NetworkInformationBuilder networkInformation() {
 208         return new NetworkInformationBuilder();
 209     }
 210
 211     public static NetworkTopologyOperationInputBuilder networkTopologyOperationInput() {
 212         return new NetworkTopologyOperationInputBuilder();
 213     }
 214
 215     public static NetworkTopologyOperationOutputBuilder networkTopologyOperationOutput() {
 216         return new NetworkTopologyOperationOutputBuilder();
 217     }
 218
 219     public static NetworkResponseInformationBuilder networkResponseInformation() {
 220         return new NetworkResponseInformationBuilder();
 221     }
 222
 223     public static ServiceLevelOperStatusBuilder serviceLevelOperStatus() {
 224         return new ServiceLevelOperStatusBuilder();
 225     }
 226
 227     public static <P> P build(Builder<P> b) {
 228         return b == null ? null : b.build();
 229     }
 230
 231     public static <P, B extends Builder<P>> P build(Function<P, B> builderConstructor, P sourceDataObject) {
 232         if (sourceDataObject == null) {
 233             return null;
 234         }
 235         B bp = builderConstructor.apply(sourceDataObject);
 236         return bp.build();
 237     }
 238
 239     public static <P, B extends Builder<P>> P build(Function<P, B> builderConstructor, P sourceDataObject,
 240         Consumer<B> builder) {
 241         if (sourceDataObject == null) {
 242             return null;
 243         }
 244         B bp = builderConstructor.apply(sourceDataObject);
 245         builder.accept(bp);
 246         return bp.build();
 247     }
 248
 249     public static <I, O> O exec(Function<I, Future<RpcResult<O>>> rpc, I rpcParameter,
 250         Function<RpcResult<O>, O> rpcResult) throws Exception {
 251         Future<RpcResult<O>> future = rpc.apply(rpcParameter);
 252         return rpcResult.apply(future.get());
 253     }
 254
 255 }