View Javadoc

1   package org.apache.maven.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   * Describes a resource being uploaded or downloaded by the repository system.
24   * 
25   * @author Benjamin Bentmann
26   */
27  public interface ArtifactTransferResource
28  {
29  
30      /**
31       * The base URL of the repository, e.g. "http://repo1.maven.org/maven2/". Unless the URL is unknown, it will be
32       * terminated by a trailing slash.
33       * 
34       * @return The base URL of the repository or an empty string if unknown, never {@code null}.
35       */
36      String getRepositoryUrl();
37  
38      /**
39       * The path of the artifact relative to the repository's base URL.
40       * 
41       * @return The path of the artifact, never {@code null}.
42       */
43      String getName();
44  
45      /**
46       * Gets the full URL of the artifact.
47       * 
48       * @return The full URL of the artifact, never {@code null}.
49       */
50      String getUrl();
51  
52      /**
53       * The size of the artifact in bytes.
54       * 
55       * @return The of the artifact in bytes or a negative value if unknown.
56       */
57      long getContentLength();
58  
59      /**
60       * Gets the timestamp when the transfer of this artifact was started.
61       * 
62       * @return The timestamp when the transfer of this artifact was started.
63       */
64      long getTransferStartTime();
65  
66  }