org.glassfish.tyrus.server

Class Server

java.lang.Object

org.glassfish.tyrus.server.Server

public class Server
extends Object

Implementation of the WebSocket Server.

Author:

Stepan Kopriva (stepan.kopriva at oracle.com), Pavel Bucek (pavel.bucek at oracle.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	STATIC_CONTENT_ROOT Path to static content to be served by created Server instance.

Constructor Summary

Constructors

Constructor and Description
Server(Class<?>... configuration) Create new server instance.
Server(Map<String,Object> properties, Class<?>... configuration) Create new server instance.
Server(String hostName, int port, String contextPath, Map<String,Object> properties, Class<?>... configuration) Construct new server.
Server(String hostName, int port, String contextPath, Map<String,Object> properties, Set<Class<?>> configuration) Construct new server.

Method Summary

Modifier and Type	Method and Description
int	getPort() Get the port which was used to start the container.
static void	main(String[] args)
void	start() Start the server.
void	stop() Stop the server.

Methods inherited from class java.lang.Object

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

Field Detail

STATIC_CONTENT_ROOT

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(java.util.Map, Class[]), Server(String, int, String, java.util.Map, Class[]), Server(String, int, String, java.util.Map, java.util.Set), Constant Field Values

Constructor Detail

Server

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

Create new server instance.

Parameters:

configuration - to be registered with the server. Classes annotated with ServerEndpoint, implementing ServerApplicationConfig or extending ServerEndpointConfig are supported.

Server

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

Create new server instance.

Parameters:

properties - properties used as a parameter to (java.util.Map) call.

configuration - to be registered with the server. Classes annotated with ServerEndpoint, implementing ServerApplicationConfig or extending ServerEndpointConfig are supported.

Server

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

Construct new server.

Parameters:

hostName - hostName of the server.

port - port of the server. When provided value is 0, default port () will be used, when -1, ephemeral port number will be used.

contextPath - root path to the server App.

properties - properties used as a parameter to (java.util.Map) call.

configuration - to be registered with the server. Classes annotated with ServerEndpoint, implementing ServerApplicationConfig or extending ServerEndpointConfig are supported.

See Also:

getPort()

Server

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

Construct new server.

Parameters:

hostName - hostName of the server.

port - port of the server. When provided value is 0, default port () will be used, when -1, ephemeral port number will be used.

contextPath - root path to the server App.

properties - properties used as a parameter to (java.util.Map) call.

configuration - to be registered with the server. Classes annotated with ServerEndpoint, implementing ServerApplicationConfig or extending ServerEndpointConfig are supported.

See Also:

getPort()

Method Detail

main

public static void main(String[] args)

start

public void start()
           throws javax.websocket.DeploymentException

Start the server.

Throws:

javax.websocket.DeploymentException

getPort

public int getPort()

Get the port which was used to start the container.

Returns:

the port which was used to start the container.

stop

public void stop()

Stop the server.