// Copyright (c) Microsoft Corporation.
// All rights reserved.
//
// This code is licensed under the MIT License.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files(the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions :
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package com.microsoft.aad.adal;

import androidx.annotation.NonNull;

/**
 * CacheKey will be the object for key.
 */
public final class CacheKey extends com.microsoft.identity.common.java.adal.cache.CacheKey {

    /**
     * Create cachekey from {@link TokenCacheItem}. It will use {@link UserInfo#getUserId()}
     * as the user for cachekey if present.
     *
     * @param item {@link TokenCacheItem} that is used to create the cache key.
     * @return String value of the {@link CacheKey} to save token.
     * @throws AuthenticationException
     */
    public static String createCacheKey(@NonNull final TokenCacheItem item) throws AuthenticationException {
        if (item == null) {
            throw new IllegalArgumentException("TokenCacheItem");
        }

        String userid = null;

        if (item.getUserInfo() != null) {
            userid = item.getUserInfo().getUserId();
        }

        final TokenEntryType tokenEntryType = item.getTokenEntryType();

        switch (tokenEntryType) {
            case REGULAR_TOKEN_ENTRY:
                return createCacheKeyForRTEntry(
                        item.getAuthority(),
                        item.getResource(),
                        item.getClientId(),
                        userid
                );
            case MRRT_TOKEN_ENTRY:
                return createCacheKeyForMRRT(
                        item.getAuthority(),
                        item.getClientId(),
                        userid
                );
            case FRT_TOKEN_ENTRY:
                return createCacheKeyForFRT(
                        item.getAuthority(),
                        item.getFamilyClientId(),
                        userid
                );
            default:
                throw new AuthenticationException(
                        ADALError.INVALID_TOKEN_CACHE_ITEM,
                        "Cannot create cachekey from given token item"
                );
        }
    }
}
