Skip to content

Commit 7dbd611

Browse files
author
Santiago Gonzalez
committed
Add JavaDoc comments
1 parent 5737437 commit 7dbd611

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

src/main/java/com/microsoft/aad/msal4j/ClientApplicationBase.java

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,9 @@ public T executorService(ExecutorService val) {
347347

348348
/**
349349
* Sets Proxy configuration to be used by the client application for all network communication.
350-
* Default is null and system defined properties if any, would be used.
350+
* Default is null and system defined properties if any, would be used. If HTTP client is set on
351+
* the client application, proxy configuration should be configured on the HTTP client object,
352+
* and not through this method.
351353
*
352354
* @param val an instance of Proxy
353355
* @return instance of the Builder on which method was called
@@ -359,7 +361,13 @@ public T proxy(Proxy val) {
359361
return self();
360362
}
361363

362-
364+
/**
365+
* Sets HTTP client to be used by the client application for all HTTP requests. Allows for fine
366+
* grained configuration of HTTP client.
367+
*
368+
* @param val Implementation of {@link IHttpClient}
369+
* @return instance of the Builder on which method was called
370+
*/
363371
public T httpClient(IHttpClient val){
364372
validateNotNull("httpClient", val);
365373

@@ -369,6 +377,8 @@ public T httpClient(IHttpClient val){
369377

370378
/**
371379
* Sets SSLSocketFactory to be used by the client application for all network communication.
380+
* If HTTP client is set on the client application, any configuration of SSL should be done on the
381+
* HTTP client and not through this method.
372382
*
373383
* @param val an instance of SSLSocketFactory
374384
* @return instance of the Builder on which method was called
@@ -393,12 +403,28 @@ T onlySendFailureTelemetry(Boolean val) {
393403
return self();
394404
}
395405

396-
T applicationName(String val) {
406+
/**
407+
* Sets application name for telemetry purposes
408+
*
409+
* @param val application name
410+
* @return instance of the Builder on which method was called
411+
*/
412+
public T applicationName(String val) {
413+
validateNotNull("applicationName", val);
414+
397415
applicationName = val;
398416
return self();
399417
}
400418

401-
T applicationVersion(String val) {
419+
/**
420+
* Sets application version for telemetry purposes
421+
*
422+
* @param val application version
423+
* @return instance of the Builder on which method was called
424+
*/
425+
public T applicationVersion(String val) {
426+
validateNotNull("applicationVersion", val);
427+
402428
applicationVersion = val;
403429
return self();
404430
}

0 commit comments

Comments
 (0)