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