Package org.yamcs.http

Class HttpServer

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.AbstractYamcsService

org.yamcs.http.HttpServer

All Implemented Interfaces:

com.google.common.util.concurrent.Service, YamcsService

public class HttpServer
extends AbstractYamcsService

Server-wide HTTP server based on Netty that provides a number of Yamcs web services:

• REST API
• WebSocket API
• Static file serving

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_URL_PREFIX
static final HttpRoute	WEBSOCKET_ROUTE

Fields inherited from class org.yamcs.AbstractYamcsService

config, log, serviceName, yamcsInstance

Constructor Summary

Constructors

Constructor	Description
HttpServer()

Method Summary

Modifier and Type	Method	Description
void	addApi(Api<Context> api)
void	addHandler(String pathSegment, Supplier<Handler> handlerSupplier)	Deprecated.
void	addRoute(String pathSegment, Supplier<HttpHandler> handler)
void	addStaticRoot(Path staticRoot)	Deprecated.
void	closeChannel(String id)
protected void	doStart()
protected void	doStop()
AuditLog	getAuditLog()
List<Binding>	getBindings()
List<io.netty.channel.Channel>	getClientChannels()
String	getContextPath()
io.netty.handler.codec.http.cors.CorsConfig	getCorsConfig()
io.netty.handler.traffic.GlobalTrafficShapingHandler	getGlobalTrafficShapingHandler()
com.google.protobuf.util.JsonFormat.Parser	getJsonParser()
com.google.protobuf.util.JsonFormat.Printer	getJsonPrinter()
com.codahale.metrics.MetricRegistry	getMetricRegistry()
ProtobufRegistry	getProtobufRegistry()
boolean	getReverseLookup()
List<Route>	getRoutes()
Spec	getSpec()	Returns the valid configuration options for this service.
TokenStore	getTokenStore()
List<Topic>	getTopics()
void	init(String yamcsInstance, String serviceName, YConfiguration config)	Initialize this service.
void	startServer()

Methods inherited from class org.yamcs.AbstractYamcsService

getConfig, getYamcsInstance

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Field Details

WEBSOCKET_ROUTE

public static final HttpRoute WEBSOCKET_ROUTE

TYPE_URL_PREFIX

public static final String TYPE_URL_PREFIX

See Also:

• Constant Field Values

Constructor Details

HttpServer

public HttpServer()

Method Details

getSpec

public Spec getSpec()

Description copied from interface: YamcsService

Returns the valid configuration options for this service.

Returns:

the argument specification, or null if the args should not be validated.

init

public void init(String yamcsInstance,
 String serviceName,
 YConfiguration config)
          throws InitException

Description copied from interface: YamcsService

Initialize this service. This is called before the service is started. All operations should finish fast.

Specified by:

init in interface YamcsService

Overrides:

init in class AbstractYamcsService

Parameters:

yamcsInstance - The yamcs instance, or null if this is a global service.

serviceName - The service name.

config - The configured arguments for this service. If YamcsService.getSpec() is implemented then this contains the arguments after being validated (including any defaults).

Throws:

InitException - When something goes wrong during the execution of this method.

addStaticRoot

@Deprecated
public void addStaticRoot(Path staticRoot)

Deprecated.

Deprecated. Use instead, passing a {@link StaticFileHandler}.

addRoute

public void addRoute(String pathSegment,
 Supplier<HttpHandler> handler)

addHandler

@Deprecated
public void addHandler(String pathSegment,
 Supplier<Handler> handlerSupplier)

Deprecated.

Deprecated. Use addRoute(String, Supplier) instead.

addApi

public void addApi(Api<Context> api)

doStart

protected void doStart()

Specified by:

doStart in class com.google.common.util.concurrent.AbstractService

startServer

public void startServer()
                 throws Exception

Throws:

Exception

getTokenStore

public TokenStore getTokenStore()

getAuditLog

public AuditLog getAuditLog()

getBindings

public List<Binding> getBindings()

getContextPath

public String getContextPath()

getRoutes

public List<Route> getRoutes()

getTopics

public List<Topic> getTopics()

getProtobufRegistry

public ProtobufRegistry getProtobufRegistry()

getGlobalTrafficShapingHandler

public io.netty.handler.traffic.GlobalTrafficShapingHandler getGlobalTrafficShapingHandler()

getJsonParser

public com.google.protobuf.util.JsonFormat.Parser getJsonParser()

getJsonPrinter

public com.google.protobuf.util.JsonFormat.Printer getJsonPrinter()

getReverseLookup

public boolean getReverseLookup()

getCorsConfig

public io.netty.handler.codec.http.cors.CorsConfig getCorsConfig()

getMetricRegistry

public com.codahale.metrics.MetricRegistry getMetricRegistry()

getClientChannels

public List<io.netty.channel.Channel> getClientChannels()

closeChannel

public void closeChannel(String id)

doStop

protected void doStop()

Specified by:

doStop in class com.google.common.util.concurrent.AbstractService