Skip to content
This repository was archived by the owner on Apr 19, 2026. It is now read-only.

Commit 5bbf20d

Browse files
tangieltangiel
authored
migrate all logging to flogger (#45)
* migrate endpoints-control to use flogger * migrate endpoints-auth to flogger * migrate endpoints-framework-auth to use flogger * disable import order checkstyle rule
1 parent e4d005f commit 5bbf20d

17 files changed

Lines changed: 132 additions & 279 deletions

File tree

‎config/checkstyle/checkstyle.xml‎

Lines changed: 0 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,6 @@
3939
<property name="allowByTailComment" value="true"/>
4040
<property name="allowNonPrintableEscapes" value="true"/>
4141
</module>
42-
<!--
43-
<module name="LineLength">
44-
<property name="max" value="100"/>
45-
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
46-
</module>
47-
-->
4842
<module name="AvoidStarImport"/>
4943
<module name="OneTopLevelClass"/>
5044
<module name="NoLineWrap"/>
@@ -98,30 +92,6 @@
9892
<message key="name.invalidPattern"
9993
value="Type name ''{0}'' must match pattern ''{1}''."/>
10094
</module>
101-
<!--
102-
<module name="MemberName">
103-
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
104-
<message key="name.invalidPattern"
105-
value="Member name ''{0}'' must match pattern ''{1}''."/>
106-
</module>
107-
<module name="ParameterName">
108-
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
109-
<message key="name.invalidPattern"
110-
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
111-
</module>
112-
<module name="CatchParameterName">
113-
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
114-
<message key="name.invalidPattern"
115-
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
116-
</module>
117-
<module name="LocalVariableName">
118-
<property name="tokens" value="VARIABLE_DEF"/>
119-
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
120-
<property name="allowOneCharVarInForLoop" value="true"/>
121-
<message key="name.invalidPattern"
122-
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
123-
</module>
124-
-->
12595
<module name="ClassTypeParameterName">
12696
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
12797
<message key="name.invalidPattern"
@@ -156,68 +126,22 @@
156126
<property name="lineWrappingIndentation" value="4"/>
157127
<property name="arrayInitIndent" value="2"/>
158128
</module>
159-
<!--
160-
<module name="AbbreviationAsWordInName">
161-
<property name="ignoreFinal" value="false"/>
162-
<property name="allowedAbbreviationLength" value="1"/>
163-
</module>
164-
<module name="OverloadMethodsDeclarationOrder"/>
165-
<module name="VariableDeclarationUsageDistance"/>
166-
-->
167-
<module name="CustomImportOrder">
168-
<property name="specialImportsRegExp" value="com.google"/>
169-
<property name="sortImportsInGroupAlphabetically" value="true"/>
170-
<property name="customImportOrderRules" value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
171-
</module>
172129
<module name="IllegalImport">
173130
<property name="illegalPkgs" value="autovalue.shaded"/>
174131
<property name="illegalPkgs" value="com.google.api.client.repackaged"/>
175132
</module>
176-
<!--
177-
<module name="MethodParamPad"/>
178-
<module name="OperatorWrap">
179-
<property name="option" value="NL"/>
180-
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
181-
</module>
182-
-->
183133
<module name="AnnotationLocation">
184134
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
185135
</module>
186136
<module name="AnnotationLocation">
187137
<property name="tokens" value="VARIABLE_DEF"/>
188138
<property name="allowSamelineMultipleAnnotations" value="true"/>
189139
</module>
190-
<!--
191-
<module name="NonEmptyAtclauseDescription"/>
192-
<module name="JavadocTagContinuationIndentation"/>
193-
<module name="SummaryJavadoc">
194-
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
195-
</module>
196-
<module name="JavadocParagraph"/>
197-
<module name="AtclauseOrder">
198-
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
199-
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
200-
</module>
201-
<module name="JavadocMethod">
202-
<property name="scope" value="public"/>
203-
<property name="allowMissingParamTags" value="true"/>
204-
<property name="allowMissingThrowsTags" value="true"/>
205-
<property name="allowMissingReturnTag" value="true"/>
206-
<property name="minLineCount" value="2"/>
207-
<property name="allowedAnnotations" value="Override, Test"/>
208-
<property name="allowThrowsTagsForSubclasses" value="true"/>
209-
</module>
210-
-->
211140
<module name="MethodName">
212141
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
213142
<message key="name.invalidPattern"
214143
value="Method name ''{0}'' must match pattern ''{1}''."/>
215144
</module>
216-
<!--
217-
<module name="SingleLineJavadoc">
218-
<property name="ignoreInlineTags" value="false"/>
219-
</module>
220-
-->
221145
<module name="EmptyCatchBlock">
222146
<property name="exceptionVariableName" value="expected"/>
223147
</module>

‎endpoints-auth/build.gradle‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ dependencies {
3535
compile "com.fasterxml.jackson.core:jackson-core:${jacksonVersion}"
3636
compile "com.fasterxml.jackson.core:jackson-databind:${jacksonVersion}"
3737
compile "com.google.guava:guava:${guavaVersion}"
38+
compile "com.google.flogger:flogger:${floggerVersion}"
39+
runtime "com.google.flogger:flogger-system-backend:${floggerVersion}"
3840
compile "com.google.http-client:google-http-client:${httpClientVersion}"
3941
compile "javax.servlet:servlet-api:${servletApiVersion}"
4042
compile "org.bitbucket.b_c:jose4j:${jose4jVersion}"

‎endpoints-auth/src/main/java/com/google/api/auth/Authenticator.java‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,16 @@
3232
import com.google.common.base.Strings;
3333
import com.google.common.collect.ImmutableMap;
3434
import com.google.common.collect.Sets;
35+
import com.google.common.flogger.FluentLogger;
3536
import com.google.common.net.HttpHeaders;
36-
37-
import org.jose4j.jwt.JwtClaims;
38-
import org.jose4j.jwt.MalformedClaimException;
39-
import org.jose4j.jwt.NumericDate;
40-
import org.jose4j.jwt.ReservedClaimNames;
41-
4237
import java.util.List;
4338
import java.util.Map;
4439
import java.util.Set;
45-
import java.util.logging.Logger;
46-
4740
import javax.servlet.http.HttpServletRequest;
41+
import org.jose4j.jwt.JwtClaims;
42+
import org.jose4j.jwt.MalformedClaimException;
43+
import org.jose4j.jwt.NumericDate;
44+
import org.jose4j.jwt.ReservedClaimNames;
4845

4946
/**
5047
* An authenticator that extracts the auth token from the HTTP request and
@@ -56,7 +53,7 @@
5653
*/
5754
public class Authenticator {
5855

59-
private static final Logger logger = Logger.getLogger(Authenticator.class.getName());
56+
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
6057

6158
private static final String ACCESS_TOKEN_PARAM_NAME = "access_token";
6259
private static final String BEARER_TOKEN_PREFIX = "Bearer ";
@@ -207,8 +204,7 @@ private static Map<String, IssuerKeyUrlConfig> generateIssuerKeyConfig(
207204
for (AuthProvider authProvider : authProviders) {
208205
String issuer = authProvider.getIssuer();
209206
if (Strings.isNullOrEmpty(issuer)) {
210-
logger.warning(
211-
String.format("The 'issuer' field is not set in AuthProvider (%s)", authProvider));
207+
logger.atWarning().log("The 'issuer' field is not set in AuthProvider (%s)", authProvider);
212208
continue;
213209
}
214210

‎endpoints-control/build.gradle‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ dependencies {
5151
compileOnly "com.google.auto.value:auto-value:${autoValueVersion}"
5252
compile "com.google.code.findbugs:jsr305:${jsr305Version}"
5353
compile "com.fasterxml.jackson.core:jackson-core:${jacksonVersion}"
54+
compile "com.google.flogger:flogger:${floggerVersion}"
55+
runtime "com.google.flogger:flogger-system-backend:${floggerVersion}"
5456
compile "com.google.guava:guava:${guavaVersion}"
5557
compile("com.google.http-client:google-http-client-jackson2:${httpClientVersion}") {
5658
exclude group: 'com.fasterxml.jackson.core', module: 'jackson-core'

0 commit comments

Comments
 (0)