This project has retired. For details please refer to its Attic page.
RepositoryStorage xref
View Javadoc
1   package org.apache.archiva.metadata.repository.storage;
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 org.apache.archiva.metadata.model.ArtifactMetadata;
23  import org.apache.archiva.metadata.model.ProjectMetadata;
24  import org.apache.archiva.metadata.model.ProjectVersionMetadata;
25  import org.apache.archiva.filter.Filter;
26  import org.apache.archiva.model.ArtifactReference;
27  import org.apache.archiva.policies.ProxyDownloadException;
28  import org.apache.archiva.repository.ManagedRepository;
29  import org.apache.archiva.repository.ManagedRepositoryContent;
30  import org.apache.archiva.xml.XMLException;
31  
32  import java.io.IOException;
33  import java.util.Collection;
34  
35  // FIXME: we should drop the repositoryId parameters and attach this to an instance of a repository storage
36  public interface RepositoryStorage
37  {
38      ProjectMetadata readProjectMetadata( String repoId, String namespace, String projectId );
39  
40      ProjectVersionMetadata readProjectVersionMetadata( ReadMetadataRequest readMetadataRequest )
41          throws RepositoryStorageMetadataInvalidException, RepositoryStorageMetadataNotFoundException,
42          RepositoryStorageRuntimeException;
43  
44      Collection<String> listRootNamespaces( String repoId, Filter<String> filter )
45          throws RepositoryStorageRuntimeException;
46  
47      Collection<String> listNamespaces( String repoId, String namespace, Filter<String> filter )
48          throws RepositoryStorageRuntimeException;
49  
50      Collection<String> listProjects( String repoId, String namespace, Filter<String> filter )
51          throws RepositoryStorageRuntimeException;
52  
53      Collection<String> listProjectVersions( String repoId, String namespace, String projectId, Filter<String> filter )
54          throws RepositoryStorageRuntimeException;
55  
56      Collection<ArtifactMetadata> readArtifactsMetadata( ReadMetadataRequest readMetadataRequest )
57          throws RepositoryStorageRuntimeException;
58  
59      // FIXME: reconsider this API, do we want to expose storage format in the form of a path?
60      ArtifactMetadata readArtifactMetadataFromPath( String repoId, String path )
61          throws RepositoryStorageRuntimeException;
62      
63      /**
64       * A relocation capable client will request the POM prior to the artifact, and will then read meta-data and do
65       * client side relocation. A simplier client (like maven 1) will only request the artifact and not use the
66       * metadatas.
67       * <p>
68       * For such clients, archiva does server-side relocation by reading itself the &lt;relocation&gt; element in
69       * metadatas and serving the expected artifact.
70       * @param managedRepository the used managed repository
71       * @param artifact the artifact reference
72       * @throws org.apache.archiva.policies.ProxyDownloadException
73       */    
74      void applyServerSideRelocation( ManagedRepository managedRepository, ArtifactReference artifact )
75          throws ProxyDownloadException;
76  
77      /**
78       * add an other method to evaluate real path as when receiving -SNAPSHOT (for maven storage)
79       * request redirect to the last build
80       * @param requestPath the web uri request
81       * @param managedRepository the used managed repository can be <code>null</code> so last version won't be resolved
82       * @return the file path
83       * @since 2.0.0
84       */
85      String getFilePath( String requestPath, org.apache.archiva.repository.ManagedRepository managedRepository );
86  
87      String getFilePathWithVersion( final String requestPath, ManagedRepositoryContent managedRepositoryContent )
88              throws RelocationException, XMLException, IOException;
89  
90  
91  }