stanford.cs106.net

Class SimpleServer

java.lang.Object

stanford.cs106.net.SimpleServer

public class SimpleServer
extends Object

This class implements a simple synchronous HTTP server that can listen on a given port and respond to requests made by clients.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleServer.SimpleServerException An exception type that represents server-related runtime errors.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT Default port to listen for requests.

Constructor Summary

Constructors

Constructor and Description
SimpleServer(int port) Constructs a new server that will listen on the given port.
SimpleServer(SimpleServerListener webApp) Constructs a new server that will listen on a default port, with the given listener to be notified as each request comes in.
SimpleServer(SimpleServerListener webApp, int port) Constructs a new server that will listen on the given port, with the given listener to be notified as each request comes in.

Method Summary

Modifier and Type	Method and Description
int	getPort() Returns the port on which this server will listen.
boolean	isRunning() Returns whether the server is currently active and listening for HTTP requests, which will be true after start() is called.
boolean	portIsAvailable() Returns true if this server's port is available for listening.
static boolean	portIsAvailable(int port) Returns true if the given port is available for listening.
HashMap<String,String>	sessionData(Request request) Returns all data associated with the given request's session.
void	sessionEnd(Request request) Ends any active session for the given request, clearing its session data.
boolean	sessionIsInProgress(Request request) Returns whether the given request contains an active session.
void	sessionStart(Request request) Begins an active session for the given request, with empty session data.
void	start() Starts a server on the given port.
void	stop() Stops the server so that it will no longer listen to HTTP requests.
String	toString() Returns a string representation of this server.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

Default port to listen for requests.

See Also:

Constant Field Values

Constructor Detail

SimpleServer

public SimpleServer(int port)

Constructs a new server that will listen on the given port. The server does not start listening until start() is called.

Parameters:

port - the port to listen on, up to 65535

SimpleServer

public SimpleServer(SimpleServerListener webApp)

Constructs a new server that will listen on a default port, with the given listener to be notified as each request comes in. The server does not start listening until start() is called.

Parameters:

webApp - listener to notify on each request

SimpleServer

public SimpleServer(SimpleServerListener webApp,
                    int port)

Constructs a new server that will listen on the given port, with the given listener to be notified as each request comes in. The server does not start listening until start() is called.

Parameters:

webApp - listener to notify on each request

port - the port to listen on, up to 65535

Method Detail

getPort

public int getPort()

Returns the port on which this server will listen.

isRunning

public boolean isRunning()

Returns whether the server is currently active and listening for HTTP requests, which will be true after start() is called.

portIsAvailable

public boolean portIsAvailable()

Returns true if this server's port is available for listening.

portIsAvailable

public static boolean portIsAvailable(int port)

Returns true if the given port is available for listening.

sessionIsInProgress

public boolean sessionIsInProgress(Request request)

Returns whether the given request contains an active session.

sessionData

public HashMap<String,String> sessionData(Request request)

Returns all data associated with the given request's session. If the given request has no active session, returns null.

sessionEnd

public void sessionEnd(Request request)

Ends any active session for the given request, clearing its session data. If there was no session for the given request, has no effect.

sessionStart

public void sessionStart(Request request)

Begins an active session for the given request, with empty session data. The session will use a unique key provided in the request by the client; if no such key is present, throws a SimpleServerException. If there was already a session for the given request, has no effect.

start

public void start()

Starts a server on the given port. It is hard coded to handle img requests and resource requests specially by just reading the files and returning them. All other requests should be handled by the user's code. If the server is already running, this will have no effect.

stop

public void stop()

Stops the server so that it will no longer listen to HTTP requests.

toString

public String toString()

Returns a string representation of this server.

Overrides:

toString in class Object