FusekiServer.Builder (Apache Jena - Fuseki Server 3.12.0)

java.lang.Object
- org.apache.jena.fuseki.main.FusekiServer.Builder

Enclosing class:: FusekiServer

public static class FusekiServer.Builder
extends Object

FusekiServer.Builder

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`FusekiServer.Builder`	`add(String name, DataService dataService)` Add a data service that includes dataset and service names.
`FusekiServer.Builder`	`add(String name, Dataset dataset)` Add the dataset with given name and a default set of services including update.
`FusekiServer.Builder`	`add(String name, Dataset dataset, boolean allowUpdate)` Add the dataset with given name and a default set of services and enabling update if allowUpdate=true.
`FusekiServer.Builder`	`add(String name, DatasetGraph dataset)` Add the dataset with given name and a default set of services including update
`FusekiServer.Builder`	`add(String name, DatasetGraph dataset, boolean allowUpdate)` Add the dataset with given name and a default set of services and enabling update if allowUpdate=true.
`FusekiServer.Builder`	`addFilter(String pathSpec, javax.servlet.Filter filter)` Add a filter with the pathSpec.
`FusekiServer.Builder`	`addOperation(String datasetName, String endpointName, Operation operation)` Create an endpoint on the dataset.
`FusekiServer.Builder`	`addServlet(String pathSpec, javax.servlet.http.HttpServlet servlet)` Add the given servlet with the `pathSpec`.
`FusekiServer.Builder`	`addServletAttribute(String attrName, Object value)` Add a servlet attribute.
`FusekiServer.Builder`	`auth(AuthScheme authScheme)` Choose the HTTP authentication scheme.
`FusekiServer`	`build()` Build a server according to the current description.
`FusekiServer.Builder`	`contextPath(String path)` Context path to Fuseki.
`FusekiServer.Builder`	`enablePing(boolean withPing)` Add the "/$/ping" servlet that responds to HTTP very efficiently.
`FusekiServer.Builder`	`enableStats(boolean withStats)` Add the "/$/stats" servlet that responds with stats about the server, including counts of all calls made.
`FusekiServer.Builder`	`https(int httpsPort, String certStore, String certStorePasswd)`
`FusekiServer.Builder`	`loopback(boolean loopback)` Restrict the server to only responding to the localhost interface.
`FusekiServer.Builder`	`parseConfigFile(String filename)` Configure using a Fuseki services/datasets assembler file.
`FusekiServer.Builder`	`passwordFile(String passwordFile)` Set the password file.
`FusekiServer.Builder`	`port(int port)` Set the port to run on.
`FusekiServer.Builder`	`realm(String realm)` Set the realm used for HTTP digest authentication.
`FusekiServer.Builder`	`registerOperation(Operation operation, ActionService handler)` Add an operation and handler to the server.
`FusekiServer.Builder`	`registerOperation(Operation operation, String contentType, ActionService handler)` Add an operation to the server, together with its triggering Content-Type (may be null) and servlet handler.
`FusekiServer.Builder`	`securityHandler(org.eclipse.jetty.security.SecurityHandler securityHandler)` Set a Jetty SecurityHandler.
`FusekiServer.Builder`	`setContextPath(String path)` Deprecated. Use `contextPath`.
`FusekiServer.Builder`	`setLoopback(boolean loopback)` Deprecated. Use `networkLoopback`.
`FusekiServer.Builder`	`setPort(int port)` Deprecated. Use `port(int)`.
`FusekiServer.Builder`	`setSecurityHandler(org.eclipse.jetty.security.SecurityHandler securityHandler)` Deprecated. Use `staticFileBase(java.lang.String)`.
`FusekiServer.Builder`	`setStaticFileBase(String directory)` Deprecated. Use `staticFileBase(java.lang.String)`.
`FusekiServer.Builder`	`setVerbose(boolean verbose)` Deprecated. Use `verbose(boolean)`.
`FusekiServer.Builder`	`staticFileBase(String directory)` Set the location (filing system directory) to serve static files from.
`FusekiServer.Builder`	`verbose(boolean verbose)` Set verbose logging

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setPort
```
@Deprecated
public FusekiServer.Builder setPort(int port)
```
    Deprecated. Use port(int).
    
    Set the port to run on.
  - port
```
public FusekiServer.Builder port(int port)
```
    Set the port to run on.
  - setContextPath
```
@Deprecated
public FusekiServer.Builder setContextPath(String path)
```
    Deprecated. Use contextPath.
    
    Context path to Fuseki. If it's "/" then Fuseki URL look like "http://host:port/dataset/query" else "http://host:port/path/dataset/query"
  - contextPath
```
public FusekiServer.Builder contextPath(String path)
```
    Context path to Fuseki. If it's "/" then Fuseki URL look like "http://host:port/dataset/query" else "http://host:port/path/dataset/query"
  - setLoopback
```
@Deprecated
public FusekiServer.Builder setLoopback(boolean loopback)
```
    Deprecated. Use networkLoopback.
    
    Restrict the server to only responding to the localhost interface.
  - loopback
```
public FusekiServer.Builder loopback(boolean loopback)
```
    Restrict the server to only responding to the localhost interface.
  - setStaticFileBase
```
@Deprecated
public FusekiServer.Builder setStaticFileBase(String directory)
```
    Deprecated. Use staticFileBase(java.lang.String).
    
    Set the location (filing system directory) to serve static file from.
  - staticFileBase
```
public FusekiServer.Builder staticFileBase(String directory)
```
    Set the location (filing system directory) to serve static files from.
  - setSecurityHandler
```
@Deprecated
public FusekiServer.Builder setSecurityHandler(org.eclipse.jetty.security.SecurityHandler securityHandler)
```
    Deprecated. Use staticFileBase(java.lang.String).
    
    Set a Jetty SecurityHandler.
    By default, the server runs with no security.
  - securityHandler
```
public FusekiServer.Builder securityHandler(org.eclipse.jetty.security.SecurityHandler securityHandler)
```
    Set a Jetty SecurityHandler.
    By default, the server runs with no security. This is more for using the basic server for testing. The full Fuseki server provides security with Apache Shiro and a defensive reverse proxy (e.g. Apache httpd) in front of the Jetty server can also be used, which provides a wide variety of proven security options.
  - setVerbose
```
@Deprecated
public FusekiServer.Builder setVerbose(boolean verbose)
```
    Deprecated. Use verbose(boolean).
    
    Set verbose logging
  - verbose
```
public FusekiServer.Builder verbose(boolean verbose)
```
    Set verbose logging
  - enableStats
```
public FusekiServer.Builder enableStats(boolean withStats)
```
    Add the "/$/stats" servlet that responds with stats about the server, including counts of all calls made.
  - enablePing
```
public FusekiServer.Builder enablePing(boolean withPing)
```
    Add the "/$/ping" servlet that responds to HTTP very efficiently. This is useful for testing whether a server is alive, for example, from a load balancer.
  - add
```
public FusekiServer.Builder add(String name,
                                Dataset dataset)
```
    Add the dataset with given name and a default set of services including update. This is equivalent to add(name, dataset, true).
  - add
```
public FusekiServer.Builder add(String name,
                                DatasetGraph dataset)
```
    Add the dataset with given name and a default set of services including update
  - add
```
public FusekiServer.Builder add(String name,
                                Dataset dataset,
                                boolean allowUpdate)
```
    Add the dataset with given name and a default set of services and enabling update if allowUpdate=true.
  - add
```
public FusekiServer.Builder add(String name,
                                DatasetGraph dataset,
                                boolean allowUpdate)
```
    Add the dataset with given name and a default set of services and enabling update if allowUpdate=true.
  - add
```
public FusekiServer.Builder add(String name,
                                DataService dataService)
```
    Add a data service that includes dataset and service names. A DataService allows for choices of the various endpoint names.
  - parseConfigFile
```
public FusekiServer.Builder parseConfigFile(String filename)
```
    Configure using a Fuseki services/datasets assembler file.
    The application is responsible for ensuring a correct classpath. For example, including a dependency on jena-text if the configuration file includes a text index.
  - auth
```
public FusekiServer.Builder auth(AuthScheme authScheme)
```
    Choose the HTTP authentication scheme.
  - realm
```
public FusekiServer.Builder realm(String realm)
```
    Set the realm used for HTTP digest authentication.
  - passwordFile
```
public FusekiServer.Builder passwordFile(String passwordFile)
```
    Set the password file. This will be used to build a security handler if one is not supplied. Setting null clears any previous entry. The file should be Eclipse jetty password file.
  - https
```
public FusekiServer.Builder https(int httpsPort,
                                  String certStore,
                                  String certStorePasswd)
```
  - addServlet
```
public FusekiServer.Builder addServlet(String pathSpec,
                                       javax.servlet.http.HttpServlet servlet)
```
    Add the given servlet with the pathSpec. These servlets are added so that they are checked after the Fuseki filter for datasets and before the static content handler (which is the last servlet) used for setStaticFileBase(String).
  - addServletAttribute
```
public FusekiServer.Builder addServletAttribute(String attrName,
                                                Object value)
```
    Add a servlet attribute. Pass a value of null to remove any existing binding.
  - addFilter
```
public FusekiServer.Builder addFilter(String pathSpec,
                                      javax.servlet.Filter filter)
```
    Add a filter with the pathSpec. Note that Fuseki dispatch uses a servlet filter which is the last in the filter chain.
  - registerOperation
```
public FusekiServer.Builder registerOperation(Operation operation,
                                              ActionService handler)
```
    Add an operation and handler to the server. This does not enable it for any dataset.
    To associate an operation with a dataset, call addOperation(java.lang.String, java.lang.String, org.apache.jena.fuseki.server.Operation) after adding the dataset.
    
    See Also:
    
    addOperation(java.lang.String, java.lang.String, org.apache.jena.fuseki.server.Operation)
  - registerOperation
```
public FusekiServer.Builder registerOperation(Operation operation,
                                              String contentType,
                                              ActionService handler)
```
    Add an operation to the server, together with its triggering Content-Type (may be null) and servlet handler.
    To associate an operation with a dataset, call addOperation(java.lang.String, java.lang.String, org.apache.jena.fuseki.server.Operation) after adding the dataset.
    
    See Also:
    
    addOperation(java.lang.String, java.lang.String, org.apache.jena.fuseki.server.Operation)
  - addOperation
```
public FusekiServer.Builder addOperation(String datasetName,
                                         String endpointName,
                                         Operation operation)
```
    Create an endpoint on the dataset. The operation must already be registered with the builder.
    
    See Also:
    
    registerOperation(Operation, ActionService)
  - build
```
public FusekiServer build()
```
    Build a server according to the current description.

Class FusekiServer.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setPort

port

setContextPath

contextPath

setLoopback

loopback

setStaticFileBase

staticFileBase

setSecurityHandler

securityHandler

setVerbose

verbose

enableStats

enablePing

add

add

add

add

add

parseConfigFile

auth

realm

passwordFile

https

addServlet

addServletAttribute

addFilter

registerOperation

registerOperation

addOperation

build