Package eu.cloudnetservice.driver.service

Class ServiceRemoteInclusion

java.lang.Object

eu.cloudnetservice.driver.service.ServiceRemoteInclusion

All Implemented Interfaces:

eu.cloudnetservice.common.document.property.DefaultedDocPropertyHolder<eu.cloudnetservice.common.document.gson.JsonDocument,ServiceRemoteInclusion>, eu.cloudnetservice.common.document.property.DocPropertyHolder<eu.cloudnetservice.common.document.gson.JsonDocument,ServiceRemoteInclusion>, Cloneable

public final class ServiceRemoteInclusion
extends Object
implements eu.cloudnetservice.common.document.property.DefaultedDocPropertyHolder<eu.cloudnetservice.common.document.gson.JsonDocument,ServiceRemoteInclusion>, Cloneable

An inclusion which can be added to a service and will download a file from the specified url to the given destination. This can be anything for example a plugin or configuration file.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceRemoteInclusion.Builder	A builder for a service remote inclusion.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	destination
static final eu.cloudnetservice.common.document.property.DocProperty<eu.cloudnetservice.common.document.gson.JsonDocument>	HEADERS	A property which can be added to a service inclusion to set the http headers to send when making the download http request.
private final eu.cloudnetservice.common.document.gson.JsonDocument	properties
private final String	url

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ServiceRemoteInclusion(@NonNull String url, @NonNull String destination, @NonNull eu.cloudnetservice.common.document.gson.JsonDocument properties)	Constructs a new service remote inclusion instance.

Method Summary

Modifier and Type	Method	Description
static @NonNull ServiceRemoteInclusion.Builder	builder()	Constructs a new builder instance for a service remote inclusion.
static @NonNull ServiceRemoteInclusion.Builder	builder(@NonNull ServiceRemoteInclusion inclusion)	Constructs a new builder for a service remote inclusion which has the properties of the given inclusion already set.
@NonNull ServiceRemoteInclusion	clone()
@NonNull String	destination()	The target file name of the inclusion download.
@NonNull eu.cloudnetservice.common.document.gson.JsonDocument	propertyHolder()
@NonNull String	toString()
@NonNull String	url()	Get the url to download the remote inclusion from.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cloudnetservice.common.document.property.DefaultedDocPropertyHolder

propertyAbsent, propertyPresent, readProperty, readPropertyOrDefault, readPropertyOrGet, readPropertyOrThrow, readPropertyOrThrow, removeProperty, writeProperty, writePropertyIfAbsent, writePropertyIfAbsent, writePropertyIfPresent, writePropertyIfPresent

Field Details

HEADERS

public static final eu.cloudnetservice.common.document.property.DocProperty<eu.cloudnetservice.common.document.gson.JsonDocument> HEADERS

A property which can be added to a service inclusion to set the http headers to send when making the download http request. All key-value pairs of the given document will be set as headers in the request.

url

private final String url

destination

private final String destination

properties

private final eu.cloudnetservice.common.document.gson.JsonDocument properties

Constructor Details

ServiceRemoteInclusion

private ServiceRemoteInclusion(@NonNull
 @NonNull String url,
 @NonNull
 @NonNull String destination,
 @NonNull
 @NonNull eu.cloudnetservice.common.document.gson.JsonDocument properties)

Constructs a new service remote inclusion instance.

Parameters:

url - the url to download the associated file from.

destination - the destination inside the service directory to copy the downloaded file to.

properties - the properties of the remote inclusion, these can for example contain the http headers to send.

Throws:

NullPointerException - if one of the given parameters is null.

Method Details

builder

@NonNull
public static @NonNull ServiceRemoteInclusion.Builder builder()

Constructs a new builder instance for a service remote inclusion.

Returns:

a new service remote inclusion builder.

builder

@NonNull
public static @NonNull ServiceRemoteInclusion.Builder builder(@NonNull
 @NonNull ServiceRemoteInclusion inclusion)

Constructs a new builder for a service remote inclusion which has the properties of the given inclusion already set.

When calling build directly after constructing a builder using this method, it will result in a service remote inclusion which is equal but not the same as the given one.

Parameters:

inclusion - the inclusion to copy the properties of.

Returns:

a new service remote inclusion builder with the properties of the given one already set.

Throws:

NullPointerException - if the given inclusion is null.

url

@NonNull
public @NonNull String url()

Get the url to download the remote inclusion from. The only supported schemes are http and https by default.

Returns:

the download url of the remote inclusion.

destination

@NonNull
public @NonNull String destination()

The target file name of the inclusion download. An inclusion destination which is outside the service directory will result in an exception.

Returns:

the destination of the downloaded inclusion file.

propertyHolder

@NonNull
public @NonNull eu.cloudnetservice.common.document.gson.JsonDocument propertyHolder()

Specified by:

propertyHolder in interface eu.cloudnetservice.common.document.property.DocPropertyHolder<eu.cloudnetservice.common.document.gson.JsonDocument,ServiceRemoteInclusion>

toString

@NonNull
public @NonNull String toString()

Overrides:

toString in class Object

clone

@NonNull
public @NonNull ServiceRemoteInclusion clone()

Overrides:

clone in class Object