Loading server.properties into S3BucketConfig

Author: jaceklaskowski

docs/cli/UnityCatalogCli.md

@@ -8,7 +8,7 @@
 
 Personal access token (PAT) to authorize requests
 
-When specified, `UnityCatalogCli` [creates an ApiClient](#getApiClient) that adds `authorization` header with `Bearer [pat]` to every request.
+When specified, `UnityCatalogCli` [creates an ApiClient](#getApiClient) that adds the bearer token in the HTTP `Authorization` header to every request.
 
 ```text
 authorization: Bearer [pat]

docs/persistent-storage/PropertiesUtil.md

@@ -1 +1,57 @@
 # PropertiesUtil
+
+`PropertiesUtil` is a system-wide [configuration of S3 buckets](#loadProperties)
+
+## Loading S3 Bucket Configuration { #loadProperties }
+
+```java
+void loadProperties()
+```
+
+`loadProperties` loads the key-value pairs from `etc/conf/server.properties` file into the [Properties](#properties).
+
+`loadProperties` prints out the following DEBUG message to the logs:
+
+```text
+Properties loaded successfully
+```
+
+`loadProperties` creates a [S3BucketConfig](S3BucketConfig.md) for every tuple of the following properties:
+
+* `s3.bucketPath.[n]`
+* `s3.accessKey.[n]`
+* `s3.secretKey.[n]`
+* `s3.sessionToken.[n]`
+
+!!! note
+    `loadProperties` silently skips processing a tuple if any of the properties is undefined (`null`).
+
+In the end, `loadProperties` registers the `S3BucketConfig`s by `s3.bucketPath`.
+
+---
+
+`loadProperties` is used when:
+
+* `PropertiesUtil` is created
+
+## Looking Up S3BucketConfig by S3 Path { #getS3BucketConfig }
+
+```java
+S3BucketConfig getS3BucketConfig(
+  String s3Path)
+```
+
+`getS3BucketConfig` creates a URI for the given `s3Path`.
+
+`getS3BucketConfig` creates a bucket path for the following URI parts (separated using `://`):
+
+* Scheme
+* Host
+
+`getS3BucketConfig` uses the bucket path (`scheme://host`) to look up the `S3BucketConfig` in the [Properties](#properties).
+
+---
+
+`getS3BucketConfig` is used when:
+
+* `TemporaryCredentialUtils` is requested to [find a S3 bucket config](../server/TemporaryCredentialUtils.md#findS3BucketConfig)

docs/persistent-storage/S3BucketConfig.md

@@ -0,0 +1,21 @@
+# S3BucketConfig
+
+`S3BucketConfig` is a S3 bucket configuration.
+
+`S3BucketConfig` is used when:
+
+* `TemporaryCredentialUtils` is requested to [findS3BucketConfig](../server/TemporaryCredentialUtils.md#findS3BucketConfig)
+* `PropertiesUtil` is requested to [getS3BucketConfig](PropertiesUtil.md#getS3BucketConfig)
+
+## Creating Instance
+
+`S3BucketConfig` takes the following to be created:
+
+* <span id="bucketPath"> `bucketPath`
+* <span id="accessKey"> `accessKey`
+* <span id="secretKey"> `secretKey`
+* <span id="sessionToken"> `sessionToken`
+
+`S3BucketConfig` is created when:
+
+* `PropertiesUtil` is requested to [loadProperties](PropertiesUtil.md#loadProperties)

docs/server/AwsCredentials.md

@@ -0,0 +1 @@
+# AwsCredentials

docs/server/TemporaryCredentialUtils.md

@@ -0,0 +1,25 @@
+# TemporaryCredentialUtils
+
+## Looking Up AwsCredentials for S3 Storage Location { #findS3BucketConfig }
+
+```java
+AwsCredentials findS3BucketConfig(
+  String storageLocation)
+```
+
+`findS3BucketConfig` requests the system-wide [PropertiesUtil](../persistent-storage/PropertiesUtil.md#instance) instance for [getS3BucketConfig](../persistent-storage/PropertiesUtil.md#getS3BucketConfig).
+
+`findS3BucketConfig` creates a [AwsCredentials](../server/AwsCredentials.md).
+
+Property | Value
+-|-
+ [accessKeyId](../server/AwsCredentials.md#accessKeyId) | [accessKey](../persistent-storage/S3BucketConfig.md#accessKey)
+ [secretAccessKey](../server/AwsCredentials.md#secretAccessKey) | [secretKey](../persistent-storage/S3BucketConfig.md#secretKey)
+ [sessionToken](../server/AwsCredentials.md#sessionToken) | [sessionToken](../persistent-storage/S3BucketConfig.md#sessionToken)
+
+---
+
+`findS3BucketConfig` is used when:
+
+* `TemporaryTableCredentialsService` is requested to [generateTemporaryTableCredential](TemporaryTableCredentialsService.md#generateTemporaryTableCredential)
+* `TemporaryVolumeCredentialsService` is requested to [generateTemporaryTableCredential](TemporaryVolumeCredentialsService.md#generateTemporaryTableCredential)