HttpFileStorage 40.0.0 API

All Implemented Interfaces:

org.ossreviewtoolkit.utils.ort.storage.FileStorage
```
public final class HttpFileStorage
 implements FileStorage
                    
```
A FileStorage that stores files on an HTTP server.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`url`
`private final String`	`query`

Constructor Summary

Constructors
Constructor	Description
`HttpFileStorage(String url, String query, Map<String, String> headers, Integer cacheMaxAgeInSeconds)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getUrl()`	The URL to store files at.
`final String`	`getQuery()`	The query string that is appended to the combination of the URL and some additional path.
`Boolean`	`exists(String path)`	Return whether the given path exists or not.
`InputStream`	`read(String path)`	Read the file at path.
`Unit`	`write(String path, InputStream inputStream)`	Write the data from inputStream to the file at path.
`Boolean`	`delete(String path)`	Delete the file at the given path and return whether the operation was successful.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpFileStorage
```
HttpFileStorage(String url, String query, Map<String, String> headers, Integer cacheMaxAgeInSeconds)
```
- Method Detail
  - getUrl
```
 final String getUrl()
```
    The URL to store files at.
  - getQuery
```
 final String getQuery()
```
    The query string that is appended to the combination of the URL and some additional path. Some storages process authentication via parameters that are within the final URL, so certain credentials can be stored in this query, e.g, "?user=standard&pwd=123". Thus, the final URL could be "https://example.com/storage/path?user=standard&pwd=123".
  - exists
```
 Boolean exists(String path)
```
    Return whether the given path exists or not.
  - read
```
 InputStream read(String path)
```
    Read the file at path. It is the caller's responsibility to close the returned InputStream after consuming it.
  - write
```
 Unit write(String path, InputStream inputStream)
```
    Write the data from inputStream to the file at path. If the file already exists it is overwritten. The provided inputStream is closed after writing it to the file.
  - delete
```
 Boolean delete(String path)
```
    Delete the file at the given path and return whether the operation was successful.