View Javadoc
1   package org.apache.maven.shared.transfer.repository.internal;
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   * @author Robert Scholte
32   */
33  interface MavenRepositoryManager
34  {
35      /**
36       * @param artifact {@link Artifact}
37       * @return the path of the local artifact.
38       */
39      String getPathForLocalArtifact( Artifact artifact );
40  
41      /**
42       * @param coordinate {@link ArtifactCoordinate}
43       * @return the path for the local artifact.
44       */
45      String getPathForLocalArtifact( ArtifactCoordinate coordinate );
46      
47      /**
48       * @param metadata {@link ArtifactMetadata}
49       * @return the path of the local metadata.
50       */
51      String getPathForLocalMetadata( ArtifactMetadata metadata );
52  
53      /**
54       * Create a new {@code ProjectBuildingRequest} with an adjusted repository session.
55       * 
56       * @param basedir the base directory of the local repository
57       * @return a new project building request
58       */
59      ProjectBuildingRequest setLocalRepositoryBasedir( ProjectBuildingRequest request, File basedir );
60  
61      /**
62       * Get the localRepositryBasedir as specified in the repository session of the request
63       * 
64       * @return the local repository base directory
65       */
66      File getLocalRepositoryBasedir();
67  }