Package nzilbb.webapp

Class StandAloneWebApp

java.lang.Object

nzilbb.util.CommandLineProgram

nzilbb.webapp.StandAloneWebApp

Direct Known Subclasses:

AnnotatorWebApp

@ProgramDescription("Utility for running stand-alone webapps")
public class StandAloneWebApp
extends CommandLineProgram

Utility for running stand-alone webapps.

Constructor Summary

Constructors

Constructor	Description
StandAloneWebApp()

Method Summary

Modifier and Type	Method	Description
static String	ContentTypeForName(String name)	Determines the content-type for a given resource name, using the file extension.
String	getFinishedPath()	Getter for finishedPath: The URI path (excluding leading '/') for the request that terminates the web app.
String	getFinishedResponse()	Getter for finishedResponse: The HTML document to show when /finishedPath is called.
Integer	getPort()	Getter for port: Server port to listen on.
String	getQuery()	Getter for query: The query string to use when opening the web-app.
File	getRoot()	Getter for root: Root directory of webapp.
static void	main(String[] argv)	Command-line entrypoint
StandAloneWebApp	setFinishedPath(String newFinishedPath)	Setter for finishedPath: The URI path (excluding leading '/') for the request that terminates the web app.
StandAloneWebApp	setFinishedResponse(String newFinishedResponse)	Setter for finishedResponse: The HTML document to show when /finishedPath is called.
StandAloneWebApp	setPort(Integer newPort)	Setter for port: Server port to listen on.
StandAloneWebApp	setQuery(String newQuery)	Setter for query: The query string to use when opening the web-app.
StandAloneWebApp	setRoot(File newRoot)	Setter for root: Root directory of webapp.
void	start()	Start handling requests

Methods inherited from class nzilbb.util.CommandLineProgram

error, error, getUsage, getV, getVersion, interpretPropertiesParameters, message, processArguments, setUsage, setV, setVersion, warning, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

StandAloneWebApp

public StandAloneWebApp()

Method Detail

main

public static void main(String[] argv)

Command-line entrypoint

getRoot

public File getRoot()

Getter for root: Root directory of webapp.

Returns:

Root directory of webapp.

setRoot

@Switch(value="Root folder of webapp",
        compulsory=true)
public StandAloneWebApp setRoot(File newRoot)

Setter for root: Root directory of webapp.

Parameters:

newRoot - Root directory of webapp.

getPort

public Integer getPort()

Getter for port: Server port to listen on.

Returns:

Server port to listen on.

setPort

@Switch("Server port to listen on (default is 9000)")
public StandAloneWebApp setPort(Integer newPort)

Setter for port: Server port to listen on.

Parameters:

newPort - Server port to listen on.

getQuery

public String getQuery()

Getter for query: The query string to use when opening the web-app.

Returns:

The query string to use when opening the web-app.

setQuery

public StandAloneWebApp setQuery(String newQuery)

Setter for query: The query string to use when opening the web-app.

Parameters:

newQuery - The query string to use when opening the web-app.

getFinishedPath

public String getFinishedPath()

Getter for finishedPath: The URI path (excluding leading '/') for the request that terminates the web app. Default is "finished".

Returns:

The URI path (excluding leading '/') for the request that terminates the web app. Default is "finished".

setFinishedPath

@Switch("The URI pathfor the request that terminates the web app. Default is \'finished\'")
public StandAloneWebApp setFinishedPath(String newFinishedPath)

Setter for finishedPath: The URI path (excluding leading '/') for the request that terminates the web app. Default is "finished".

Parameters:

newFinishedPath - The URI path (excluding leading '/') for the request that terminates the web app. Default is "finished".

getFinishedResponse

public String getFinishedResponse()

Getter for finishedResponse: The HTML document to show when /finishedPath is called.

Returns:

The HTML document to show when /finishedPath is called.

setFinishedResponse

@Switch("The HTML document to show when /finishedPath is called")
public StandAloneWebApp setFinishedResponse(String newFinishedResponse)

Setter for finishedResponse: The HTML document to show when /finishedPath is called.

Parameters:

newFinishedResponse - The HTML document to show when /finishedPath is called.

ContentTypeForName

public static String ContentTypeForName(String name)

Determines the content-type for a given resource name, using the file extension.

Parameters:

name -

Returns:

A valid content-type

start

public void start()

Start handling requests