package Torello.Browser.BrowserAPI;

// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Java-HTML Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.JavaScriptAPI.*;
import Torello.JSON.*;

import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;

import Torello.JavaDoc.Annotations.StaticFunctional;
import Torello.JavaDoc.Annotations.JDHeaderBackgroundImg;

import Torello.Browser.BrowserAPI.NestedHelpers.Commands.CacheStorage$$Commands;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// JDK Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import javax.json.JsonObject;
import javax.json.JsonValue;

/**
 * <SPAN CLASS=COPIEDJDK><B><CODE>[No Description Provided by Google]</CODE></B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class CacheStorage
{
    // No Pubic Constructors
    private CacheStorage() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Eliminated Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Unique identifier of the Cache object.

     * <EMBED CLASS='external-html' DATA-CTAS='String' DATA-FILE-ID=CDP.EliminatedType
     *     DATA-NAME=CacheId>
     */
    public static final String CacheId =
        "CacheId has been eliminated.\n" +
        "It was replaced with the standard Java-Type: String";


    // ********************************************************************************************
    // ********************************************************************************************
    // Enumerated String Constants Lists
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * type of HTTP response cached
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> CachedResponseType = new ReadOnlyArrayList<>
        (String.class, "basic", "cors", "default", "error", "opaqueRedirect", "opaqueResponse");



    // ********************************************************************************************
    // ********************************************************************************************
    // Basic Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Cache identifier.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=CacheStorage DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class Cache
        extends BaseType<Cache>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<CacheStorage.Cache> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                CacheStorage$$Cache$$.singleton;

        /** An opaque unique id of the cache. */
        public final String cacheId;

        /** Security origin of the cache. */
        public final String securityOrigin;

        /** Storage key of the cache. */
        public final String storageKey;

        /**
         * Storage bucket of the cache.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final Storage.StorageBucket storageBucket;

        /** The name of the cache. */
        public final String cacheName;

        /** Constructor.  Please review this class' fields for documentation. */
        public Cache(
                ReadOnlyList<Boolean> isPresent, String cacheId, String securityOrigin,
                String storageKey, Storage.StorageBucket storageBucket, String cacheName
            )
        {
            super(singleton, Domains.CacheStorage, "Cache", 5);

            this.cacheId        = cacheId;
            this.securityOrigin = securityOrigin;
            this.storageKey     = storageKey;
            this.storageBucket  = storageBucket;
            this.cacheName      = cacheName;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 5, "CacheStorage.Cache");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static Cache fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<Cache> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Cached response
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=CacheStorage DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class CachedResponse
        extends BaseType<CachedResponse>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<CacheStorage.CachedResponse> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                CacheStorage$$CachedResponse$$.singleton;

        /** Entry content, base64-encoded. (Encoded as a base64 string when passed over JSON) */
        public final String body;

        /** Constructor.  Please review this class' fields for documentation. */
        public CachedResponse(ReadOnlyList<Boolean> isPresent, String body)
        {
            super(singleton, Domains.CacheStorage, "CachedResponse", 1);

            this.body = body;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 1, "CacheStorage.CachedResponse");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static CachedResponse fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<CachedResponse> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Data entry.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=CacheStorage DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class DataEntry
        extends BaseType<DataEntry>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<CacheStorage.DataEntry> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                CacheStorage$$DataEntry$$.singleton;

        /** Request URL. */
        public final String requestURL;

        /** Request method. */
        public final String requestMethod;

        /** Request headers */
        public final CacheStorage.Header[] requestHeaders;

        /** Number of seconds since epoch. */
        public final Number responseTime;

        /** HTTP response status code. */
        public final int responseStatus;

        /** HTTP response status text. */
        public final String responseStatusText;

        /**
         * HTTP response type
         * <EMBED CLASS='external-html' DATA-D=CacheStorage DATA-C=CachedResponseType DATA-F=responseType DATA-FILE-ID=CDP.EL2>
         * @see BaseType#enumStrList(String)
         */
        public final String responseType;

        /** Response headers */
        public final CacheStorage.Header[] responseHeaders;

        /** Constructor.  Please review this class' fields for documentation. */
        public DataEntry(
                ReadOnlyList<Boolean> isPresent, String requestURL, String requestMethod,
                Header[] requestHeaders, Number responseTime, int responseStatus,
                String responseStatusText, String responseType, Header[] responseHeaders
            )
        {
            super(singleton, Domains.CacheStorage, "DataEntry", 8);

            this.requestURL         = requestURL;
            this.requestMethod      = requestMethod;
            this.requestHeaders     = requestHeaders;
            this.responseTime       = responseTime;
            this.responseStatus     = responseStatus;
            this.responseStatusText = responseStatusText;
            this.responseType       = responseType;
            this.responseHeaders    = responseHeaders;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 8, "CacheStorage.DataEntry");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static DataEntry fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<DataEntry> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=CacheStorage DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class Header
        extends BaseType<Header>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<CacheStorage.Header> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                CacheStorage$$Header$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String name;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String value;

        /** Constructor.  Please review this class' fields for documentation. */
        public Header(ReadOnlyList<Boolean> isPresent, String name, String value)
        {
            super(singleton, Domains.CacheStorage, "Header", 2);

            this.name   = name;
            this.value  = value;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "CacheStorage.Header");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static Header fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<Header> descriptor()
        { return singleton.descriptor(); }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Command-Return Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Requests data from cache.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=CacheStorage DATA-API=BrowserAPI DATA-CMD=requestEntries>
     * @see CacheStorage#requestEntries
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_CMD_JDHBI")
    public static class requestEntries$$RET
        extends BaseType<requestEntries$$RET>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<CacheStorage.requestEntries$$RET> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.CmdReturns.
                CacheStorage$$requestEntries$$RET.singleton;

        /** Array of object store data entries. */
        public final CacheStorage.DataEntry[] cacheDataEntries;

        /**
         * Count of returned entries from this storage. If pathFilter is empty, it
         * is the count of all entries from this storage.
         */
        public final Number returnCount;

        /** Constructor.  Please review this class' fields for documentation. */
        public requestEntries$$RET
            (ReadOnlyList<Boolean> isPresent, DataEntry[] cacheDataEntries, Number returnCount)
        {
            super(singleton, Domains.CacheStorage, "requestEntries", 2);

            this.cacheDataEntries   = cacheDataEntries;
            this.returnCount        = returnCount;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "CacheStorage.requestEntries$$RET");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static requestEntries$$RET fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<requestEntries$$RET> descriptor()
        { return singleton.descriptor(); }
    }




    // ********************************************************************************************
    // ********************************************************************************************
    // Commands
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Deletes a cache.
     * 
     * @param cacheId Id of cache for deletion.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> deleteCache(String cacheId)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "cacheId", false, "CacheStorage.deleteCache", cacheId);

        return Script.NO_RET(Domains.CacheStorage, "deleteCache", requestJSON);
    }

    /**
     * Deletes a cache entry.
     * 
     * @param cacheId Id of cache where the entry will be deleted.
     * 
     * @param request URL spec of the request.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> deleteEntry(String cacheId, String request)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            CacheStorage$$Commands.deleteEntry$$, "CacheStorage.deleteEntry",
            cacheId, request
        );

        return Script.NO_RET(Domains.CacheStorage, "deleteEntry", requestJSON);
    }

    /**
     * Requests cache names.
     * 
     * @param securityOrigin 
     * At least and at most one of securityOrigin, storageKey, storageBucket must be specified.
     * Security origin.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param storageKey Storage key.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param storageBucket Storage bucket. If not specified, it uses the default bucket.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link CacheStorage.Cache}[]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link CacheStorage.Cache}[]&gt;</CODE> will be returned
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link CacheStorage.Cache}[] (<B>caches</B>)</CODE>
     * <BR />
     * Caches for the security origin.
     * </DIV>
     */
    public static Script<CacheStorage.Cache[]> requestCacheNames
        (String securityOrigin, String storageKey, Storage.StorageBucket storageBucket)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            CacheStorage$$Commands.requestCacheNames$$, "CacheStorage.requestCacheNames",
            securityOrigin, storageKey, storageBucket
        );

        return new Script<>(
            Domains.CacheStorage, "requestCacheNames", requestJSON,
            CacheStorage$$Commands::requestCacheNames,
            CacheStorage.Cache[].class
        );
    }

    /**
     * Fetches cache entry.
     * 
     * @param cacheId Id of cache that contains the entry.
     * 
     * @param requestURL URL spec of the request.
     * 
     * @param requestHeaders headers of the request.
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link CacheStorage.CachedResponse}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link CacheStorage.CachedResponse}&gt;</CODE> will be returned
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link CacheStorage.CachedResponse} (<B>response</B>)</CODE>
     * <BR />
     * Response read from the cache.
     * </DIV>
     */
    public static Script<CacheStorage.CachedResponse> requestCachedResponse
        (String cacheId, String requestURL, Header[] requestHeaders)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            CacheStorage$$Commands.requestCachedResponse$$, "CacheStorage.requestCachedResponse",
            cacheId, requestURL, requestHeaders
        );

        return new Script<>(
            Domains.CacheStorage, "requestCachedResponse", requestJSON,
            CacheStorage$$Commands::requestCachedResponse,
            CacheStorage.CachedResponse.class
        );
    }

    /**
     * Requests data from cache.
     * 
     * @param cacheId ID of cache to get entries from.
     * 
     * @param skipCount Number of records to skip.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param pageSize Number of records to fetch.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param pathFilter If present, only return the entries containing this substring in the path
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link requestEntries$$RET}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link requestEntries$$RET}&gt;</CODE> will be returned
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:{@link requestEntries$$RET}
     * A dedicated return type implies that the browser may return more than 1 datum
     * </DIV>
     */
    public static Script<requestEntries$$RET> requestEntries
        (String cacheId, Integer skipCount, Integer pageSize, String pathFilter)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            CacheStorage$$Commands.requestEntries$$, "CacheStorage.requestEntries",
            cacheId, skipCount, pageSize, pathFilter
        );

        return new Script<>(
            Domains.CacheStorage, "requestEntries", requestJSON,
            requestEntries$$RET::fromJSON,
            requestEntries$$RET.class
        );
    }


}