org.apache.samza.rest

Class SamzaRestService

java.lang.Object

org.apache.samza.rest.SamzaRestService

public class SamzaRestService
extends java.lang.Object

The main Java class for the Samza REST API. It runs an embedded Jetty server so it can be deployed as a Jar file. This class can be started from the command line by providing the --config-path parameter to a Samza REST config file which will be used to configure the default resources exposed by the API. It can also be managed programmatically using the addServlet(javax.servlet.Servlet, String), start() and stop() methods.

Constructor Summary

Constructors

Constructor and Description
SamzaRestService(org.eclipse.jetty.server.Server server, org.apache.samza.metrics.ReadableMetricsRegistry metricsRegistry, java.util.Map<java.lang.String,org.apache.samza.metrics.MetricsReporter> metricsReporters, org.eclipse.jetty.servlet.ServletContextHandler context)

Method Summary

Modifier and Type	Method and Description
void	addServlet(javax.servlet.Servlet servlet, java.lang.String path) Adds the specified Servlet to the server at the specified path.
static void	main(java.lang.String[] args) Command line interface to run the server.
void	start() Starts the server asynchronously.
void	stop() Stops the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

SamzaRestService

public SamzaRestService(org.eclipse.jetty.server.Server server,
                        org.apache.samza.metrics.ReadableMetricsRegistry metricsRegistry,
                        java.util.Map<java.lang.String,org.apache.samza.metrics.MetricsReporter> metricsReporters,
                        org.eclipse.jetty.servlet.ServletContextHandler context)

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Command line interface to run the server.

Parameters:

args - arguments supported by CommandLine. In particular, --config-path and --config-factory are used to read the Samza REST config file.

Throws:

java.lang.Exception - if the server could not be successfully started.

addServlet

public void addServlet(javax.servlet.Servlet servlet,
                       java.lang.String path)

Adds the specified Servlet to the server at the specified path.

Parameters:

servlet - the Servlet to be added.

path - the path for the servlet.

start

public void start()
           throws java.lang.Exception

Starts the server asynchronously. To stop the server, see stop().

Throws:

java.lang.Exception - if the server could not be successfully started.

stop

public void stop()
          throws java.lang.Exception

Stops the server.

Throws:

java.lang.Exception - if the server could not be successfully stopped.