sila_java.library.server_base

Class SiLAServer.Builder

java.lang.Object

sila_java.library.server_base.SiLAServer.Builder

Enclosing class:

SiLAServer

public static class SiLAServer.Builder
extends Object

Server Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SiLAServer.Builder.BinaryDatabaseProvider
static interface	SiLAServer.Builder.ConfigWrapperProvider

Method Summary

Modifier and Type	Method and Description
SiLAServer.Builder	addFCPAffectedByMetadata(@NonNull String FCPAffectedByMetadata, String... FQIMetadata) Very early stage API to specify FCP Affected by Metadata will most likely be changed in the future
SiLAServer.Builder	addFeature(@NonNull FeatureImplementation featureImplementation) Add a Feature to be exposed
SiLAServer.Builder	addFeature(@NonNull String featureDescription, @NonNull BindableService featureService) Add a Feature to be exposed
SiLAServer.Builder	addFeature(@NonNull String featureDescription, @NonNull ServerServiceDefinition serverServiceFeatureDefinition) Add a Feature to be exposed
SiLAServer.Builder	addInterceptor(@NonNull ServerInterceptor interceptor) Add a gRPC ServerInterceptor to the server
Map<String,String>	getFeatureDefinitions()
IServerConfigWrapper	getNewServerConfigurationWrapper() Get a new server configuration wrapper instance
static SiLAServer.Builder	newBuilder(@NonNull ServerInformation serverInformation) Create builder for a Server
SiLAServer.Builder	removeFCPAffectedByMetadata(@NonNull String FCPAffectedByMetadata, String... FQIMetadata) Very early stage API to remove FCP Affected by Metadata will most likely be changed in the future
SiLAServer	start() Starts and Creates the SiLA Server
SiLAServer.Builder	withBinaryDatabaseInjector() Add a BinaryDatabaseInjector to the server so the BinaryDatabase is easily accessible to feature implementations
SiLAServer.Builder	withBinaryTransferSupport() Enable support for binary transfer
SiLAServer.Builder	withBinaryTransferSupport(boolean binaryTransferSupport) Enable or disable support for binary transfer
SiLAServer.Builder	withCustomBinaryDatabaseProvider(SiLAServer.Builder.BinaryDatabaseProvider customBinaryDatabaseProvider) Allows to set a custom binary database instead of the default one.
SiLAServer.Builder	withCustomConfigWrapperProvider(SiLAServer.Builder.ConfigWrapperProvider customConfigWrapperProvider) Allows to set a custom configuration wrapper instead of the default one
SiLAServer.Builder	withDefaultServerConfiguration(ServerConfiguration defaultServerConfiguration) Define the default server configuration.
SiLAServer.Builder	withDiscovery(@NonNull boolean isEnabled) Enables or disables Network Discovery
SiLAServer.Builder	withHost(String host) Define the host or IP address on which the services will be exclusively served on.
SiLAServer.Builder	withMetadataExtractingInterceptor() Add a MetadataExtractingInterceptor to the server
SiLAServer.Builder	withName(String name) Define the server name.
SiLAServer.Builder	withNetworkInterface(@NonNull String interfaceName) Enables Discovery on a certain interface
SiLAServer.Builder	withoutDiscovery() Disables Network Discovery
SiLAServer.Builder	withPersistentConfig() Allows to specify whether the server configuration should be persisted.
SiLAServer.Builder	withPersistentConfig(boolean usePersistentConfig) Allows to specify whether the server configuration should be persisted.
SiLAServer.Builder	withPersistentConfigFile(Path persistentConfigFile) Allows to specify the file to save and or load the server configuration
SiLAServer.Builder	withPersistentTLS(@NonNull Path privateKeyFile, @NonNull Path certificateFile) Use persistent TLS credentials.
SiLAServer.Builder	withPersistentTLS(@NonNull Path privateKeyFile, @NonNull Path certificateFile, String certificatePassword) Use persistent TLS credentials.
SiLAServer.Builder	withPort(int port) Define Specific Port for the services (otherwise a default range will be chosen)
SiLAServer.Builder	withTLS(@NonNull X509Certificate certChain, @NonNull PrivateKey privateKey) Use TLS certification
SiLAServer.Builder	withUnsafeCommunication(boolean unsafeCommunication) Deprecated. Unsafe plain-text communication is forbidden by the SiLA 2 Standard
SiLAServer.Builder	withUUID(UUID uuid) Define the server UUID.

Methods inherited from class java.lang.Object

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

Method Detail

getFeatureDefinitions

public Map<String,String> getFeatureDefinitions()

withDiscovery

public SiLAServer.Builder withDiscovery(@NonNull
                                        @NonNull boolean isEnabled)

Enables or disables Network Discovery

Parameters:

isEnabled - true to enable network discovery

withoutDiscovery

public SiLAServer.Builder withoutDiscovery()

Disables Network Discovery

withNetworkInterface

public SiLAServer.Builder withNetworkInterface(@NonNull
                                               @NonNull String interfaceName)

Enables Discovery on a certain interface

Parameters:

interfaceName - Name of network interface to use discovery

withPort

public SiLAServer.Builder withPort(int port)

Define Specific Port for the services (otherwise a default range will be chosen)

Parameters:

port - Port on which the server runs.

withHost

public SiLAServer.Builder withHost(@Nullable
                                   String host)

Define the host or IP address on which the services will be exclusively served on.

Parameters:

host - host or IP address on which the server runs.

withName

public SiLAServer.Builder withName(@Nullable
                                   String name)

Define the server name. Setting this will override previously persisted server name.

Returns:

this builder

withUUID

public SiLAServer.Builder withUUID(@Nullable
                                   UUID uuid)

Define the server UUID. Setting this will override previously persisted server UUID.

Returns:

this builder

withDefaultServerConfiguration

public SiLAServer.Builder withDefaultServerConfiguration(@Nullable
                                                         ServerConfiguration defaultServerConfiguration)

Define the default server configuration. Setting this will not override previously persisted server configuration.

Returns:

this builder

withUnsafeCommunication

public SiLAServer.Builder withUnsafeCommunication(boolean unsafeCommunication)

Deprecated. Unsafe plain-text communication is forbidden by the SiLA 2 Standard

withBinaryTransferSupport

public SiLAServer.Builder withBinaryTransferSupport(boolean binaryTransferSupport)

Enable or disable support for binary transfer

Returns:

this builder

withBinaryDatabaseInjector

public SiLAServer.Builder withBinaryDatabaseInjector()

Add a BinaryDatabaseInjector to the server so the BinaryDatabase is easily accessible to feature implementations

Returns:

this builder

withBinaryTransferSupport

public SiLAServer.Builder withBinaryTransferSupport()

Enable support for binary transfer

Returns:

this builder

withCustomBinaryDatabaseProvider

public SiLAServer.Builder withCustomBinaryDatabaseProvider(@Nullable
                                                           SiLAServer.Builder.BinaryDatabaseProvider customBinaryDatabaseProvider)

Allows to set a custom binary database instead of the default one. The provider is responsible for closing the database.

Parameters:

customBinaryDatabaseProvider - The SiLAServer.Builder.BinaryDatabaseProvider to set

Returns:

this builder

addFeature

public SiLAServer.Builder addFeature(@NonNull
                                     @NonNull String featureDescription,
                                     @NonNull
                                     @NonNull BindableService featureService)

Add a Feature to be exposed

Parameters:

featureDescription - Feature Description as String Content in XML

featureService - Feature Service implemented with gRPC

Implementation Note:

Unfortunately there is no straightforward way to validate the pure protobuf descriptions and the generated gRPC descriptions.

addFCPAffectedByMetadata

public SiLAServer.Builder addFCPAffectedByMetadata(@NonNull
                                                   @NonNull String FCPAffectedByMetadata,
                                                   @NonNull
                                                   String... FQIMetadata)

Very early stage API to specify FCP Affected by Metadata will most likely be changed in the future

Parameters:

FCPAffectedByMetadata - The fully qualified feature or command or property identifier affected

FQIMetadata - The fully qualified metadata affecting the feature or command or property

Returns:

this builder

removeFCPAffectedByMetadata

public SiLAServer.Builder removeFCPAffectedByMetadata(@NonNull
                                                      @NonNull String FCPAffectedByMetadata,
                                                      @NonNull
                                                      String... FQIMetadata)

Very early stage API to remove FCP Affected by Metadata will most likely be changed in the future

Parameters:

FCPAffectedByMetadata - The fully qualified feature or command or property identifier affected

FQIMetadata - The fully qualified metadata affecting the feature or command or property

Returns:

this builder

addFeature

public SiLAServer.Builder addFeature(@NonNull
                                     @NonNull FeatureImplementation featureImplementation)

Add a Feature to be exposed

Parameters:

featureImplementation - Exposing both the description and implementation

addFeature

public SiLAServer.Builder addFeature(@NonNull
                                     @NonNull String featureDescription,
                                     @NonNull
                                     @NonNull ServerServiceDefinition serverServiceFeatureDefinition)

Add a Feature to be exposed

Parameters:

featureDescription - Feature Description as String Content in XML

serverServiceFeatureDefinition - Server service definition feature implemented with gRPC

start

public SiLAServer start()
                 throws IOException

Starts and Creates the SiLA Server

Returns:

SiLA Server

Throws:

IOException

withTLS

public SiLAServer.Builder withTLS(@NonNull
                                  @NonNull X509Certificate certChain,
                                  @NonNull
                                  @NonNull PrivateKey privateKey)

Use TLS certification

Parameters:

certChain - InputStream certification

privateKey - InputStream private key

withPersistentTLS

public SiLAServer.Builder withPersistentTLS(@NonNull
                                            @NonNull Path privateKeyFile,
                                            @NonNull
                                            @NonNull Path certificateFile,
                                            @Nullable
                                            String certificatePassword)

Use persistent TLS credentials. Will create a self-signed certificate if both file are missing

Parameters:

certificateFile - Path to the private key PEM file

privateKeyFile - Path to the certificate PEM file

certificatePassword - Password of the certificate if any

withPersistentTLS

public SiLAServer.Builder withPersistentTLS(@NonNull
                                            @NonNull Path privateKeyFile,
                                            @NonNull
                                            @NonNull Path certificateFile)

Use persistent TLS credentials. Will create a self-signed certificate if both file are missing

Parameters:

certificateFile - Path to the private key PEM file

privateKeyFile - Path to the certificate PEM file

addInterceptor

public SiLAServer.Builder addInterceptor(@NonNull
                                         @NonNull ServerInterceptor interceptor)

Add a gRPC ServerInterceptor to the server

Parameters:

interceptor - The ServerInterceptor to add

Returns:

this builder

withCustomConfigWrapperProvider

public SiLAServer.Builder withCustomConfigWrapperProvider(@Nullable
                                                          SiLAServer.Builder.ConfigWrapperProvider customConfigWrapperProvider)

Allows to set a custom configuration wrapper instead of the default one

Parameters:

customConfigWrapperProvider - The SiLAServer.Builder.ConfigWrapperProvider to set

Returns:

this builder

withPersistentConfig

public SiLAServer.Builder withPersistentConfig(boolean usePersistentConfig)

Allows to specify whether the server configuration should be persisted. If no config file is set via withPersistentConfigFile(Path), the file "server.cfg" will be used.

Parameters:

usePersistentConfig - The boolean

Returns:

this builder

withPersistentConfig

public SiLAServer.Builder withPersistentConfig()

Allows to specify whether the server configuration should be persisted. If no config file is set via withPersistentConfigFile(Path), the file "server.cfg" will be used.

Returns:

this builder

withPersistentConfigFile

public SiLAServer.Builder withPersistentConfigFile(Path persistentConfigFile)

Allows to specify the file to save and or load the server configuration

Parameters:

persistentConfigFile - The path to save and or load the server configuration

Returns:

this builder

withMetadataExtractingInterceptor

public SiLAServer.Builder withMetadataExtractingInterceptor()

Add a MetadataExtractingInterceptor to the server

Returns:

this builder

Implementation Note:

The order of added interceptors is preserved. Thus, interceptors added with addInterceptor(ServerInterceptor) before this method precede the MetadataExtractingInterceptor in the call handling chain.

newBuilder

public static SiLAServer.Builder newBuilder(@NonNull
                                            @NonNull ServerInformation serverInformation)
                                     throws IOException

Create builder for a Server

Parameters:

serverInformation - Meta server information defined by the server implementer

Throws:

IOException

getNewServerConfigurationWrapper

public IServerConfigWrapper getNewServerConfigurationWrapper()
                                                      throws IOException

Get a new server configuration wrapper instance

Returns:

a new server configuration wrapper instance

Throws:

IOException