com.github.peterbencze.serritor.internal.web

Class WebApi

java.lang.Object

com.github.peterbencze.serritor.internal.web.WebApi

Direct Known Subclasses:

SecuredWebApi

public class WebApi
extends Object

A web API implementation that allows users to register HTTP and WebSocket endpoints that can be used to interact with the crawler while it is running.

Constructor Summary

Constructors

Constructor and Description
WebApi(ServerConfiguration serverConfig) Creates a WebApi instance.

Method Summary

Modifier and Type	Method and Description
void	addHttpEndpoint(HttpMethod httpMethod, String path, HttpHandler handler) Adds an HTTP endpoint to the web API.
void	addWebSocketEndpoint(String path, WebSocketHandler handler) Adds a WebSocket endpoint to the web API.
protected org.eclipse.jetty.servlet.ServletContextHandler	getContextHandler() Returns the servlet context.
Set<org.eclipse.jetty.websocket.api.Session>	getOpenWebSocketSessions(Class<? extends WebSocketHandler> socketHandlerClass) Returns a set of open WebSocket sessions that represent connections to the specific endpoint.
protected org.eclipse.jetty.server.Server	getServer() Returns the Jetty HTTP servlet server.
ServerConfiguration	getServerConfiguration() Returns the configuration of the web server.
void	start() Starts the web server.
void	stop() Stops the web server.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebApi

public WebApi(ServerConfiguration serverConfig)

Creates a WebApi instance.

Parameters:

serverConfig - the configuration of the web server

Method Detail

getServerConfiguration

public ServerConfiguration getServerConfiguration()

Returns the configuration of the web server.

Returns:

the configuration of the web server

start

public void start()

Starts the web server.

stop

public void stop()

Stops the web server.

getOpenWebSocketSessions

public Set<org.eclipse.jetty.websocket.api.Session> getOpenWebSocketSessions(Class<? extends WebSocketHandler> socketHandlerClass)

Returns a set of open WebSocket sessions that represent connections to the specific endpoint.

Parameters:

socketHandlerClass - the runtime class of the WebSocket endpoint handler

Returns:

a set of open WebSocket sessions that represent connections to the specific endpoint

addHttpEndpoint

public void addHttpEndpoint(HttpMethod httpMethod,
                            String path,
                            HttpHandler handler)

Adds an HTTP endpoint to the web API.

Parameters:

httpMethod - the HTTP method of the endpoint

path - the path of the endpoint

handler - the handler of the endpoint

addWebSocketEndpoint

public void addWebSocketEndpoint(String path,
                                 WebSocketHandler handler)

Adds a WebSocket endpoint to the web API.

Parameters:

path - the path of the endpoint

handler - the handler of the endpoint

getServer

protected org.eclipse.jetty.server.Server getServer()

Returns the Jetty HTTP servlet server.

Returns:

the Jetty HTTP servlet server

getContextHandler

protected org.eclipse.jetty.servlet.ServletContextHandler getContextHandler()

Returns the servlet context.

Returns:

the servlet context