1 /* 2 * Copyright (C) 2018 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package com.android.tradefed.config.remote; 17 18 import com.android.tradefed.config.ConfigurationException; 19 import com.android.tradefed.config.Option; 20 21 import java.io.File; 22 23 import javax.annotation.Nonnull; 24 25 /** 26 * Interface for objects that can resolve a remote file into a local one. For example: 27 * gs://bucket/dir/file.txt would be downloaded and changed to a local path. 28 */ 29 public interface IRemoteFileResolver { 30 31 /** 32 * Resolve the remote file. 33 * 34 * @param consideredFile {@link File} evaluated as remote. 35 * @param option The original option configuring the file. 36 * @return The resolved local file. 37 * @throws ConfigurationException if something goes wrong. 38 */ resolveRemoteFiles(File consideredFile, Option option)39 public @Nonnull File resolveRemoteFiles(File consideredFile, Option option) 40 throws ConfigurationException; 41 42 /** Returns the associated protocol supported for download. */ getSupportedProtocol()43 public @Nonnull String getSupportedProtocol(); 44 } 45