spark

Class SparkBase

java.lang.Object

spark.SparkBase

Direct Known Subclasses:

Spark

public abstract class SparkBase
extends Object

Spark base class

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_ACCEPT_TYPE
protected static String	externalStaticFileFolder
protected static boolean	initialized
protected static String	ipAddress
protected static String	keystoreFile
protected static String	keystorePassword
protected static int	port
protected static SimpleRouteMatcher	routeMatcher
protected static SparkServer	server
static int	SPARK_DEFAULT_PORT
protected static String	staticFileFolder
protected static String	truststoreFile
protected static String	truststorePassword

Constructor Summary

Constructors

Constructor and Description
SparkBase()

Method Summary

Modifier and Type	Method and Description
protected static void	addFilter(String httpMethod, FilterImpl filter)
protected static void	addRoute(String httpMethod, RouteImpl route)
static void	externalStaticFileLocation(String externalFolder) Sets the external folder serving static files.
static void	ipAddress(String ipAddress) Set the IP address that Spark should listen on.
static void	port(int port) Set the port that Spark should listen on.
static void	secure(String keystoreFile, String keystorePassword, String truststoreFile, String truststorePassword) Set the connection to be secure, using the specified keystore and truststore.
static void	setIpAddress(String ipAddress) Deprecated. replaced by ipAddress(String)
static void	setPort(int port) Deprecated. replaced by port(int)
static void	setSecure(String keystoreFile, String keystorePassword, String truststoreFile, String truststorePassword) Deprecated. replaced by secure(String, String, String, String)
static void	staticFileLocation(String folder) Sets the folder in classpath serving static files.
static void	stop() Stops the Spark server and clears all routes
protected static FilterImpl	wrap(String path, Filter filter) Wraps the filter in FilterImpl
protected static RouteImpl	wrap(String path, Route route) Wraps the route in RouteImpl
protected static FilterImpl	wrap(String path, String acceptType, Filter filter) Wraps the filter in FilterImpl
protected static RouteImpl	wrap(String path, String acceptType, Route route) Wraps the route in RouteImpl

Methods inherited from class java.lang.Object

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

Field Detail

SPARK_DEFAULT_PORT

public static final int SPARK_DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_ACCEPT_TYPE

protected static final String DEFAULT_ACCEPT_TYPE

See Also:

Constant Field Values

initialized

protected static boolean initialized

port

protected static int port

ipAddress

protected static String ipAddress

keystoreFile

protected static String keystoreFile

keystorePassword

protected static String keystorePassword

truststoreFile

protected static String truststoreFile

truststorePassword

protected static String truststorePassword

staticFileFolder

protected static String staticFileFolder

externalStaticFileFolder

protected static String externalStaticFileFolder

server

protected static SparkServer server

routeMatcher

protected static SimpleRouteMatcher routeMatcher

Constructor Detail

SparkBase

public SparkBase()

Method Detail

setIpAddress

public static void setIpAddress(String ipAddress)

Deprecated. replaced by ipAddress(String)

Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'. This has to be called before any route mapping is done.

Parameters:

ipAddress - The ipAddress

ipAddress

public static void ipAddress(String ipAddress)

Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'. This has to be called before any route mapping is done.

Parameters:

ipAddress - The ipAddress

setPort

public static void setPort(int port)

Deprecated. replaced by port(int)

Set the port that Spark should listen on. If not called the default port is 4567. This has to be called before any route mapping is done. If provided port = 0 then the an arbitrary available port will be used.

Parameters:

port - The port number

port

public static void port(int port)

Set the port that Spark should listen on. If not called the default port is 4567. This has to be called before any route mapping is done. If provided port = 0 then the an arbitrary available port will be used.

Parameters:

port - The port number

setSecure

public static void setSecure(String keystoreFile,
                             String keystorePassword,
                             String truststoreFile,
                             String truststorePassword)

Deprecated. replaced by secure(String, String, String, String)

Set the connection to be secure, using the specified keystore and truststore. This has to be called before any route mapping is done. You have to supply a keystore file, truststore file is optional (keystore will be reused). This method is only relevant when using embedded Jetty servers. It should not be used if you are using Servlets, where you will need to secure the connection in the servlet container

Parameters:

keystoreFile - The keystore file location as string

keystorePassword - the password for the keystore

truststoreFile - the truststore file location as string, leave null to reuse keystore

truststorePassword - the trust store password

secure

public static void secure(String keystoreFile,
                          String keystorePassword,
                          String truststoreFile,
                          String truststorePassword)

Set the connection to be secure, using the specified keystore and truststore. This has to be called before any route mapping is done. You have to supply a keystore file, truststore file is optional (keystore will be reused). This method is only relevant when using embedded Jetty servers. It should not be used if you are using Servlets, where you will need to secure the connection in the servlet container

Parameters:

keystoreFile - The keystore file location as string

keystorePassword - the password for the keystore

truststoreFile - the truststore file location as string, leave null to reuse keystore

truststorePassword - the trust store password

staticFileLocation

public static void staticFileLocation(String folder)

Sets the folder in classpath serving static files. Observe: this method must be called before all other methods.

Parameters:

folder - the folder in classpath.

externalStaticFileLocation

public static void externalStaticFileLocation(String externalFolder)

Sets the external folder serving static files. Observe: this method must be called before all other methods.

Parameters:

externalFolder - the external folder serving static files.

stop

public static void stop()

Stops the Spark server and clears all routes

wrap

protected static RouteImpl wrap(String path,
                                Route route)

Wraps the route in RouteImpl

Parameters:

path - the path

route - the route

Returns:

the wrapped route

wrap

protected static RouteImpl wrap(String path,
                                String acceptType,
                                Route route)

Wraps the route in RouteImpl

Parameters:

path - the path

acceptType - the accept type

route - the route

Returns:

the wrapped route

wrap

protected static FilterImpl wrap(String path,
                                 Filter filter)

Wraps the filter in FilterImpl

Parameters:

path - the path

filter - the filter

Returns:

the wrapped route

wrap

protected static FilterImpl wrap(String path,
                                 String acceptType,
                                 Filter filter)

Wraps the filter in FilterImpl

Parameters:

path - the path

acceptType - the accept type

filter - the filter

Returns:

the wrapped route

addRoute

protected static void addRoute(String httpMethod,
                               RouteImpl route)

addFilter

protected static void addFilter(String httpMethod,
                                FilterImpl filter)