libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Add migration for terms and conditions required action in FED_USER_REQUIRED_ACTION table

Browse source 
Closes #27228

Signed-off-by: Stefan Guilhen <sguilhen@redhat.com>
This commit is contained in:
Stefan Guilhen 2024-03-06 10:57:36 -03:00 committed by Pedro Igor
parent d3a81b5f15
commit 1099f03fe6
3 changed files with 79 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/custom/JpaUpdate25_0_0_FederatedTermsAndConditionsRequiredAction.java Normal file
View file

@ -0,0 +1,54 @@
/*
* Copyright 2024 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.keycloak.connections.jpa.updater.liquibase.custom;
import liquibase.exception.CustomChangeException;
import liquibase.statement.core.UpdateStatement;
import liquibase.structure.core.Table;
import org.keycloak.models.UserModel;
/**
* Custom liquibase change to migrate legacy {@code terms and conditions} required action for federated users (table
* {@code FED_USER_REQUIRED_ACTION}, in line with what {@link JpaUpdate21_0_2_TermsAndConditionsRequiredAction}
* did to migrate the same action for regular users.
* </p>
* The legacy value was in lowercase, and it was changed to upper case to match the other required actions in Keycloak.
* This class ensures that the legacy action set for federated users is properly migrated to upper case when upgrading
* the server.
*
* @author <a href="mailto:sguilhen@redhat.com">Stefan Guilhen</a>
*/
public class JpaUpdate25_0_0_FederatedTermsAndConditionsRequiredAction extends CustomKeycloakTask {
private static final String TERMS_AND_CONDITION_LEGACY_ALIAS = "terms_and_conditions";
@Override
protected void generateStatementsImpl() throws CustomChangeException {
statements.add(
new UpdateStatement(null, null, database.correctObjectName("FED_USER_REQUIRED_ACTION", Table.class))
.addNewColumnValue("REQUIRED_ACTION", UserModel.RequiredAction.TERMS_AND_CONDITIONS.name())
.setWhereClause("REQUIRED_ACTION=?")
.addWhereParameter(TERMS_AND_CONDITION_LEGACY_ALIAS)
);
}
@Override
protected String getTaskId() {
return "Federated Terms And Conditions required action alias change (25.0.0)";
}
}

24
model/jpa/src/main/resources/META-INF/jpa-changelog-25.0.0.xml Normal file
View file

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!--
~ * Copyright 2024 Red Hat, Inc. and/or its affiliates
~ * and other contributors as indicated by the @author tags.
~ *
~ * Licensed under the Apache License, Version 2.0 (the "License");
~ * you may not use this file except in compliance with the License.
~ * You may obtain a copy of the License at
~ *
~ * http://www.apache.org/licenses/LICENSE-2.0
~ *
~ * Unless required by applicable law or agreed to in writing, software
~ * distributed under the License is distributed on an "AS IS" BASIS,
~ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ * See the License for the specific language governing permissions and
~ * limitations under the License.
-->
<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">
<changeSet author="keycloak" id="25.0.0-27228">
<customChange class="org.keycloak.connections.jpa.updater.liquibase.custom.JpaUpdate25_0_0_FederatedTermsAndConditionsRequiredAction"/>
</changeSet>
</databaseChangeLog>

1
model/jpa/src/main/resources/META-INF/jpa-changelog-master.xml
View file

@ -80,5 +80,6 @@
<include file="META-INF/jpa-changelog-22.0.0.xml"/>
<include file="META-INF/jpa-changelog-23.0.0.xml"/>
<include file="META-INF/jpa-changelog-24.0.0.xml"/>
<include file="META-INF/jpa-changelog-25.0.0.xml"/>
</databaseChangeLog>