View Javadoc
1   package org.apache.maven.shared.transfer.repository;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  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,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.File;
23  
24  import org.apache.maven.artifact.Artifact;
25  import org.apache.maven.artifact.metadata.ArtifactMetadata;
26  import org.apache.maven.project.ProjectBuildingRequest;
27  import org.apache.maven.shared.transfer.artifact.ArtifactCoordinate;
28  
29  /**
30   * 
31   */
32  public interface RepositoryManager
33  {
34  
35      /**
36       * @param buildingRequest {@link ProjectBuildingRequest}
37       * @param artifact {@link Artifact}
38       * @return the path of the local artifact.
39       */
40      String getPathForLocalArtifact( ProjectBuildingRequest buildingRequest, Artifact artifact );
41  
42      /**
43       * @param buildingRequest {@link ProjectBuildingRequest}
44       * @param coordinate {@link ArtifactCoordinate}
45       * @return the path for the local artifact.
46       */
47      String getPathForLocalArtifact( ProjectBuildingRequest buildingRequest, ArtifactCoordinate coordinate );
48      
49      /**
50       * @param buildingRequest {@link ProjectBuildingRequest}
51       * @param metadata {@link ArtifactMetadata}
52       * @return the path of the local metadata.
53       */
54      String getPathForLocalMetadata( ProjectBuildingRequest buildingRequest, ArtifactMetadata metadata );
55  
56      /**
57       * Create a new {@code ProjectBuildingRequest} with an adjusted repository session.
58       * 
59       * @param request the project building request
60       * @param basedir the base directory of the local repository
61       * @return a new project building request
62       */
63      ProjectBuildingRequest setLocalRepositoryBasedir( ProjectBuildingRequest request, File basedir );
64  
65      /**
66       * Get the localRepositryBasedir as specified in the repository session of the request
67       * 
68       * @param request the build request
69       * @return the local repository base directory
70       */
71      File getLocalRepositoryBasedir( ProjectBuildingRequest request );
72  }