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.resolution;
20  
21  import java.util.List;
22  
23  import org.eclipse.aether.RepositorySystemSession;
24  import org.eclipse.aether.internal.impl.DefaultArtifactResolver;
25  import org.eclipse.aether.resolution.ArtifactResult;
26  import org.eclipse.aether.spi.resolution.ArtifactResolverPostProcessor;
27  
28  /**
29   * Support class to implement {@link ArtifactResolverPostProcessor}.
30   *
31   * @since 1.9.0
32   */
33  public abstract class ArtifactResolverPostProcessorSupport implements ArtifactResolverPostProcessor {
34      protected static final String CONFIG_PROPS_PREFIX = DefaultArtifactResolver.CONFIG_PROPS_PREFIX + "postProcessor.";
35  
36      /**
37       * This implementation will call into underlying code only if enabled.
38       */
39      @Override
40      public void postProcess(RepositorySystemSession session, List<ArtifactResult> artifactResults) {
41          if (isEnabled(session)) {
42              doPostProcess(session, artifactResults);
43          }
44      }
45  
46      protected abstract void doPostProcess(RepositorySystemSession session, List<ArtifactResult> artifactResults);
47  
48      /**
49       * Returns {@code true} if session configuration marks this instance as enabled.
50       * <p>
51       * Default value is {@code false}.
52       */
53      protected abstract boolean isEnabled(RepositorySystemSession session);
54  }