Skip to content

Commit 8fc555b

Browse files
author
Bogdan Mocanu
committed
Update the documentation with information about the features in v1.3.0
1 parent 7697c0c commit 8fc555b

File tree

3 files changed

+29
-9
lines changed

3 files changed

+29
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Mobile ID Java client (v1.2.0)
1+
# Mobile ID Java client (v1.3.0)
22

33
Swisscom Mobile ID is a cost-efficient, managed authentication service from Swisscom. The customer-facing API is
44
based on open standard ETSI 102 2041. The library from this repository is a reference implementation for

docs/build-download-or-link.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ For Maven projects, add the following in your _POM_ file:
3737
<dependency>
3838
<groupId>ch.mobileid.mid-java-client</groupId>
3939
<artifactId>mid-java-client-rest</artifactId>
40-
<version>1.2.0</version> <!-- or any later version - see README.md in the repository's root -->
40+
<version>1.3.0</version> <!-- or any later version - see README.md in the repository's root -->
4141
</dependency>
4242
</dependencies>
4343
<!-- Alternatively, you can also reference the SOAP implementation of the client; adding both of them does not make much sense -->
4444
<dependencies>
4545
<dependency>
4646
<groupId>ch.mobileid.mid-java-client</groupId>
4747
<artifactId>mid-java-client-soap</artifactId>
48-
<version>1.2.0</version> <!-- or any later version - see README.md in the repository's root -->
48+
<version>1.3.0</version> <!-- or any later version - see README.md in the repository's root -->
4949
</dependency>
5050
</dependencies>
5151
</project>
@@ -60,9 +60,9 @@ plugins {
6060
// ...
6161
6262
dependencies {
63-
compile 'ch.mobileid.mid-java-client:mid-java-client-rest:1.2.0' // or any later version - see README.md in the repository's root
63+
compile 'ch.mobileid.mid-java-client:mid-java-client-rest:1.3.0' // or any later version - see README.md in the repository's root
6464
// Alternatively, you can also reference the SOAP implementation of the client; adding both of them does not make much sense
65-
compile 'ch.mobileid.mid-java-client:mid-java-client-soap:1.2.0' // or any later version - see README.md in the repository's root
65+
compile 'ch.mobileid.mid-java-client:mid-java-client-soap:1.3.0' // or any later version - see README.md in the repository's root
6666
// ...
6767
}
6868
```

docs/use-the-client-programmatically.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ For Maven projects, add the following in your _POM_ file:
1515
<dependency>
1616
<groupId>ch.mobileid.mid-java-client</groupId>
1717
<artifactId>mid-java-client-rest</artifactId>
18-
<version>1.2.0</version> <!-- or any later version - see README.md in the repository's root -->
18+
<version>1.3.0</version> <!-- or any later version - see README.md in the repository's root -->
1919
</dependency>
2020
</dependencies>
2121
<!-- Alternatively, you can also reference the SOAP implementation of the client; adding both of them does not make much sense -->
2222
<dependencies>
2323
<dependency>
2424
<groupId>ch.mobileid.mid-java-client</groupId>
2525
<artifactId>mid-java-client-soap</artifactId>
26-
<version>1.2.0</version> <!-- or any later version - see README.md in the repository's root -->
26+
<version>1.3.0</version> <!-- or any later version - see README.md in the repository's root -->
2727
</dependency>
2828
</dependencies>
2929
</project>
@@ -38,9 +38,9 @@ plugins {
3838
// ...
3939
4040
dependencies {
41-
compile 'ch.mobileid.mid-java-client:mid-java-client-rest:1.2.0' // or any later version - see README.md in the repository's root
41+
compile 'ch.mobileid.mid-java-client:mid-java-client-rest:1.3.0' // or any later version - see README.md in the repository's root
4242
// Alternatively, you can also reference the SOAP implementation of the client; adding both of them does not make much sense
43-
compile 'ch.mobileid.mid-java-client:mid-java-client-soap:1.2.0' // or any later version - see README.md in the repository's root
43+
compile 'ch.mobileid.mid-java-client:mid-java-client-soap:1.3.0' // or any later version - see README.md in the repository's root
4444
// ...
4545
}
4646
```
@@ -140,3 +140,23 @@ receiptRequest.addReceiptRequestExtension();
140140
ReceiptResponse receiptResponse = client.requestSyncReceipt(signatureResponse.getTracking(), receiptRequest);
141141
System.out.println(receiptResponse.toString());
142142
```
143+
144+
## Custom AP ID and AP password per request
145+
146+
The _ClientConfiguration_ class provides a central place where the Application Provider (AP) ID and AP password credentials can be configured.
147+
This information is used whenever a request (signature, status, profile, receipt) is sent to Mobile ID.
148+
This information is used by Mobile ID to know which AP is the one that is sending the request.
149+
150+
While this central configuration of AP credentials is very convenient, there are scenarios where one single Mobile ID client instance
151+
should serve multiple APs, each with its own AP ID and AP password. For this case, since v1.3.0, the Mobile ID client allows you to
152+
override the AP ID and AP password per request:
153+
154+
```java
155+
SignatureRequest request = new SignatureRequest();
156+
request.setOverrideApId("custom-ap-id");
157+
request.setOverrideApPassword("custom-ap-password")
158+
...
159+
```
160+
161+
These methods are available for all operations and are also transferred in the tracking object that is used when an async signature
162+
operation is called and the client needs to poll for that signature's status.

0 commit comments

Comments
 (0)