You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by ng...@apache.org on 2011/01/16 14:18:36 UTC
svn commit: r1059552 -
/mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/
Author: ngn
Date: Sun Jan 16 13:18:35 2011
New Revision: 1059552
URL: http://svn.apache.org/viewvc?rev=1059552&view=rev
Log:
Adding Javadoc
Modified:
mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdHocCommandDataBuilder.java
mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsole.java
mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsoleController.java
mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ExtendedXMPPConnection.java
mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/HtmlFormBuilder.java
mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ResourceNotFoundException.java
Modified: mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdHocCommandDataBuilder.java
URL: http://svn.apache.org/viewvc/mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdHocCommandDataBuilder.java?rev=1059552&r1=1059551&r2=1059552&view=diff
==============================================================================
--- mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdHocCommandDataBuilder.java (original)
+++ mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdHocCommandDataBuilder.java Sun Jan 16 13:18:35 2011
@@ -26,8 +26,18 @@ import org.jivesoftware.smackx.FormField
import org.jivesoftware.smackx.packet.AdHocCommandData;
import org.jivesoftware.smackx.packet.DataForm;
+/**
+ * Builds {@link AdHocCommandData} from posted data
+ *
+ * @author The Apache MINA Project (dev@mina.apache.org)
+ */
public class AdHocCommandDataBuilder {
+ /**
+ * Builds {@link AdHocCommandData} from posted data
+ * @param parameters
+ * @return
+ */
public AdHocCommandData build(Map<String, String[]> parameters) {
AdHocCommandData commandData = new AdHocCommandData();
commandData.setSessionID(getSingleValue(parameters, AdminConsoleController.SESSION_FIELD));
Modified: mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsole.java
URL: http://svn.apache.org/viewvc/mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsole.java?rev=1059552&r1=1059551&r2=1059552&view=diff
==============================================================================
--- mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsole.java (original)
+++ mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsole.java Sun Jan 16 13:18:35 2011
@@ -23,12 +23,20 @@ import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.webapp.WebAppContext;
-
+/**
+ * Standalone admin console. Defaults to listening on port 8222.
+ *
+ * @author The Apache MINA Project (dev@mina.apache.org)
+ */
public class AdminConsole {
- private int port = 8080;
+ private int port = 8222;
private Server server;
-
+
+ /**
+ * Start the admin console in an embedded web server
+ * @throws Exception
+ */
public void start() throws Exception {
server = new Server(port);
@@ -42,7 +50,27 @@ public class AdminConsole {
server.start();
}
+ /**
+ * Stop the admin console
+ * @throws Exception
+ */
public void stop() throws Exception {
server.stop();
}
+
+ /**
+ * Get the port on which the admin console will listen. Defaults to 8222.
+ * @return The port
+ */
+ public int getPort() {
+ return port;
+ }
+
+ /**
+ * Set the port on which the admin console will listen.
+ * @param port The port
+ */
+ public void setPort(int port) {
+ this.port = port;
+ }
}
Modified: mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsoleController.java
URL: http://svn.apache.org/viewvc/mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsoleController.java?rev=1059552&r1=1059551&r2=1059552&view=diff
==============================================================================
--- mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsoleController.java (original)
+++ mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/AdminConsoleController.java Sun Jan 16 13:18:35 2011
@@ -45,6 +45,11 @@ import org.springframework.web.bind.anno
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.servlet.ModelAndView;
+/**
+ * MVC controller
+ *
+ * @author The Apache MINA Project (dev@mina.apache.org)
+ */
@Controller
public class AdminConsoleController {
@@ -71,6 +76,9 @@ public class AdminConsoleController {
this.connectionConfiguration = connectionConfiguration;
}
+ /**
+ * Show the first page
+ */
@RequestMapping("/")
public ModelAndView index(HttpSession session) throws XMPPException {
ExtendedXMPPConnection client = (ExtendedXMPPConnection) session.getAttribute(SESSION_ATTRIBUTE);
@@ -91,7 +99,9 @@ public class AdminConsoleController {
return entity.getBareJID().getFullQualifiedName();
}
-
+ /**
+ * Show the initial command form
+ */
@RequestMapping(value="/{command}", method=RequestMethod.GET)
public ModelAndView command(@PathVariable("command") String command, HttpSession session) throws XMPPException {
ExtendedXMPPConnection client = (ExtendedXMPPConnection) session.getAttribute(SESSION_ATTRIBUTE);
@@ -116,6 +126,9 @@ public class AdminConsoleController {
}
}
+ /**
+ * Handle a submitted form and show the result or additional form
+ */
@RequestMapping(value="/{command}", method=RequestMethod.POST)
public ModelAndView submitCommand(@PathVariable("command") String command, HttpServletRequest request, HttpSession session) throws XMPPException {
ExtendedXMPPConnection client = (ExtendedXMPPConnection) session.getAttribute(SESSION_ATTRIBUTE);
@@ -191,6 +204,9 @@ public class AdminConsoleController {
return new ExtendedXMPPConnection(connectionConfiguration);
}
+ /**
+ * Connect and authenticate the user
+ */
@RequestMapping(value="/login", method=RequestMethod.POST)
public ModelAndView login(@RequestParam("username") String username, @RequestParam("password") String password, HttpSession session) {
ExtendedXMPPConnection client = createXMPPConnection();
@@ -206,6 +222,9 @@ public class AdminConsoleController {
}
}
+ /**
+ * Log out and disconnect the user
+ */
@RequestMapping(value="/logout")
public ModelAndView logout(HttpSession session) {
ExtendedXMPPConnection client = (ExtendedXMPPConnection) session.getAttribute(SESSION_ATTRIBUTE);
Modified: mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ExtendedXMPPConnection.java
URL: http://svn.apache.org/viewvc/mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ExtendedXMPPConnection.java?rev=1059552&r1=1059551&r2=1059552&view=diff
==============================================================================
--- mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ExtendedXMPPConnection.java (original)
+++ mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ExtendedXMPPConnection.java Sun Jan 16 13:18:35 2011
@@ -30,6 +30,11 @@ import org.jivesoftware.smack.XMPPConnec
import org.jivesoftware.smack.filter.PacketFilter;
import org.jivesoftware.smack.packet.Packet;
+/**
+ * Extends {@link XMPPConnection} to add support for synchronous request-response
+ *
+ * @author The Apache MINA Project (dev@mina.apache.org)
+ */
public class ExtendedXMPPConnection extends XMPPConnection {
public ExtendedXMPPConnection(ConnectionConfiguration config, CallbackHandler callbackHandler) {
@@ -72,6 +77,12 @@ public class ExtendedXMPPConnection exte
}
}
+ /**
+ * Send a request and wait for the response.
+ * @param request
+ * @return
+ * @throws InterruptedException
+ */
public Packet sendSync(Packet request) throws InterruptedException {
LinkedBlockingQueue<Packet> queue = new LinkedBlockingQueue<Packet>();
PacketListener listener = new SyncPacketListener(queue);
Modified: mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/HtmlFormBuilder.java
URL: http://svn.apache.org/viewvc/mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/HtmlFormBuilder.java?rev=1059552&r1=1059551&r2=1059552&view=diff
==============================================================================
--- mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/HtmlFormBuilder.java (original)
+++ mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/HtmlFormBuilder.java Sun Jan 16 13:18:35 2011
@@ -27,8 +27,18 @@ import org.jivesoftware.smackx.FormField
import org.jivesoftware.smackx.FormField.Option;
import org.jivesoftware.smackx.packet.DataForm;
+/**
+ * Builds an HTML form from a {@link DataForm}
+ *
+ * @author The Apache MINA Project (dev@mina.apache.org)
+ */
public class HtmlFormBuilder {
+ /**
+ * Builds an HTML form from a {@link DataForm}
+ * @param form
+ * @return
+ */
public String build(DataForm form) {
if (form == null)
return "";
Modified: mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ResourceNotFoundException.java
URL: http://svn.apache.org/viewvc/mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ResourceNotFoundException.java?rev=1059552&r1=1059551&r2=1059552&view=diff
==============================================================================
--- mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ResourceNotFoundException.java (original)
+++ mina/vysper/trunk/server/admin-console/src/main/java/org/apache/vysper/console/ResourceNotFoundException.java Sun Jan 16 13:18:35 2011
@@ -22,6 +22,10 @@ package org.apache.vysper.console;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;
+/**
+ *
+ * @author The Apache MINA Project (dev@mina.apache.org)
+ */
@SuppressWarnings("serial")
@ResponseStatus(value=HttpStatus.NOT_FOUND)
public class ResourceNotFoundException extends RuntimeException {