1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.repository;
20
21 /**
22 * Describes a resource being uploaded or downloaded by the repository system.
23 *
24 * @author Benjamin Bentmann
25 */
26 public interface ArtifactTransferResource {
27
28 /**
29 * The base URL of the repository, e.g. "http://repo1.maven.org/maven2/". Unless the URL is unknown, it will be
30 * terminated by a trailing slash.
31 *
32 * @return The base URL of the repository or an empty string if unknown, never {@code null}.
33 */
34 String getRepositoryUrl();
35
36 /**
37 * The path of the artifact relative to the repository's base URL.
38 *
39 * @return The path of the artifact, never {@code null}.
40 */
41 String getName();
42
43 /**
44 * Gets the full URL of the artifact.
45 *
46 * @return The full URL of the artifact, never {@code null}.
47 */
48 String getUrl();
49
50 /**
51 * The size of the artifact in bytes.
52 *
53 * @return The of the artifact in bytes or a negative value if unknown.
54 */
55 long getContentLength();
56
57 /**
58 * Gets the timestamp when the transfer of this artifact was started.
59 *
60 * @return The timestamp when the transfer of this artifact was started.
61 */
62 long getTransferStartTime();
63 }