Package org.glassfish.jersey.server

Class JerseySeBootstrapConfiguration.Builder

java.lang.Object

org.glassfish.jersey.server.JerseySeBootstrapConfiguration.Builder

All Implemented Interfaces:

SeBootstrap.Configuration.Builder

Enclosing class:

JerseySeBootstrapConfiguration

public static final class JerseySeBootstrapConfiguration.Builder
extends Object
implements SeBootstrap.Configuration.Builder

Method Summary

Modifier and Type	Method	Description
JerseySeBootstrapConfiguration.Builder	autoStart(Boolean autostart)	Define if the WebServer should auto-start at bootstrap.
JerseySeBootstrapConfiguration	build()	Builds a bootstrap configuration instance from the provided property values.
JerseySeBootstrapConfiguration.Builder	from(Object externalConfig)	Optional convenience method to bulk-load external configuration.
<T> JerseySeBootstrapConfiguration.Builder	from(BiFunction<String,Class<T>,Optional<T>> configProvider)	Convenience method for bulk-loading configuration from a property supplier.
JerseySeBootstrapConfiguration.Builder	property(String name, Object value)	Sets the property name to the provided value.
JerseySeBootstrapConfiguration.Builder	webServerClass(Class<? extends WebServer> webServerClass)	Set the the respective WebServer class to be used by the WebServerProvider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

host, port, protocol, rootPath, sslClientAuthentication, sslContext

Method Detail

build

public JerseySeBootstrapConfiguration build()

Description copied from interface: SeBootstrap.Configuration.Builder

Builds a bootstrap configuration instance from the provided property values.

Specified by:

build in interface SeBootstrap.Configuration.Builder

Returns:

SeBootstrap.Configuration built from provided property values.

property

public JerseySeBootstrapConfiguration.Builder property(String name,
                                                       Object value)

Description copied from interface: SeBootstrap.Configuration.Builder

Sets the property name to the provided value.

This method does not check the validity, type or syntax of the provided value.

Specified by:

property in interface SeBootstrap.Configuration.Builder

Parameters:

name - name of the parameter to set.

value - value to set, or null to use the default value.

Returns:

the updated builder.

webServerClass

public JerseySeBootstrapConfiguration.Builder webServerClass(Class<? extends WebServer> webServerClass)

Set the the respective WebServer class to be used by the WebServerProvider.

Parameters:

webServerClass - the class implementing WebServer.

Returns:

the updated builder.

autoStart

public JerseySeBootstrapConfiguration.Builder autoStart(Boolean autostart)

Define if the WebServer should auto-start at bootstrap.

Parameters:

autostart - the auto-start flag.

Returns:

the updated builder.

from

public <T> JerseySeBootstrapConfiguration.Builder from(BiFunction<String,Class<T>,Optional<T>> configProvider)

Description copied from interface: SeBootstrap.Configuration.Builder

Convenience method for bulk-loading configuration from a property supplier.

Implementations ask the passed provider function for the actual values of all their supported properties, before returning from this configuration method. For each single request the implementation provides the name of the property and the expected data type of the value. If no such property exists (i. e. either the name is unknown or misspelled, or the type does not exactly match), the Optional is empty.

Specified by:

from in interface SeBootstrap.Configuration.Builder

Type Parameters:

T - Type of the requested property value.

Parameters:

configProvider - Retrieval function of externally managed properties. MUST NOT return null.

Returns:

the updated builder.

from

public JerseySeBootstrapConfiguration.Builder from(Object externalConfig)

Description copied from interface: SeBootstrap.Configuration.Builder

Optional convenience method to bulk-load external configuration.

Implementations are free to support any external configuration mechanics, or none at all. It is completely up to the implementation what set of properties is effectively loaded from the provided external configuration, possibly none at all.

If the passed external configuration mechanics is unsupported, this method MUST simply do nothing.

Portable applications should not call this method, as the outcome is completely implementation-specific.

Specified by:

from in interface SeBootstrap.Configuration.Builder

Parameters:

externalConfig - source of externally managed properties

Returns:

the updated builder.