Class DefaultChunkedFileQueryBuilder

java.lang.Object

eu.cloudnetservice.driver.network.chunk.defaults.builder.DefaultChunkedFileQueryBuilder

All Implemented Interfaces:

ChunkedFileQueryBuilder

public class DefaultChunkedFileQueryBuilder
extends Object
implements ChunkedFileQueryBuilder

Default implementation of a builder for a file query from a remote network component.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private int	chunkSize
private String	dataIdentifier
private ChannelMessageTarget	dataSource
private static final DataBuf	EMPTY_BUFFER
private Consumer<DataBuf.Mutable>	messageBufferConfigurator

Constructor Summary

Constructors

Constructor	Description
DefaultChunkedFileQueryBuilder()

Method Summary

Modifier and Type	Method	Description
@NonNull ChunkedFileQueryBuilder	chunkSize(int chunkSize)	The size of the chunks in bytes that will be transferred from the remote to the caller.
@NonNull ChunkedFileQueryBuilder	configureMessageBuffer(@NonNull Consumer<DataBuf.Mutable> bufferConfigurer)	A consumer that is called when the actual request is sent to the data source.
@NonNull ChunkedFileQueryBuilder	dataIdentifier(@NonNull String dataIdentifier)	The identifier for the data should be transferred from the remote to the caller.
@NonNull CompletableFuture<InputStream>	query()	Queries the data from the remote and completes with an input stream when the transmission was successful.
@NonNull CompletableFuture<Path>	queryToPath(@NonNull Path target)	Queries the data from the remote and redirects it into the given file path.
@NonNull CompletableFuture<Path>	queryToTempFile()	Queries the data from the remote and redirects it into a temporary file.
@NonNull ChunkedFileQueryBuilder	requestFromNode(@NonNull String nodeId)	Sets that the file data should be requested from the node with the given id.
@NonNull ChunkedFileQueryBuilder	requestFromService(@NonNull String serviceName)	Sets that the file data should be requested from the service with the given name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EMPTY_BUFFER

private static final DataBuf EMPTY_BUFFER

dataIdentifier

private String dataIdentifier

dataSource

private ChannelMessageTarget dataSource

messageBufferConfigurator

private Consumer<DataBuf.Mutable> messageBufferConfigurator

chunkSize

private int chunkSize

Constructor Details

DefaultChunkedFileQueryBuilder

public DefaultChunkedFileQueryBuilder()

Method Details

chunkSize

@NonNull
public @NonNull ChunkedFileQueryBuilder chunkSize(int chunkSize)

The size of the chunks in bytes that will be transferred from the remote to the caller.

Specified by:

chunkSize in interface ChunkedFileQueryBuilder

Parameters:

chunkSize - the size of the chunks that should be transferred from the remote to the caller.

Returns:

this builder, for chaining.

dataIdentifier

@NonNull
public @NonNull ChunkedFileQueryBuilder dataIdentifier(@NonNull
 @NonNull String dataIdentifier)

The identifier for the data should be transferred from the remote to the caller.

Specified by:

dataIdentifier in interface ChunkedFileQueryBuilder

Parameters:

dataIdentifier - the identifier of the data that should be transferred.

Returns:

this builder, for chaining.

requestFromNode

@NonNull
public @NonNull ChunkedFileQueryBuilder requestFromNode(@NonNull
 @NonNull String nodeId)

Sets that the file data should be requested from the node with the given id. Note: the source must be directly available to the caller, else the data will never reach the caller.

Specified by:

requestFromNode in interface ChunkedFileQueryBuilder

Parameters:

nodeId - the id of the node to request the data from.

Returns:

this builder, for chaining.

requestFromService

@NonNull
public @NonNull ChunkedFileQueryBuilder requestFromService(@NonNull
 @NonNull String serviceName)

Sets that the file data should be requested from the service with the given name. Note: the source must be directly available to the caller, else the data will never reach the caller.

Specified by:

requestFromService in interface ChunkedFileQueryBuilder

Parameters:

serviceName - the name of the service to request the data from.

Returns:

this builder, for chaining.

configureMessageBuffer

@NonNull
public @NonNull ChunkedFileQueryBuilder configureMessageBuffer(@NonNull
 @NonNull Consumer<DataBuf.Mutable> bufferConfigurer)

A consumer that is called when the actual request is sent to the data source. The consumer can append additional information to the buffer that is relevant for the remote side to identify the data to transmit.

Specified by:

configureMessageBuffer in interface ChunkedFileQueryBuilder

Parameters:

bufferConfigurer - the configurator for additional transmitted information about the request.

Returns:

this builder, for chaining.

query

@NonNull
public @NonNull CompletableFuture<InputStream> query()

Queries the data from the remote and completes with an input stream when the transmission was successful.

Specified by:

query in interface ChunkedFileQueryBuilder

Returns:

a future completed with an input stream of the transmitted data.

queryToTempFile

@NonNull
public @NonNull CompletableFuture<Path> queryToTempFile()

Queries the data from the remote and redirects it into a temporary file. The path to the file is wrapped in the returned future.

Specified by:

queryToTempFile in interface ChunkedFileQueryBuilder

Returns:

a future completed with the path to which the transmitted contents were written.

queryToPath

@NonNull
public @NonNull CompletableFuture<Path> queryToPath(@NonNull
 @NonNull Path target)

Queries the data from the remote and redirects it into the given file path.

Specified by:

queryToPath in interface ChunkedFileQueryBuilder

Parameters:

target - the path to the file into which the response data should be written.

Returns:

a future completed with the path to which the transmitted contents were written.