Skip to content

Commit

Permalink
KEYCLOAK-1280: i18n logging for
Browse files Browse the repository at this point in the history
org.keycloak.authentication.authenticators.broker
  • Loading branch information
ssilvert committed Jan 21, 2016
1 parent 3b4cb94 commit b1baea7
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 13 deletions.
Expand Up @@ -3,7 +3,6 @@
import javax.ws.rs.core.MultivaluedMap; import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response; import javax.ws.rs.core.Response;


import org.jboss.logging.Logger;
import org.keycloak.authentication.AuthenticationFlowContext; import org.keycloak.authentication.AuthenticationFlowContext;
import org.keycloak.authentication.AuthenticationFlowError; import org.keycloak.authentication.AuthenticationFlowError;
import org.keycloak.authentication.AuthenticationFlowException; import org.keycloak.authentication.AuthenticationFlowException;
Expand All @@ -15,22 +14,23 @@
import org.keycloak.models.KeycloakSession; import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel; import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel; import org.keycloak.models.UserModel;
import org.keycloak.services.ServicesLogger;
import org.keycloak.services.messages.Messages; import org.keycloak.services.messages.Messages;


/** /**
* @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a> * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
*/ */
public class IdpConfirmLinkAuthenticator extends AbstractIdpAuthenticator { public class IdpConfirmLinkAuthenticator extends AbstractIdpAuthenticator {


protected static Logger logger = Logger.getLogger(IdpConfirmLinkAuthenticator.class); protected static ServicesLogger logger = ServicesLogger.ROOT_LOGGER;


@Override @Override
protected void authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext) { protected void authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext) {
ClientSessionModel clientSession = context.getClientSession(); ClientSessionModel clientSession = context.getClientSession();


String existingUserInfo = clientSession.getNote(EXISTING_USER_INFO); String existingUserInfo = clientSession.getNote(EXISTING_USER_INFO);
if (existingUserInfo == null) { if (existingUserInfo == null) {
logger.warnf("No duplication detected."); logger.noDuplicationDetected();
context.attempted(); context.attempted();
return; return;
} }
Expand Down
Expand Up @@ -5,7 +5,6 @@


import javax.ws.rs.core.Response; import javax.ws.rs.core.Response;


import org.jboss.logging.Logger;
import org.keycloak.authentication.AuthenticationFlowContext; import org.keycloak.authentication.AuthenticationFlowContext;
import org.keycloak.authentication.authenticators.broker.util.ExistingUserInfo; import org.keycloak.authentication.authenticators.broker.util.ExistingUserInfo;
import org.keycloak.authentication.authenticators.broker.util.SerializedBrokeredIdentityContext; import org.keycloak.authentication.authenticators.broker.util.SerializedBrokeredIdentityContext;
Expand All @@ -16,14 +15,15 @@
import org.keycloak.models.KeycloakSession; import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel; import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel; import org.keycloak.models.UserModel;
import org.keycloak.services.ServicesLogger;
import org.keycloak.services.messages.Messages; import org.keycloak.services.messages.Messages;


/** /**
* @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a> * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
*/ */
public class IdpCreateUserIfUniqueAuthenticator extends AbstractIdpAuthenticator { public class IdpCreateUserIfUniqueAuthenticator extends AbstractIdpAuthenticator {


protected static Logger logger = Logger.getLogger(IdpCreateUserIfUniqueAuthenticator.class); protected static ServicesLogger logger = ServicesLogger.ROOT_LOGGER;




@Override @Override
Expand All @@ -43,7 +43,7 @@ protected void authenticateImpl(AuthenticationFlowContext context, SerializedBro


String username = getUsername(context, serializedCtx, brokerContext); String username = getUsername(context, serializedCtx, brokerContext);
if (username == null) { if (username == null) {
logger.warnf("%s is null. Reset flow and enforce showing reviewProfile page", realm.isRegistrationEmailAsUsername() ? "Email" : "Username"); logger.resetFlow(realm.isRegistrationEmailAsUsername() ? "Email" : "Username");
context.getClientSession().setNote(ENFORCE_UPDATE_PROFILE, "true"); context.getClientSession().setNote(ENFORCE_UPDATE_PROFILE, "true");
context.resetFlow(); context.resetFlow();
return; return;
Expand Down
Expand Up @@ -6,7 +6,6 @@
import javax.ws.rs.core.Response; import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriBuilder; import javax.ws.rs.core.UriBuilder;


import org.jboss.logging.Logger;
import org.keycloak.authentication.AuthenticationFlowContext; import org.keycloak.authentication.AuthenticationFlowContext;
import org.keycloak.authentication.AuthenticationFlowError; import org.keycloak.authentication.AuthenticationFlowError;
import org.keycloak.authentication.requiredactions.VerifyEmail; import org.keycloak.authentication.requiredactions.VerifyEmail;
Expand All @@ -24,6 +23,7 @@
import org.keycloak.models.KeycloakSession; import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel; import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel; import org.keycloak.models.UserModel;
import org.keycloak.services.ServicesLogger;
import org.keycloak.services.messages.Messages; import org.keycloak.services.messages.Messages;
import org.keycloak.services.resources.LoginActionsService; import org.keycloak.services.resources.LoginActionsService;


Expand All @@ -32,7 +32,7 @@
*/ */
public class IdpEmailVerificationAuthenticator extends AbstractIdpAuthenticator { public class IdpEmailVerificationAuthenticator extends AbstractIdpAuthenticator {


protected static Logger logger = Logger.getLogger(IdpEmailVerificationAuthenticator.class); protected static ServicesLogger logger = ServicesLogger.ROOT_LOGGER;


@Override @Override
protected void authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext) { protected void authenticateImpl(AuthenticationFlowContext context, SerializedBrokeredIdentityContext serializedCtx, BrokeredIdentityContext brokerContext) {
Expand All @@ -41,7 +41,7 @@ protected void authenticateImpl(AuthenticationFlowContext context, SerializedBro
ClientSessionModel clientSession = context.getClientSession(); ClientSessionModel clientSession = context.getClientSession();


if (realm.getSmtpConfig().size() == 0) { if (realm.getSmtpConfig().size() == 0) {
logger.warnf("Smtp is not configured for the realm. Ignoring email verification authenticator"); logger.smtpNotConfigured();
context.attempted(); context.attempted();
return; return;
} }
Expand Down Expand Up @@ -78,7 +78,7 @@ protected void authenticateImpl(AuthenticationFlowContext context, SerializedBro
} catch (EmailException e) { } catch (EmailException e) {
event.error(Errors.EMAIL_SEND_FAILED); event.error(Errors.EMAIL_SEND_FAILED);


logger.error("Failed to send email to confirm identity broker linking", e); logger.confirmBrokerEmailFailed(e);
Response challenge = context.form() Response challenge = context.form()
.setError(Messages.EMAIL_SENT_ERROR) .setError(Messages.EMAIL_SENT_ERROR)
.createErrorPage(); .createErrorPage();
Expand Down Expand Up @@ -118,7 +118,7 @@ protected void actionImpl(AuthenticationFlowContext context, SerializedBrokeredI
context.setUser(existingUser); context.setUser(existingUser);
context.success(); context.success();
} else { } else {
logger.error("Key parameter don't match with the expected value from client session"); logger.keyParamDoesNotMatch();
Response challengeResponse = context.form() Response challengeResponse = context.form()
.setError(Messages.INVALID_ACCESS_CODE) .setError(Messages.INVALID_ACCESS_CODE)
.createErrorPage(); .createErrorPage();
Expand Down
Expand Up @@ -5,7 +5,6 @@
import javax.ws.rs.core.MultivaluedMap; import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response; import javax.ws.rs.core.Response;


import org.jboss.logging.Logger;
import org.keycloak.authentication.AuthenticationFlowContext; import org.keycloak.authentication.AuthenticationFlowContext;
import org.keycloak.authentication.authenticators.broker.util.SerializedBrokeredIdentityContext; import org.keycloak.authentication.authenticators.broker.util.SerializedBrokeredIdentityContext;
import org.keycloak.broker.provider.BrokeredIdentityContext; import org.keycloak.broker.provider.BrokeredIdentityContext;
Expand All @@ -21,6 +20,7 @@
import org.keycloak.models.UserModel; import org.keycloak.models.UserModel;
import org.keycloak.models.utils.FormMessage; import org.keycloak.models.utils.FormMessage;
import org.keycloak.representations.idm.IdentityProviderRepresentation; import org.keycloak.representations.idm.IdentityProviderRepresentation;
import org.keycloak.services.ServicesLogger;
import org.keycloak.services.resources.AttributeFormDataProcessor; import org.keycloak.services.resources.AttributeFormDataProcessor;
import org.keycloak.services.validation.Validation; import org.keycloak.services.validation.Validation;


Expand All @@ -29,7 +29,7 @@
*/ */
public class IdpReviewProfileAuthenticator extends AbstractIdpAuthenticator { public class IdpReviewProfileAuthenticator extends AbstractIdpAuthenticator {


protected static Logger logger = Logger.getLogger(IdpReviewProfileAuthenticator.class); protected static ServicesLogger logger = ServicesLogger.ROOT_LOGGER;


@Override @Override
public boolean requiresUser() { public boolean requiresUser() {
Expand Down
24 changes: 24 additions & 0 deletions services/src/main/java/org/keycloak/services/ServicesLogger.java
Expand Up @@ -110,4 +110,28 @@ public interface ServicesLogger extends BasicLogger {
@LogMessage(level = WARN) @LogMessage(level = WARN)
@Message(id=18, value="Client %s doesn't have have authentication method configured. Fallback to %s") @Message(id=18, value="Client %s doesn't have have authentication method configured. Fallback to %s")
void authMethodFallback(String clientId, String expectedClientAuthType); void authMethodFallback(String clientId, String expectedClientAuthType);

@LogMessage(level = WARN)
@Message(id=19, value="No duplication detected.")
void noDuplicationDetected();

@LogMessage(level = WARN)
@Message(id=20, value="%s is null. Reset flow and enforce showing reviewProfile page")
void resetFlow(String emailOrUserName);

@LogMessage(level = ERROR)
@Message(id=21, value="Failed to send email to confirm identity broker linking")
void confirmBrokerEmailFailed(@Cause Throwable t);

@LogMessage(level = ERROR)
@Message(id=22, value="Key parameter don't match with the expected value from client session")
void keyParamDoesNotMatch();

@LogMessage(level = WARN)
@Message(id=23, value="Smtp is not configured for the realm. Ignoring email verification authenticator")
void smtpNotConfigured();

@LogMessage(level = WARN)
@Message(id=23, value="Smtp is not configured for the realm. Ignoring email verification authenticator")
void smtpNotConfigured();
} }

0 comments on commit b1baea7

Please sign in to comment.