source.dussan.org Git - archiva.git/blob

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