Specify return type explicitely to avoid faulty inferring
[Sone.git] / src / main / java / net / pterodactylus / sone / web / ajax / JsonPage.java
index 3c7f587..9583437 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - JsonPage.java - Copyright © 2010–2013 David Roden
+ * Sone - JsonPage.java - Copyright © 2010–2016 David Roden
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 
 package net.pterodactylus.sone.web.ajax;
 
+import static java.util.logging.Logger.getLogger;
+
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.io.PrintWriter;
-import java.net.URI;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import javax.annotation.Nonnull;
+
 import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.sone.web.SessionProvider;
 import net.pterodactylus.sone.web.WebInterface;
-import net.pterodactylus.sone.web.page.FreenetPage;
 import net.pterodactylus.sone.web.page.FreenetRequest;
 import net.pterodactylus.util.io.Closer;
-import net.pterodactylus.util.logging.Logging;
 import net.pterodactylus.util.web.Page;
 import net.pterodactylus.util.web.Response;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import freenet.clients.http.SessionManager.Session;
 import freenet.clients.http.ToadletContext;
 
 /**
@@ -44,10 +45,10 @@ import freenet.clients.http.ToadletContext;
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public abstract class JsonPage implements FreenetPage {
+public abstract class JsonPage implements Page<FreenetRequest> {
 
        /** The logger. */
-       private static final Logger logger = Logging.getLogger(JsonPage.class);
+       private static final Logger logger = getLogger(JsonPage.class.getName());
 
        /** The JSON serializer. */
        private static final ObjectMapper objectMapper = new ObjectMapper();
@@ -57,6 +58,7 @@ public abstract class JsonPage implements FreenetPage {
 
        /** The Sone web interface. */
        protected final WebInterface webInterface;
+       private final SessionProvider sessionProvider;
 
        /**
         * Creates a new JSON page at the given path.
@@ -69,66 +71,19 @@ public abstract class JsonPage implements FreenetPage {
        public JsonPage(String path, WebInterface webInterface) {
                this.path = path;
                this.webInterface = webInterface;
+               this.sessionProvider = webInterface;
        }
 
        //
        // ACCESSORS
        //
 
-       /**
-        * Returns the current session, creating a new session if there is no
-        * current session.
-        *
-        * @param toadletContenxt
-        *            The toadlet context
-        * @return The current session, or {@code null} if there is no current
-        *         session
-        */
-       protected Session getCurrentSession(ToadletContext toadletContenxt) {
-               return webInterface.getCurrentSession(toadletContenxt);
-       }
-
-       /**
-        * Returns the current session, creating a new session if there is no
-        * current session and {@code create} is {@code true}.
-        *
-        * @param toadletContenxt
-        *            The toadlet context
-        * @param create
-        *            {@code true} to create a new session if there is no current
-        *            session, {@code false} otherwise
-        * @return The current session, or {@code null} if there is no current
-        *         session
-        */
-       protected Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
-               return webInterface.getCurrentSession(toadletContenxt, create);
-       }
-
-       /**
-        * Returns the currently logged in Sone.
-        *
-        * @param toadletContext
-        *            The toadlet context
-        * @return The currently logged in Sone, or {@code null} if no Sone is
-        *         currently logged in
-        */
        protected Sone getCurrentSone(ToadletContext toadletContext) {
-               return webInterface.getCurrentSone(toadletContext);
+               return sessionProvider.getCurrentSone(toadletContext, true);
        }
 
-       /**
-        * Returns the currently logged in Sone.
-        *
-        * @param toadletContext
-        *            The toadlet context
-        * @param create
-        *            {@code true} to create a new session if no session exists,
-        *            {@code false} to not create a new session
-        * @return The currently logged in Sone, or {@code null} if no Sone is
-        *         currently logged in
-        */
-       protected Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
-               return webInterface.getCurrentSone(toadletContext, create);
+       protected Sone getCurrentSone(ToadletContext toadletContext, boolean createSession) {
+               return sessionProvider.getCurrentSone(toadletContext, createSession);
        }
 
        //
@@ -143,7 +98,8 @@ public abstract class JsonPage implements FreenetPage {
         *            The request to handle
         * @return The created JSON object
         */
-       protected abstract JsonReturnObject createJsonObject(FreenetRequest request);
+       @Nonnull
+       protected abstract JsonReturnObject createJsonObject(@Nonnull FreenetRequest request);
 
        /**
         * Returns whether this command needs the form password for authentication
@@ -177,6 +133,7 @@ public abstract class JsonPage implements FreenetPage {
         *
         * @return A reply signaling success
         */
+       @Nonnull
        protected static JsonReturnObject createSuccessJsonObject() {
                return new JsonReturnObject(true);
        }
@@ -188,6 +145,7 @@ public abstract class JsonPage implements FreenetPage {
         *            The error that has occured
         * @return The JSON object, signalling failure and the error code
         */
+       @Nonnull
        protected static JsonReturnObject createErrorJsonObject(String error) {
                return new JsonErrorReturnObject(error);
        }
@@ -240,14 +198,6 @@ public abstract class JsonPage implements FreenetPage {
                }
        }
 
-       /**
-        * {@inheritDoc}
-        */
-       @Override
-       public boolean isLinkExcepted(URI link) {
-               return false;
-       }
-
        //
        // PRIVATE METHODS
        //
@@ -265,10 +215,10 @@ public abstract class JsonPage implements FreenetPage {
                OutputStreamWriter writer = null;
                PrintWriter printWriter = null;
                try {
-                       writer = new OutputStreamWriter(byteArrayOutputStream, "uTF-8");
+                       writer = new OutputStreamWriter(byteArrayOutputStream, "UTF-8");
                        printWriter = new PrintWriter(writer);
                        t.printStackTrace(printWriter);
-                       byteArrayOutputStream.flush();
+                       printWriter.flush();
                        return byteArrayOutputStream.toByteArray();
                } catch (IOException ioe1) {
                        /* quite not possible. */