View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.internal.impl.filter;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import java.util.Collections;
26  import java.util.HashMap;
27  import java.util.Map;
28  import java.util.stream.Collectors;
29  
30  import org.eclipse.aether.RepositorySystemSession;
31  import org.eclipse.aether.artifact.Artifact;
32  import org.eclipse.aether.impl.RemoteRepositoryFilterManager;
33  import org.eclipse.aether.metadata.Metadata;
34  import org.eclipse.aether.repository.RemoteRepository;
35  import org.eclipse.aether.spi.connector.filter.RemoteRepositoryFilter;
36  import org.eclipse.aether.spi.connector.filter.RemoteRepositoryFilterSource;
37  
38  import static java.util.Objects.requireNonNull;
39  
40  /**
41   * Default implementation of {@link RemoteRepositoryFilterManager}, it always returns a {@link RemoteRepositoryFilter}
42   * instance, even if no filter sources enabled/registered (then "always allow" instance).
43   * <p>
44   * The created {@link RemoteRepositoryFilter} instance is created once per session and cached.
45   *
46   * @since 1.9.0
47   */
48  @Singleton
49  @Named
50  public final class DefaultRemoteRepositoryFilterManager implements RemoteRepositoryFilterManager {
51      private static final String INSTANCE_KEY = DefaultRemoteRepositoryFilterManager.class.getName() + ".instance";
52  
53      private final Map<String, RemoteRepositoryFilterSource> sources;
54  
55      /**
56       * SL enabled ctor.
57       *
58       * @deprecated for SL and testing purposes only.
59       */
60      @Deprecated
61      public DefaultRemoteRepositoryFilterManager() {
62          this.sources = new HashMap<>();
63      }
64  
65      @Inject
66      public DefaultRemoteRepositoryFilterManager(Map<String, RemoteRepositoryFilterSource> sources) {
67          this.sources = requireNonNull(sources);
68      }
69  
70      @Override
71      public RemoteRepositoryFilter getRemoteRepositoryFilter(RepositorySystemSession session) {
72          return (RemoteRepositoryFilter) session.getData().computeIfAbsent(INSTANCE_KEY, () -> {
73              HashMap<String, RemoteRepositoryFilter> filters = new HashMap<>();
74              for (Map.Entry<String, RemoteRepositoryFilterSource> entry : sources.entrySet()) {
75                  RemoteRepositoryFilter filter = entry.getValue().getRemoteRepositoryFilter(session);
76                  if (filter != null) {
77                      filters.put(entry.getKey(), filter);
78                  }
79              }
80              if (!filters.isEmpty()) {
81                  return new Participants(filters);
82              } else {
83                  return null;
84              }
85          });
86      }
87  
88      /**
89       * {@link RemoteRepositoryFilter} instance when there are participant filters present. It evaluates into result
90       * using {@link Consensus}.
91       */
92      private static class Participants implements RemoteRepositoryFilter {
93          private final Map<String, RemoteRepositoryFilter> participants;
94  
95          private Participants(Map<String, RemoteRepositoryFilter> participants) {
96              this.participants = Collections.unmodifiableMap(participants);
97          }
98  
99          @Override
100         public RemoteRepositoryFilter.Result acceptArtifact(RemoteRepository remoteRepository, Artifact artifact) {
101             return new Consensus(
102                     participants.entrySet().stream().collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue()
103                             .acceptArtifact(remoteRepository, artifact))));
104         }
105 
106         @Override
107         public RemoteRepositoryFilter.Result acceptMetadata(RemoteRepository remoteRepository, Metadata metadata) {
108             return new Consensus(
109                     participants.entrySet().stream().collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue()
110                             .acceptMetadata(remoteRepository, metadata))));
111         }
112     }
113 
114     /**
115      * {@link RemoteRepositoryFilter.Result} based on "consensus". All participant have to "accept" to make this
116      * instance "accept".
117      */
118     private static class Consensus implements RemoteRepositoryFilter.Result {
119         private final boolean accepted;
120 
121         private final String reasoning;
122 
123         Consensus(Map<String, RemoteRepositoryFilter.Result> results) {
124             this.accepted = results.values().stream().allMatch(RemoteRepositoryFilter.Result::isAccepted);
125             this.reasoning = results.values().stream()
126                     .filter(r -> !r.isAccepted())
127                     .map(RemoteRepositoryFilter.Result::reasoning)
128                     .collect(Collectors.joining("; "));
129         }
130 
131         @Override
132         public boolean isAccepted() {
133             return accepted;
134         }
135 
136         @Override
137         public String reasoning() {
138             return reasoning;
139         }
140     }
141 }