org.keycloak.storage.StorageId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of keycloak-server-spi Show documentation
There is a newer version: 26.0.5
/*
 * Copyright 2016 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.storage;

import org.keycloak.component.ComponentModel;
import org.keycloak.models.ClientModel;
import org.keycloak.models.UserModel;

import java.io.Serializable;
import java.util.Objects;

/**
 * @author Bill Burke
 * @version $Revision: 1 $
 */
public class StorageId implements Serializable {
    private final String providerId;
    private final String externalId;


    public StorageId(String id) {
        if (!id.startsWith("f:")) {
            providerId = null;
            externalId = id;
        } else {
            int providerIndex = id.indexOf(':', 2);
            providerId = id.substring(2, providerIndex);
            externalId = id.substring(providerIndex + 1);
        }
    }

    public StorageId(String providerId, String externalId) {
        if (providerId != null && providerId.contains(":")) {
            throw new IllegalArgumentException("Provider must not contain a colon (:) character");
        }
        this.providerId = providerId;
        this.externalId = externalId;
    }

    public boolean isLocal() {
        return getProviderId() == null;
    }

    public String getId() {
        return providerId == null ? externalId : ("f:" + providerId + ":" + externalId);
    }

    public String getProviderId() {
        return providerId;
    }

    public String getExternalId() {
        return externalId;
    }

    /**
     * generate the id string that should be returned by UserModel.getId()
     *
     * @param model
     * @param externalId id used to resolve user in external storage
     * @return
     */
    public static String keycloakId(ComponentModel model, String externalId) {
        return new StorageId(model.getId(), externalId).getId();
    }

    public static String externalId(String keycloakId) {
        return new StorageId(keycloakId).getExternalId();
    }
    public static String providerId(String keycloakId) {
        return new StorageId(keycloakId).getProviderId();
    }

    public static boolean isLocalStorage(String id) {
        return new StorageId(id).getProviderId() == null;
    }

    /**
     * @deprecated Use {@link #providerId(String)} instead.
     */
    public static String resolveProviderId(UserModel user) {
        return providerId(user.getId());
    }

    /**
     * @deprecated Use {@link #isLocalStorage(String)} instead.
     */
    public static boolean isLocalStorage(UserModel user) {
        return isLocalStorage(user.getId());
    }

    /**
     * @deprecated Use {@link #providerId(String)} instead.
     */
    public static String resolveProviderId(ClientModel client) {
        return providerId(client.getId());
    }

    /**
     * @deprecated Use {@link #isLocalStorage(String)} instead.
     */
    public static boolean isLocalStorage(ClientModel client) {
        return isLocalStorage(client.getId());
    }

    @Override
    public int hashCode() {
        return Objects.hash(providerId, externalId);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final StorageId other = (StorageId) obj;
        if ( ! Objects.equals(this.providerId, other.providerId)) {
            return false;
        }
        if ( ! Objects.equals(this.externalId, other.externalId)) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        return getId();
    }

}