org.apache.jena.fuseki.embedded

Class FusekiEmbeddedServer

java.lang.Object

org.apache.jena.fuseki.embedded.FusekiEmbeddedServer

public class FusekiEmbeddedServer
extends Object

Embedded Fuseki server. This is a Fuseki server running with a precofigured set of datasets and services. There is no admin UI.

To create a embedded sever, use FusekiEmbeddedServer (make(int, java.lang.String, org.apache.jena.sparql.core.DatasetGraph) is a packaging of a call to FusekiEmbeddedServer for the case of one dataset, responding to localhost only).

The application should call start() to actually start the server (it wil run in the background : see join()).

Example:

      DatasetGraph dsg = ... ;
      FusekiEmbeddedServer server = FusekiEmbeddedServer.create()
          .setPort(1234)
          .add("/ds", dsg)
          .build() ;
       server.start() ;
 

Compact form (use the builder pattern above to get more flexibility):

    FusekiEmbeddedServer.make(1234, "/ds", dsg).start() ;
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FusekiEmbeddedServer.Builder FusekiEmbeddedServer.Builder

Field Summary

Fields

Modifier and Type	Field and Description
org.eclipse.jetty.server.Server	server

Method Summary

Modifier and Type	Method and Description
static FusekiEmbeddedServer.Builder	create()
DataAccessPointRegistry	getDataAccessPointRegistry() Get the DataAccessPointRegistry.
org.eclipse.jetty.server.Server	getJettyServer() Get the underlying Jetty server which has also been set up.
int	getPort() Return the port begin used.
javax.servlet.ServletContext	getServletContext() Get the ServletContext.
void	join() Wait for the server to exit.
static FusekiEmbeddedServer	make(int port, String name, DatasetGraph dsg) Construct a Fuseki server for one dataset.
FusekiEmbeddedServer	start() Start the server - the server continues to run after this call returns.
void	stop() Stop the server.

Methods inherited from class java.lang.Object

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

Field Detail

server

public final org.eclipse.jetty.server.Server server

Method Detail

make

public static FusekiEmbeddedServer make(int port,
                                        String name,
                                        DatasetGraph dsg)

Construct a Fuseki server for one dataset. It only responds to localhost. The returned server has not been started

create

public static FusekiEmbeddedServer.Builder create()

getPort

public int getPort()

Return the port begin used. This will be the give port, which defauls to 3330, or the one actually allocated if the port was 0 ("choose a free port").

getJettyServer

public org.eclipse.jetty.server.Server getJettyServer()

Get the underlying Jetty server which has also been set up.

getServletContext

public javax.servlet.ServletContext getServletContext()

Get the ServletContext. Adding new servlets is possible with care.

getDataAccessPointRegistry

public DataAccessPointRegistry getDataAccessPointRegistry()

Get the DataAccessPointRegistry. This method is intended for inspecting the registry.

start

public FusekiEmbeddedServer start()

Start the server - the server continues to run after this call returns. To synchronise with the server stopping, call join().

stop

public void stop()

Stop the server.

join

public void join()

Wait for the server to exit. This call is blocking.