com.hazelcast.client.impl.connection.tcp.KeyValuePairGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hazelcast-jdbc Show documentation
Hazelcast JDBC Driver
The newest version!
/*
 * Copyright (c) 2008-2024, Hazelcast, Inc. All Rights Reserved.
 *
 * 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 com.hazelcast.client.impl.connection.tcp;

import com.hazelcast.client.impl.protocol.task.AuthenticationBaseMessageTask;
import com.hazelcast.cp.CPGroupId;
import com.hazelcast.cp.CPGroupsSnapshot;
import com.hazelcast.cp.internal.RaftGroupId;
import com.hazelcast.internal.json.Json;
import com.hazelcast.internal.json.JsonArray;
import com.hazelcast.internal.json.JsonObject;
import com.hazelcast.internal.json.JsonValue;
import com.hazelcast.version.Version;

import java.util.AbstractMap;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.stream.Collectors;

import static com.hazelcast.client.impl.connection.tcp.AuthenticationKeyValuePairConstants.CLUSTER_VERSION;
import static com.hazelcast.client.impl.connection.tcp.AuthenticationKeyValuePairConstants.CP_LEADERS_INFO;
import static com.hazelcast.client.impl.connection.tcp.AuthenticationKeyValuePairConstants.MEMBER_GROUPS_INFO;
import static com.hazelcast.internal.util.JsonUtil.getArray;

/**
 * Utility to create key-value map for client authentication messages.
 *
 * @see AuthenticationBaseMessageTask
 */
public final class KeyValuePairGenerator {

    public static final String GROUPS = "groups";
    public static final String VERSION = "version";

    private KeyValuePairGenerator() { }

    // called on server side
    public static Map createKeyValuePairs(Collection> memberGroups,
                                                          int version,
                                                          boolean enterprise,
                                                          Version clusterVersion,
                                                          CPGroupsSnapshot cpMemberSnapshot) {
        Map keyValuePairs = new HashMap<>();
        keyValuePairs.put(CLUSTER_VERSION, clusterVersion.toString());
        if (enterprise) {
            keyValuePairs.put(MEMBER_GROUPS_INFO, toJsonString(memberGroups, version));
            // CP Group information will be empty if license check is not met
            if (!cpMemberSnapshot.getAllGroupInformation().isEmpty()) {
                keyValuePairs.put(CP_LEADERS_INFO, toJsonString(cpMemberSnapshot));
            }
        }
        return keyValuePairs;
    }

    // called on server side to extract CP leaders information for clients
    private static String toJsonString(CPGroupsSnapshot cpMemberSnapshot) {
        if (cpMemberSnapshot.getAllGroupInformation().isEmpty()) {
            return "[]";
        }

        // We only want CP group leaders (for now) on clients
        Map leadersInfo = cpMemberSnapshot.getAllGroupInformation().entrySet().stream()
               .map(entry -> new AbstractMap.SimpleEntry<>(entry.getKey(), cpMemberSnapshot.getApUuid(entry.getValue().leader())))
               .collect(Collectors.toMap(AbstractMap.SimpleEntry::getKey, AbstractMap.SimpleEntry::getValue));

        JsonArray baseArray = Json.array();
        for (Map.Entry entry : leadersInfo.entrySet()) {
            if (entry.getKey() instanceof RaftGroupId raftId) {
                JsonObject baseObject = Json.object();
                baseObject.add("raftId", Json.object()
                        .add("name", raftId.getName())
                        .add("id", raftId.getId())
                        .add("seed", raftId.getSeed()));

                baseObject.add("leaderUUID", entry.getValue().toString());
                baseArray.add(baseObject);
            } else {
                throw new IllegalArgumentException("Unknown CPGroupId class provided: " + entry.getKey());
            }
        }
        return baseArray.toString();
    }

    // called on client side to store CP leader information
    public static Map parseJsonForCPMembership(String jsonArray) {
        if (jsonArray.equals("[]")) {
            return Collections.emptyMap();
        }

        JsonArray baseArray = Json.parse(jsonArray).asArray();
        Map leadersMap = new HashMap<>(baseArray.size());
        for (JsonValue entry : baseArray) {
            JsonObject baseObject = entry.asObject();
            JsonValue raftIdValue = baseObject.get("raftId");
            JsonValue leaderUUIDValue = baseObject.get("leaderUUID");
            if (raftIdValue == null || leaderUUIDValue == null) {
                throw new IllegalArgumentException("Invalid Json string received for CP group view: " + jsonArray);
            }
            JsonObject raftIdObject = raftIdValue.asObject();
            RaftGroupId raftGroupId = new RaftGroupId(raftIdObject.get("name").asString(),
                    raftIdObject.get("seed").asLong(), raftIdObject.get("id").asLong());
            UUID leaderUUID = UUID.fromString(leaderUUIDValue.asString());
            leadersMap.put(raftGroupId, leaderUUID);
        }
        return leadersMap;
    }

    // called on server side
    private static String toJsonString(Collection> memberGroups, int version) {
        JsonObject root = new JsonObject();
        root.add(VERSION, version);

        JsonArray allMemberGroups = new JsonArray();
        for (Collection groupUuids : memberGroups) {
            JsonArray memberGroup = new JsonArray();
            for (UUID memberUuid : groupUuids) {
                memberGroup.add(memberUuid.toString());
            }
            allMemberGroups.add(memberGroup);
        }
        root.add(GROUPS, allMemberGroups);
        return root.toString();
    }

    // called on client side to parse server string
    public static MemberGroupsAndVersionHolder parseJsonForMemberGroups(String memberGroupsJsonString) {
        JsonValue value = Json.parse(memberGroupsJsonString);
        JsonObject root = value.asObject();
        JsonValue versionValue = root.get(VERSION);
        int version = versionValue.asInt();

        Collection> allMemberGroups = new HashSet<>();
        JsonArray groups = getArray(root, GROUPS);
        List uuidArrays = groups.values();

        for (JsonValue uuidArrayValue : uuidArrays) {
            JsonArray uuidArray = uuidArrayValue.asArray();
            Set memberGroup = new HashSet<>();
            for (JsonValue uuidValue : uuidArray.values()) {
                UUID uuid = UUID.fromString(uuidValue.asString());
                memberGroup.add(uuid);
            }

            allMemberGroups.add(memberGroup);
        }

        return new MemberGroupsAndVersionHolder(allMemberGroups, version);
    }

    /**
     * State holder for all member groups returned from
     * the cluster and for their member list version.
     *
     * @param allMemberGroups all member groups info as a collection of
     *                        member-uuid groups
     * @param version         member list version
     */
    public record MemberGroupsAndVersionHolder(
            Collection> allMemberGroups,
            int version
    ) { }
}