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

Method Summary

Modifier and Type	Method and Description
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
Map<String,String>	getFeatureDefinitions()
SiLAServer	start() Starts and Creates the SiLA Server
BinaryDatabase	withBinaryTransferSupport() Enable support for binary transfer by creating and using the default H2 binary transfer database implementation
SiLAServer.Builder	withBinaryTransferSupport(@NonNull BinaryDatabase binarySupportImpl) Enable support for binary transfer
static SiLAServer.Builder	withConfig(@NonNull Path configurationFile, @NonNull ServerInformation serverInformation) Create builder for a Server with a persistent configuration file
SiLAServer.Builder	withDiscovery(@NonNull String interfaceName) Enables Discovery on a certain interface
static SiLAServer.Builder	withoutConfig(@NonNull ServerInformation serverInformation) Create builder for a Server with a non-persistent configuration
SiLAServer.Builder	withPersistedTLS(@NonNull Path privateKeyFile, @NonNull Path certificateFile, String certificatePassword) Use Persisted TLS certification.
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

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 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.

withBinaryTransferSupport

public SiLAServer.Builder withBinaryTransferSupport(@NonNull
                                                    @NonNull BinaryDatabase binarySupportImpl)

Enable support for binary transfer

withUnsafeCommunication

public SiLAServer.Builder withUnsafeCommunication(boolean unsafeCommunication)

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

withBinaryTransferSupport

public BinaryDatabase withBinaryTransferSupport()

Enable support for binary transfer by creating and using the default H2 binary transfer database implementation

Returns:

the created binary database

See Also:

H2BinaryDatabase

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.

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

withPersistedTLS

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

Use Persisted TLS certification. 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

withoutConfig

public static SiLAServer.Builder withoutConfig(@NonNull
                                               @NonNull ServerInformation serverInformation)

Create builder for a Server with a non-persistent configuration

Parameters:

serverInformation - Meta server information defined by the server implementer

withConfig

public static SiLAServer.Builder withConfig(@NonNull
                                            @NonNull Path configurationFile,
                                            @NonNull
                                            @NonNull ServerInformation serverInformation)
                                     throws IOException

Create builder for a Server with a persistent configuration file

Parameters:

configurationFile - The file persisting the server name and UUID data for that server instance

serverInformation - Meta server information defined by the server implementer

Throws:

IOException