Tyrus 2.2.0 · org.glassfish.tyrus.server.Server · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private final Set<Class<?>>	configuration
private final String	contextPath
private static final String	DEFAULT_CONTEXT_PATH
private static final String	DEFAULT_HOST_NAME
private static final int	DEFAULT_PORT
private final String	hostName
private static final Logger	LOGGER
private volatile int	port
private final Map<String, Object>	properties
private ServerContainer	server
public static final String	STATIC_CONTENT_ROOT Path to static content to be served by created Server instance.

Constructor Summary

Access	Constructor and Description
public	Server(Class<?>... to be registered with the server. Classes annotated with `jakarta.websocket.server.ServerEndpoint`, implementing `jakarta.websocket.server.ServerApplicationConfig` or extending `jakarta.websocket.server.ServerEndpointConfig` are supported. configuration) Create new server instance.
public	Server(Map<String, Object> properties used as a parameter to `(java.util.Map)` call. properties, Class<?>... to be registered with the server. Classes annotated with `jakarta.websocket.server.ServerEndpoint`, implementing `jakarta.websocket.server.ServerApplicationConfig` or extending `jakarta.websocket.server.ServerEndpointConfig` are supported. configuration) Create new server instance.
public	Server(String hostName of the server. hostName, int port of the server. When provided value is `0`, default port (8025) will be used, when `-1`, ephemeral port number will be used. port, String root path to the server App. contextPath, Map<String, Object> properties used as a parameter to `(java.util.Map)` call. properties, Class<?>... to be registered with the server. Classes annotated with `jakarta.websocket.server.ServerEndpoint`, implementing `jakarta.websocket.server.ServerApplicationConfig` or extending `jakarta.websocket.server.ServerEndpointConfig` are supported. configuration) Construct new server.
public	Server(String hostName of the server. hostName, int port of the server. When provided value is `0`, default port (8025) will be used, when `-1`, ephemeral port number will be used. port, String root path to the server App. contextPath, Map<String, Object> properties used as a parameter to `(java.util.Map)` call. properties, Set<Class<?>> to be registered with the server. Classes annotated with `jakarta.websocket.server.ServerEndpoint`, implementing `jakarta.websocket.server.ServerApplicationConfig` or extending `jakarta.websocket.server.ServerEndpointConfig` are supported. configuration) Construct new server.

Method Summary

Modifier and Type	Method and Description
private static Set<Class<?>>	getClassesFromString(String rawString)
public int	Returns: the port which was used to start the container. getPort() Get the port which was used to start the container.
public static void	main(String[] args)
public void	start() Start the server.
public void	stop() Stop the server.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

configuration	back to summary
private final Set<Class<?>> configuration

contextPath	back to summary
private final String contextPath

DEFAULT_CONTEXT_PATH	back to summary
private static final String DEFAULT_CONTEXT_PATH

DEFAULT_HOST_NAME	back to summary
private static final String DEFAULT_HOST_NAME

DEFAULT_PORT	back to summary
private static final int DEFAULT_PORT

hostName	back to summary
private final String hostName

LOGGER	back to summary
private static final Logger LOGGER

port	back to summary
private volatile int port

properties	back to summary
private final Map<String, Object> properties

server	back to summary
private ServerContainer server

STATIC_CONTENT_ROOT back to summary

STATIC_CONTENT_ROOT	back to summary
public static final String STATIC_CONTENT_ROOT Path to static content to be served by created Server instance. Value have to be non-empty `String` and should represent content root of static content (file system path). See Also `Server#Server(java.util.Map, Class[])`, `Server#Server(String, int, String, java.util.Map, Class[])`, `Server#Server(String, int, String, java.util.Map, java.util.Set)`

public static final String STATIC_CONTENT_ROOT

Path to static content to be served by created Server instance.

Value have to be non-empty String and should represent content root of static content (file system path).

See Also: Server#Server(java.util.Map, Class[]), Server#Server(String, int, String, java.util.Map, Class[]), Server#Server(String, int, String, java.util.Map, java.util.Set)

Constructor Detail

Server back to summary

Server	back to summary
public Server(Class<?>... configuration) Create new server instance. Parameters configuration:Class<?>[] to be registered with the server. Classes annotated with `jakarta.websocket.server.ServerEndpoint`, implementing `jakarta.websocket.server.ServerApplicationConfig` or extending `jakarta.websocket.server.ServerEndpointConfig` are supported.

public Server(Class<?>... configuration)

Create new server instance.

Parameters

configuration:Class<?>[]: to be registered with the server. Classes annotated with jakarta.websocket.server.ServerEndpoint, implementing jakarta.websocket.server.ServerApplicationConfig or extending jakarta.websocket.server.ServerEndpointConfig are supported.

Server back to summary

Server	back to summary
public Server(Map<String, Object> properties, Class<?>... configuration) Create new server instance. Parameters properties:Map<String, Object> properties used as a parameter to `(java.util.Map)` call. configuration:Class<?>[] to be registered with the server. Classes annotated with `jakarta.websocket.server.ServerEndpoint`, implementing `jakarta.websocket.server.ServerApplicationConfig` or extending `jakarta.websocket.server.ServerEndpointConfig` are supported.

public Server(Map<String, Object> properties, Class<?>... configuration)

Create new server instance.

Parameters

properties:Map<String, Object>: properties used as a parameter to (java.util.Map) call.
configuration:Class<?>[]: to be registered with the server. Classes annotated with jakarta.websocket.server.ServerEndpoint, implementing jakarta.websocket.server.ServerApplicationConfig or extending jakarta.websocket.server.ServerEndpointConfig are supported.

Server back to summary

Server	back to summary
public Server(String hostName, int port, String contextPath, Map<String, Object> properties, Class<?>... configuration) Construct new server. Parameters hostName:String hostName of the server. port:int port of the server. When provided value is `0`, default port (8025) will be used, when `-1`, ephemeral port number will be used. contextPath:String root path to the server App. properties:Map<String, Object> properties used as a parameter to `(java.util.Map)` call. configuration:Class<?>[] to be registered with the server. Classes annotated with `jakarta.websocket.server.ServerEndpoint`, implementing `jakarta.websocket.server.ServerApplicationConfig` or extending `jakarta.websocket.server.ServerEndpointConfig` are supported. See Also `getPort()`

public Server(String hostName, int port, String contextPath, Map<String, Object> properties, Class<?>... configuration)

Construct new server.

Parameters

hostName:String: hostName of the server.
port:int: port of the server. When provided value is 0, default port (8025) will be used, when -1, ephemeral port number will be used.
contextPath:String: root path to the server App.
properties:Map<String, Object>: properties used as a parameter to (java.util.Map) call.
configuration:Class<?>[]: to be registered with the server. Classes annotated with jakarta.websocket.server.ServerEndpoint, implementing jakarta.websocket.server.ServerApplicationConfig or extending jakarta.websocket.server.ServerEndpointConfig are supported.

See Also

getPort()

Server back to summary

Server	back to summary
public Server(String hostName, int port, String contextPath, Map<String, Object> properties, Set<Class<?>> configuration) Construct new server. Parameters hostName:String hostName of the server. port:int port of the server. When provided value is `0`, default port (8025) will be used, when `-1`, ephemeral port number will be used. contextPath:String root path to the server App. properties:Map<String, Object> properties used as a parameter to `(java.util.Map)` call. configuration:Set<Class<?>> to be registered with the server. Classes annotated with `jakarta.websocket.server.ServerEndpoint`, implementing `jakarta.websocket.server.ServerApplicationConfig` or extending `jakarta.websocket.server.ServerEndpointConfig` are supported. See Also `getPort()`

public Server(String hostName, int port, String contextPath, Map<String, Object> properties, Set<Class<?>> configuration)

Construct new server.

Parameters

hostName:String: hostName of the server.
port:int: port of the server. When provided value is 0, default port (8025) will be used, when -1, ephemeral port number will be used.
contextPath:String: root path to the server App.
properties:Map<String, Object>: properties used as a parameter to (java.util.Map) call.
configuration:Set<Class<?>>: to be registered with the server. Classes annotated with jakarta.websocket.server.ServerEndpoint, implementing jakarta.websocket.server.ServerApplicationConfig or extending jakarta.websocket.server.ServerEndpointConfig are supported.

See Also

getPort()

public Class Server

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail