org.openqa.selenium.devtools.v123.indexeddb.IndexedDB Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-devtools-v123 Show documentation
Show all versions of selenium-devtools-v123 Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
package org.openqa.selenium.devtools.v123.indexeddb;
import org.openqa.selenium.Beta;
import org.openqa.selenium.devtools.Command;
import org.openqa.selenium.devtools.Event;
import org.openqa.selenium.devtools.ConverterFunctions;
import java.util.Map;
import java.util.LinkedHashMap;
import org.openqa.selenium.json.JsonInput;
@Beta()
public class IndexedDB {
/**
* Clears all entries from an object store.
*/
public static Command clearObjectStore(java.util.Optional securityOrigin, java.util.Optional storageKey, java.util.Optional storageBucket, java.lang.String databaseName, java.lang.String objectStoreName) {
java.util.Objects.requireNonNull(databaseName, "databaseName is required");
java.util.Objects.requireNonNull(objectStoreName, "objectStoreName is required");
LinkedHashMap params = new LinkedHashMap<>();
securityOrigin.ifPresent(p -> params.put("securityOrigin", p));
storageKey.ifPresent(p -> params.put("storageKey", p));
storageBucket.ifPresent(p -> params.put("storageBucket", p));
params.put("databaseName", databaseName);
params.put("objectStoreName", objectStoreName);
return new Command<>("IndexedDB.clearObjectStore", Map.copyOf(params));
}
/**
* Deletes a database.
*/
public static Command deleteDatabase(java.util.Optional securityOrigin, java.util.Optional storageKey, java.util.Optional storageBucket, java.lang.String databaseName) {
java.util.Objects.requireNonNull(databaseName, "databaseName is required");
LinkedHashMap params = new LinkedHashMap<>();
securityOrigin.ifPresent(p -> params.put("securityOrigin", p));
storageKey.ifPresent(p -> params.put("storageKey", p));
storageBucket.ifPresent(p -> params.put("storageBucket", p));
params.put("databaseName", databaseName);
return new Command<>("IndexedDB.deleteDatabase", Map.copyOf(params));
}
/**
* Delete a range of entries from an object store
*/
public static Command deleteObjectStoreEntries(java.util.Optional securityOrigin, java.util.Optional storageKey, java.util.Optional storageBucket, java.lang.String databaseName, java.lang.String objectStoreName, org.openqa.selenium.devtools.v123.indexeddb.model.KeyRange keyRange) {
java.util.Objects.requireNonNull(databaseName, "databaseName is required");
java.util.Objects.requireNonNull(objectStoreName, "objectStoreName is required");
java.util.Objects.requireNonNull(keyRange, "keyRange is required");
LinkedHashMap params = new LinkedHashMap<>();
securityOrigin.ifPresent(p -> params.put("securityOrigin", p));
storageKey.ifPresent(p -> params.put("storageKey", p));
storageBucket.ifPresent(p -> params.put("storageBucket", p));
params.put("databaseName", databaseName);
params.put("objectStoreName", objectStoreName);
params.put("keyRange", keyRange);
return new Command<>("IndexedDB.deleteObjectStoreEntries", Map.copyOf(params));
}
/**
* Disables events from backend.
*/
public static Command disable() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("IndexedDB.disable", Map.copyOf(params));
}
/**
* Enables events from backend.
*/
public static Command enable() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("IndexedDB.enable", Map.copyOf(params));
}
public static class RequestDataResponse {
private final java.util.List objectStoreDataEntries;
private final java.lang.Boolean hasMore;
public RequestDataResponse(java.util.List objectStoreDataEntries, java.lang.Boolean hasMore) {
this.objectStoreDataEntries = java.util.Objects.requireNonNull(objectStoreDataEntries, "objectStoreDataEntries is required");
this.hasMore = java.util.Objects.requireNonNull(hasMore, "hasMore is required");
}
/**
* Array of object store data entries.
*/
public java.util.List getObjectStoreDataEntries() {
return objectStoreDataEntries;
}
/**
* If true, there are more entries to fetch in the given range.
*/
public java.lang.Boolean getHasMore() {
return hasMore;
}
private static RequestDataResponse fromJson(JsonInput input) {
java.util.List objectStoreDataEntries = null;
java.lang.Boolean hasMore = false;
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "objectStoreDataEntries":
objectStoreDataEntries = input.readArray(org.openqa.selenium.devtools.v123.indexeddb.model.DataEntry.class);
break;
case "hasMore":
hasMore = input.nextBoolean();
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new RequestDataResponse(objectStoreDataEntries, hasMore);
}
}
/**
* Requests data from object store or index.
*/
public static Command requestData(java.util.Optional securityOrigin, java.util.Optional storageKey, java.util.Optional storageBucket, java.lang.String databaseName, java.lang.String objectStoreName, java.lang.String indexName, java.lang.Integer skipCount, java.lang.Integer pageSize, java.util.Optional keyRange) {
java.util.Objects.requireNonNull(databaseName, "databaseName is required");
java.util.Objects.requireNonNull(objectStoreName, "objectStoreName is required");
java.util.Objects.requireNonNull(indexName, "indexName is required");
java.util.Objects.requireNonNull(skipCount, "skipCount is required");
java.util.Objects.requireNonNull(pageSize, "pageSize is required");
LinkedHashMap params = new LinkedHashMap<>();
securityOrigin.ifPresent(p -> params.put("securityOrigin", p));
storageKey.ifPresent(p -> params.put("storageKey", p));
storageBucket.ifPresent(p -> params.put("storageBucket", p));
params.put("databaseName", databaseName);
params.put("objectStoreName", objectStoreName);
params.put("indexName", indexName);
params.put("skipCount", skipCount);
params.put("pageSize", pageSize);
keyRange.ifPresent(p -> params.put("keyRange", p));
return new Command<>("IndexedDB.requestData", Map.copyOf(params), input -> input.read(org.openqa.selenium.devtools.v123.indexeddb.IndexedDB.RequestDataResponse.class));
}
public static class GetMetadataResponse {
private final java.lang.Number entriesCount;
private final java.lang.Number keyGeneratorValue;
public GetMetadataResponse(java.lang.Number entriesCount, java.lang.Number keyGeneratorValue) {
this.entriesCount = java.util.Objects.requireNonNull(entriesCount, "entriesCount is required");
this.keyGeneratorValue = java.util.Objects.requireNonNull(keyGeneratorValue, "keyGeneratorValue is required");
}
/**
* the entries count
*/
public java.lang.Number getEntriesCount() {
return entriesCount;
}
/**
* the current value of key generator, to become the next inserted
* key into the object store. Valid if objectStore.autoIncrement
* is true.
*/
public java.lang.Number getKeyGeneratorValue() {
return keyGeneratorValue;
}
private static GetMetadataResponse fromJson(JsonInput input) {
java.lang.Number entriesCount = 0;
java.lang.Number keyGeneratorValue = 0;
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "entriesCount":
entriesCount = input.nextNumber();
break;
case "keyGeneratorValue":
keyGeneratorValue = input.nextNumber();
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new GetMetadataResponse(entriesCount, keyGeneratorValue);
}
}
/**
* Gets metadata of an object store.
*/
public static Command getMetadata(java.util.Optional securityOrigin, java.util.Optional storageKey, java.util.Optional storageBucket, java.lang.String databaseName, java.lang.String objectStoreName) {
java.util.Objects.requireNonNull(databaseName, "databaseName is required");
java.util.Objects.requireNonNull(objectStoreName, "objectStoreName is required");
LinkedHashMap params = new LinkedHashMap<>();
securityOrigin.ifPresent(p -> params.put("securityOrigin", p));
storageKey.ifPresent(p -> params.put("storageKey", p));
storageBucket.ifPresent(p -> params.put("storageBucket", p));
params.put("databaseName", databaseName);
params.put("objectStoreName", objectStoreName);
return new Command<>("IndexedDB.getMetadata", Map.copyOf(params), input -> input.read(org.openqa.selenium.devtools.v123.indexeddb.IndexedDB.GetMetadataResponse.class));
}
/**
* Requests database with given name in given frame.
*/
public static Command requestDatabase(java.util.Optional securityOrigin, java.util.Optional storageKey, java.util.Optional storageBucket, java.lang.String databaseName) {
java.util.Objects.requireNonNull(databaseName, "databaseName is required");
LinkedHashMap params = new LinkedHashMap<>();
securityOrigin.ifPresent(p -> params.put("securityOrigin", p));
storageKey.ifPresent(p -> params.put("storageKey", p));
storageBucket.ifPresent(p -> params.put("storageBucket", p));
params.put("databaseName", databaseName);
return new Command<>("IndexedDB.requestDatabase", Map.copyOf(params), ConverterFunctions.map("databaseWithObjectStores", org.openqa.selenium.devtools.v123.indexeddb.model.DatabaseWithObjectStores.class));
}
/**
* Requests database names for given security origin.
*/
public static Command> requestDatabaseNames(java.util.Optional securityOrigin, java.util.Optional storageKey, java.util.Optional storageBucket) {
LinkedHashMap params = new LinkedHashMap<>();
securityOrigin.ifPresent(p -> params.put("securityOrigin", p));
storageKey.ifPresent(p -> params.put("storageKey", p));
storageBucket.ifPresent(p -> params.put("storageBucket", p));
return new Command<>("IndexedDB.requestDatabaseNames", Map.copyOf(params), ConverterFunctions.map("databaseNames", input -> input.readArray(java.lang.String.class)));
}
}