1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 | 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 Storage { // ******************************************************************************************** // ******************************************************************************************** // Class Header Stuff // ******************************************************************************************** // ******************************************************************************************** // No Pubic Constructors private Storage () { } // 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 : Storage.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>(2); parameterNames.put("clearDataForOrigin", v); Collections.addAll(v, new String[] { "origin", "storageTypes", }); v = new Vector<String>(1); parameterNames.put("getCookies", v); Collections.addAll(v, new String[] { "browserContextId", }); v = new Vector<String>(2); parameterNames.put("setCookies", v); Collections.addAll(v, new String[] { "cookies", "browserContextId", }); v = new Vector<String>(1); parameterNames.put("clearCookies", v); Collections.addAll(v, new String[] { "browserContextId", }); v = new Vector<String>(1); parameterNames.put("getUsageAndQuota", v); Collections.addAll(v, new String[] { "origin", }); v = new Vector<String>(2); parameterNames.put("overrideQuotaForOrigin", v); Collections.addAll(v, new String[] { "origin", "quotaSize", }); v = new Vector<String>(1); parameterNames.put("trackCacheStorageForOrigin", v); Collections.addAll(v, new String[] { "origin", }); v = new Vector<String>(1); parameterNames.put("trackIndexedDBForOrigin", v); Collections.addAll(v, new String[] { "origin", }); v = new Vector<String>(1); parameterNames.put("untrackCacheStorageForOrigin", v); Collections.addAll(v, new String[] { "origin", }); v = new Vector<String>(1); parameterNames.put("untrackIndexedDBForOrigin", v); Collections.addAll(v, new String[] { "origin", }); parameterNames.put("getTrustTokens", EMPTY_VEC_STR); v = new Vector<String>(1); parameterNames.put("clearTrustTokens", v); Collections.addAll(v, new String[] { "issuerOrigin", }); } // ******************************************************************************************** // ******************************************************************************************** // Types - Static Inner Classes // ******************************************************************************************** // ******************************************************************************************** /** Enum of possible storage types. */ public static final String[] StorageType = { "appcache", "cookies", "file_systems", "indexeddb", "local_storage", "shader_cache", "websql", "service_workers", "cache_storage", "all", "other", }; /** Usage for a storage type. */ public static class UsageForType 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, }; } /** Name of storage type. */ public final String storageType; /** Storage usage (bytes). */ public final Number usage; /** * Constructor * * @param storageType Name of storage type. * * @param usage Storage usage (bytes). */ public UsageForType(String storageType, Number usage) { // 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 (storageType == null) BRDPC.throwNPE("storageType"); if (usage == null) BRDPC.throwNPE("usage"); // 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("storageType", storageType, "Storage.StorageType", Storage.StorageType); this.storageType = storageType; this.usage = usage; } /** * JSON Object Constructor * @param jo A Json-Object having data about an instance of {@code 'UsageForType'}. */ public UsageForType (JsonObject jo) { this.storageType = ReadJSON.getString(jo, "storageType", false, true); this.usage = ReadNumberJSON.get(jo, "usage", 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; UsageForType o = (UsageForType) other; return Objects.equals(this.storageType, o.storageType) && Objects.equals(this.usage, o.usage); } /** Generates a Hash-Code for {@code 'this'} instance */ public int hashCode() { return Objects.hashCode(this.storageType) + Objects.hashCode(this.usage); } } /** * Pair of issuer origin and number of available (signed, but not used) Trust * Tokens from that issuer. * <BR /> * <BR /><B>EXPERIMENTAL</B> */ public static class TrustTokens 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 issuerOrigin; /** <CODE>[No Description Provided by Google]</CODE> */ public final Number count; /** * Constructor * * @param issuerOrigin - * * @param count - */ public TrustTokens(String issuerOrigin, Number count) { // 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 (issuerOrigin == null) BRDPC.throwNPE("issuerOrigin"); if (count == null) BRDPC.throwNPE("count"); this.issuerOrigin = issuerOrigin; this.count = count; } /** * JSON Object Constructor * @param jo A Json-Object having data about an instance of {@code 'TrustTokens'}. */ public TrustTokens (JsonObject jo) { this.issuerOrigin = ReadJSON.getString(jo, "issuerOrigin", false, true); this.count = ReadNumberJSON.get(jo, "count", 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; TrustTokens o = (TrustTokens) other; return Objects.equals(this.issuerOrigin, o.issuerOrigin) && Objects.equals(this.count, o.count); } /** Generates a Hash-Code for {@code 'this'} instance */ public int hashCode() { return Objects.hashCode(this.issuerOrigin) + Objects.hashCode(this.count); } } /** A cache's contents have been modified. */ public static class cacheStorageContentUpdated extends BrowserEvent implements java.io.Serializable { /** For Object Serialization. java.io.Serializable */ protected static final long serialVersionUID = 1; public boolean[] optionals() { return new boolean[] { false, false, }; } /** Origin to update. */ public final String origin; /** Name of cache in origin. */ public final String cacheName; /** * Constructor * * @param origin Origin to update. * * @param cacheName Name of cache in origin. */ public cacheStorageContentUpdated(String origin, String cacheName) { super("Storage", "cacheStorageContentUpdated", 2); // 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 (origin == null) BRDPC.throwNPE("origin"); if (cacheName == null) BRDPC.throwNPE("cacheName"); this.origin = origin; this.cacheName = cacheName; } /** * JSON Object Constructor * @param jo A Json-Object having data about an instance of {@code 'cacheStorageContentUpdated'}. */ public cacheStorageContentUpdated (JsonObject jo) { super("Storage", "cacheStorageContentUpdated", 2); this.origin = ReadJSON.getString(jo, "origin", 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; cacheStorageContentUpdated o = (cacheStorageContentUpdated) other; return Objects.equals(this.origin, o.origin) && Objects.equals(this.cacheName, o.cacheName); } /** Generates a Hash-Code for {@code 'this'} instance */ public int hashCode() { return Objects.hashCode(this.origin) + Objects.hashCode(this.cacheName); } } /** A cache has been added/deleted. */ public static class cacheStorageListUpdated extends BrowserEvent implements java.io.Serializable { /** For Object Serialization. java.io.Serializable */ protected static final long serialVersionUID = 1; public boolean[] optionals() { return new boolean[] { false, }; } /** Origin to update. */ public final String origin; /** * Constructor * * @param origin Origin to update. */ public cacheStorageListUpdated(String origin) { super("Storage", "cacheStorageListUpdated", 1); // 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 (origin == null) BRDPC.throwNPE("origin"); this.origin = origin; } /** * JSON Object Constructor * @param jo A Json-Object having data about an instance of {@code 'cacheStorageListUpdated'}. */ public cacheStorageListUpdated (JsonObject jo) { super("Storage", "cacheStorageListUpdated", 1); this.origin = ReadJSON.getString(jo, "origin", 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; cacheStorageListUpdated o = (cacheStorageListUpdated) other; return Objects.equals(this.origin, o.origin); } /** Generates a Hash-Code for {@code 'this'} instance */ public int hashCode() { return Objects.hashCode(this.origin); } } /** The origin's IndexedDB object store has been modified. */ public static class indexedDBContentUpdated extends BrowserEvent 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, }; } /** Origin to update. */ public final String origin; /** Database to update. */ public final String databaseName; /** ObjectStore to update. */ public final String objectStoreName; /** * Constructor * * @param origin Origin to update. * * @param databaseName Database to update. * * @param objectStoreName ObjectStore to update. */ public indexedDBContentUpdated (String origin, String databaseName, String objectStoreName) { super("Storage", "indexedDBContentUpdated", 3); // 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 (origin == null) BRDPC.throwNPE("origin"); if (databaseName == null) BRDPC.throwNPE("databaseName"); if (objectStoreName == null) BRDPC.throwNPE("objectStoreName"); this.origin = origin; this.databaseName = databaseName; this.objectStoreName = objectStoreName; } /** * JSON Object Constructor * @param jo A Json-Object having data about an instance of {@code 'indexedDBContentUpdated'}. */ public indexedDBContentUpdated (JsonObject jo) { super("Storage", "indexedDBContentUpdated", 3); this.origin = ReadJSON.getString(jo, "origin", false, true); this.databaseName = ReadJSON.getString(jo, "databaseName", false, true); this.objectStoreName = ReadJSON.getString(jo, "objectStoreName", 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; indexedDBContentUpdated o = (indexedDBContentUpdated) other; return Objects.equals(this.origin, o.origin) && Objects.equals(this.databaseName, o.databaseName) && Objects.equals(this.objectStoreName, o.objectStoreName); } /** Generates a Hash-Code for {@code 'this'} instance */ public int hashCode() { return Objects.hashCode(this.origin) + Objects.hashCode(this.databaseName) + Objects.hashCode(this.objectStoreName); } } /** The origin's IndexedDB database list has been modified. */ public static class indexedDBListUpdated extends BrowserEvent implements java.io.Serializable { /** For Object Serialization. java.io.Serializable */ protected static final long serialVersionUID = 1; public boolean[] optionals() { return new boolean[] { false, }; } /** Origin to update. */ public final String origin; /** * Constructor * * @param origin Origin to update. */ public indexedDBListUpdated(String origin) { super("Storage", "indexedDBListUpdated", 1); // 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 (origin == null) BRDPC.throwNPE("origin"); this.origin = origin; } /** * JSON Object Constructor * @param jo A Json-Object having data about an instance of {@code 'indexedDBListUpdated'}. */ public indexedDBListUpdated (JsonObject jo) { super("Storage", "indexedDBListUpdated", 1); this.origin = ReadJSON.getString(jo, "origin", 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; indexedDBListUpdated o = (indexedDBListUpdated) other; return Objects.equals(this.origin, o.origin); } /** Generates a Hash-Code for {@code 'this'} instance */ public int hashCode() { return Objects.hashCode(this.origin); } } // Counter for keeping the WebSocket Request ID's distinct. private static int counter = 1; /** * Clears storage for origin. * * @param origin Security origin. * * @param storageTypes Comma separated list of StorageType to clear. * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></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> clearDataForOrigin (String origin, String storageTypes) { // 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 (origin == null) BRDPC.throwNPE("origin"); if (storageTypes == null) BRDPC.throwNPE("storageTypes"); final int webSocketID = 37000000 + 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("clearDataForOrigin"), parameterNames.get("clearDataForOrigin"), optionals, webSocketID, "Storage.clearDataForOrigin", origin, storageTypes ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } /** * Returns all browser cookies. * * @param browserContextId Browser context to use when called on the browser endpoint. * <BR /><B>OPTIONAL</B> * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Network.Cookie}[]></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><JsonObject, * {@link Network.Cookie}[]></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 Network.Cookie}[] (<B>cookies</B></CODE>) * <BR />Array of cookie objects. * </LI> * </UL> */ public static Script<String, JsonObject, Network.Cookie[]> getCookies (String browserContextId) { final int webSocketID = 37001000 + counter++; final boolean[] optionals = { true, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("getCookies"), parameterNames.get("getCookies"), optionals, webSocketID, "Storage.getCookies", browserContextId ); // 'JSON Binding' ... Converts Browser Response-JSON to 'Network.Cookie[]' Function<JsonObject, Network.Cookie[]> responseProcessor = (JsonObject jo) -> (jo.getJsonArray("cookies") == null) ? null : RJArrDimN.objArr(jo.getJsonArray("cookies"), null, 0, Network.Cookie[].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); } /** * Sets given cookies. * * @param cookies Cookies to be set. * * @param browserContextId Browser context to use when called on the browser endpoint. * <BR /><B>OPTIONAL</B> * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></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> setCookies (Network.CookieParam[] cookies, String browserContextId) { // 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 (cookies == null) BRDPC.throwNPE("cookies"); final int webSocketID = 37002000 + counter++; final boolean[] optionals = { false, true, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("setCookies"), parameterNames.get("setCookies"), optionals, webSocketID, "Storage.setCookies", cookies, browserContextId ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } /** * Clears cookies. * * @param browserContextId Browser context to use when called on the browser endpoint. * <BR /><B>OPTIONAL</B> * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></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> clearCookies(String browserContextId) { final int webSocketID = 37003000 + counter++; final boolean[] optionals = { true, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("clearCookies"), parameterNames.get("clearCookies"), optionals, webSocketID, "Storage.clearCookies", browserContextId ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } /** * Returns usage and quota in bytes. * * @param origin Security origin. * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret4}></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 Ret4} 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 Ret4}</B> * * <BR /><BR /><UL CLASS=JDUL> * <LI><CODE><B>Ret4.a:</B> Number (<B>usage</B>)</CODE> * <BR />Storage usage (bytes). * <BR /><BR /></LI> * <LI><CODE><B>Ret4.b:</B> Number (<B>quota</B>)</CODE> * <BR />Storage quota (bytes). * <BR /><BR /></LI> * <LI><CODE><B>Ret4.c:</B> Boolean (<B>overrideActive</B>)</CODE> * <BR />Whether or not the origin has an active storage quota override * <BR /><BR /></LI> * <LI><CODE><B>Ret4.d:</B> {@link Storage.UsageForType}[] (<B>usageBreakdown</B>)</CODE> * <BR />Storage usage per type (bytes). * </LI> * </UL> */ public static Script<String, JsonObject, Ret4<Number, Number, Boolean, Storage.UsageForType[]>> getUsageAndQuota (String origin) { // 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 (origin == null) BRDPC.throwNPE("origin"); final int webSocketID = 37004000 + counter++; final boolean[] optionals = { false, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("getUsageAndQuota"), parameterNames.get("getUsageAndQuota"), optionals, webSocketID, "Storage.getUsageAndQuota", origin ); // 'JSON Binding' ... Converts Browser Response-JSON into Java-Type 'Ret4' Function<JsonObject, Ret4<Number, Number, Boolean, Storage.UsageForType[]>> responseProcessor = (JsonObject jo) -> new Ret4<>( ReadNumberJSON.get(jo, "usage", false, true), ReadNumberJSON.get(jo, "quota", false, true), ReadBoxedJSON.getBoolean(jo, "overrideActive", true), (jo.getJsonArray("usageBreakdown") == null) ? null : RJArrDimN.objArr(jo.getJsonArray("usageBreakdown"), null, 0, Storage.UsageForType[].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); } /** * Override quota for the specified origin * <BR /><B>EXPERIMENTAL</B> * * @param origin Security origin. * * @param quotaSize * The quota size (in bytes) to override the original quota with. * If this is called multiple times, the overridden quota will be equal to * the quotaSize provided in the final call. If this is called without * specifying a quotaSize, the quota will be reset to the default value for * the specified origin. If this is called multiple times with different * origins, the override will be maintained for each origin until it is * disabled (called without a quotaSize). * <BR /><B>OPTIONAL</B> * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></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> overrideQuotaForOrigin (String origin, Number quotaSize) { // 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 (origin == null) BRDPC.throwNPE("origin"); final int webSocketID = 37005000 + counter++; final boolean[] optionals = { false, true, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("overrideQuotaForOrigin"), parameterNames.get("overrideQuotaForOrigin"), optionals, webSocketID, "Storage.overrideQuotaForOrigin", origin, quotaSize ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } /** * Registers origin to be notified when an update occurs to its cache storage list. * * @param origin Security origin. * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></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> trackCacheStorageForOrigin(String origin) { // 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 (origin == null) BRDPC.throwNPE("origin"); final int webSocketID = 37006000 + counter++; final boolean[] optionals = { false, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("trackCacheStorageForOrigin"), parameterNames.get("trackCacheStorageForOrigin"), optionals, webSocketID, "Storage.trackCacheStorageForOrigin", origin ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } /** * Registers origin to be notified when an update occurs to its IndexedDB. * * @param origin Security origin. * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></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> trackIndexedDBForOrigin(String origin) { // 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 (origin == null) BRDPC.throwNPE("origin"); final int webSocketID = 37007000 + counter++; final boolean[] optionals = { false, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("trackIndexedDBForOrigin"), parameterNames.get("trackIndexedDBForOrigin"), optionals, webSocketID, "Storage.trackIndexedDBForOrigin", origin ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } /** * Unregisters origin from receiving notifications for cache storage. * * @param origin Security origin. * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></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> untrackCacheStorageForOrigin(String origin) { // 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 (origin == null) BRDPC.throwNPE("origin"); final int webSocketID = 37008000 + counter++; final boolean[] optionals = { false, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("untrackCacheStorageForOrigin"), parameterNames.get("untrackCacheStorageForOrigin"), optionals, webSocketID, "Storage.untrackCacheStorageForOrigin", origin ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } /** * Unregisters origin from receiving notifications for IndexedDB. * * @param origin Security origin. * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></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> untrackIndexedDBForOrigin(String origin) { // 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 (origin == null) BRDPC.throwNPE("origin"); final int webSocketID = 37009000 + counter++; final boolean[] optionals = { false, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("untrackIndexedDBForOrigin"), parameterNames.get("untrackIndexedDBForOrigin"), optionals, webSocketID, "Storage.untrackIndexedDBForOrigin", origin ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } /** * Returns the number of stored Trust Tokens per issuer for the * current browsing context. * <BR /><B>EXPERIMENTAL</B> * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Storage.TrustTokens}[]></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><JsonObject, * {@link Storage.TrustTokens}[]></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 Storage.TrustTokens}[] (<B>tokens</B></CODE>) * <BR />- * </LI> * </UL> */ public static Script<String, JsonObject, Storage.TrustTokens[]> getTrustTokens() { final int webSocketID = 37010000 + counter++; final boolean[] optionals = new boolean[0]; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("getTrustTokens"), parameterNames.get("getTrustTokens"), optionals, webSocketID, "Storage.getTrustTokens" ); // 'JSON Binding' ... Converts Browser Response-JSON to 'Storage.TrustTokens[]' Function<JsonObject, Storage.TrustTokens[]> responseProcessor = (JsonObject jo) -> (jo.getJsonArray("tokens") == null) ? null : RJArrDimN.objArr(jo.getJsonArray("tokens"), null, 0, Storage.TrustTokens[].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); } /** * Removes all Trust Tokens issued by the provided issuerOrigin. * Leaves other stored data, including the issuer's Redemption Records, intact. * <BR /><B>EXPERIMENTAL</B> * * @param issuerOrigin - * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * Boolean></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><JsonObject, * Boolean></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>Boolean (<B>didDeleteTokens</B></CODE>) * <BR />True if any tokens were deleted, false otherwise. * </LI> * </UL> */ public static Script<String, JsonObject, Boolean> clearTrustTokens(String issuerOrigin) { // 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 (issuerOrigin == null) BRDPC.throwNPE("issuerOrigin"); final int webSocketID = 37011000 + counter++; final boolean[] optionals = { false, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("clearTrustTokens"), parameterNames.get("clearTrustTokens"), optionals, webSocketID, "Storage.clearTrustTokens", issuerOrigin ); // 'JSON Binding' ... Converts Browser Response-JSON to 'Boolean' Function<JsonObject, Boolean> responseProcessor = (JsonObject jo) -> ReadPrimJSON.getBoolean(jo, "didDeleteTokens"); // 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); } } |