Uses of Interface
eu.cloudnetservice.driver.document.Document

Packages that use Document

Package	Description
eu.cloudnetservice.driver
eu.cloudnetservice.driver.cluster
eu.cloudnetservice.driver.database
eu.cloudnetservice.driver.document
eu.cloudnetservice.driver.document.property
eu.cloudnetservice.driver.module
eu.cloudnetservice.driver.module.driver
eu.cloudnetservice.driver.provider
eu.cloudnetservice.driver.service

Uses of Document in eu.cloudnetservice.driver

Fields in eu.cloudnetservice.driver declared as Document

Modifier and Type	Field	Description
private final Document	DriverEnvironment.properties

Methods in eu.cloudnetservice.driver that return Document

Modifier and Type	Method	Description
@NonNull Document	DriverEnvironment.propertyHolder()	Get the underlying document that all read and write operations are delegated to.

Constructors in eu.cloudnetservice.driver with parameters of type Document

Modifier	Constructor	Description
	DriverEnvironment(@NonNull String name, @NonNull Document properties)	Constructs a new driver environment instance.

Uses of Document in eu.cloudnetservice.driver.cluster

Fields in eu.cloudnetservice.driver.cluster declared as Document

Modifier and Type	Field	Description
private final Document	NetworkClusterNode.properties
protected final Document	NodeInfoSnapshot.properties

Methods in eu.cloudnetservice.driver.cluster that return Document

Modifier and Type	Method	Description
@NonNull Document	NetworkClusterNode.propertyHolder()	Get the underlying document that all read and write operations are delegated to.
@NonNull Document	NodeInfoSnapshot.propertyHolder()	Get the underlying document that all read and write operations are delegated to.

Constructors in eu.cloudnetservice.driver.cluster with parameters of type Document

Modifier	Constructor	Description
	NetworkClusterNode(@NonNull String uniqueId, @NonNull List<HostAndPort> listeners, @NonNull Document properties)	Creates a new instance of a network cluster node.
	NodeInfoSnapshot(long creationTime, long startupMillis, int maxMemory, int usedMemory, int reservedMemory, int currentServicesCount, boolean drain, @NonNull NetworkClusterNode node, @NonNull CloudNetVersion version, @NonNull ProcessSnapshot processSnapshot, double maxCPUUsageToStartServices, @NonNull Collection<ModuleConfiguration> modules, @NonNull Document properties)	Constructs a new network cluster node info snapshot instance.

Uses of Document in eu.cloudnetservice.driver.database

Methods in eu.cloudnetservice.driver.database that return Document

Modifier and Type	Method	Description
@Nullable Document	Database.get(@NonNull String key)	Gets the associated document with the given key from the database.

Methods in eu.cloudnetservice.driver.database that return types with arguments of type Document

Modifier and Type	Method	Description
@NonNull Collection<Document>	Database.documents()	Get all values which are currently stored and mapped to a key in the database.
@NonNull CompletableFuture<Collection<Document>>	Database.documentsAsync()	Get all values which are currently stored and mapped to a key in the database.
@NonNull Map<String,Document>	Database.entries()	Get all key-value pairs which are currently stored in the database.
@NonNull CompletableFuture<Map<String,Document>>	Database.entriesAsync()	Get all key-value pairs which are currently stored in the database.
@NonNull Collection<Document>	Database.find(@NonNull String fieldName, @Nullable String fieldValue)	Searches for all entries in the database which value contains the given field and the field value matches the given value.
@NonNull Collection<Document>	Database.find(@NonNull Map<String,String> filters)	Searches for all entries in the database which contain each entry of the provided map.
@NonNull CompletableFuture<Collection<Document>>	Database.findAsync(@NonNull String fieldName, @Nullable String fieldValue)	Searches for all entries in the database which value contains the given field and the field value matches the given value.
@NonNull CompletableFuture<Collection<Document>>	Database.findAsync(@NonNull Map<String,String> filters)	Searches for all entries in the database which contain each entry of the provided map.
@NonNull CompletableFuture<Document>	Database.getAsync(@NonNull String key)	Gets the associated document with the given key from the database.

Methods in eu.cloudnetservice.driver.database with parameters of type Document

Modifier and Type	Method	Description
boolean	Database.insert(@NonNull String key, @NonNull Document document)	Associates the given key with the given document in the database.
@NonNull CompletableFuture<Boolean>	Database.insertAsync(@NonNull String key, @NonNull Document document)	Associates the given key with the given document in the database.

Uses of Document in eu.cloudnetservice.driver.document

Subinterfaces of Document in eu.cloudnetservice.driver.document

Modifier and Type	Interface	Description
static interface	Document.Mutable	A mutable version of a document.

Methods in eu.cloudnetservice.driver.document that return Document

Modifier and Type	Method	Description
@NonNull Document	Document.immutableCopy()	Makes an immutable copy of this document.
default @NonNull Document	Document.readDocument(@NonNull String key)	Reads a document of the same type from this document or returns an empty document if no value is associated with the given key.
@UnknownNullability Document	Document.readDocument(@NonNull String key, @Nullable Document def)	Reads a document of the same type from this document or returns an empty document if no value is associated with the given key.

Methods in eu.cloudnetservice.driver.document with parameters of type Document

Modifier and Type	Method	Description
Document.Mutable	Document.Mutable.append(@NonNull Document document)	Appends all key-value pairs of the given document into this document.
Document.Mutable	Document.Mutable.append(@NonNull String key, @Nullable Document value)	Appends the given document associated with the given key to this document.
@UnknownNullability Document	Document.readDocument(@NonNull String key, @Nullable Document def)	Reads a document of the same type from this document or returns an empty document if no value is associated with the given key.

Uses of Document in eu.cloudnetservice.driver.document.property

Methods in eu.cloudnetservice.driver.document.property that return Document

Modifier and Type	Method	Description
@NonNull Document	DocPropertyHolder.propertyHolder()	Get the underlying document that all read and write operations are delegated to.

Methods in eu.cloudnetservice.driver.document.property with parameters of type Document

Modifier and Type	Method	Description
E	DefaultingDocProperty.readFrom(@NonNull Document document)	Called to read the value of this property from the given document.
E	DocProperty.readFrom(@NonNull Document document)	Called to read the value of this property from the given document.
E	ReadOnlyDocProperty.readFrom(@NonNull Document document)	Called to read the value of this property from the given document.
O	RewritingDocProperty.readFrom(@NonNull Document document)	Called to read the value of this property from the given document.
E	StandardDocProperty.readFrom(@NonNull Document document)	Called to read the value of this property from the given document.

Method parameters in eu.cloudnetservice.driver.document.property with type arguments of type Document

Modifier and Type	Method	Description
default S	DefaultedDocPropertyHolder.Mutable.WithDirectModifier.modifyAndSetProperties(@NonNull Function<Document.Mutable, ? extends Document> modifier)	Applies the given operator to the underlying document and copies over all items from the underlying document into this holder.

Uses of Document in eu.cloudnetservice.driver.module

Fields in eu.cloudnetservice.driver.module declared as Document

Modifier and Type	Field	Description
private final @Nullable Document	ModuleConfiguration.properties	The field for the properties record component.

Methods in eu.cloudnetservice.driver.module that return Document

Modifier and Type	Method	Description
@Nullable Document	ModuleConfiguration.properties()	Returns the value of the properties record component.

Constructors in eu.cloudnetservice.driver.module with parameters of type Document

Modifier	Constructor	Description
	ModuleConfiguration(boolean runtimeModule, boolean storesSensitiveData, @NonNull String group, @NonNull String name, @NonNull String version, @NonNull String main, @Nullable String description, @Nullable String author, @Nullable String website, @Nullable String dataFolder, @Nullable ModuleRepository[] repositories, @Nullable ModuleDependency[] dependencies, int minJavaVersionId, @Nullable Document properties)	Creates an instance of a ModuleConfiguration record class.

Uses of Document in eu.cloudnetservice.driver.module.driver

Methods in eu.cloudnetservice.driver.module.driver that return Document

Modifier and Type	Method	Description
@NonNull Document	DriverModule.readConfig(@NonNull DocumentFactory factory)	Reads the configuration file of this module from the default or overridden configuration path (via module.json) into a json document, throwing an exception when the document is invalid.

Methods in eu.cloudnetservice.driver.module.driver with parameters of type Document

Modifier and Type	Method	Description
void	DriverModule.writeConfig(@NonNull Document config)	Writes the given configuration document to the default configuration path DriverModule.configPath().

Uses of Document in eu.cloudnetservice.driver.provider

Methods in eu.cloudnetservice.driver.provider with parameters of type Document

Modifier and Type	Method	Description
void	SpecificCloudServiceProvider.updateProperties(@NonNull Document properties)	Updates the properties of the current service info to include all properties set in the given document.
@NonNull CompletableFuture<Void>	SpecificCloudServiceProvider.updatePropertiesAsync(@NonNull Document properties)	Updates the properties of the current service info to include all properties set in the given document.

Uses of Document in eu.cloudnetservice.driver.service

Fields in eu.cloudnetservice.driver.service declared as Document

Modifier and Type	Field	Description
protected final Document	ServiceConfigurationBase.properties
protected Document	ServiceDeployment.Builder.properties
protected final Document	ServiceDeployment.properties
private Document	ServiceEnvironmentType.Builder.properties
private final Document	ServiceEnvironmentType.properties
protected final Document	ServiceInfoSnapshot.properties
protected Document	ServiceRemoteInclusion.Builder.properties
private final Document	ServiceRemoteInclusion.properties

Methods in eu.cloudnetservice.driver.service that return Document

Modifier and Type	Method	Description
@NonNull Document	ServiceConfigurationBase.propertyHolder()	Get the underlying document that all read and write operations are delegated to.
@NonNull Document	ServiceDeployment.propertyHolder()	Get the underlying document that all read and write operations are delegated to.
@NonNull Document	ServiceEnvironmentType.propertyHolder()	Get the underlying document that all read and write operations are delegated to.
@NonNull Document	ServiceInfoSnapshot.propertyHolder()	Get the underlying document that all read and write operations are delegated to.
@NonNull Document	ServiceRemoteInclusion.propertyHolder()	Get the underlying document that all read and write operations are delegated to.

Methods in eu.cloudnetservice.driver.service with parameters of type Document

Modifier and Type	Method	Description
B	ServiceConfigurationBase.Builder.properties(@NonNull Document properties)	The properties to apply to the underlying created configuration.
@NonNull ServiceDeployment.Builder	ServiceDeployment.Builder.properties(@NonNull Document properties)	Sets the properties of the deployment.
@NonNull ServiceEnvironmentType.Builder	ServiceEnvironmentType.Builder.properties(@NonNull Document properties)	Sets the properties of the service environment type.
@NonNull ServiceRemoteInclusion.Builder	ServiceRemoteInclusion.Builder.properties(@NonNull Document properties)	Sets the properties of the service remote inclusion.

Constructors in eu.cloudnetservice.driver.service with parameters of type Document

Modifier	Constructor	Description
protected	GroupConfiguration(@NonNull String name, @NonNull Set<String> jvmOptions, @NonNull Set<String> processParameters, @NonNull Map<String,String> environmentVariables, @NonNull Set<String> targetEnvironments, @NonNull Set<ServiceTemplate> templates, @NonNull Set<ServiceDeployment> deployments, @NonNull Set<ServiceRemoteInclusion> includes, @NonNull Document properties)	Constructs a new group configuration instance.
protected	ServiceConfiguration(@NonNull ServiceId serviceId, @NonNull ProcessConfiguration processConfig, @NonNull ServiceCreateRetryConfiguration retryConfiguration, int port, @NonNull String runtime, @Nullable String hostAddress, @Nullable String javaCommand, boolean autoDeleteOnStop, boolean staticService, @NonNull Set<String> groups, @NonNull Set<String> deletedFilesAfterStop, @NonNull Set<ServiceTemplate> templates, @NonNull Set<ServiceDeployment> deployments, @NonNull Set<ServiceRemoteInclusion> includes, @NonNull Document properties)	Constructs a new service configuration instance.
protected	ServiceConfigurationBase(@NonNull Set<ServiceTemplate> templates, @NonNull Set<ServiceDeployment> deployments, @NonNull Set<ServiceRemoteInclusion> includes, @NonNull Document properties)	Constructs a new service configuration base instance.
protected	ServiceDeployment(@NonNull ServiceTemplate template, @NonNull Collection<Pattern> excludes, @NonNull Collection<Pattern> includes, @NonNull Document properties)	Constructs a new service deployment instance.
private	ServiceEnvironmentType(@NonNull String name, int defaultServiceStartPort, @NonNull Set<String> defaultProcessArguments, @NonNull Document properties)	Constructs a new service environment type instance.
	ServiceInfoSnapshot(long creationTime, @NonNull HostAndPort address, @NonNull ProcessSnapshot processSnapshot, @NonNull ServiceConfiguration configuration, long connectedTime, @NonNull ServiceLifeCycle lifeCycle, @NonNull Document properties)	Constructs a new service info snapshot.
private	ServiceRemoteInclusion(@NonNull String url, @NonNull String destination, @NonNull String cacheStrategy, @NonNull Document properties)	Constructs a new service remote inclusion instance.
protected	ServiceTask(@NonNull String name, @NonNull String runtime, @Nullable String hostAddress, @Nullable String javaCommand, @NonNull String nameSplitter, boolean disableIpRewrite, boolean maintenance, boolean autoDeleteOnStop, boolean staticServices, @NonNull Set<String> groups, @NonNull Set<String> associatedNodes, @NonNull Set<String> deletedFilesAfterStop, @NonNull ProcessConfiguration processConfiguration, int startPort, int minServiceCount, @NonNull Set<ServiceTemplate> templates, @NonNull Set<ServiceDeployment> deployments, @NonNull Set<ServiceRemoteInclusion> includes, @NonNull Document properties)	Constructs a new service task instance.