org.wandora.utils

Class HTTPServer

java.lang.Object

org.wandora.utils.HTTPServer

Direct Known Subclasses:

WandoraHttpServer

public abstract class HTTPServer
extends java.lang.Object

For the ssl to work you need to create a certificate in command prompt with the keytool utility (should be in jdk bin directory). For example: keytool -genkey -keystore storefile -keyalg RSA After you have generated the certificate you need to run java with the following parameters (or you may set the properties programmatically with System.setProperty): -Djavax.net.ssl.keyStore=storefile -Djavax.net.ssl.keyStorePassword=password Every request is sent to handleRequest(Socket) which, after doing basic authentication and parsing the requests, calls handleRequest(Socket,String). It then calls the two abstract methods getPage and getContentType. The most simple way to make a HTTPServer is to implement these two methods. If you need to do more advanced handling you may also override one of the handleRequest methods.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	HTTPServer.ServerThread

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	loginPass
protected java.lang.String	loginUser
protected java.util.HashMap<java.lang.String,java.lang.String>	mimeTypes
protected int	port
protected boolean	printExceptions
protected boolean	running
protected java.net.ServerSocket	serverSocket
protected HTTPServer.ServerThread	serverThread
protected boolean	useSSL

Constructor Summary

Constructors

Constructor and Description
HTTPServer(int port) Creates a new instance of ScreenShotServer

Method Summary

Modifier and Type	Method and Description
static void	badRequest(java.io.OutputStream out)
static void	copyStream(java.io.InputStream in, java.io.OutputStream out)
java.lang.String	getLoginPassword()
java.lang.String	getLoginUser()
protected abstract boolean	getPage(java.io.OutputStream out, java.lang.String[] parameters) Gets the contents of the page for the given request.
static java.lang.String	getParamValue(java.lang.String param, java.lang.String[] params) Returns the first parameter value with the given key.
int	getPort()
java.lang.String	getRealm()
protected void	handleRequest(java.net.Socket s) Handles http request.
protected void	handleRequest(java.net.Socket s, java.lang.String get) Handles the request by getting the contents of the page using getPage.
boolean	isRunning()
boolean	isUseSSL()
static void	notFound(java.io.OutputStream out) A convenience method to respond with a not found message.
static java.lang.String[]	parseGetParams(java.lang.String get) Parses parameters from url.
protected void	registerMimeTypes()
void	returnFile(java.io.OutputStream out, java.io.File f)
void	setLogin(java.lang.String user, java.lang.String password) Set credential required to use the server.
void	setPort(int p)
void	setPrintExceptions(boolean value)
void	setUseSSL(boolean value) Enables or disables use of SSL sockets.
void	start() Starts the server.
void	stopServer() Stops the server and waits for the server thread to die before returning.
static void	writeHeader(java.io.OutputStream out, java.lang.String contentType)
void	writeHeaderForFile(java.io.OutputStream out, java.io.File f)
void	writeHeaderForFile(java.io.OutputStream out, java.lang.String extension)
static void	writeHTMLHeader(java.io.OutputStream out)
static void	writeInternalServerError(java.io.OutputStream out, java.lang.String message, java.lang.Throwable t)
static void	writeSimpleHTML(java.io.OutputStream out, java.lang.String title, java.lang.String content)

Methods inherited from class java.lang.Object

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

Field Detail

port

protected int port

running

protected boolean running

printExceptions

protected boolean printExceptions

useSSL

protected boolean useSSL

loginUser

protected java.lang.String loginUser

loginPass

protected java.lang.String loginPass

serverSocket

protected java.net.ServerSocket serverSocket

serverThread

protected HTTPServer.ServerThread serverThread

mimeTypes

protected java.util.HashMap<java.lang.String,java.lang.String> mimeTypes

Constructor Detail

HTTPServer

public HTTPServer(int port)

Creates a new instance of ScreenShotServer

Method Detail

registerMimeTypes

protected void registerMimeTypes()

handleRequest

protected void handleRequest(java.net.Socket s)
                      throws java.io.IOException

Handles http request. Does simple authentication check if requiredCredentials has been set.

Throws:

java.io.IOException

getRealm

public java.lang.String getRealm()

copyStream

public static void copyStream(java.io.InputStream in,
                              java.io.OutputStream out)
                       throws java.io.IOException

Throws:

java.io.IOException

returnFile

public void returnFile(java.io.OutputStream out,
                       java.io.File f)
                throws java.io.IOException

Throws:

java.io.IOException

writeHeaderForFile

public void writeHeaderForFile(java.io.OutputStream out,
                               java.lang.String extension)
                        throws java.io.IOException

Throws:

java.io.IOException

writeHeaderForFile

public void writeHeaderForFile(java.io.OutputStream out,
                               java.io.File f)
                        throws java.io.IOException

Throws:

java.io.IOException

writeHTMLHeader

public static void writeHTMLHeader(java.io.OutputStream out)
                            throws java.io.IOException

Throws:

java.io.IOException

writeHeader

public static void writeHeader(java.io.OutputStream out,
                               java.lang.String contentType)
                        throws java.io.IOException

Throws:

java.io.IOException

writeSimpleHTML

public static void writeSimpleHTML(java.io.OutputStream out,
                                   java.lang.String title,
                                   java.lang.String content)
                            throws java.io.IOException

Throws:

java.io.IOException

writeInternalServerError

public static void writeInternalServerError(java.io.OutputStream out,
                                            java.lang.String message,
                                            java.lang.Throwable t)
                                     throws java.io.IOException

Throws:

java.io.IOException

handleRequest

protected void handleRequest(java.net.Socket s,
                             java.lang.String get)
                      throws java.io.IOException

Handles the request by getting the contents of the page using getPage. Then writes the header and the contents and closes socket.

Throws:

java.io.IOException

getPage

protected abstract boolean getPage(java.io.OutputStream out,
                                   java.lang.String[] parameters)

Gets the contents of the page for the given request.

parseGetParams

public static java.lang.String[] parseGetParams(java.lang.String get)

Parses parameters from url.

Returns:

A String array where first element is the requested page and after that every odd index contains a parameter key and every even index value for previous key.

notFound

public static void notFound(java.io.OutputStream out)
                     throws java.io.IOException

A convenience method to respond with a not found message.

Throws:

java.io.IOException

badRequest

public static void badRequest(java.io.OutputStream out)
                       throws java.io.IOException

Throws:

java.io.IOException

getParamValue

public static java.lang.String getParamValue(java.lang.String param,
                                             java.lang.String[] params)

Returns the first parameter value with the given key.

Parameters:

param - The key of the param to find.

params - The parameters as returned by parseGetParams.

Returns:

The first parameter value with the given key or null if non is found.

setPrintExceptions

public void setPrintExceptions(boolean value)

getPort

public int getPort()

setPort

public void setPort(int p)

setLogin

public void setLogin(java.lang.String user,
                     java.lang.String password)

Set credential required to use the server. If user is null or empty string, allows anonymous login.

getLoginUser

public java.lang.String getLoginUser()

getLoginPassword

public java.lang.String getLoginPassword()

setUseSSL

public void setUseSSL(boolean value)

Enables or disables use of SSL sockets. You must set this before starting the server. See notes in the class description about configuring SSL.

isUseSSL

public boolean isUseSSL()

start

public void start()

Starts the server. If server is already running, stops it first.

isRunning

public boolean isRunning()

stopServer

public void stopServer()

Stops the server and waits for the server thread to die before returning.