View Javadoc

1   package org.apache.maven.artifact.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  
23  import java.util.List;
24  
25  import org.apache.maven.artifact.Artifact;
26  import org.apache.maven.artifact.metadata.ArtifactMetadata;
27  import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
28  import org.apache.maven.repository.Proxy;
29  
30  public interface ArtifactRepository
31  {
32      String pathOf( Artifact artifact );
33  
34      String pathOfRemoteRepositoryMetadata( ArtifactMetadata artifactMetadata );
35  
36      String pathOfLocalRepositoryMetadata( ArtifactMetadata metadata, ArtifactRepository repository );
37  
38      String getUrl();
39  
40      void setUrl( String url );
41  
42      String getBasedir();
43  
44      String getProtocol();
45  
46      String getId();
47  
48      void setId( String id );
49  
50      ArtifactRepositoryPolicy getSnapshots();
51  
52      void setSnapshotUpdatePolicy( ArtifactRepositoryPolicy policy );
53  
54      ArtifactRepositoryPolicy getReleases();
55  
56      void setReleaseUpdatePolicy( ArtifactRepositoryPolicy policy );
57  
58      ArtifactRepositoryLayout getLayout();
59  
60      void setLayout( ArtifactRepositoryLayout layout );
61  
62      String getKey();
63  
64      @Deprecated
65      boolean isUniqueVersion();
66  
67      @Deprecated
68      boolean isBlacklisted();
69  
70      @Deprecated
71      void setBlacklisted( boolean blackListed );
72  
73      //
74      // New interface methods for the repository system.
75      //
76      Artifact find( Artifact artifact );
77  
78      /**
79       * Finds the versions of the specified artifact that are available in this repository.
80       *
81       * @param artifact The artifact whose available versions should be determined, must not be {@code null}.
82       * @return The available versions of the artifact or an empty list if none, never {@code null}.
83       */
84      List<String> findVersions( Artifact artifact );
85  
86      /**
87       * Indicates whether this repository is backed by actual projects. For instance, the build reactor or IDE workspace
88       * are examples of such repositories.
89       *
90       * @return {@code true} if the repository is backed by actual projects, {@code false} otherwise.
91       */
92      boolean isProjectAware();
93  
94      void setAuthentication( Authentication authentication );
95      Authentication getAuthentication();
96  
97      void setProxy( Proxy proxy );
98      Proxy getProxy();
99  
100     List<ArtifactRepository> getMirroredRepositories();
101     void setMirroredRepositories( List<ArtifactRepository> mirroredRepositories );
102 
103 }