de.bensoft.acis.server

Class Server

java.lang.Object

de.bensoft.acis.utils.Logging.Loggable

de.bensoft.acis.server.Server

All Implemented Interfaces:

java.lang.Runnable

public class Server
extends Logging.Loggable
implements java.lang.Runnable

Represents a web server specially designed for an ACIS system.
It manages Users and their Sessions.
Functionality can be added through ServerContexts and their corresponding ServerContext.ServerContextHandlers such as the SampleRequestHandler.

Request syntax: e.g. http://myacis.com:4964/

Authentication: /auth?user=<USERNAME>&pass=<PASSWORD_AS_MD5>
Returns: The session token or "ERROR: INCORRECT AUTHENTICATION DATA" (401), "ERROR: INCOMPLETE AUTHENTICATION DATA" (400)

Logout: /deauth?key=<SESSION_TOKEN>
Returns: true (if successful) or "ERROR: INTERNAL SERVER ERROR" (500)

ServerContexts added through registerContext(ServerContext): /<CONTEXT_PATH>?key=<SESSION_TOKEN> + PARAMS (key only if context requires authentication)
Returns standardized: "ERROR: AUTHENTICATION REQUIRED" (401), "ERROR: SESSION NOT FOUND OR EXPIRED" (401), "ERROR: USER NOT ALLOWED TO ACCESS THIS PATH" (403), "ERROR: INTERNAL SERVER ERROR" (500)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Server.HttpStatusCodeRepresentation Contains common HTTP status codes used by the system.

Constructor Summary

Constructors

Constructor and Description
Server(int port) Constructor for the server.

Method Summary

Modifier and Type	Method and Description
void	addUser(User user) Adds a User to the system.
java.lang.String	generateSessionId(int len) Generates a unique session ID String.
long	getTokenExpirationTime() Returns the expiration time of a token.
int	getTokenLength() Returns the token length.
User	getUser(java.lang.String username) Returns a User object.
void	registerContext(ServerContext context) Registers a new ServerContext in the server.
void	removeUser(java.lang.String username) Removes a certain User from the system.
void	run()
void	setTokenExpirationTime(long tokenExpirationTime) Sets the expiration time of a token.
void	setTokenLength(int tokenLength) Sets the token length.
void	start() Starts the web server listening on the specified port.
void	stop() Stops the web server.

Methods inherited from class de.bensoft.acis.utils.Logging.Loggable

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

public Server(int port)

Constructor for the server.

Parameters:

port - The port the server will run at.

Method Detail

getTokenExpirationTime

public long getTokenExpirationTime()

Returns the expiration time of a token.

Returns:

The token expiration time.

setTokenExpirationTime

public void setTokenExpirationTime(long tokenExpirationTime)

Sets the expiration time of a token.

Parameters:

tokenExpirationTime - The token expiration time to set.

getTokenLength

public int getTokenLength()

Returns the token length.

Returns:

The token length.

setTokenLength

public void setTokenLength(int tokenLength)

Sets the token length.

Parameters:

tokenLength - The token length to set.

registerContext

public void registerContext(ServerContext context)
                     throws java.lang.IllegalArgumentException

Registers a new ServerContext in the server.

Parameters:

context - The ServerContext to register.

Throws:

java.lang.IllegalArgumentException - When there is already a registered ServerContext with the same route as context.

start

public void start()
           throws java.lang.Exception

Starts the web server listening on the specified port.

Throws:

java.lang.Exception - When the specified port is already in use.

stop

public void stop()

Stops the web server.

run

public void run()

Specified by:

run in interface java.lang.Runnable

addUser

public void addUser(User user)

Adds a User to the system.

Parameters:

user - The User to add.

getUser

public User getUser(java.lang.String username)

Returns a User object.

Parameters:

username - The name of the User.

Returns:

The User if it is present, else returns null.

removeUser

public void removeUser(java.lang.String username)

Removes a certain User from the system.

Parameters:

username - The User's name to remove.

generateSessionId

public java.lang.String generateSessionId(int len)

Generates a unique session ID String.

Parameters:

len - The length of the session ID.

Returns:

The session id.