com.azure.identity.implementation.msalextensions.cachepersister.CachePersister Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.identity.implementation.msalextensions.cachepersister;

import com.azure.identity.implementation.msalextensions.cachepersister.windows.WindowsDPAPICacheProtector;
import com.sun.jna.Platform;

import java.io.IOException;

/**
 * Wrapper class for CacheProtector
 * Determines the type of CacheProtector to use (if possible) and instantiates it
 * Also contains wrapper methods for read, write, and delete cache
 * */
public final class CachePersister {

    private CacheProtectorBase cacheProtector;

    /**
     * Default constructor
     * */
    private CachePersister(CacheProtectorBase cacheProtector) {
        this.cacheProtector = cacheProtector;
    }

    /**
     * Wrapper method for reading cache
     *
     * @return byte[] of cache contents
     * */
    public byte[] readCache() {
        return cacheProtector.readCache();
    }

    /**
     * Wrapper method for writing to the cache
     *
     * @param data Cache contents
     * */
    public void writeCache(byte[] data) {
        cacheProtector.writeCache(data);
    }

    public boolean deleteCache() {
        return cacheProtector.deleteCache();
    }

    /**
     * Builder for CachePersister class
     * Creates appropriate file paths and account and service names, and calls createCacheProtector
     * */
    public static class Builder {

        private String cacheLocation;
        private String lockfileLocation;

        /**
         * Default builder based on platform for cache file, and default service and account names
         */
        public Builder() {

            // determine platform and create cache file location
            if (Platform.isWindows()) {
                cacheLocation = java.nio.file.Paths.get(System.getProperty("user.home"),
                    "AppData", "Local", ".IdentityService", "msal.cache").toString();
            } else {
                cacheLocation = java.nio.file.Paths.get(System.getProperty("user.home"),
                    "msal.cache").toString();
            }
            lockfileLocation = cacheLocation + ".lockfile";
//
//            serviceName = "Microsoft.Developer.IdentityService";
//            accountName = "MSALCache";
        }

        /**
         * @return Builder with updated cacheLocation and lockfileLocation
         * */
        public Builder cacheLocation(String cacheLocation) {
            this.cacheLocation = cacheLocation;
            this.lockfileLocation = cacheLocation + ".lockfile";
            return this;
        }

        /**
         * @return Builder with updated lockfileLocation
         * */
        public Builder lockfileLocation(String lockfileLocation) {
            this.lockfileLocation = lockfileLocation;
            return this;
        }

        /**
         * Builds CachePersister with all the information passed into the Builder
         *
         * @return newly instantiated CachePersister
         * */
        public CachePersister build() throws RuntimeException {
            if (Platform.isWindows()) {
                try {
                    return new CachePersister(new WindowsDPAPICacheProtector(cacheLocation, lockfileLocation));
                } catch (IOException e) {
                    throw new RuntimeException("IO Exception in creating the WindowsDPAPICacheProtector");
                }
            } else {
                throw new PlatformNotSupportedException("Platform is not supported");
            }
        }
    }
}