software.chronicle.datagrid

Interface ServerBuilder

All Known Implementing Classes:

VanillaServerBuilder

public interface ServerBuilder

Method Summary

Modifier and Type	Method and Description
AssetTree	build() Creates and returns an AssetTree representing a started server.
static ServerBuilder	create(byte hostId, String yamlConfigFile)
ServerBuilder	withCluster(@NotNull String cluster) Sets the cluster for this builder.
ServerBuilder	withHomeDirectory(@NotNull String homeDirectory) Sets the location where the server shall have is "home directory".
ServerBuilder	withRegion(@NotNull String region) Sets the region for this builder.
ServerBuilder	withSkipWelcomeMessage() Sets that the welcome message and settings should be skipped upon build.

Method Detail

withCluster

ServerBuilder withCluster(@NotNull
                          @NotNull String cluster)

Sets the cluster for this builder.

The builder's default cluster is no cluster (null) specified. No cluster means that if there is only one cluster, that one will be selected. If there are several clusters an Exception will be thrown upon build()

Parameters:

cluster - to set

Returns:

this builder

withRegion

ServerBuilder withRegion(@NotNull
                         @NotNull String region)

Sets the region for this builder.

The builder's default region is ""

Parameters:

region - to set

Returns:

this builder

withHomeDirectory

ServerBuilder withHomeDirectory(@NotNull
                                @NotNull String homeDirectory)

Sets the location where the server shall have is "home directory".

The default value is "." making the current directory the home directory

Parameters:

homeDirectory - to set

Returns:

this builder

withSkipWelcomeMessage

ServerBuilder withSkipWelcomeMessage()

Sets that the welcome message and settings should be skipped upon build.

Returns:

this builder

build

AssetTree build()

Creates and returns an AssetTree representing a started server.

Returns:

an AssetTree representing a started server

create

static ServerBuilder create(byte hostId,
                            String yamlConfigFile)