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

   1 package org.apache.archiva.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 org.apache.archiva.model.ArtifactReference;
  23 import org.apache.archiva.model.RepositoryURL;
  24 import org.apache.archiva.repository.layout.LayoutException;
  25
  26 /**
  27  * RemoteRepositoryContent interface for interacting with a remote repository in an abstract way,
  28  * without the need for processing based on URLs, or working with the database.
  29  *
  30  *
  31  */
  32 public interface RemoteRepositoryContent
  33 {
  34     /**
  35      * <p>
  36      * Convenience method to get the repository id.
  37      * </p>
  38      *
  39      * <p>
  40      * Equivalent to calling <code>.getRepository().getId()</code>
  41      * </p>
  42      *
  43      * @return the repository id.
  44      */
  45     String getId();
  46
  47     /**
  48      * Get the repository configuration associated with this
  49      * repository content.
  50      *
  51      * @return the repository that is associated with this repository content.
  52      */
  53     RemoteRepository getRepository();
  54
  55     /**
  56      * <p>
  57      * Convenience method to get the repository url.
  58      * </p>
  59      *
  60      * <p>
  61      * Equivalent to calling <code>new RepositoryURL( this.getRepository().getUrl() )</code>
  62      * </p>
  63      *
  64      * @return the repository url.
  65      */
  66     RepositoryURL getURL();
  67
  68     /**
  69      * Set the repository configuration to associate with this
  70      * repository content.
  71      *
  72      * @param repo the repository to associate with this repository content.
  73      */
  74     void setRepository( RemoteRepository repo );
  75
  76     /**
  77      * Given a repository relative path to a filename, return the {@link org.apache.archiva.model.VersionedReference} object suitable for the path.
  78      *
  79      * @param path the path relative to the repository base dir for the artifact.
  80      * @return the {@link ArtifactReference} representing the path.  (or null if path cannot be converted to
  81      *         a {@link ArtifactReference})
  82      * @throws LayoutException if there was a problem converting the path to an artifact.
  83      */
  84     ArtifactReference toArtifactReference( String path )
  85         throws LayoutException;
  86
  87     /**
  88      * Given an ArtifactReference, return the relative path to the artifact.
  89      *
  90      * @param reference the artifact reference to use.
  91      * @return the relative path to the artifact.
  92      */
  93     String toPath( ArtifactReference reference );
  94
  95     /**
  96      * Given an ArtifactReference, return the url to the artifact.
  97      *
  98      * @param reference the artifact reference to use.
  99      * @return the relative path to the artifact.
 100      */
 101     RepositoryURL toURL( ArtifactReference reference );
 102 }