package Torello.Browser;

import java.util.*;
import javax.json.*;
import javax.json.stream.*;
import java.io.*;

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.function.Function;

import Torello.Java.Additional.*;
import Torello.Java.JSON.*;

import static Torello.Java.JSON.JFlag.*;

import Torello.Java.StrCmpr;
import Torello.JavaDoc.StaticFunctional;
import Torello.JavaDoc.JDHeaderBackgroundImg;
import Torello.JavaDoc.Excuse;

/**
 * <SPAN CLASS=COPIEDJDK><B><CODE>[No Description Provided by Google]</CODE></B></SPAN>
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=CODE_GEN_NOTE>
 */
@StaticFunctional(Excused={"counter"}, Excuses={Excuse.CONFIGURATION})
@JDHeaderBackgroundImg(EmbedTagFileID="WOOD_PLANK_NOTE")
public class CacheStorage
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private CacheStorage () { }

    // These two Vector's are used by all the "Methods" exported by this class.  java.lang.reflect
    // is used to generate the JSON String's.  It saves thousands of lines of Auto-Generated Code.
    private static final Map<String, Vector<String>>    parameterNames = new HashMap<>();
    private static final Map<String, Vector<Class<?>>>  parameterTypes = new HashMap<>();

    // Some Methods do not take any parameters - for instance all the "enable()" and "disable()"
    // I simply could not get ride of RAW-TYPES and UNCHECKED warnings... so there are now,
    // offically, two empty-vectors.  One for String's, and the other for Classes.

    private static final Vector<String>     EMPTY_VEC_STR = new Vector<>();
    private static final Vector<Class<?>>   EMPTY_VEC_CLASS = new Vector<>();

    static
    {
        for (Method m : CacheStorage.class.getMethods())
        {
            // This doesn't work!  The parameter names are all "arg0" ... "argN"
            // It works for java.lang.reflect.Field, BUT NOT java.lang.reflect.Parameter!
            //
            // Vector<String> parameterNamesList = new Vector<>(); -- NOPE!

            Vector<Class<?>> parameterTypesList = new Vector<>();
        
            for (Parameter p : m.getParameters()) parameterTypesList.add(p.getType());

            parameterTypes.put(
                m.getName(),
                (parameterTypesList.size() > 0) ? parameterTypesList : EMPTY_VEC_CLASS
            );
        }
    }

    static
    {
        Vector<String> v = null;

        v = new Vector<String>(1);
        parameterNames.put("deleteCache", v);
        Collections.addAll(v, new String[]
        { "cacheId", });

        v = new Vector<String>(2);
        parameterNames.put("deleteEntry", v);
        Collections.addAll(v, new String[]
        { "cacheId", "request", });

        v = new Vector<String>(1);
        parameterNames.put("requestCacheNames", v);
        Collections.addAll(v, new String[]
        { "securityOrigin", });

        v = new Vector<String>(3);
        parameterNames.put("requestCachedResponse", v);
        Collections.addAll(v, new String[]
        { "cacheId", "requestURL", "requestHeaders", });

        v = new Vector<String>(4);
        parameterNames.put("requestEntries", v);
        Collections.addAll(v, new String[]
        { "cacheId", "skipCount", "pageSize", "pathFilter", });
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Types - Static Inner Classes
    // ********************************************************************************************
    // ********************************************************************************************

    // public static class CacheId => String
    
    /** type of HTTP response cached */
    public static final String[] CachedResponseType =
    { "basic", "cors", "default", "error", "opaqueResponse", "opaqueRedirect", };
    
    /** Data entry. */
    public static class DataEntry
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, false, false, false, false, false, false, }; }
        
        /** 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 */
        public final String responseType;
        
        /** Response headers */
        public final CacheStorage.Header[] responseHeaders;
        
        /**
         * Constructor
         *
         * @param requestURL Request URL.
         * 
         * @param requestMethod Request method.
         * 
         * @param requestHeaders Request headers
         * 
         * @param responseTime Number of seconds since epoch.
         * 
         * @param responseStatus HTTP response status code.
         * 
         * @param responseStatusText HTTP response status text.
         * 
         * @param responseType HTTP response type
         * 
         * @param responseHeaders Response headers
         */
        public DataEntry(
                String requestURL, String requestMethod, CacheStorage.Header[] requestHeaders, 
                Number responseTime, int responseStatus, String responseStatusText, 
                String responseType, CacheStorage.Header[] responseHeaders
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (requestURL == null)         BRDPC.throwNPE("requestURL");
            if (requestMethod == null)      BRDPC.throwNPE("requestMethod");
            if (requestHeaders == null)     BRDPC.throwNPE("requestHeaders");
            if (responseTime == null)       BRDPC.throwNPE("responseTime");
            if (responseStatusText == null) BRDPC.throwNPE("responseStatusText");
            if (responseType == null)       BRDPC.throwNPE("responseType");
            if (responseHeaders == null)    BRDPC.throwNPE("responseHeaders");
            
            // Exception-Check(s) to ensure that if any parameters which must adhere to a
            // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
            
            BRDPC.checkIAE("responseType", responseType, "CacheStorage.CachedResponseType", CacheStorage.CachedResponseType);
            
            this.requestURL          = requestURL;
            this.requestMethod       = requestMethod;
            this.requestHeaders      = requestHeaders;
            this.responseTime        = responseTime;
            this.responseStatus      = responseStatus;
            this.responseStatusText  = responseStatusText;
            this.responseType        = responseType;
            this.responseHeaders     = responseHeaders;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'DataEntry'}.
         */
        public DataEntry (JsonObject jo)
        {
            this.requestURL          = ReadJSON.getString(jo, "requestURL", false, true);
            this.requestMethod       = ReadJSON.getString(jo, "requestMethod", false, true);
            this.requestHeaders = (jo.getJsonArray("requestHeaders") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("requestHeaders"), null, 0, CacheStorage.Header[].class);
        
            this.responseTime        = ReadNumberJSON.get(jo, "responseTime", false, true);
            this.responseStatus      = ReadPrimJSON.getInt(jo, "responseStatus");
            this.responseStatusText  = ReadJSON.getString(jo, "responseStatusText", false, true);
            this.responseType        = ReadJSON.getString(jo, "responseType", false, true);
            this.responseHeaders = (jo.getJsonArray("responseHeaders") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("responseHeaders"), null, 0, CacheStorage.Header[].class);
        
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            DataEntry o = (DataEntry) other;
        
            return
                    Objects.equals(this.requestURL, o.requestURL)
                &&  Objects.equals(this.requestMethod, o.requestMethod)
                &&  Arrays.deepEquals(this.requestHeaders, o.requestHeaders)
                &&  Objects.equals(this.responseTime, o.responseTime)
                &&  (this.responseStatus == o.responseStatus)
                &&  Objects.equals(this.responseStatusText, o.responseStatusText)
                &&  Objects.equals(this.responseType, o.responseType)
                &&  Arrays.deepEquals(this.responseHeaders, o.responseHeaders);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.requestURL)
                +   Objects.hashCode(this.requestMethod)
                +   Arrays.deepHashCode(this.requestHeaders)
                +   Objects.hashCode(this.responseTime)
                +   this.responseStatus
                +   Objects.hashCode(this.responseStatusText)
                +   Objects.hashCode(this.responseType)
                +   Arrays.deepHashCode(this.responseHeaders);
        }
    }
    
    /** Cache identifier. */
    public static class Cache
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, false, }; }
        
        /** An opaque unique id of the cache. */
        public final String cacheId;
        
        /** Security origin of the cache. */
        public final String securityOrigin;
        
        /** The name of the cache. */
        public final String cacheName;
        
        /**
         * Constructor
         *
         * @param cacheId An opaque unique id of the cache.
         * 
         * @param securityOrigin Security origin of the cache.
         * 
         * @param cacheName The name of the cache.
         */
        public Cache(String cacheId, String securityOrigin, String cacheName)
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (cacheId == null)        BRDPC.throwNPE("cacheId");
            if (securityOrigin == null) BRDPC.throwNPE("securityOrigin");
            if (cacheName == null)      BRDPC.throwNPE("cacheName");
            
            this.cacheId         = cacheId;
            this.securityOrigin  = securityOrigin;
            this.cacheName       = cacheName;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'Cache'}.
         */
        public Cache (JsonObject jo)
        {
            this.cacheId         = ReadJSON.getString(jo, "cacheId", false, true);
            this.securityOrigin  = ReadJSON.getString(jo, "securityOrigin", false, true);
            this.cacheName       = ReadJSON.getString(jo, "cacheName", false, true);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            Cache o = (Cache) other;
        
            return
                    Objects.equals(this.cacheId, o.cacheId)
                &&  Objects.equals(this.securityOrigin, o.securityOrigin)
                &&  Objects.equals(this.cacheName, o.cacheName);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.cacheId)
                +   Objects.hashCode(this.securityOrigin)
                +   Objects.hashCode(this.cacheName);
        }
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class Header
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String name;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String value;
        
        /**
         * Constructor
         *
         * @param name -
         * 
         * @param value -
         */
        public Header(String name, String value)
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (name == null)  BRDPC.throwNPE("name");
            if (value == null) BRDPC.throwNPE("value");
            
            this.name   = name;
            this.value  = value;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'Header'}.
         */
        public Header (JsonObject jo)
        {
            this.name   = ReadJSON.getString(jo, "name", false, true);
            this.value  = ReadJSON.getString(jo, "value", false, true);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            Header o = (Header) other;
        
            return
                    Objects.equals(this.name, o.name)
                &&  Objects.equals(this.value, o.value);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.name)
                +   Objects.hashCode(this.value);
        }
    }
    
    /** Cached response */
    public static class CachedResponse
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, }; }
        
        /** Entry content, base64-encoded. (Encoded as a base64 string when passed over JSON) */
        public final String body;
        
        /**
         * Constructor
         *
         * @param body Entry content, base64-encoded. (Encoded as a base64 string when passed over JSON)
         */
        public CachedResponse(String body)
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (body == null) BRDPC.throwNPE("body");
            
            this.body  = body;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'CachedResponse'}.
         */
        public CachedResponse (JsonObject jo)
        {
            this.body  = ReadJSON.getString(jo, "body", false, true);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            CachedResponse o = (CachedResponse) other;
        
            return
                    Objects.equals(this.body, o.body);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.body);
        }
    }
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Deletes a cache.
     * 
     * @param cacheId Id of cache for deletion.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> deleteCache(String cacheId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (cacheId == null) BRDPC.throwNPE("cacheId");
        
        final int       webSocketID = 13000000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("deleteCache"),
            parameterNames.get("deleteCache"),
            optionals, webSocketID,
            "CacheStorage.deleteCache",
            cacheId
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * 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;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> deleteEntry(String cacheId, String request)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (cacheId == null) BRDPC.throwNPE("cacheId");
        if (request == null) BRDPC.throwNPE("request");
        
        final int       webSocketID = 13001000 + counter++;
        final boolean[] optionals   = { false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("deleteEntry"),
            parameterNames.get("deleteEntry"),
            optionals, webSocketID,
            "CacheStorage.deleteEntry",
            cacheId, request
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Requests cache names.
     * 
     * @param securityOrigin Security origin.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link CacheStorage.Cache}[]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link CacheStorage.Cache}[] (<B>caches</B></CODE>)
     *     <BR />Caches for the security origin.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, CacheStorage.Cache[]> requestCacheNames
        (String securityOrigin)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (securityOrigin == null) BRDPC.throwNPE("securityOrigin");
        
        final int       webSocketID = 13002000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("requestCacheNames"),
            parameterNames.get("requestCacheNames"),
            optionals, webSocketID,
            "CacheStorage.requestCacheNames",
            securityOrigin
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'CacheStorage.Cache[]'
        Function<JsonObject, CacheStorage.Cache[]> responseProcessor = (JsonObject jo) ->
            (jo.getJsonArray("caches") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("caches"), null, 0, CacheStorage.Cache[].class);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * 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;String, {@link JsonObject},
     * {@link CacheStorage.CachedResponse}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link CacheStorage.CachedResponse} (<B>response</B></CODE>)
     *     <BR />Response read from the cache.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, CacheStorage.CachedResponse> requestCachedResponse
        (String cacheId, String requestURL, CacheStorage.Header[] requestHeaders)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (cacheId == null)        BRDPC.throwNPE("cacheId");
        if (requestURL == null)     BRDPC.throwNPE("requestURL");
        if (requestHeaders == null) BRDPC.throwNPE("requestHeaders");
        
        final int       webSocketID = 13003000 + counter++;
        final boolean[] optionals   = { false, false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("requestCachedResponse"),
            parameterNames.get("requestCachedResponse"),
            optionals, webSocketID,
            "CacheStorage.requestCachedResponse",
            cacheId, requestURL, requestHeaders
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'CacheStorage.CachedResponse'
        Function<JsonObject, CacheStorage.CachedResponse> responseProcessor = (JsonObject jo) ->
            ReadJSON.getObject(jo, "response", CacheStorage.CachedResponse.class, false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Requests data from cache.
     * 
     * @param cacheId ID of cache to get entries from.
     * 
     * @param skipCount Number of records to skip.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param pageSize Number of records to fetch.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param pathFilter If present, only return the entries containing this substring in the path
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret2}&gt;</CODE>
     *
     * <BR /><BR />This {@link Script} may be <B STYLE='color:red'>executed</B> (using 
     * {@link Script#exec()}), and a {@link Promise} returned.
     *
     * <BR /><BR />When the {@code Promise} is <B STYLE='color: red'>awaited</B>
     * (using {@link Promise#await()}), the {@code Ret2} will subsequently
     * be returned from that call.
     * 
     * <BR /><BR />The <B STYLE='color: red'>returned</B> values are encapsulated
     * in an instance of <B>{@link Ret2}</B>
     *
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE><B>Ret2.a:</B> {@link CacheStorage.DataEntry}[] (<B>cacheDataEntries</B>)</CODE>
     *     <BR />Array of object store data entries.
     *     <BR /><BR /></LI>
     * <LI><CODE><B>Ret2.b:</B> Number (<B>returnCount</B>)</CODE>
     *     <BR />Count of returned entries from this storage. If pathFilter is empty, it
     *     is the count of all entries from this storage.
     *     </LI>
     * </UL>
     */
    public static Script<String, JsonObject, Ret2<CacheStorage.DataEntry[], Number>> requestEntries
        (String cacheId, Integer skipCount, Integer pageSize, String pathFilter)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (cacheId == null) BRDPC.throwNPE("cacheId");
        
        final int       webSocketID = 13004000 + counter++;
        final boolean[] optionals   = { false, true, true, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("requestEntries"),
            parameterNames.get("requestEntries"),
            optionals, webSocketID,
            "CacheStorage.requestEntries",
            cacheId, skipCount, pageSize, pathFilter
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON into Java-Type 'Ret2'
        Function<JsonObject, Ret2<CacheStorage.DataEntry[], Number>> 
            responseProcessor = (JsonObject jo) -> new Ret2<>(
                (jo.getJsonArray("cacheDataEntries") == null)
                    ? null
                    : ReadArrJSON.DimN.objArr(jo.getJsonArray("cacheDataEntries"), null, 0, CacheStorage.DataEntry[].class),
                ReadNumberJSON.get(jo, "returnCount", false, true)
            );
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
}