Skip to content

Commit 0e5e4df

Browse files
committed
change Pascal case in READMEs, samples, tests
1 parent 550432c commit 0e5e4df

File tree

13 files changed

+34
-34
lines changed

13 files changed

+34
-34
lines changed

documents/FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To enable logging in the samples, you will need to set the following system prop
3535
For example, to run `BasicPubSub` with logging you could use the following:
3636

3737
```sh
38-
mvn compile exec:java -pl samples/mqtt/mqtt5x509 -Daws.crt.debugnative=true -Daws.crt.log.level=Debug -Daws.crt.log.destionation=Stdout -Dexec.mainClass=pubsub.PubSub -Dexec.args='--endpoint <endpoint> --cert <path to cert> --key <path to key>'
38+
mvn compile exec:java -pl samples/Mqtt/Mqtt5X509 -Daws.crt.debugnative=true -Daws.crt.log.level=Debug -Daws.crt.log.destionation=Stdout -Dexec.mainClass=pubsub.PubSub -Dexec.args='--endpoint <endpoint> --cert <path to cert> --key <path to key>'
3939
```
4040

4141
You can also enable [CloudWatch logging](https://docs.aws.amazon.com/iot/latest/developerguide/cloud-watch-logs.html) for IoT which will provide you with additional information that is not available on the client side sdk.

samples/Mqtt/Mqtt5AwsWebsocket/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ To run this sample from the `aws-iot-device-sdk-java-v2` folder use the followin
7373

7474
```sh
7575
mvn compile exec:java \
76-
-pl samples/mqtt/mqtt5awswebsocket \
76+
-pl samples/Mqtt/Mqtt5AwsWebsocket \
7777
-Dexec.args="\
7878
--endpoint <endpoint> \
7979
--signing_region <Signing region for websocket connection>"
@@ -82,7 +82,7 @@ mvn compile exec:java \
8282
If you would like to see what optional arguments are available, use the `--help` argument:
8383
```sh
8484
mvn compile exec:java \
85-
-pl samples/mqtt/mqtt5awswebsocket \
85+
-pl samples/Mqtt/Mqtt5AwsWebsocket \
8686
-Dexec.args="\
8787
--help"
8888
```

samples/Mqtt/Mqtt5CustomAuthSigned/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To run this sample from the `aws-iot-device-sdk-java-v2` folder use the followin
7272

7373
```sh
7474
mvn compile exec:java \
75-
-pl samples/mqtt/mqtt5customauthsigned \
75+
-pl samples/Mqtt/Mqtt5CustomAuthSigned \
7676
-Dexec.args=" \
7777
--endpoint <endpoint> \
7878
--authorizer_name <The name of the custom authorizer to invoke> \
@@ -86,7 +86,7 @@ mvn compile exec:java \
8686
If you would like to see what optional arguments are available, use the `--help` argument:
8787
```sh
8888
mvn compile exec:java \
89-
-pl samples/mqtt/mqtt5customauthsigned \
89+
-pl samples/Mqtt/Mqtt5CustomAuthSigned \
9090
-Dexec.args=" \
9191
--help"
9292
```

samples/Mqtt/Mqtt5CustomAuthUnsigned/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To run this sample from the `aws-iot-device-sdk-java-v2` folder use the followin
7272

7373
```sh
7474
mvn compile exec:java \
75-
-pl samples/mqtt/mqtt5customauthunsigned \
75+
-pl samples/Mqtt/Mqtt5CustomAuthUnsigned \
7676
-Dexec.args=" \
7777
--endpoint <endpoint> \
7878
--authorizer_name <The name of the custom authroizer to invoke> \
@@ -83,7 +83,7 @@ mvn compile exec:java \
8383
If you would like to see what optional arguments are available, use the `--help` argument:
8484
```sh
8585
mvn compile exec:java \
86-
-pl samples/mqtt/mqtt5customauthunsigned \
86+
-pl samples/Mqtt/Mqtt5CustomAuthUnsigned \
8787
-Dexec.args=" \
8888
--help"
8989
```

samples/Mqtt/Mqtt5Pkcs11/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ To run this sample from the `aws-iot-device-sdk-java-v2` folder use the followin
7373

7474
```sh
7575
mvn compile exec:java \
76-
-pl samples/mqtt/mqtt5pkcs11 \
76+
-pl samples/Mqtt/Mqtt5Pkcs11 \
7777
-Dexec.args="\
7878
--endpoint <ENDPOINT> \
7979
--cert <PATH TO CERTIFICATE> \
@@ -86,7 +86,7 @@ mvn compile exec:java \
8686
If you would like to see what optional arguments are available, use the `--help` argument:
8787
```sh
8888
mvn compile exec:java \
89-
-pl samples/mqtt/mqtt5pkcs11 \
89+
-pl samples/Mqtt/Mqtt5Pkcs11 \
9090
-Dexec.args="\
9191
--help"
9292
```

samples/Mqtt/Mqtt5X509/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To run this sample from the `aws-iot-device-sdk-java-v2` folder use the followin
7272

7373
```sh
7474
mvn compile exec:java \
75-
-pl samples/mqtt/mqtt5x509 \
75+
-pl samples/Mqtt/Mqtt5X509 \
7676
-Dexec.args=" \
7777
--endpoint <endpoint> \
7878
--cert <Path to certificate file> \
@@ -82,7 +82,7 @@ mvn compile exec:java \
8282
If you would like to see what optional arguments are available, use the `--help` argument:
8383
```sh
8484
mvn compile exec:java \
85-
-pl samples/mqtt/mqtt5x509 \
85+
-pl samples/Mqtt/Mqtt5X509 \
8686
-Dexec.args=" \
8787
--help"
8888
```

samples/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,42 +12,42 @@ This directory contains sample applications for [aws-iot-device-sdk-java-v2](../
1212

1313
## Samples
1414
### MQTT5 Client Samples
15-
##### MQTT5 is the recommended MQTT Client. Additional infomration and usage instructions can be found in the [MQTT5 User Guide](../documents/MQTT5_Userguide.md). The samples below will create an MQTT5 client, connect using the selected method, subscribe to a topic, publish to the topic, and then disconnect.
15+
##### MQTT5 is the recommended MQTT Client. Additional infomration and usage instructions can be found in the [MQTT5 User Guide](../documents/Mqtt5_Userguide.md). The samples below will create an MQTT5 client, connect using the selected method, subscribe to a topic, publish to the topic, and then disconnect.
1616
| MQTT5 Client Sample | Description |
1717
|--------|-------------|
18-
| [X509-based mutual TLS](./mqtt/mqtt5x509/README.md) | Demonstrates connecting to AWS IoT Core using X.509 certificates and private keys.
19-
| [Websockets with Sigv4 authentication](./mqtt/mqtt5awswebsocket/README.md) | Shows how to authenticate over websockets using AWS Signature Version 4 credentials. |
20-
| [AWS Signed Custom Authorizer Lambda Function](./mqtt/mqtt5customauthsigned/README.md) | Connecting with a signed Lambda-backed custom authorizer.
21-
| [AWS Unsigned Custom Authorizer Lambda Function](./mqtt/mqtt5customauthunsigned/README.md) | Connecting with an unsigned Lambda-backed custom authorizer.
22-
| [PKCS11](./mqtt/mqtt5pkcs11/README.md) | Demonstrates connecting using a hardware security module (HSM) or smartcard with PKCS#11. |
18+
| [X509-based mutual TLS](./Mqtt/Mqtt5X509/README.md) | Demonstrates connecting to AWS IoT Core using X.509 certificates and private keys.
19+
| [Websockets with Sigv4 authentication](./Mqtt/Mqtt5AwsWebsocket/README.md) | Shows how to authenticate over websockets using AWS Signature Version 4 credentials. |
20+
| [AWS Signed Custom Authorizer Lambda Function](./Mqtt/Mqtt5CustomAuthSigned/README.md) | Connecting with a signed Lambda-backed custom authorizer.
21+
| [AWS Unsigned Custom Authorizer Lambda Function](./Mqtt/Mqtt5CustomAuthUnsigned/README.md) | Connecting with an unsigned Lambda-backed custom authorizer.
22+
| [PKCS11](./Mqtt/Mqtt5Pkcs11/README.md) | Demonstrates connecting using a hardware security module (HSM) or smartcard with PKCS#11. |
2323
| [Other Connection Methods](../documents/MQTT5_Userguide.md#how-to-create-an-mqtt5-client-based-on-desired-connection-method) | More connection methods are available for review in the MQTT5 Userguide
2424

2525
### Service Client Samples
2626
##### AWS offers a number of IoT related services using MQTT. The samples below demonstrate how to use the service clients provided by the SDK to interact with those services.
2727
| Service Client Sample | Description |
2828
|--------|-------------|
29-
| [Basic Fleet Provisioning](./serviceclients/provisioning/basic/README.md) | Provision a device using the Fleet Provisioning template. |
30-
| [CSR Fleet Provisioning](./serviceclients/provisioning/csr/README.md) | Demonstrates CSR-based device certificate provisioning. |
31-
| [Shadow Sandbox](./serviceclients/shadowsandbox/README.md) | Sandbox sample to manage and sync device state using the IoT Device Shadow service. |
32-
| [Jobs Sandbox](./serviceclients/jobssandbox/README.md) | Sandbox sample to receive and execute remote operations sent from the Jobs service. |
33-
| [Commands Sandbox](./serviceclients/provisioning/csr/README.md) | Sandbox sample to demonstrante Commands service. |
29+
| [Basic Fleet Provisioning](./ServiceClients/Provisioning/Basic/README.md) | Provision a device using the Fleet Provisioning template. |
30+
| [CSR Fleet Provisioning](./ServiceClients/Provisioning/Csr/README.md) | Demonstrates CSR-based device certificate provisioning. |
31+
| [Shadow Sandbox](./ServiceClients/ShadowSandbox/README.md) | Sandbox sample to manage and sync device state using the IoT Device Shadow service. |
32+
| [Jobs Sandbox](./ServiceClients/JobsSandbox/README.md) | Sandbox sample to receive and execute remote operations sent from the Jobs service. |
33+
| [Commands Sandbox](./ServiceClients/CommandsSandbox/README.md) | Sandbox sample to demonstrante Commands service. |
3434

3535
### Greengrass Samples
3636
##### Samples that interact with [AWS Greengrass](https://aws.amazon.com/greengrass/).
3737
| Greengrass Sample | Description |
3838
|--------|-------------|
39-
| [Greengrass Discovery](./greengrass/discovery/README.md) | Discover and connect to a local Greengrass core. |
40-
| [Greengrass IPC](./greengrass/greengrassipc/README.md) | Demonstrates Inter-Process Communication (IPC) with Greengrass components. |
39+
| [Greengrass Discovery](./Greengrass/Discovery/README.md) | Discover and connect to a local Greengrass core. |
40+
| [Greengrass IPC](./Greengrass/GreengrassIPC/README.md) | Demonstrates Inter-Process Communication (IPC) with Greengrass components. |
4141

4242
### Instructions
4343

4444
First, install `aws-iot-device-sdk-java-v2`. Installation instructions for the SDK are [Provided Here](../README.md#installation).
4545

46-
Each sample's README contains prerequisites, arguments, and detailed instructions. For example, the [MQTT X509 Sample README](./mqtt/mqtt5x509/README.md) instructs to run the sample with the following command:
46+
Each sample's README contains prerequisites, arguments, and detailed instructions. For example, the [MQTT X509 Sample README](./Mqtt/Mqtt5x509/README.md) instructs to run the sample with the following command:
4747

4848
```sh
4949
mvn compile exec:java \
50-
-pl samples/mqtt/mqtt5x509 \
50+
-pl samples/Mqtt/Mqtt5x509 \
5151
-Dexec.args=" \
5252
--endpoint <ENDPOINT> \
5353
--cert <PATH TO CERTIFICATE FILE> \
@@ -60,7 +60,7 @@ If you want to run a sample using the latest release of the SDK, instead of comp
6060

6161
```sh
6262
mvn -P latest-release compile exec:java \
63-
-pl samples/mqtt/mqtt5x509 \
63+
-pl samples/Mqtt/Mqtt5X509 \
6464
-Dexec.args=" \
6565
--endpoint <ENDPOINT> \
6666
--cert <PATH TO CERTIFICATE FILE> \
@@ -74,7 +74,7 @@ This will run the sample using the latest released version of the SDK rather tha
7474
All samples will show their options and arguments by passing in `--help`. For example:
7575
``` sh
7676
mvn compile exec:java \
77-
-pl samples/mqtt/mqtt5x509 \
77+
-pl samples/Mqtt/Mqtt5X509 \
7878
-Dexec.args=" \
7979
--help"
8080
```

samples/ServiceClients/CommandsSandbox/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Replace with the following with the data from your AWS account:
179179
To run the sample, use the following Shell command:
180180

181181
```shell
182-
mvn compile exec:java -pl samples/CommandsSandbox -Dexec.mainClass=commands.CommandsSandbox \
182+
mvn compile exec:java -pl samples/ServiceClients/CommandsSandbox -Dexec.mainClass=commands.CommandsSandbox \
183183
-Dexec.args="--endpoint <endpoint> --cert <path to certificate> --key <path to private key> --thing <thing-name> --client-id <mqtt-client-id>"
184184
```
185185

samples/ServiceClients/JobsSandbox/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ job permission so that you can name the jobs whatever you would like.
139139
To run the Jobs sample use the following command:
140140

141141
``` sh
142-
mvn compile exec:java -pl samples/JobsSandbox -Dexec.mainClass=jobs.JobsSandbox -Dexec.args="--endpoint <endpoint> --cert <path to certificate> --key <path to private key> --thing <thing name>"
142+
mvn compile exec:java -pl samples/ServiceClients/JobsSandbox -Dexec.mainClass=jobs.JobsSandbox -Dexec.args="--endpoint <endpoint> --cert <path to certificate> --key <path to private key> --thing <thing name>"
143143
```
144144

145145
If an AWS IoT Thing resource with the given name does not exist, the sample will first create it. Once the thing

samples/ServiceClients/Provisioning/Basic/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ to perform the actual provisioning in the section below.
253253
To run the sample with your certificate and private key, use the following command:
254254

255255
``` sh
256-
mvn compile exec:java -pl samples/Provisioning/Basic -Dexec.mainClass=identity.BasicProvisioning -Dexec.args="--endpoint <endpoint> --cert <path to certificate> --key <path to private key> --template <provisioning template name> --params '{"SerialNumber":"1","DeviceLocation":"Seattle"}'"
256+
mvn compile exec:java -pl samples/ServiceClients/Provisioning/Basic -Dexec.mainClass=identity.BasicProvisioning -Dexec.args="--endpoint <endpoint> --cert <path to certificate> --key <path to private key> --template <provisioning template name> --params '{"SerialNumber":"1","DeviceLocation":"Seattle"}'"
257257
```
258258

259259
As per normal, replace the `<>` parameters with the proper values. Notice that we provided substitution values for the two parameters in the template body, `DeviceLocation` and `SerialNumber`.

0 commit comments

Comments
 (0)