Package org.glassfish.jersey.server

Class JerseySeBootstrapConfiguration

java.lang.Object

org.glassfish.jersey.server.JerseySeBootstrapConfiguration

All Implemented Interfaces:

SeBootstrap.Configuration

public final class JerseySeBootstrapConfiguration
extends Object
implements SeBootstrap.Configuration

Jersey implementation of SeBootstrap.Configuration implementing arbitrary methods for acquiring the configuration settings.

Since:

3.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JerseySeBootstrapConfiguration.Builder

Nested classes/interfaces inherited from interface jakarta.ws.rs.SeBootstrap.Configuration

SeBootstrap.Configuration.SSLClientAuthentication

Field Summary

Fields

Modifier and Type	Field	Description
protected static Random	RANDOM

Fields inherited from interface jakarta.ws.rs.SeBootstrap.Configuration

DEFAULT_PORT, FREE_PORT, HOST, PORT, PROTOCOL, ROOT_PATH, SSL_CLIENT_AUTHENTICATION, SSL_CONTEXT

Method Summary

Modifier and Type	Method	Description
boolean	allowPrivilegedPorts()	Defines if the WebServer should start on a privileged port when port is not set.
boolean	autoStart()	Defines if the WebServer should automatically start.
static JerseySeBootstrapConfiguration.Builder	builder()	Return a Jersey instance of SeBootstrap.Configuration.Builder with prefilled values.
static JerseySeBootstrapConfiguration	from(SeBootstrap.Configuration configuration)	Factory method creating JerseySeBootstrapConfiguration wrapper around SeBootstrap.Configuration.
boolean	isHttps()	If the protocol schema is HTTPS, return true.
Object	property(String name)	Returns the value of the property with the given name, or null if there is no property of that name.
SSLContext	sslContext()	Return SSLContext in the configuration if the protocol scheme is HTTPS.
URI	uri(boolean resolveDefaultPort)	Compose URI based on properties defined in this configuration.

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

baseUri, baseUriBuilder, hasProperty, host, port, protocol, rootPath, sslClientAuthentication

Field Detail

RANDOM

protected static final Random RANDOM

Method Detail

property

public Object property(String name)

Description copied from interface: SeBootstrap.Configuration

Returns the value of the property with the given name, or null if there is no property of that name.

Specified by:

property in interface SeBootstrap.Configuration

Parameters:

name - a String specifying the name of the property.

Returns:

an Object containing the value of the property, or null if no property exists matching the given name.

uri

public URI uri(boolean resolveDefaultPort)

Compose URI based on properties defined in this configuration.

Parameters:

resolveDefaultPort - if true the port is not set, it is resolved as Container.DEFAULT_HTTP_PORT or Container.DEFAULT_HTTPS_PORT based on the protocol scheme.

Returns:

Composed URI based on properties defined in this configuration.

sslContext

public SSLContext sslContext()

Return SSLContext in the configuration if the protocol scheme is HTTPS.

Specified by:

sslContext in interface SeBootstrap.Configuration

Returns:

the SSLContext in the configuration.

See Also:

SeBootstrap.Configuration.SSL_CONTEXT

isHttps

public boolean isHttps()

If the protocol schema is HTTPS, return true.

Returns:

true when the protocol schema is HTTPS.

autoStart

public boolean autoStart()

Defines if the WebServer should automatically start.

Returns:

false if ServerProperties.WEBSERVER_AUTO_START is false, true otherwise.

allowPrivilegedPorts

public boolean allowPrivilegedPorts()

Defines if the WebServer should start on a privileged port when port is not set.

Returns:

true if ServerProperties.WEBSERVER_AUTO_START is true, false otherwise.

from

public static JerseySeBootstrapConfiguration from(SeBootstrap.Configuration configuration)

Factory method creating JerseySeBootstrapConfiguration wrapper around SeBootstrap.Configuration.

Parameters:

configuration - wrapped configuration

Returns:

JerseySeBootstrapConfiguration wrapper around SeBootstrap.Configuration.

builder

public static JerseySeBootstrapConfiguration.Builder builder()

Return a Jersey instance of SeBootstrap.Configuration.Builder with prefilled values.

Returns:

a Jersey instance of SeBootstrap.Configuration.Builder.