diff options
Diffstat (limited to 'src/uk/org/ury/server')
| -rw-r--r-- | src/uk/org/ury/server/AbstractRequestHandler.java | 254 | ||||
| -rw-r--r-- | src/uk/org/ury/server/ApiRequestHandler.java | 42 | ||||
| -rw-r--r-- | src/uk/org/ury/server/HttpHandler.java | 205 | ||||
| -rw-r--r-- | src/uk/org/ury/server/HttpListenerThread.java | 127 | ||||
| -rw-r--r-- | src/uk/org/ury/server/HttpWorkerThread.java | 104 | ||||
| -rw-r--r-- | src/uk/org/ury/server/Server.java | 99 | ||||
| -rw-r--r-- | src/uk/org/ury/server/ServerRequestHandler.java | 95 | ||||
| -rw-r--r-- | src/uk/org/ury/server/exceptions/BadRequestException.java | 47 | ||||
| -rw-r--r-- | src/uk/org/ury/server/exceptions/HandleFailureException.java | 46 | ||||
| -rw-r--r-- | src/uk/org/ury/server/exceptions/HandlerNotFoundException.java | 51 | ||||
| -rw-r--r-- | src/uk/org/ury/server/exceptions/HandlerSetupFailureException.java | 55 | ||||
| -rw-r--r-- | src/uk/org/ury/server/exceptions/HandlingException.java | 48 | ||||
| -rw-r--r-- | src/uk/org/ury/server/exceptions/NotAHandlerException.java | 34 | ||||
| -rw-r--r-- | src/uk/org/ury/server/exceptions/UnknownFunctionException.java | 37 | ||||
| -rw-r--r-- | src/uk/org/ury/server/package.html | 23 |
15 files changed, 0 insertions, 1267 deletions
diff --git a/src/uk/org/ury/server/AbstractRequestHandler.java b/src/uk/org/ury/server/AbstractRequestHandler.java deleted file mode 100644 index 9b964b0..0000000 --- a/src/uk/org/ury/server/AbstractRequestHandler.java +++ /dev/null @@ -1,254 +0,0 @@ -/** - * - */ -package uk.org.ury.server; - -import java.io.IOException; -import java.io.UnsupportedEncodingException; -import java.net.URLDecoder; -import java.util.HashMap; -import java.util.Locale; -import java.util.Map; - -import org.apache.http.HttpException; -import org.apache.http.HttpRequest; -import org.apache.http.HttpResponse; -import org.apache.http.HttpStatus; -import org.apache.http.entity.StringEntity; -import org.apache.http.protocol.HTTP; -import org.apache.http.protocol.HttpContext; -import org.apache.http.protocol.HttpRequestHandler; -import org.json.simple.JSONValue; - -import uk.org.ury.protocol.Directive; -import uk.org.ury.protocol.Status; -import uk.org.ury.server.exceptions.BadRequestException; -import uk.org.ury.server.exceptions.HandleFailureException; -import uk.org.ury.server.exceptions.HandlerNotFoundException; -import uk.org.ury.server.exceptions.HandlerSetupFailureException; -import uk.org.ury.server.exceptions.HandlingException; -import uk.org.ury.server.exceptions.NotAHandlerException; -import uk.org.ury.server.exceptions.UnknownFunctionException; - -/** - * An abstract request handler for HttpCore, providing basic functionality such - * as uniform error response. - * - * @author Matt Windsor - */ -public abstract class AbstractRequestHandler implements HttpRequestHandler { - protected Server server; - protected String mount; - - /** - * Constructs a new AbstractRequestHandler. - * - * Obviously, this class cannot be instantiated directly. - * - * @param server - * The instance of the URY server responsible for the request. - * - * @param mount - * The directory to which this handler is to be mounted. - */ - public AbstractRequestHandler(Server server, String mount) { - this.server = server; - this.mount = mount; - } - - /** - * Begins handling of a HTTP request. - * - * @param request - * The HTTP request. - * - * @param response - * The response that the handler will populate during the - * handling of the request. - * - * @param context - * The HTTP context. - */ - @Override - public void handle(HttpRequest request, HttpResponse response, - HttpContext context) throws HttpException, IOException { - String method = request.getRequestLine().getMethod() - .toUpperCase(Locale.ENGLISH); - - if (method.equals("GET")) { - try { - handleGet(request, response, context); - } catch (HandlerNotFoundException e) { - // TODO: log - serveError(request, response, HttpStatus.SC_NOT_FOUND, - e.getMessage()); - } catch (BadRequestException e) { - // TODO: log - serveError(request, response, HttpStatus.SC_BAD_REQUEST, - e.getMessage()); - } catch (HandlingException e) { - serveError(request, response, - HttpStatus.SC_INTERNAL_SERVER_ERROR, e.getMessage()); - } - } else { - serveError(request, response, HttpStatus.SC_NOT_IMPLEMENTED, - "Method not implemented."); - } - } - - /** - * Serves a HTTP plain-text error as the HTTP response for a request. - * - * @param request - * The request that is being responded to. - * - * @param response - * The response to populate with the error message. - * - * @param code - * HTTP status code to use. - * - * @param reason - * The reason to display to the client. - */ - protected void serveError(HttpRequest request, HttpResponse response, - int code, String reason) { - // Get the reason string to put in the error response. - String statusReason = ""; - - switch (code) { - case HttpStatus.SC_BAD_REQUEST: - statusReason = "Bad Request"; - break; - case HttpStatus.SC_NOT_FOUND: - statusReason = "Not Found"; - break; - default: - case HttpStatus.SC_INTERNAL_SERVER_ERROR: - statusReason = "Internal Server Error"; - break; - } - - response.setStatusLine(request.getProtocolVersion(), code, statusReason); - StringEntity entity = null; - - try { - Map<String, Object> content = new HashMap<String, Object>(); - - content.put(Directive.STATUS.toString(), Status.ERROR.toString()); - content.put(Directive.REASON.toString(), reason); - - entity = new StringEntity(JSONValue.toJSONString(content)); - } catch (UnsupportedEncodingException e) { - // TODO Auto-generated catch block - e.printStackTrace(); - } - - if (entity != null) { - entity.setContentType(HTTP.PLAIN_TEXT_TYPE); - response.setEntity(entity); - } - } - - /** - * Handles a HTTP GET request. - * - * @param request - * The HTTP request. - * - * @param response - * The response that the handler will populate during the - * handling of the request. - * - * @param context - * The HTTP context. - * - * @throws HandlerNotFoundException - * if the client requested a request handler that could not be - * found on the class path. - * - * @throws HandlerSetupFailureException - * if the handler was found but could not be set up (eg does not - * implement appropriate interface or cannot be instantiated). - * - * @throws HandleFailureException - * if an appropriate handler was contacted, but it failed to - * process the request. - * - * @throws BadRequestException - * if the request was malformed or invalid. - * - * @throws NotAHandlerException - * if the class requested to handle the request is not a - * handler. - * - * @throws UnknownFunctionException - * if the request is for a path that does not correspond to one - * of this handler's functions. - */ - protected abstract void handleGet(HttpRequest request, - HttpResponse response, HttpContext context) - throws HandlerNotFoundException, HandlerSetupFailureException, - HandleFailureException, BadRequestException, NotAHandlerException, - UnknownFunctionException; - - /** - * Parses a query string, populating a key-value map of the URL-unescaped - * results. - * - * @param query - * The query string to parse. - * - * @return A map associating parameter keys and values. - * - * @throws UnsupportedEncodingException - * if the URL decoder fails. - */ - protected final Map<String, String> parseQueryString(String query) - throws UnsupportedEncodingException { - Map<String, String> params = new HashMap<String, String>(); - - // At least one parameter - if (query != null && query.endsWith("&") == false) { - String[] qsplit = { query }; - - // More than one parameter - split the query. - if (query.contains("&")) - qsplit = query.split("&"); - - for (String param : qsplit) { - // Has a value - if (param.contains("=") && param.endsWith("=") == false) { - String[] paramsplit = param.split("="); - params.put(URLDecoder.decode(paramsplit[0], "UTF-8"), - URLDecoder.decode(paramsplit[1], "UTF-8")); - } - // Doesn't have a value - else if (param.contains("=") == false) { - params.put(URLDecoder.decode(param, "UTF-8"), null); - } - } - } - - return params; - } - - /** - * Gets the query string element of a URI. - * - * @param uri - * The Uniform Resource Indicator whose query string should be - * extracted. - * - * @return The query string, or null if it does not exist. - */ - protected final String getQueryString(String uri) { - String result = null; - - if (uri.contains("?") && uri.endsWith("?") == false) { - result = uri.split("\\?")[1]; - } - - return result; - } -}
\ No newline at end of file diff --git a/src/uk/org/ury/server/ApiRequestHandler.java b/src/uk/org/ury/server/ApiRequestHandler.java deleted file mode 100644 index a2290f8..0000000 --- a/src/uk/org/ury/server/ApiRequestHandler.java +++ /dev/null @@ -1,42 +0,0 @@ -package uk.org.ury.server; - -import java.util.Map; - -import uk.org.ury.server.exceptions.HandleFailureException; - - -/** - * Interface for classes that can handle requests addressed to their - * class name from the main server. - * - * For an example of how to implement a RequestHandler, see - * ServerRequestHandler. - * - * @author Matt Windsor - */ -public interface ApiRequestHandler -{ - /** - * Handle a server GET request (that is, a request for data - * output). - * - * @param parameters A key-value map of parameters supplied with the - * server request. Typically, the "function" - * parameter will detail the function that the - * request handler is expected to perform. - * - * @param server The server from which the request originated. - * This will be able to provide the handler with - * pooled resources, for example the database. - * - * @return A series of key-value pairs to pass back to - * the client. - * - * @throws HandleFailureException if the handler cannot - * handle the request. - */ - - public Map<String, Object> - handleGetRequest (Map<String, String> parameters, Server server) - throws HandleFailureException; -} diff --git a/src/uk/org/ury/server/HttpHandler.java b/src/uk/org/ury/server/HttpHandler.java deleted file mode 100644 index 948e03a..0000000 --- a/src/uk/org/ury/server/HttpHandler.java +++ /dev/null @@ -1,205 +0,0 @@ -/* - * HttpHandler.java - * --------------------- - * - * Part of the URY Server Platform - * - * V0.00 2011/03/20 - * - * (C) 2011 URY Computing - * - * Based on the HttpCore example code, which is available under the - * Apache License, version 2.0; the copyright notice provided with - * said code follows. - * - * ==================================================================== - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * ==================================================================== - * - * This software consists of voluntary contributions made by many - * individuals on behalf of the Apache Software Foundation. For more - * information on the Apache Software Foundation, please see - * <http://www.apache.org/>. - */ - -package uk.org.ury.server; - -import java.io.UnsupportedEncodingException; -import java.net.MalformedURLException; -import java.net.URL; -import java.util.Map; - -import org.apache.http.HttpRequest; -import org.apache.http.HttpResponse; -import org.apache.http.HttpStatus; -import org.apache.http.entity.StringEntity; -import org.apache.http.protocol.HTTP; -import org.apache.http.protocol.HttpContext; -import org.apache.http.protocol.HttpRequestHandler; -import org.json.simple.JSONValue; - -import uk.org.ury.protocol.Directive; -import uk.org.ury.protocol.Status; -import uk.org.ury.server.exceptions.BadRequestException; -import uk.org.ury.server.exceptions.HandleFailureException; -import uk.org.ury.server.exceptions.HandlerNotFoundException; -import uk.org.ury.server.exceptions.HandlerSetupFailureException; -import uk.org.ury.server.exceptions.NotAHandlerException; - -/** - * @author Matt Windsor, Apache Software Foundation - */ -public class HttpHandler extends AbstractRequestHandler implements - HttpRequestHandler { - - /** - * Construct a new HttpHandler. - * - * @param server - * The instance of the URY server responsible for the request. - * - * @param mount - * The directory to which this handler is to be mounted. - */ - public HttpHandler(Server server, String mount) { - super(server, mount); - } - - /** - * Handle a HTTP GET request. - * - * @param request - * The HTTP request. - * - * @param response - * The response that the handler will populate during the - * handling of the request. - * - * @param context - * The HTTP context. - * - * @throws HandlerNotFoundException - * if the client requested a request handler that could not be - * found on the class path. - * - * @throws HandlerSetupFailureException - * if the handler was found but could not be set up (eg does not - * implement appropriate interface or cannot be instantiated). - * - * @throws HandleFailureException - * if an appropriate handler was contacted, but it failed to - * process the request. - * - * @throws BadRequestException - * if the request was malformed or invalid. - * - * @throws NotAHandlerException - * if the class requested to handle the request is not a - * handler. - */ - @Override - public void handleGet(HttpRequest request, HttpResponse response, - HttpContext context) throws HandlerNotFoundException, - HandlerSetupFailureException, HandleFailureException, - BadRequestException, NotAHandlerException { - String path = request.getRequestLine().getUri(); - - if (path.equals("/index.html") || path.equals("/")) { - // Someone's trying to get the index page! - // Humour them. - - response.setStatusLine(request.getProtocolVersion(), - HttpStatus.SC_OK, "OK"); - - StringEntity entity = null; - - try { - entity = new StringEntity(Server.DOCTYPE + Server.INDEX_HTML); - } catch (UnsupportedEncodingException e) { - throw new HandlerSetupFailureException("(Index page)", e); - } - - entity.setContentType("text/html"); - - response.setEntity(entity); - } else { - // Convert this into a URL and fan out the various parts of it. - - URL pathURL = null; - - try { - pathURL = new URL("http://localhost" + path); - } catch (MalformedURLException e) { - throw new BadRequestException(e); - } - - String className = "uk.org.ury" - + pathURL.getPath().replace('/', '.'); - System.out.println(className); - Class<?> newClass = null; - - try { - newClass = Class.forName(className); - } catch (ClassNotFoundException e) { - throw new HandlerNotFoundException(className, e); - } - - if (ApiRequestHandler.class.isAssignableFrom(newClass) == false) - throw new NotAHandlerException(className); - - String queryString = pathURL.getQuery(); - Map<String, String> parameters; - - try { - parameters = parseQueryString(queryString); - } catch (UnsupportedEncodingException e) { - throw new HandlerSetupFailureException(className, e); - } - - Map<String, Object> content = null; - - try { - ApiRequestHandler srh = ((ApiRequestHandler) newClass - .newInstance()); - content = srh.handleGetRequest(parameters, server); - } catch (InstantiationException e) { - throw new HandlerSetupFailureException(className, e); - } catch (IllegalAccessException e) { - throw new HandlerSetupFailureException(className, e); - } - - // Everything seems OK, so make the response. - - response.setStatusLine(request.getProtocolVersion(), - HttpStatus.SC_OK, "OK"); - - content.put(Directive.STATUS.toString(), Status.OK.toString()); - - StringEntity entity = null; - - try { - entity = new StringEntity(JSONValue.toJSONString(content)); - } catch (UnsupportedEncodingException e) { - throw new HandlerSetupFailureException(className, e); - } - - entity.setContentType(HTTP.PLAIN_TEXT_TYPE); - response.setEntity(entity); - } - } -} diff --git a/src/uk/org/ury/server/HttpListenerThread.java b/src/uk/org/ury/server/HttpListenerThread.java deleted file mode 100644 index c6b042b..0000000 --- a/src/uk/org/ury/server/HttpListenerThread.java +++ /dev/null @@ -1,127 +0,0 @@ -/* - * HttpListenerThread.java - * ----------------------- - * - * Part of the URY Server Platform - * - * V0.00 2011/03/20 - * - * (C) 2011 URY Computing - * - * Based on the HttpCore example code, which is available under the - * Apache License, version 2.0; the copyright notice provided with - * said code follows. - * - * ==================================================================== - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * ==================================================================== - * - * This software consists of voluntary contributions made by many - * individuals on behalf of the Apache Software Foundation. For more - * information on the Apache Software Foundation, please see - * <http://www.apache.org/>. - */ - -package uk.org.ury.server; - -import java.io.IOException; -import java.net.ServerSocket; -import java.net.Socket; - -import org.apache.http.HttpResponseInterceptor; -import org.apache.http.impl.DefaultConnectionReuseStrategy; -import org.apache.http.impl.DefaultHttpResponseFactory; -import org.apache.http.impl.DefaultHttpServerConnection; -import org.apache.http.params.CoreConnectionPNames; -import org.apache.http.params.CoreProtocolPNames; -import org.apache.http.params.HttpParams; -import org.apache.http.params.SyncBasicHttpParams; -import org.apache.http.protocol.HttpProcessor; -import org.apache.http.protocol.HttpRequestHandlerRegistry; -import org.apache.http.protocol.HttpService; -import org.apache.http.protocol.ImmutableHttpProcessor; -import org.apache.http.protocol.ResponseConnControl; -import org.apache.http.protocol.ResponseContent; -import org.apache.http.protocol.ResponseDate; -import org.apache.http.protocol.ResponseServer; - -import uk.org.ury.library.LibraryRequestHandler; - -/** - * Listener thread for the URY server HTTP interface. - * - * @author Matt Windsor, Apache Software Foundation - */ -public class HttpListenerThread extends Thread { - private ServerSocket ssocket; - private HttpParams params; - private HttpProcessor httpproc; - private HttpRequestHandlerRegistry registry; - private HttpService service; - - public HttpListenerThread(int port, Server server) throws IOException { - ssocket = new ServerSocket(port); - params = new SyncBasicHttpParams(); - - params.setIntParameter(CoreConnectionPNames.SO_TIMEOUT, 5000) - .setIntParameter(CoreConnectionPNames.SOCKET_BUFFER_SIZE, - 8 * 1024) - .setBooleanParameter( - CoreConnectionPNames.STALE_CONNECTION_CHECK, false) - .setBooleanParameter(CoreConnectionPNames.TCP_NODELAY, true) - .setParameter(CoreProtocolPNames.ORIGIN_SERVER, - "HttpComponents/1.1"); - - httpproc = new ImmutableHttpProcessor(new HttpResponseInterceptor[] { - new ResponseDate(), new ResponseServer(), - new ResponseContent(), new ResponseConnControl() }); - - registry = new HttpRequestHandlerRegistry(); - registry.register("/library/*", new LibraryRequestHandler(server, - "/library")); - registry.register("*", new HttpHandler(server, "")); - - service = new HttpService(httpproc, - new DefaultConnectionReuseStrategy(), - new DefaultHttpResponseFactory(), registry, params); - } - - /** - * Thread execution body. - */ - @Override - public void run() { - while (Thread.interrupted() == false) { - Socket csocket = null; - DefaultHttpServerConnection conn = new DefaultHttpServerConnection(); - Thread thread = null; - - try { - csocket = ssocket.accept(); - conn.bind(csocket, params); - } catch (IOException e) { - e.printStackTrace(); - break; - } - - thread = new HttpWorkerThread(service, conn); - thread.setDaemon(true); - thread.start(); - } - } -} diff --git a/src/uk/org/ury/server/HttpWorkerThread.java b/src/uk/org/ury/server/HttpWorkerThread.java deleted file mode 100644 index 246038c..0000000 --- a/src/uk/org/ury/server/HttpWorkerThread.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * HttpWorkerThread.java - * --------------------- - * - * Part of the URY Server Platform - * - * V0.00 2011/03/20 - * - * (C) 2011 URY Computing - * - * Based on the HttpCore example code, which is available under the - * Apache License, version 2.0; the copyright notice provided with - * said code follows. - * - * ==================================================================== - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * ==================================================================== - * - * This software consists of voluntary contributions made by many - * individuals on behalf of the Apache Software Foundation. For more - * information on the Apache Software Foundation, please see - * <http://www.apache.org/>. - */ - -package uk.org.ury.server; - -import java.io.IOException; -import java.io.InterruptedIOException; - -import org.apache.http.ConnectionClosedException; -import org.apache.http.HttpException; -import org.apache.http.HttpServerConnection; -import org.apache.http.protocol.BasicHttpContext; -import org.apache.http.protocol.HttpContext; -import org.apache.http.protocol.HttpService; - -/** - * A worker thread in the server HTTP interface. - * - * This thread handles requests from the connected client, passing them to the - * request handler(s). - * - * @author Matt Windsor, Apache Software Foundation - */ -public class HttpWorkerThread extends Thread { - private final HttpService service; - private final HttpServerConnection conn; - - /** - * Construct a new HttpWorkerThread. - * - * @param service - * The HTTP service the thread is working for. - * @param conn - * The connection the thread is listening on. - */ - public HttpWorkerThread(HttpService service, HttpServerConnection conn) { - super(); - this.service = service; - this.conn = conn; - } - - /** - * Thread execution body. - */ - public void run() { - HttpContext context = new BasicHttpContext(null); - - try { - while (Thread.interrupted() == false && conn.isOpen()) { - service.handleRequest(conn, context); - } - } catch (ConnectionClosedException e) { - System.out.println("Client closed connection."); - } catch (InterruptedIOException e) { - System.out.println("Interrupted IO: " + e.getMessage()); - } catch (IOException e) { - e.printStackTrace(); - } catch (HttpException e) { - e.printStackTrace(); - } finally { - try { - conn.shutdown(); - } catch (IOException e) { - // Ignore - } - } - } -} diff --git a/src/uk/org/ury/server/Server.java b/src/uk/org/ury/server/Server.java deleted file mode 100644 index 0ab8c8c..0000000 --- a/src/uk/org/ury/server/Server.java +++ /dev/null @@ -1,99 +0,0 @@ -/* - * Server.java - * ----------- - * - * Part of the URY Server Platform - * - * V0.00 2011/03/20 - * - * (C) 2011 URY Computing - */ - -package uk.org.ury.server; - -import java.io.IOException; - -import uk.org.ury.config.ConfigReader; -import uk.org.ury.database.DatabaseDriver; -import uk.org.ury.database.UserClass; -import uk.org.ury.database.exceptions.ConnectionFailureException; -import uk.org.ury.database.exceptions.MissingCredentialsException; - -/** - * The unified URY server, accepting requests over HTTP. - * - * @author Matt Windsor - * @version 2011.0320 - */ -public class Server { - public static final String SERVER_VERSION = "SLUT 0.0"; - public static final String DOCTYPE = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\"" - + "\"http://www.w3.org/TR/html4/strict.dtd\">"; - public static final String INDEX_HTML = "\n<html>" + "\n <head>" - + "\n <title>" + SERVER_VERSION + "</title>" + "\n </head>" - + "\n <body>" + "\n <h1>Welcome to the " + SERVER_VERSION - + " server</h1>" - + "\n <p>This server exposes a class-based API for accessing" - + "\n the internals of the " + SERVER_VERSION + " system.</p>" - + "\n <p>See the documentation for details.</p>" + "\n </body>" - + "\n</html>"; - - /** - * The main method, which serves to create a server. - * - * @param args - * The argument vector. - */ - public static void main(String[] args) { - Server srv = new Server(); - srv.run(); - } - - /** - * Run the server. - */ - private void run() { - Thread thread = null; - - try { - thread = new HttpListenerThread(8000, this); - } catch (IOException e) { - e.printStackTrace(); - System.exit(-1); - } - - thread.setDaemon(false); - thread.run(); - } - - /** - * Gets a database connection using the given user class. - * - * @param userClass - * The user class to get a connection for. - * - * @return a database connection, which may or may not have been created on - * this call. - * - * @throws MissingCredentialsException - * if the credentials for the given userclass are missing. - * - * @throws ConnectionFailureException - * if the connection failed. - */ - public DatabaseDriver getDatabaseConnection(UserClass userClass) - throws MissingCredentialsException, ConnectionFailureException { - // TODO: Singleton - - ConfigReader config = new ConfigReader("res/conf.xml"); - - return new DatabaseDriver(config, UserClass.READ_ONLY); - } - - /** - * @return the version string of the server. - */ - public String getVersion() { - return SERVER_VERSION; - } -} diff --git a/src/uk/org/ury/server/ServerRequestHandler.java b/src/uk/org/ury/server/ServerRequestHandler.java deleted file mode 100644 index df67faf..0000000 --- a/src/uk/org/ury/server/ServerRequestHandler.java +++ /dev/null @@ -1,95 +0,0 @@ -/** - * - */ -package uk.org.ury.server; - -import java.util.HashMap; -import java.util.Map; - -import uk.org.ury.server.Server; -import uk.org.ury.server.ApiRequestHandler; -import uk.org.ury.server.exceptions.HandleFailureException; - - -/** - * A request handler for server queries. - * - * @author Matt Windsor - */ - -public class ServerRequestHandler implements ApiRequestHandler -{ - /** - * Handle a server GET request (that is, a request for data - * output). - * - * @param parameters A key-value map of parameters supplied with - * the server request. Typically, the function - * parameter will detail the function that the - * request handler is expected to perform. - * - * @param server The server from which the request originated. - * This will be able to provide the handler with - * pooled resources, for example the database. - * - * @return A list of lines to return in the body of the - * server's response to the client. - * - * @throws HandleFailureException if the handler cannot - * handle the request. - */ - - @Override - public Map<String, Object> - handleGetRequest (Map<String, String> parameters, Server server) - throws HandleFailureException - { - Map<String, Object> response = new HashMap<String, Object> (); - - if (parameters.containsKey ("function")) - { - String function = parameters.get ("function"); - - if (function.equals ("info")) - { - getInfo (response, server); - } - else if (function.equals ("help")) - { - response.put ("INFO", "Available functions:"); - response.put ("INFO", "info - Get server information."); - } - else if (function.equals ("test")) - response.put ("INFO", "Test succeeded."); - else - throw new HandleFailureException ("Unknown function: " - + function + ". (Try 'function=help'.)"); - - } - else - throw new HandleFailureException ("No function provided. (Try 'function=help'.)"); - - return response; - } - - - /** - * Retrieve information about the server. - * - * @param response The response list to populate. - * - * @param server The server providing database resources. - * - * @throws HandleFailureException if an error occurs - * that thwarts the handling of the request. - */ - - private void - getInfo (Map<String, Object> response, Server server) - throws HandleFailureException - { - response.put ("INFO", "University Radio York BAPS Replacement"); - response.put ("INFO", "Server version is " + server.getVersion ()); - } - -} diff --git a/src/uk/org/ury/server/exceptions/BadRequestException.java b/src/uk/org/ury/server/exceptions/BadRequestException.java deleted file mode 100644 index 189c7f5..0000000 --- a/src/uk/org/ury/server/exceptions/BadRequestException.java +++ /dev/null @@ -1,47 +0,0 @@ -/** - * - */ -package uk.org.ury.server.exceptions; - -/** - * Exception thrown when the server meets a malformed request, or - * part of one. - * - * @author Matt Windsor - */ - -public class BadRequestException extends HandlingException -{ - - /** - * - */ - private static final long serialVersionUID = 1825771401085225357L; - - - /** - * Construct a new BadRequestException with a default reason. - */ - - public - BadRequestException () - { - super ("Bad request."); - } - - - /** - * Construct a new HandlerNotFoundException with a chained - * exception. - * - * @param cause The exception that this new exception is to - * wrap. - */ - - public - BadRequestException (Throwable cause) - { - super ("Bad request. (" - + cause.getMessage () + ")", cause); - } -} diff --git a/src/uk/org/ury/server/exceptions/HandleFailureException.java b/src/uk/org/ury/server/exceptions/HandleFailureException.java deleted file mode 100644 index ddcfdea..0000000 --- a/src/uk/org/ury/server/exceptions/HandleFailureException.java +++ /dev/null @@ -1,46 +0,0 @@ -/** - * - */ -package uk.org.ury.server.exceptions; - -/** - * Generic exception thrown when a server request handler fails to - * handle a request. - * - * @author Matt Windsor - */ - -public class HandleFailureException extends HandlingException -{ - - /** - * Change this! ---v - */ - - private static final long serialVersionUID = -397479334359858162L; - - - /** - * Construct a new HandleFailureException with a - * default reason. - */ - - public - HandleFailureException () - { - super ("Server request handler failed to handle the request."); - } - - - /** - * Construct a new HandleFailureException. - * - * @param reason The explanation for the exception. - */ - - public - HandleFailureException (String reason) - { - super (reason); - } -} diff --git a/src/uk/org/ury/server/exceptions/HandlerNotFoundException.java b/src/uk/org/ury/server/exceptions/HandlerNotFoundException.java deleted file mode 100644 index 7b614f6..0000000 --- a/src/uk/org/ury/server/exceptions/HandlerNotFoundException.java +++ /dev/null @@ -1,51 +0,0 @@ -/** - * - */ -package uk.org.ury.server.exceptions; - -/** - * Exception thrown when the server request handler requested - * by the client is not * found in the class space. - * - * @author Matt Windsor - */ - -public class HandlerNotFoundException extends HandlingException -{ - - /** - * TODO: Change this! ---v - */ - - private static final long serialVersionUID = -397479334359858162L; - - - /** - * Construct a new HandlerNotFoundException with a - * default reason. - */ - - public - HandlerNotFoundException () - { - super ("Handler not found."); - } - - - /** - * Construct a new HandlerNotFoundException with a class name and - * chained exception. - * - * @param className The name of the missing handler class. - * - * @param cause The exception that this new exception is to - * wrap. - */ - - public - HandlerNotFoundException (String className, Throwable cause) - { - super ("Handler " + className + " not found. (" - + cause.getMessage () + ")", cause); - } -} diff --git a/src/uk/org/ury/server/exceptions/HandlerSetupFailureException.java b/src/uk/org/ury/server/exceptions/HandlerSetupFailureException.java deleted file mode 100644 index d301eac..0000000 --- a/src/uk/org/ury/server/exceptions/HandlerSetupFailureException.java +++ /dev/null @@ -1,55 +0,0 @@ -/** - * - */ -package uk.org.ury.server.exceptions; - -/** - * Exception thrown when the server request handler requested - * by the client cannot be set up to process the request. - * - * @author Matt Windsor - */ - -public class HandlerSetupFailureException extends HandlingException -{ - - /** - * TODO: Change this! ---v - */ - - private static final long serialVersionUID = -397479334359858162L; - - - /** - * Construct a new HandlerNotFoundException with a - * default reason. - */ - - public - HandlerSetupFailureException () - { - super ("Handler setup failed."); - } - - - /** - * Construct a new HandlerSetupFailureException with a class name - * and chained exception. - * - * Use this to hide exception specifics from higher abstraction - * layers. - * - * @param className The name of the failed handler class. - * - * @param cause The exception that this new exception is to - * wrap. - */ - - public - HandlerSetupFailureException (String className, - Throwable cause) - { - super ("Setup for handler " + className + " failed (reason: " - + cause.getMessage () + ").", cause); - } -} diff --git a/src/uk/org/ury/server/exceptions/HandlingException.java b/src/uk/org/ury/server/exceptions/HandlingException.java deleted file mode 100644 index 2ce681b..0000000 --- a/src/uk/org/ury/server/exceptions/HandlingException.java +++ /dev/null @@ -1,48 +0,0 @@ -/** - * - */ -package uk.org.ury.server.exceptions; - -/** - * Generic exception thrown when the server cannot handle a request. - * - * @author Matt Windsor - */ - -public class HandlingException extends Exception -{ - /** - * TODO: Change this! ---v - */ - - private static final long serialVersionUID = -397479334359858162L; - - - /** - * Construct a HandlingException with a reason. - * - * @param string The reason to present. - */ - - public - HandlingException (String string) - { - super (string); - } - - - /** - * Construct a HandlingException with a reason and a cause to - * chain. - * - * @param string The reason to present. - * - * @param cause The thrown cause that this exception should wrap. - */ - - public - HandlingException (String string, Throwable cause) - { - super (string, cause); - } -} diff --git a/src/uk/org/ury/server/exceptions/NotAHandlerException.java b/src/uk/org/ury/server/exceptions/NotAHandlerException.java deleted file mode 100644 index 9a67d62..0000000 --- a/src/uk/org/ury/server/exceptions/NotAHandlerException.java +++ /dev/null @@ -1,34 +0,0 @@ -/** - * - */ -package uk.org.ury.server.exceptions; - -/** - * Exception thrown if the class requested as a handler by the client - * is, in fact, not a handler (it does not implement RequestHandler). - * - * @author Matt Windsor - */ - -public class NotAHandlerException extends HandlingException -{ - /** - * - */ - private static final long serialVersionUID = -7268289187311868036L; - - /** - * Construct a NotAHandlerException with the name of the class that - * is not a handler. - * - * @param className The name of the offending class. - */ - - public - NotAHandlerException (String className) - { - super ("Class " + className + " is not a request handler."); - // TODO Auto-generated constructor stub - } - -} diff --git a/src/uk/org/ury/server/exceptions/UnknownFunctionException.java b/src/uk/org/ury/server/exceptions/UnknownFunctionException.java deleted file mode 100644 index 13c1386..0000000 --- a/src/uk/org/ury/server/exceptions/UnknownFunctionException.java +++ /dev/null @@ -1,37 +0,0 @@ -/* - * UnknownFunctionException.java - * ----------------------------- - * - * Part of the URY Server Platform - * - * V0.00 2011/03/20 - * - * (C) 2011 URY Computing - */ - -package uk.org.ury.server.exceptions; - -/** - * Exception thrown when a handler receives a request for a path that does not - * correspond to one of its functions. - * - * @author Matt Windsor - * - */ -public class UnknownFunctionException extends HandlingException { - /** - * - */ - private static final long serialVersionUID = -7557785978712465975L; - - /** - * Construct a new UnknownFunctionException. - * - * @param path - * The path that was requested. - */ - public UnknownFunctionException(String path) { - super("Not found: " + path); - } - -} diff --git a/src/uk/org/ury/server/package.html b/src/uk/org/ury/server/package.html deleted file mode 100644 index b19b3b7..0000000 --- a/src/uk/org/ury/server/package.html +++ /dev/null @@ -1,23 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" -"http://www.w3.org/TR/html4/strict.dtd"> - -<HTML> - <HEAD> - <TITLE>uk.org.ury.server</TITLE> - </HEAD> - <BODY> - <P>The URY Server kernel.</P> - <P>The URY Server provides high-level access to the assets - (database, files and sound playback) available on the computer - systems of a radio station, exposing an intuitive application - programming interface using standard formats.</P> - <P>The server kernel consists of an Apache HttpCore-based HTTP - server implementation, which serves the high-level interface - to the server, code for managing the external modules that make - up the URY backend, and a common provider of objects useful to - server-level modules.</P> - <P>Though designed and built to replace the systems in place - at University Radio York, it is hoped that the URY Server will - be of use - </BODY> -</HTML>
\ No newline at end of file |