sxp-integration/sxp-ep-provider/src/main/java/org/opendaylight/groupbasedpolicy/sxp/ep/provider/impl/util/EPTemplateUtil.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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.groupbasedpolicy.sxp.ep.provider.impl.util;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.base.MoreObjects;
  12 import com.google.common.base.Optional;
  13 import com.google.common.collect.Ordering;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import java.util.ArrayList;
  17 import java.util.List;
  18 import javax.annotation.Nonnull;
  19 import javax.annotation.Nullable;
  20 import org.apache.commons.lang3.tuple.MutablePair;
  21 import org.apache.commons.lang3.tuple.Pair;
  22 import org.apache.commons.net.util.SubnetUtils;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ConditionName;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.EndpointGroupId;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.groupbasedpolicy.sxp.integration.sxp.ep.provider.model.rev160302.sxp.ep.mapper.EndpointForwardingTemplateBySubnet;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.groupbasedpolicy.sxp.integration.sxp.ep.provider.model.rev160302.sxp.ep.mapper.EndpointPolicyTemplateBySgt;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.database.rev160308.Sgt;
  29
  30 /**
  31  * Purpose: util methods for {@link EndpointForwardingTemplateBySubnet} and {@link EndpointPolicyTemplateBySgt}
  32  */
  33 public final class EPTemplateUtil {
  34
  35     public static final String FULL_IPV4_MASK_SUFFIX = "/32";
  36     private static final Comparable EMPTY_COMPARABLE = "";
  37
  38     private EPTemplateUtil() {
  39         throw new IllegalAccessError("constructing util class");
  40     }
  41
  42     public static boolean isPlain(final IpPrefix key) {
  43         return key.getIpv4Prefix().getValue().endsWith(FULL_IPV4_MASK_SUFFIX);
  44     }
  45
  46     public static SubnetInfoKeyDecorator buildSubnetInfoKey(@Nonnull final IpPrefix value) {
  47         return new SubnetInfoKeyDecorator(new SubnetUtils(value.getIpv4Prefix().getValue()).getInfo());
  48     }
  49
  50     public static <L, R> ListenableFuture<OptionalMutablePair<L, R>> compositeRead(
  51             final ListenableFuture<Optional<L>> leftRead, final ListenableFuture<Optional<R>> rightRead) {
  52
  53         final OptionalMutablePair<L, R> compositeResult = new OptionalMutablePair<>();
  54         final List<ListenableFuture<?>> results = new ArrayList<>(2);
  55
  56         results.add(Futures.transform(leftRead, new Function<Optional<L>, OptionalMutablePair<L, R>>() {
  57             @Nullable
  58             @Override
  59             public OptionalMutablePair<L, R> apply(@Nullable final Optional<L> input) {
  60                 compositeResult.setLeft(input);
  61                 return compositeResult;
  62             }
  63         }));
  64
  65         results.add(Futures.transform(rightRead, new Function<Optional<R>, OptionalMutablePair<L, R>>() {
  66             @Nullable
  67             @Override
  68             public OptionalMutablePair<L, R> apply(@Nullable final Optional<R> input) {
  69                 compositeResult.setRight(input);
  70                 return compositeResult;
  71             }
  72         }));
  73
  74         return Futures.transform(Futures.successfulAsList(results),
  75                 new Function<List<?>, OptionalMutablePair<L, R>>() {
  76                     @Nullable
  77                     @Override
  78                     public OptionalMutablePair<L, R> apply(@Nullable final List<?> input) {
  79                         return compositeResult;
  80                     }
  81                 });
  82     }
  83
  84     public static <K, V> ListenableFuture<Pair<K, V>> wrapToPair(
  85             final K keyItem,
  86             final ListenableFuture<Optional<V>> valueFromRead) {
  87         return Futures.transform(valueFromRead, new Function<Optional<V>, Pair<K, V>>() {
  88             @Nullable
  89             @Override
  90             public Pair<K, V> apply(@Nullable final Optional<V> input) {
  91                 return new MutablePair<>(keyItem, input.orNull());
  92             }
  93         });
  94     }
  95
  96     public static <V> ListenableFuture<Optional<V>> wrapToOptional(final ListenableFuture<V> value) {
  97         return Futures.transform(value, new Function<V, Optional<V>>() {
  98             @Nullable
  99             @Override
 100             public Optional<V> apply(@Nullable final V input) {
 101                 return Optional.fromNullable(input);
 102             }
 103         });
 104     }
 105
 106     public static Ordering<EndpointGroupId> createEndpointGroupIdOrdering() {
 107         return Ordering.natural().onResultOf(new Function<EndpointGroupId, Comparable>() {
 108             @Nullable
 109             @Override
 110             public Comparable apply(@Nullable final EndpointGroupId input) {
 111                 if (input == null) {
 112                     return EMPTY_COMPARABLE;
 113                 }
 114                 return MoreObjects.firstNonNull(input.getValue(), EMPTY_COMPARABLE);
 115             }
 116         });
 117     }
 118
 119     public static Ordering<ConditionName> createConditionNameOrdering() {
 120         return Ordering.natural().onResultOf(new Function<ConditionName, Comparable>() {
 121             @Nullable
 122             @Override
 123             public Comparable apply(@Nullable final ConditionName input) {
 124                 if (input == null) {
 125                     return EMPTY_COMPARABLE;
 126                 }
 127                 return MoreObjects.firstNonNull(input.getValue(), EMPTY_COMPARABLE);
 128             }
 129         });
 130     }
 131
 132     public static Ordering<Sgt> createSgtOrdering() {
 133         return Ordering.natural().onResultOf(new Function<Sgt, Comparable>() {
 134             @Nullable
 135             @Override
 136             public Comparable apply(@Nullable final Sgt input) {
 137                 if (input == null) {
 138                     return EMPTY_COMPARABLE;
 139                 }
 140                 return MoreObjects.firstNonNull(input.getValue(), EMPTY_COMPARABLE);
 141             }
 142         });
 143     }
 144
 145     public static class OptionalMutablePair<L, R> extends MutablePair<Optional<L>, Optional<R>> {
 146         public OptionalMutablePair() {
 147             super(Optional.absent(), Optional.absent());
 148         }
 149     }
 150 }