• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2023 Google LLC
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *    * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *    * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *
15  *    * Neither the name of Google LLC nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 package com.google.auth.oauth2;
33 
34 import java.io.IOException;
35 import java.io.InputStream;
36 import java.util.Properties;
37 
38 class MetricsUtils {
39   static final String API_CLIENT_HEADER = "x-goog-api-client";
40   private static final String authLibraryVersion = getAuthLibraryVersion();
41   private static final String javaLanguageVersion = System.getProperty("java.version");
42 
43   /**
44    * Gets the x-goog-api-client header value for the current Java language version and the auth
45    * library version.
46    *
47    * @return the header value.
48    */
getLanguageAndAuthLibraryVersions()49   static String getLanguageAndAuthLibraryVersions() {
50     return String.format("gl-java/%s auth/%s", javaLanguageVersion, authLibraryVersion);
51   }
52 
getAuthLibraryVersion()53   private static String getAuthLibraryVersion() {
54     // Attempt to read the library's version from a properties file generated during the build.
55     // This value should be read and cached for later use.
56     String version = "unknown-version";
57     try (InputStream inputStream =
58         MetricsUtils.class.getResourceAsStream(
59             "/com/google/auth/oauth2/google-auth-library.properties")) {
60       if (inputStream != null) {
61         final Properties properties = new Properties();
62         properties.load(inputStream);
63         version = properties.getProperty("google-auth-library.version");
64       }
65     } catch (IOException e) {
66       // Ignore.
67     }
68     return version;
69   }
70 }
71