From 6fa1c2d91ce6e7b0e70f2d1a2d9f674080c691f5 Mon Sep 17 00:00:00 2001 From: nickfelt Date: Thu, 23 Jun 2016 09:37:42 -0700 Subject: [PATCH] Refactor SessionMetadata and TransportCredentials toString() methods This cleanups up the toString() methods of all implementations of these interfaces, as pre-work for adding tests against the legacy logging statement in FlowRunner used for ICANN reporting, so that we can validate against any changes to that log statement in the future. It removes system hash codes since those aren't really safe to rely on in test code and they really don't help with debugging anyway. It also standardizes SessionMetadata.toString() a bit and regroups methods on that interface so all the getters are together. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=125686039 --- .../registry/flows/GaeUserCredentials.java | 6 ++++-- .../registry/flows/HttpSessionMetadata.java | 11 +++++------ .../flows/PasswordOnlyTransportCredentials.java | 7 +++++++ java/google/registry/flows/SessionMetadata.java | 4 ++-- .../flows/StatelessRequestSessionMetadata.java | 17 ++++++++--------- java/google/registry/flows/TlsCredentials.java | 1 - 6 files changed, 26 insertions(+), 20 deletions(-) diff --git a/java/google/registry/flows/GaeUserCredentials.java b/java/google/registry/flows/GaeUserCredentials.java index a3b4390ee..c7c83a6f4 100644 --- a/java/google/registry/flows/GaeUserCredentials.java +++ b/java/google/registry/flows/GaeUserCredentials.java @@ -15,8 +15,8 @@ package google.registry.flows; import static com.google.appengine.api.users.UserServiceFactory.getUserService; +import static com.google.common.base.MoreObjects.toStringHelper; import static com.google.common.base.Strings.nullToEmpty; -import static java.lang.System.identityHashCode; import com.google.appengine.api.users.User; import com.google.common.annotations.VisibleForTesting; @@ -59,7 +59,9 @@ public class GaeUserCredentials implements TransportCredentials { @Override public String toString() { - return String.format("GaeUserCredentials@%s{gaeUser: %s}", identityHashCode(this), gaeUser); + return toStringHelper(getClass()) + .add("gaeUser", gaeUser) + .toString(); } /** User is not logged in as a GAE user. */ diff --git a/java/google/registry/flows/HttpSessionMetadata.java b/java/google/registry/flows/HttpSessionMetadata.java index e17c110de..7dd7b838b 100644 --- a/java/google/registry/flows/HttpSessionMetadata.java +++ b/java/google/registry/flows/HttpSessionMetadata.java @@ -53,6 +53,11 @@ public class HttpSessionMetadata implements SessionMetadata { return (Set) session.getAttribute(SERVICE_EXTENSIONS); } + @Override + public int getFailedLoginAttempts() { + return Optional.fromNullable((Integer) session.getAttribute(FAILED_LOGIN_ATTEMPTS)).or(0); + } + @Override public void setClientId(String clientId) { session.setAttribute(CLIENT_ID, clientId); @@ -63,11 +68,6 @@ public class HttpSessionMetadata implements SessionMetadata { session.setAttribute(SERVICE_EXTENSIONS, serviceExtensionUris); } - @Override - public int getFailedLoginAttempts() { - return Optional.fromNullable((Integer) session.getAttribute(FAILED_LOGIN_ATTEMPTS)).or(0); - } - @Override public void incrementFailedLoginAttempts() { session.setAttribute(FAILED_LOGIN_ATTEMPTS, getFailedLoginAttempts() + 1); @@ -81,7 +81,6 @@ public class HttpSessionMetadata implements SessionMetadata { @Override public String toString() { return toStringHelper(getClass()) - .add("system hash code", System.identityHashCode(this)) .add("clientId", getClientId()) .add("failedLoginAttempts", getFailedLoginAttempts()) .add("serviceExtensionUris", Joiner.on('.').join(nullToEmpty(getServiceExtensionUris()))) diff --git a/java/google/registry/flows/PasswordOnlyTransportCredentials.java b/java/google/registry/flows/PasswordOnlyTransportCredentials.java index 8a0955d2a..f0634af99 100644 --- a/java/google/registry/flows/PasswordOnlyTransportCredentials.java +++ b/java/google/registry/flows/PasswordOnlyTransportCredentials.java @@ -14,6 +14,8 @@ package google.registry.flows; +import static com.google.common.base.MoreObjects.toStringHelper; + import google.registry.flows.EppException.AuthenticationErrorException; import google.registry.model.registrar.Registrar; @@ -25,4 +27,9 @@ public class PasswordOnlyTransportCredentials implements TransportCredentials { throw new BadRegistrarPasswordException(); } } + + @Override + public String toString() { + return toStringHelper(getClass()).toString(); + } } diff --git a/java/google/registry/flows/SessionMetadata.java b/java/google/registry/flows/SessionMetadata.java index f85bd691d..50344eafa 100644 --- a/java/google/registry/flows/SessionMetadata.java +++ b/java/google/registry/flows/SessionMetadata.java @@ -30,12 +30,12 @@ public interface SessionMetadata { Set getServiceExtensionUris(); + int getFailedLoginAttempts(); + void setClientId(String clientId); void setServiceExtensionUris(Set serviceExtensionUris); - int getFailedLoginAttempts(); - void incrementFailedLoginAttempts(); void resetFailedLoginAttempts(); diff --git a/java/google/registry/flows/StatelessRequestSessionMetadata.java b/java/google/registry/flows/StatelessRequestSessionMetadata.java index 035fb4712..3fd3ebed6 100644 --- a/java/google/registry/flows/StatelessRequestSessionMetadata.java +++ b/java/google/registry/flows/StatelessRequestSessionMetadata.java @@ -35,6 +35,11 @@ public class StatelessRequestSessionMetadata implements SessionMetadata { this.serviceExtensionUris = checkNotNull(serviceExtensionUris); } + @Override + public void invalidate() { + throw new UnsupportedOperationException(); + } + @Override public String getClientId() { return clientId; @@ -46,8 +51,8 @@ public class StatelessRequestSessionMetadata implements SessionMetadata { } @Override - public void invalidate() { - throw new UnsupportedOperationException(); + public int getFailedLoginAttempts() { + return 0; } @Override @@ -60,11 +65,6 @@ public class StatelessRequestSessionMetadata implements SessionMetadata { throw new UnsupportedOperationException(); } - @Override - public int getFailedLoginAttempts() { - throw new UnsupportedOperationException(); - } - @Override public void incrementFailedLoginAttempts() { throw new UnsupportedOperationException(); @@ -75,12 +75,11 @@ public class StatelessRequestSessionMetadata implements SessionMetadata { throw new UnsupportedOperationException(); } - @Override public String toString() { return toStringHelper(getClass()) - .add("system hash code", System.identityHashCode(this)) .add("clientId", getClientId()) + .add("failedLoginAttempts", getFailedLoginAttempts()) .add("serviceExtensionUris", Joiner.on('.').join(nullToEmpty(getServiceExtensionUris()))) .toString(); } diff --git a/java/google/registry/flows/TlsCredentials.java b/java/google/registry/flows/TlsCredentials.java index 3bdb81a0e..7aae1764a 100644 --- a/java/google/registry/flows/TlsCredentials.java +++ b/java/google/registry/flows/TlsCredentials.java @@ -166,7 +166,6 @@ public class TlsCredentials implements TransportCredentials { @Override public String toString() { return toStringHelper(getClass()) - .add("system hash code", System.identityHashCode(this)) .add("clientCertificateHash", clientCertificateHash) .add("clientAddress", clientInetAddr) .add("sni", sni)