Skip to content

Commit 3d482e9

Browse files
sangonzalsangonzal
authored
Merge pull request #136 from AzureAD/sagonzal/IncludeNameAndVersionInHeaders
Add appName and appVersion headers.
2 parents 3a00e31 + 7a0a9fc commit 3d482e9

13 files changed

+211
-116
lines changed

‎src/main/java/com/microsoft/aad/msal4j/AuthenticationResultSupplier.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public IAuthenticationResult get() {
4949

5050
try(TelemetryHelper telemetryHelper =
5151
clientApplication.getServiceBundle().getTelemetryManager().createTelemetryHelper(
52-
msalRequest.requestContext().getTelemetryRequestId(),
52+
msalRequest.requestContext().telemetryRequestId(),
5353
msalRequest.application().clientId(),
5454
apiEvent,
5555
true)) {
@@ -81,7 +81,7 @@ public IAuthenticationResult get() {
8181
return result;
8282
}
8383

84-
void logResult(AuthenticationResult result, ClientDataHttpHeaders headers)
84+
void logResult(AuthenticationResult result, HttpHeaders headers)
8585
{
8686
if (!StringHelper.isBlank(result.accessToken())) {
8787

@@ -120,11 +120,11 @@ void logResult(AuthenticationResult result, ClientDataHttpHeaders headers)
120120

121121
private ApiEvent initializeApiEvent(MsalRequest msalRequest){
122122
ApiEvent apiEvent = new ApiEvent(clientApplication.logPii());
123-
msalRequest.requestContext().setTelemetryRequestId(
123+
msalRequest.requestContext().telemetryRequestId(
124124
clientApplication.getServiceBundle().getTelemetryManager().generateRequestId());
125-
apiEvent.setApiId(msalRequest.requestContext().getAcquireTokenPublicApi().getApiId());
126-
apiEvent.setCorrelationId(msalRequest.requestContext().getCorrelationId());
127-
apiEvent.setRequestId(msalRequest.requestContext().getTelemetryRequestId());
125+
apiEvent.setApiId(msalRequest.requestContext().publicApi().getApiId());
126+
apiEvent.setCorrelationId(msalRequest.requestContext().correlationId());
127+
apiEvent.setRequestId(msalRequest.requestContext().telemetryRequestId());
128128
apiEvent.setWasSuccessful(false);
129129

130130
if(clientApplication instanceof ConfidentialClientApplication){

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

Lines changed: 61 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,24 @@ abstract class ClientApplicationBase implements IClientApplicationBase {
5959

6060
@Accessors(fluent = true)
6161
@Getter
62-
public Proxy proxy;
62+
private Proxy proxy;
6363

6464
@Accessors(fluent = true)
6565
@Getter
66-
public SSLSocketFactory sslSocketFactory;
66+
private SSLSocketFactory sslSocketFactory;
6767

6868
@Accessors(fluent = true)
6969
@Getter
7070
protected TokenCache tokenCache;
7171

72+
@Accessors(fluent = true)
73+
@Getter
74+
private String applicationName;
75+
76+
@Accessors(fluent = true)
77+
@Getter
78+
private String applicationVersion;
79+
7280
@Override
7381
public CompletableFuture<IAuthenticationResult> acquireToken(AuthorizationCodeParameters parameters) {
7482

@@ -138,7 +146,10 @@ public CompletableFuture<Set<IAccount>> getAccounts() {
138146

139147
@Override
140148
public CompletableFuture removeAccount(IAccount account) {
141-
RemoveAccountRunnable runnable = new RemoveAccountRunnable(this, account);
149+
MsalRequest msalRequest = new MsalRequest(this, null,
150+
createRequestContext(PublicApi.REMOVE_ACCOUNTS)){};
151+
152+
RemoveAccountRunnable runnable = new RemoveAccountRunnable(msalRequest, account);
142153

143154
CompletableFuture<Void> future =
144155
serviceBundle.getExecutorService() != null ? CompletableFuture.runAsync(runnable, serviceBundle.getExecutorService())
@@ -149,7 +160,7 @@ public CompletableFuture removeAccount(IAccount account) {
149160
AuthenticationResult acquireTokenCommon(MsalRequest msalRequest, Authority requestAuthority)
150161
throws Exception {
151162

152-
ClientDataHttpHeaders headers = msalRequest.headers();
163+
HttpHeaders headers = msalRequest.headers();
153164

154165
if (logPii) {
155166
log.debug(LogHelper.createMessage(
@@ -198,10 +209,7 @@ private AuthenticationResultSupplier getAuthenticationResultSupplier(MsalRequest
198209
}
199210

200211
RequestContext createRequestContext(PublicApi publicApi) {
201-
return new RequestContext(
202-
clientId,
203-
correlationId(),
204-
publicApi);
212+
return new RequestContext(this, publicApi);
205213
}
206214

207215
ServiceBundle getServiceBundle() {
@@ -233,6 +241,8 @@ abstract static class Builder<T extends Builder<T>> {
233241
private IHttpClient httpClient;
234242
private Consumer<List<HashMap<String, String>>> telemetryConsumer;
235243
private Boolean onlySendFailureTelemetry = false;
244+
private String applicationName;
245+
private String applicationVersion;
236246
private ITokenCacheAccessAspect tokenCacheAccessAspect;
237247

238248
/**
@@ -336,8 +346,12 @@ public T executorService(ExecutorService val) {
336346
}
337347

338348
/**
339-
* Sets Proxy configuration to be used by the client application for all network communication.
340-
* Default is null and system defined properties if any, would be used.
349+
* Sets Proxy configuration to be used by the client application (MSAL4J by default uses
350+
* {@link javax.net.ssl.HttpsURLConnection}) for all network communication.
351+
* If no proxy value is passed in, system defined properties are used. If HTTP client is set on
352+
* the client application (via ClientApplication.builder().httpClient()),
353+
* proxy configuration should be done on the HTTP client object being passed in,
354+
* and not through this method.
341355
*
342356
* @param val an instance of Proxy
343357
* @return instance of the Builder on which method was called
@@ -349,7 +363,13 @@ public T proxy(Proxy val) {
349363
return self();
350364
}
351365

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

@@ -359,6 +379,8 @@ public T httpClient(IHttpClient val){
359379

360380
/**
361381
* Sets SSLSocketFactory to be used by the client application for all network communication.
382+
* If HTTP client is set on the client application (via ClientApplication.builder().httpClient()),
383+
* any configuration of SSL should be done on the HTTP client and not through this method.
362384
*
363385
* @param val an instance of SSLSocketFactory
364386
* @return instance of the Builder on which method was called
@@ -383,6 +405,32 @@ T onlySendFailureTelemetry(Boolean val) {
383405
return self();
384406
}
385407

408+
/**
409+
* Sets application name for telemetry purposes
410+
*
411+
* @param val application name
412+
* @return instance of the Builder on which method was called
413+
*/
414+
public T applicationName(String val) {
415+
validateNotNull("applicationName", val);
416+
417+
applicationName = val;
418+
return self();
419+
}
420+
421+
/**
422+
* Sets application version for telemetry purposes
423+
*
424+
* @param val application version
425+
* @return instance of the Builder on which method was called
426+
*/
427+
public T applicationVersion(String val) {
428+
validateNotNull("applicationVersion", val);
429+
430+
applicationVersion = val;
431+
return self();
432+
}
433+
386434
/**
387435
* Sets ITokenCacheAccessAspect to be used for cache_data persistence.
388436
*
@@ -415,6 +463,8 @@ private static Authority createDefaultAADAuthority() {
415463
validateAuthority = builder.validateAuthority;
416464
correlationId = builder.correlationId;
417465
logPii = builder.logPii;
466+
applicationName = builder.applicationName;
467+
applicationVersion = builder.applicationVersion;
418468
telemetryConsumer = builder.telemetryConsumer;
419469
proxy = builder.proxy;
420470
sslSocketFactory = builder.sslSocketFactory;

‎src/main/java/com/microsoft/aad/msal4j/DeviceCodeFlowRequest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ private DeviceCode parseJsonToDeviceCodeAndSetParameters(
8585
DeviceCode result;
8686
result = JsonHelper.convertJsonToObject(json, DeviceCode.class);
8787

88-
String correlationIdHeader = headers.get(ClientDataHttpHeaders.CORRELATION_ID_HEADER_NAME);
88+
String correlationIdHeader = headers.get(HttpHeaders.CORRELATION_ID_HEADER_NAME);
8989
if(correlationIdHeader != null){
9090
result.correlationId(correlationIdHeader);
9191
}

‎src/main/java/com/microsoft/aad/msal4j/ClientDataHttpHeaders.java‎ renamed to ‎src/main/java/com/microsoft/aad/msal4j/HttpHeaders.java‎

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,28 @@
55

66
import java.util.Collections;
77
import java.util.HashMap;
8-
import java.util.List;
98
import java.util.Map;
109
import java.util.function.BiConsumer;
1110

12-
final class ClientDataHttpHeaders {
11+
final class HttpHeaders {
1312

14-
private final static String PRODUCT_HEADER_NAME = "x-client-SKU";
15-
private final static String PRODUCT_HEADER_VALUE = "MSAL.Java";
13+
final static String PRODUCT_HEADER_NAME = "x-client-SKU";
14+
final static String PRODUCT_HEADER_VALUE = "MSAL.Java";
1615

17-
private final static String PRODUCT_VERSION_HEADER_NAME = "x-client-VER";
18-
private final static String PRODUCT_VERSION_HEADER_VALUE = getProductVersion();
16+
final static String PRODUCT_VERSION_HEADER_NAME = "x-client-VER";
17+
final static String PRODUCT_VERSION_HEADER_VALUE = getProductVersion();
1918

20-
private final static String CPU_HEADER_NAME = "x-client-CPU";
21-
private final static String CPU_HEADER_VALUE = System.getProperty("os.arch");
19+
final static String CPU_HEADER_NAME = "x-client-CPU";
20+
final static String CPU_HEADER_VALUE = System.getProperty("os.arch");
2221

23-
private final static String OS_HEADER_NAME = "x-client-OS";
24-
private final static String OS_HEADER_VALUE = System.getProperty("os.name");
22+
final static String OS_HEADER_NAME = "x-client-OS";
23+
final static String OS_HEADER_VALUE = System.getProperty("os.name");
24+
25+
final static String APPLICATION_NAME_HEADER_NAME = "x-app-name";
26+
private final String applicationNameHeaderValue;
27+
28+
final static String APPLICATION_VERSION_HEADER_NAME = "x-app-ver";
29+
private final String applicationVersionHeaderValue;
2530

2631
final static String CORRELATION_ID_HEADER_NAME = "client-request-id";
2732
private final String correlationIdHeaderValue;
@@ -32,13 +37,11 @@ final class ClientDataHttpHeaders {
3237
private final String headerValues;
3338
private final Map<String, String> headerMap = new HashMap<>();
3439

35-
ClientDataHttpHeaders(final String correlationId) {
36-
if (!StringHelper.isBlank(correlationId)) {
37-
this.correlationIdHeaderValue = correlationId;
38-
}
39-
else {
40-
this.correlationIdHeaderValue = RequestContext.generateNewCorrelationId();
41-
}
40+
HttpHeaders(final RequestContext requestContext) {
41+
correlationIdHeaderValue = requestContext.correlationId();
42+
applicationNameHeaderValue = requestContext.applicationName();
43+
applicationVersionHeaderValue = requestContext.applicationVersion();
44+
4245
this.headerValues = initHeaderMap();
4346
}
4447

@@ -49,13 +52,21 @@ private String initHeaderMap() {
4952
headerMap.put(key, val);
5053
sb.append(key).append("=").append(val).append(";");
5154
};
55+
5256
init.accept(PRODUCT_HEADER_NAME, PRODUCT_HEADER_VALUE);
5357
init.accept(PRODUCT_VERSION_HEADER_NAME, PRODUCT_VERSION_HEADER_VALUE);
5458
init.accept(OS_HEADER_NAME, OS_HEADER_VALUE);
5559
init.accept(CPU_HEADER_NAME, CPU_HEADER_VALUE);
5660
init.accept(REQUEST_CORRELATION_ID_IN_RESPONSE_HEADER_NAME, REQUEST_CORRELATION_ID_IN_RESPONSE_HEADER_VALUE);
5761
init.accept(CORRELATION_ID_HEADER_NAME, this.correlationIdHeaderValue);
5862

63+
if(!StringHelper.isBlank(this.applicationNameHeaderValue)){
64+
init.accept(APPLICATION_NAME_HEADER_NAME, this.applicationNameHeaderValue);
65+
}
66+
if(!StringHelper.isBlank(this.applicationVersionHeaderValue)){
67+
init.accept(APPLICATION_VERSION_HEADER_NAME, this.applicationVersionHeaderValue);
68+
}
69+
5970
return sb.toString();
6071
}
6172

@@ -73,10 +84,9 @@ public String toString() {
7384
}
7485

7586
private static String getProductVersion() {
76-
if (ClientDataHttpHeaders.class.getPackage().getImplementationVersion() == null) {
87+
if (HttpHeaders.class.getPackage().getImplementationVersion() == null) {
7788
return "1.0";
7889
}
79-
return ClientDataHttpHeaders.class.getPackage()
80-
.getImplementationVersion();
90+
return HttpHeaders.class.getPackage().getImplementationVersion();
8191
}
8292
}

‎src/main/java/com/microsoft/aad/msal4j/HttpHelper.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ static IHttpResponse executeHttpRequest(final HttpRequest httpRequest,
2121
IHttpResponse httpResponse;
2222

2323
try(TelemetryHelper telemetryHelper = serviceBundle.getTelemetryManager().createTelemetryHelper(
24-
requestContext.getTelemetryRequestId(),
25-
requestContext.getClientId(),
24+
requestContext.telemetryRequestId(),
25+
requestContext.clientId(),
2626
httpEvent,
2727
false)){
2828

@@ -54,7 +54,7 @@ private static void addRequestInfoToTelemetry(final HttpRequest httpRequest, Htt
5454
}
5555
} catch(Exception ex){
5656
String correlationId = httpRequest.headerValue(
57-
ClientDataHttpHeaders.CORRELATION_ID_HEADER_NAME);
57+
HttpHeaders.CORRELATION_ID_HEADER_NAME);
5858

5959
log.warn(LogHelper.createMessage("Setting URL telemetry fields failed: " +
6060
LogHelper.getPiiScrubbedDetails(ex),
@@ -93,11 +93,11 @@ private static void verifyReturnedCorrelationId(final HttpRequest httpRequest,
9393
IHttpResponse httpResponse) {
9494

9595
String sentCorrelationId = httpRequest.headerValue(
96-
ClientDataHttpHeaders.CORRELATION_ID_HEADER_NAME);
96+
HttpHeaders.CORRELATION_ID_HEADER_NAME);
9797

9898
String returnedCorrelationId = HttpUtils.headerValue(
9999
httpResponse.headers(),
100-
ClientDataHttpHeaders.CORRELATION_ID_HEADER_NAME);
100+
HttpHeaders.CORRELATION_ID_HEADER_NAME);
101101

102102
if (StringHelper.isBlank(returnedCorrelationId) ||
103103
!returnedCorrelationId.equals(sentCorrelationId)) {

‎src/main/java/com/microsoft/aad/msal4j/MsalRequest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ abstract class MsalRequest {
1919
private final RequestContext requestContext;
2020

2121
@Getter(value = AccessLevel.PACKAGE, lazy = true)
22-
private final ClientDataHttpHeaders headers = new ClientDataHttpHeaders(requestContext.getCorrelationId());
22+
private final HttpHeaders headers = new HttpHeaders(requestContext);
2323
}
2424

2525

‎src/main/java/com/microsoft/aad/msal4j/PublicApi.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ enum PublicApi {
1313
ACQUIRE_TOKEN_FOR_CLIENT(729),
1414
ACQUIRE_TOKEN_BY_AUTHORIZATION_CODE(831),
1515
ACQUIRE_TOKEN_SILENTLY(800),
16-
GET_ACCOUNTS(801);
16+
GET_ACCOUNTS(801),
17+
REMOVE_ACCOUNTS(802);
1718

1819
private final int apiId;
1920

‎src/main/java/com/microsoft/aad/msal4j/RemoveAccountRunnable.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@
88

99
class RemoveAccountRunnable implements Runnable {
1010

11-
ClientDataHttpHeaders headers;
12-
ClientApplicationBase clientApplication;
11+
private RequestContext requestContext;
12+
private ClientApplicationBase clientApplication;
1313
IAccount account;
1414

15-
RemoveAccountRunnable
16-
(ClientApplicationBase clientApplication, IAccount account) {
17-
this.clientApplication = clientApplication;
18-
this.headers = new ClientDataHttpHeaders(clientApplication.correlationId());
15+
RemoveAccountRunnable(MsalRequest msalRequest, IAccount account) {
16+
this.clientApplication = msalRequest.application();
17+
this.requestContext = msalRequest.requestContext();
1918
this.account = account;
2019
}
2120

@@ -30,7 +29,7 @@ public void run() {
3029
} catch (Exception ex) {
3130
clientApplication.log.error(
3231
LogHelper.createMessage("Execution of " + this.getClass() + " failed.",
33-
this.headers.getHeaderCorrelationIdValue()), ex);
32+
requestContext.correlationId()), ex);
3433

3534
throw new CompletionException(ex);
3635
}

0 commit comments

Comments
 (0)