ListingRetriever (BucketFS Java 3.1.2 API)

java.lang.Object
- com.exasol.bucketfs.list.ListingRetriever

```
public class ListingRetriever
extends Object
```
This class retrieves the list of buckets or of objects inside a bucket.

Constructor Summary

Constructors
Constructor Description

ListingRetriever(HttpClient httpClient)
Create a new instance of ListingRetriever.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static URI`	`publicReadUri(String protocol, String host, int port, String suffix)`
`static String`	`removeLeadingSeparator(String path)`
`Stream<String>`	`retrieve(URI uri, String readPassword)`	Retrieve the content for the given URI as stream.

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

- Constructor Detail
  - ListingRetriever
```
public ListingRetriever(HttpClient httpClient)
```
    Create a new instance of ListingRetriever.
    
    Parameters:
    
    httpClient - HTTP client to access the BucketFS service
- Method Detail
  - publicReadUri
```
public static URI publicReadUri(String protocol,
                                String host,
                                int port,
                                String suffix)
```
    Parameters:
    
    protocol - protocol
    
    host - host name or IP address for the URI
    
    port - port
    
    suffix - e.g. name of the bucket
    
    Returns:
    
    URI made up from the specified elements
  - removeLeadingSeparator
```
public static String removeLeadingSeparator(String path)
```
    Parameters:
    
    path - remove leading BucketConstants.PATH_SEPARATOR from this path
    
    Returns:
    
    path with potential leading BucketConstants.PATH_SEPARATOR removed
  - retrieve
```
public Stream<String> retrieve(URI uri,
                               String readPassword)
                        throws BucketAccessException
```
    Retrieve the content for the given URI as stream.
    
    Parameters:
    
    uri - URI to retrieve listing for
    
    readPassword - read password, only relevant for non-public buckets
    
    Returns:
    
    stream of strings
    
    Throws:
    
    BucketAccessException - in case of failure