001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.transfer;
020
021import java.io.File;
022
023import org.eclipse.aether.RequestTrace;
024
025/**
026 * Describes a resource being uploaded or downloaded by the repository system.
027 */
028public final class TransferResource {
029
030    private final String repositoryId;
031
032    private final String repositoryUrl;
033
034    private final String resourceName;
035
036    private final File file;
037
038    private final long startTime;
039
040    private final RequestTrace trace;
041
042    private long contentLength = -1L;
043
044    private long resumeOffset;
045
046    /**
047     * Creates a new transfer resource with the specified properties.
048     *
049     * @param repositoryUrl The base URL of the repository, may be {@code null} or empty if unknown. If not empty, a
050     * trailing slash will automatically be added if missing.
051     * @param resourceName The relative path to the resource within the repository, may be {@code null}. A leading slash
052     * (if any) will be automatically removed.
053     * @param file The source/target file involved in the transfer, may be {@code null}.
054     * @param trace The trace information, may be {@code null}.
055     *
056     * @deprecated As of 1.1.0, replaced by {@link #TransferResource(java.lang.String, java.lang.String,
057     * java.lang.String, java.io.File, org.eclipse.aether.RequestTrace)}
058     */
059    @Deprecated
060    public TransferResource(String repositoryUrl, String resourceName, File file, RequestTrace trace) {
061        this(null, repositoryUrl, resourceName, file, trace);
062    }
063
064    /**
065     * Creates a new transfer resource with the specified properties.
066     *
067     * @param repositoryId The ID of the repository used to transfer the resource, may be {@code null} or
068     *                     empty if unknown.
069     * @param repositoryUrl The base URL of the repository, may be {@code null} or empty if unknown. If not empty, a
070     *            trailing slash will automatically be added if missing.
071     * @param resourceName The relative path to the resource within the repository, may be {@code null}. A leading slash
072     *            (if any) will be automatically removed.
073     * @param file The source/target file involved in the transfer, may be {@code null}.
074     * @param trace The trace information, may be {@code null}.
075     *
076     * @since 1.1.0
077     */
078    public TransferResource(
079            String repositoryId, String repositoryUrl, String resourceName, File file, RequestTrace trace) {
080        if (repositoryId == null || repositoryId.isEmpty()) {
081            this.repositoryId = "";
082        } else {
083            this.repositoryId = repositoryId;
084        }
085
086        if (repositoryUrl == null || repositoryUrl.isEmpty()) {
087            this.repositoryUrl = "";
088        } else if (repositoryUrl.endsWith("/")) {
089            this.repositoryUrl = repositoryUrl;
090        } else {
091            this.repositoryUrl = repositoryUrl + '/';
092        }
093
094        if (resourceName == null || resourceName.isEmpty()) {
095            this.resourceName = "";
096        } else if (resourceName.startsWith("/")) {
097            this.resourceName = resourceName.substring(1);
098        } else {
099            this.resourceName = resourceName;
100        }
101
102        this.file = file;
103
104        this.trace = trace;
105
106        startTime = System.currentTimeMillis();
107    }
108
109    /**
110     * The ID of the repository, e.g., "central".
111     *
112     * @return The ID of the repository or an empty string if unknown, never {@code null}.
113     *
114     * @since 1.1.0
115     */
116    public String getRepositoryId() {
117        return repositoryId;
118    }
119
120    /**
121     * The base URL of the repository, e.g. "http://repo1.maven.org/maven2/". Unless the URL is unknown, it will be
122     * terminated by a trailing slash.
123     *
124     * @return The base URL of the repository or an empty string if unknown, never {@code null}.
125     */
126    public String getRepositoryUrl() {
127        return repositoryUrl;
128    }
129
130    /**
131     * The path of the resource relative to the repository's base URL, e.g. "org/apache/maven/maven/3.0/maven-3.0.pom".
132     *
133     * @return The path of the resource, never {@code null}.
134     */
135    public String getResourceName() {
136        return resourceName;
137    }
138
139    /**
140     * Gets the local file being uploaded or downloaded. When the repository system merely checks for the existence of a
141     * remote resource, no local file will be involved in the transfer.
142     *
143     * @return The source/target file involved in the transfer or {@code null} if none.
144     */
145    public File getFile() {
146        return file;
147    }
148
149    /**
150     * The size of the resource in bytes. Note that the size of a resource during downloads might be unknown to the
151     * client which is usually the case when transfers employ compression like gzip. In general, the content length is
152     * not known until the transfer has {@link TransferListener#transferStarted(TransferEvent) started}.
153     *
154     * @return The size of the resource in bytes or a negative value if unknown.
155     */
156    public long getContentLength() {
157        return contentLength;
158    }
159
160    /**
161     * Sets the size of the resource in bytes.
162     *
163     * @param contentLength The size of the resource in bytes or a negative value if unknown.
164     * @return This resource for chaining, never {@code null}.
165     */
166    public TransferResource setContentLength(long contentLength) {
167        this.contentLength = contentLength;
168        return this;
169    }
170
171    /**
172     * Gets the byte offset within the resource from which the download starts. A positive offset indicates a previous
173     * download attempt is being resumed, {@code 0} means the transfer starts at the first byte.
174     *
175     * @return The zero-based index of the first byte being transferred, never negative.
176     */
177    public long getResumeOffset() {
178        return resumeOffset;
179    }
180
181    /**
182     * Sets the byte offset within the resource at which the download starts.
183     *
184     * @param resumeOffset The zero-based index of the first byte being transferred, must not be negative.
185     * @return This resource for chaining, never {@code null}.
186     */
187    public TransferResource setResumeOffset(long resumeOffset) {
188        if (resumeOffset < 0L) {
189            throw new IllegalArgumentException("resume offset cannot be negative");
190        }
191        this.resumeOffset = resumeOffset;
192        return this;
193    }
194
195    /**
196     * Gets the timestamp when the transfer of this resource was started.
197     *
198     * @return The timestamp when the transfer of this resource was started.
199     */
200    public long getTransferStartTime() {
201        return startTime;
202    }
203
204    /**
205     * Gets the trace information that describes the higher level request/operation during which this resource is
206     * transferred.
207     *
208     * @return The trace information about the higher level operation or {@code null} if none.
209     */
210    public RequestTrace getTrace() {
211        return trace;
212    }
213
214    @Override
215    public String toString() {
216        return getRepositoryUrl() + getResourceName() + " <> " + getFile();
217    }
218}