Skip to content

Commit 95ccd2b

Browse files
ServerProperties and server.properties
1 parent 6bec491 commit 95ccd2b

File tree

6 files changed

+25
-21
lines changed

6 files changed

+25
-21
lines changed

docs/credential-vending/AwsCredentialVendor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
`AwsCredentialVendor` is used to [vend S3 bucket credentials](#vendAwsCredentials) for [CredentialOperations](CredentialOperations.md#awsCredentialVendor) (to [vend credentials](CredentialOperations.md#vendCredential) for `s3://` storage scheme).
44

5-
`AwsCredentialVendor` uses [server.properties](../server/ServerPropertiesUtils.md#getS3Configurations) configuration file for S3 bucket security configurations.
5+
`AwsCredentialVendor` uses [server.properties](../server/ServerProperties.md#getS3Configurations) configuration file for S3 bucket security configurations.
66

77
!!! note "AWS Security Token Service (STS)"
88
`AwsCredentialVendor` uses [AWS Security Token Service (STS)](https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html) to request [temporary, limited-privilege security credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html):
@@ -17,7 +17,7 @@
1717
Map<String, S3StorageConfig> s3Configurations
1818
```
1919

20-
`AwsCredentialVendor` initializes `s3Configurations` based on [server.properties](../server/ServerPropertiesUtils.md#getS3Configurations) configuration file.
20+
`AwsCredentialVendor` initializes `s3Configurations` based on [server.properties](../server/ServerProperties.md#getS3Configurations) configuration file.
2121

2222
This `s3Configurations` is used to look up [S3StorageConfig](S3StorageConfig.md)s to [vend S3 bucket credentials](#vendAwsCredentials).
2323

docs/credential-vending/S3StorageConfig.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
* <span id="secretKey"> Secret Key
1212
* <span id="sessionToken"> Session Token
1313

14-
`S3StorageConfig` is created only when `ServerProperties` is requested for the [S3 configurations](../server/ServerPropertiesUtils.md#getS3Configurations).
14+
`S3StorageConfig` is created only when `ServerProperties` is requested for the [S3 configurations](../server/ServerProperties.md#getS3Configurations).
1515

1616
`S3StorageConfig` is used by the following services:
1717

docs/persistent-storage/HibernateUtil.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
`HibernateUtil` is used to access the system-wide [SessionFactory](#sessionFactory) ([Hibernate]({{ hibernate.javadoc }}/org/hibernate/SessionFactory.html)).
44

5-
## ServerPropertiesUtils { #properties }
5+
## ServerProperties { #properties }
66

7-
`HibernateUtil` gets at the only instance of [ServerPropertiesUtils](../server/ServerPropertiesUtils.md#instance) in a static initializer.
7+
`HibernateUtil` gets at the only instance of [ServerProperties](../server/ServerProperties.md#instance) in a static initializer.
88

99
??? note "Static Initializer"
1010
A **static initializer** declared in a class is executed when the class is initialized.

docs/server/ServerPropertiesUtils.md renamed to docs/server/ServerProperties.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
# ServerPropertiesUtils
1+
# ServerProperties
22

33
## Creating Instance
44

5-
`ServerPropertiesUtils` takes no arguments to be created.
5+
`ServerProperties` takes no arguments to be created.
66

7-
While being created, `ServerPropertiesUtils` [loads server configuration](#loadProperties).
7+
While being created, `ServerProperties` [loads server configuration](#loadProperties).
88

9-
`ServerPropertiesUtils` is created once to be available [system-wide](#instance).
9+
`ServerProperties` is created once to be available [system-wide](#instance).
1010

11-
## ServerPropertiesUtils Instance { #instance }
11+
## ServerProperties Instance { #instance }
1212

1313
``` java
14-
ServerPropertiesUtils instance
14+
ServerProperties instance
1515
```
1616

17-
`ServerPropertiesUtils` is available system-wide as one single instance.
17+
`ServerProperties` is available system-wide as one single instance.
1818

1919
``` scala
20-
import io.unitycatalog.server.persist.utils.ServerPropertiesUtils
21-
val s3conf = ServerPropertiesUtils.getInstance.getS3Configurations
20+
import io.unitycatalog.server.persist.utils.ServerProperties
21+
val s3conf = ServerProperties.getInstance.getS3Configurations
2222
```
2323

24-
This `ServerPropertiesUtils` instance is used when:
24+
This `ServerProperties` instance is used when:
2525

2626
* `UnityCatalogServer` is requested to [addServices](UnityCatalogServer.md#addServices)
2727
* [FileUtils](../persistent-storage/FileUtils.md#properties) is created (and requested to [modifyS3Directory](../persistent-storage/FileUtils.md#modifyS3Directory))
@@ -36,11 +36,11 @@ This `ServerPropertiesUtils` instance is used when:
3636

3737
## Server Properties { #properties }
3838

39-
`ServerPropertiesUtils` [loads server configuration](#loadProperties) from `etc/conf/server.properties` when [created](#creating-instance).
39+
`ServerProperties` [loads server configuration](#loadProperties) from `etc/conf/server.properties` when [created](#creating-instance).
4040

4141
When there is no `etc/conf/server.properties`, the server properties is empty.
4242

43-
`ServerPropertiesUtils` uses the properties for the following:
43+
`ServerProperties` uses the properties for the following:
4444

4545
* [getProperty](#getProperty)
4646
* [getS3Configurations](#getS3Configurations)
@@ -124,13 +124,13 @@ Properties loaded successfully
124124

125125
## Logging
126126

127-
Enable `ALL` logging level for `io.unitycatalog.server.persist.utils.ServerPropertiesUtils` logger to see what happens inside.
127+
Enable `ALL` logging level for `io.unitycatalog.server.persist.utils.ServerProperties` logger to see what happens inside.
128128

129129
Add the following line to `etc/conf/server.log4j2.properties`:
130130

131131
```text
132-
logger.ServerPropertiesUtils.name = io.unitycatalog.server.persist.utils.ServerPropertiesUtils
133-
logger.ServerPropertiesUtils.level = all
132+
logger.ServerProperties.name = io.unitycatalog.server.persist.utils.ServerProperties
133+
logger.ServerProperties.level = all
134134
```
135135

136136
Refer to [Logging](../logging.md).

docs/server/UnityCatalogServer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The summary of the single metastore is available through [MetastoreService](Meta
2929
`UnityCatalogServer` uses the following configuration files:
3030

3131
* `etc/conf/server.log4j2.properties`
32-
* [etc/conf/server.properties](ServerPropertiesUtils.md)
32+
* [etc/conf/server.properties](ServerProperties.md)
3333

3434
## Port
3535

docs/server/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,7 @@ usage: bin/start-uc-server
1414

1515
!!! note
1616
The REST API requests can come from any Unity Catalog API-compatible client, incl. [Unity Catalog CLI](../cli/index.md).
17+
18+
## Server Configuration
19+
20+
The Localhost Reference Server uses `etc/conf/server.properties` file for [server configuration](ServerProperties.md#loadProperties).

0 commit comments

Comments
 (0)