Skip to content

Commit ba7f2e8

Browse files
committed
Adjust javadocs so they build correctly
1 parent a9c84d3 commit ba7f2e8

5 files changed

Lines changed: 27 additions & 9 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ The Duo Universal Client for Java is available from Duo Security on Maven. Incl
2626
<dependency>
2727
<groupId>com.duosecurity</groupId>
2828
<artifactId>duo-universal-sdk</artifactId>
29-
<version>1.1.0</version>
29+
<version>1.1.1</version>
3030
</dependency>
3131
```
32-
See https://mvnrepository.com/artifact/com.duosecurity/duo-universal-sdk/1.1.0 for more details.
32+
See https://mvnrepository.com/artifact/com.duosecurity/duo-universal-sdk/1.1.1 for more details.
3333

3434
# Demo
3535

duo-example/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<modelVersion>4.0.0</modelVersion>
1111

1212
<artifactId>duo-example</artifactId>
13-
<version>1.1.0</version>
13+
<version>1.1.1</version>
1414
<name>Duo Universal Java</name>
1515
<url>https://github.com/duosecurity/duo_universal_java/</url>
1616
<description>Duo Web SDK for two-factor authentication</description>
@@ -38,7 +38,7 @@
3838
<dependency>
3939
<groupId>com.duosecurity</groupId>
4040
<artifactId>duo-universal-sdk</artifactId>
41-
<version>1.1.0</version>
41+
<version>1.1.1</version>
4242
</dependency>
4343
<dependency>
4444
<groupId>org.springframework</groupId>

duo-universal-sdk/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<artifactId>duo-universal-sdk</artifactId>
88
<groupId>com.duosecurity</groupId>
9-
<version>1.1.0</version>
9+
<version>1.1.1</version>
1010
<name>Duo Universal Java</name>
1111
<url>https://github.com/duosecurity/duo_universal_java/</url>
1212
<description>Duo Web SDK for two-factor authentication</description>

duo-universal-sdk/src/main/java/com/duosecurity/Client.java

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public class Client {
3838

3939
private static final String USER_AGENT_LIB = "duo_universal_java";
4040

41-
private static final String USER_AGENT_VERSION = "1.1.0";
41+
private static final String USER_AGENT_VERSION = "1.1.1";
4242

4343
// **************************************************
4444
// Fields
@@ -68,6 +68,12 @@ private Client() {
6868

6969
/**
7070
* Legacy simple constructor.
71+
* @param clientId This value is the client id provided by Duo in the admin panel.
72+
* @param clientSecret This value is the client secret provided by Duo in the admin panel.
73+
* @param apiHost This value is the api host provided by Duo in the admin panel.
74+
* @param redirectUri This value is the uri which Duo should redirect to after 2FA is completed.
75+
*
76+
* @throws DuoException For problems building the client
7177
* @deprecated The constructors are deprecated.
7278
* Prefer the {@link Client.Builder} for instantiating Clients
7379
*/
@@ -79,6 +85,14 @@ public Client(String clientId, String clientSecret, String apiHost, String redir
7985

8086
/**
8187
* Legacy constructor which allows specifying custom CaCerts.
88+
* @param clientId This value is the client id provided by Duo in the admin panel.
89+
* @param clientSecret This value is the client secret provided by Duo in the admin panel.
90+
* @param apiHost This value is the api host provided by Duo in the admin panel.
91+
* @param redirectUri This value is the uri which Duo should redirect to after 2FA is completed.
92+
* @param userCaCerts This value is a list of CA Certificates used to validate connections to Duo
93+
*
94+
* @throws DuoException For problems building the client
95+
*
8296
* @deprecated The constructors are deprecated.
8397
* Prefer the {@link Client.Builder} for instantiating Clients
8498
*/
@@ -136,8 +150,6 @@ public static class Builder {
136150
* @param clientSecret This value is the client secret provided by Duo in the admin panel.
137151
* @param apiHost This value is the api host provided by Duo in the admin panel.
138152
* @param redirectUri This value is the uri which Duo should redirect to after 2FA is completed.
139-
*
140-
* @throws DuoException For problems validating the client parameters
141153
*/
142154
public Builder(String clientId, String clientSecret, String apiHost,
143155
String redirectUri) {
@@ -176,6 +188,8 @@ public Client build() throws DuoException {
176188
* Optionally use custom CA Certificates when validating connections to Duo.
177189
*
178190
* @param userCaCerts List of CA Certificates to use
191+
*
192+
* @return the Builder
179193
*/
180194
public Builder setCACerts(String[] userCaCerts) {
181195
if (validateCaCert(userCaCerts)) {
@@ -189,6 +203,8 @@ public Builder setCACerts(String[] userCaCerts) {
189203
* Defaults true to use duo_code.
190204
*
191205
* @param useDuoCodeAttribute true/false toggle
206+
*
207+
* @return the Builder
192208
*/
193209
public Builder setUseDuoCodeAttribute(boolean useDuoCodeAttribute) {
194210
this.useDuoCodeAttribute = useDuoCodeAttribute;
@@ -199,6 +215,8 @@ public Builder setUseDuoCodeAttribute(boolean useDuoCodeAttribute) {
199215
* Optionally appends string to userAgent.
200216
*
201217
* @param newUserAgent Additional info that will be added to the end of the user agent string
218+
*
219+
* @return the Builder
202220
*/
203221
public Builder appendUserAgentInfo(String newUserAgent) {
204222
userAgent = format("%s %s", userAgent, newUserAgent);

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<groupId>com.duosecurity</groupId>
88
<artifactId>duo-universal-java</artifactId>
99
<packaging>pom</packaging>
10-
<version>1.1.0</version>
10+
<version>1.1.1</version>
1111

1212
<name>Duo Universal Java</name>
1313
<url>https://github.com/duosecurity/duo_universal_java/</url>

0 commit comments

Comments
 (0)