com.moderocky.mask.api.web

Class WebServer<C extends WebConnection>

java.lang.Object

java.lang.Thread

com.moderocky.mask.api.web.WebServer<C>

Type Parameters:

C - Your connection type

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

WebJSonAPI

public abstract class WebServer<C extends WebConnection>
extends Thread
implements Runnable

This class is for creating a basic webserver capable of serving static pages. You can further extend its behaviour using listeners (see WebRequestListener and registerListener(Class, WebRequestListener) for further information.)

This does take a generic for your web connection extender (if you are using one) however the generic is not used in some returns. This is to avoid a nasty bit of casting in some of the creator classes in the backend. As you're likely to be the only one creating connections, it is perfectly safe to assume that all WebConnections present in this class or returned by it are of your generic type "C" and castable.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
WebServer(int port, String webContentRoot) This creates a simple webserver capable of serving static pages.
WebServer(int port, String webContentRoot, boolean sendDebugMessages) See above - with the option to send debug messages to console during errors.

Method Summary

Modifier and Type	Method and Description
protected void	addConnection(WebConnection connection)
protected <X extends WebActionEvent> X	callEvent(X event)
abstract C	createConnection(Socket socket)
@NotNull String	get404()
@NotNull List<WebConnection>	getConnectionPool()
@NotNull String	getDefaultFileName()
@NotNull String	getMethodNotSupportedFileName()
int	getPort()
File	getWebRootFolder()
boolean	hasConnections()
boolean	isDebug()
void	registerListener(Class<? extends WebActionEvent> event, WebRequestListener<?> listener)
protected void	removeConnection(WebConnection connection)
void	run()
void	shutDown()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

WebServer

public WebServer(int port,
                 String webContentRoot)

This creates a simple webserver capable of serving static pages. If you would like to create a more complex webserver, you ought to copy this class and use an extender of the WebConnection abstract class.

Parameters:

port - The web port; 80 is the default one

webContentRoot - The folder path where your website files will be

WebServer

public WebServer(int port,
                 String webContentRoot,
                 boolean sendDebugMessages)

See above - with the option to send debug messages to console during errors.

Parameters:

port - The web port; 80 is the default one

webContentRoot - The folder path where your website files will be

sendDebugMessages - Whether to send debug messages

Method Detail

callEvent

protected <X extends WebActionEvent> X callEvent(X event)

registerListener

public void registerListener(Class<? extends WebActionEvent> event,
                             WebRequestListener<?> listener)

isDebug

public boolean isDebug()

getWebRootFolder

public File getWebRootFolder()

getDefaultFileName

@NotNull
public @NotNull String getDefaultFileName()

get404

@NotNull
public @NotNull String get404()

getMethodNotSupportedFileName

@NotNull
public @NotNull String getMethodNotSupportedFileName()

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

createConnection

public abstract C createConnection(Socket socket)

Parameters:

socket - The socket

Returns:

new WebConnection(socket, this) {};

getPort

public int getPort()

hasConnections

public boolean hasConnections()

addConnection

protected void addConnection(WebConnection connection)

removeConnection

protected void removeConnection(WebConnection connection)

getConnectionPool

@NotNull
public @NotNull List<WebConnection> getConnectionPool()

shutDown

public void shutDown()