org.apache.jena.fuseki.main

Class FusekiServer

java.lang.Object

org.apache.jena.fuseki.main.FusekiServer

public class FusekiServer
extends Object

Embedded Fuseki server. This is a Fuseki server running with a pre-configured set of datasets and services. There is no admin UI and no security.

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

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

Example:

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

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FusekiServer.Builder FusekiServer.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 FusekiServer.Builder	create() Return a builder, with the default choices of actions available.
static FusekiServer.Builder	create(OperationRegistry serviceDispatchRegistry) Return a builder, with a custom set of operation-action mappings.
DataAccessPointRegistry	getDataAccessPointRegistry() Get the DataAccessPointRegistry.
org.eclipse.jetty.server.Server	getJettyServer() Get the underlying Jetty server which has also been set up.
OperationRegistry	getOperationRegistry() Get the OperationRegistry.
int	getPort() Return the port being used.
javax.servlet.ServletContext	getServletContext() Get the ServletContext used for Fuseki processing.
boolean	hasUserAccessControl() Return whether this server has any access control enabled.
void	join() Wait for the server to exit.
static FusekiServer	make(int port, String name, DatasetGraph dsg) Construct a Fuseki server for one dataset.
FusekiServer	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 FusekiServer 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 FusekiServer.Builder create()

Return a builder, with the default choices of actions available.

create

public static FusekiServer.Builder create(OperationRegistry serviceDispatchRegistry)

Return a builder, with a custom set of operation-action mappings. An endpoint must still be created for the server to be able to provide the action. An endpoint dispatches to an operation, and an operation maps to an implementation. This is a specialised operation - normal use is the operation create().

getPort

public int getPort()

Return the port being used. This will be the give port, which defaults to 3330, or the one actually allocated if the port was 0 ("choose a free port"). If https in use, this is the HTTPS 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 used for Fuseki processing. Adding new servlets is possible with care.

getDataAccessPointRegistry

public DataAccessPointRegistry getDataAccessPointRegistry()

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

getOperationRegistry

public OperationRegistry getOperationRegistry()

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

hasUserAccessControl

public boolean hasUserAccessControl()

Return whether this server has any access control enabled.

start

public FusekiServer 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.