From e265ef0b8f99024736dc69beba946b9928a7bbf1 Mon Sep 17 00:00:00 2001 From: delvh Date: Mon, 30 Dec 2019 15:15:25 +0100 Subject: [PATCH] Updated Javadoc --- .../server/LoginCredentialProcessor.java | 12 +++-- .../java/envoy/server/MessageProcessor.java | 10 ++-- .../envoy/server/ObjectMessageProcessor.java | 46 +++++++++++-------- .../envoy/server/ObjectMessageReader.java | 20 ++++---- .../java/envoy/server/ObjectProcessor.java | 21 +++++++-- src/main/java/envoy/server/Startup.java | 11 ++++- 6 files changed, 77 insertions(+), 43 deletions(-) diff --git a/src/main/java/envoy/server/LoginCredentialProcessor.java b/src/main/java/envoy/server/LoginCredentialProcessor.java index 37f36e7..f208a3e 100644 --- a/src/main/java/envoy/server/LoginCredentialProcessor.java +++ b/src/main/java/envoy/server/LoginCredentialProcessor.java @@ -4,24 +4,26 @@ import envoy.data.LoginCredentials; import envoy.data.User; /** + * This {@link ObjectProcessor} handles {@link LoginCredentials}.
+ *
* Project: envoy-server-standalone
* File: LoginCredentialProcessor.java
* Created: 30.12.2019
- * + * * @author Kai S. K. Engelbart - * @since + * @since Envoy Server Standalone v0.1-alpha */ public class LoginCredentialProcessor implements ObjectProcessor { // TODO: Acquire user IDs from database private static long currentUserId = 1; + @Override + public Class getInputClass() { return LoginCredentials.class; } + @Override public User process(LoginCredentials input) { System.out.println("Received login credentials " + input); return new User(currentUserId++, input.getName()); } - - @Override - public Class getInputClass() { return LoginCredentials.class; } } diff --git a/src/main/java/envoy/server/MessageProcessor.java b/src/main/java/envoy/server/MessageProcessor.java index 85313ca..ea52c55 100644 --- a/src/main/java/envoy/server/MessageProcessor.java +++ b/src/main/java/envoy/server/MessageProcessor.java @@ -3,18 +3,20 @@ package envoy.server; import envoy.data.Message; /** + * This {@link ObjectProcessor} handles incoming {@link Message}s.
+ *
* Project: envoy-server-standalone
* File: MessageProcessor.java
* Created: 30.12.2019
- * + * * @author Kai S. K. Engelbart - * @since + * @since Envoy Server Standalone v0.1-alpha */ public class MessageProcessor implements ObjectProcessor { @Override - public Void process(Message input) { return null; } + public Class getInputClass() { return Message.class; } @Override - public Class getInputClass() { return Message.class; } + public Void process(Message input) { return null; } } diff --git a/src/main/java/envoy/server/ObjectMessageProcessor.java b/src/main/java/envoy/server/ObjectMessageProcessor.java index 8bf8ad6..53e53da 100644 --- a/src/main/java/envoy/server/ObjectMessageProcessor.java +++ b/src/main/java/envoy/server/ObjectMessageProcessor.java @@ -12,10 +12,12 @@ import com.jenkov.nioserver.Message; import com.jenkov.nioserver.WriteProxy; /** + * Handles incoming objects.
+ *
* Project: envoy-server-standalone
* File: ObjectMessageProcessor.java
* Created: 28.12.2019
- * + * * @author Kai S. K. Engelbart * @since Envoy Server Standalone v0.1-alpha */ @@ -23,6 +25,12 @@ public class ObjectMessageProcessor implements IMessageProcessor { private final Set> processors; + /** + * The constructor to set the {@link ObjectProcessor}s. + * + * @param processors the {@link ObjectProcessor} to set + * @since Envoy Server Standalone v0.1-alpha + */ public ObjectMessageProcessor(Set> processors) { this.processors = processors; } @SuppressWarnings("unchecked") @@ -33,27 +41,25 @@ public class ObjectMessageProcessor implements IMessageProcessor { System.out.println("Read object: " + obj.toString()); // Process object - processors.stream() - .filter(p -> p.getInputClass().isInstance(obj)) - .forEach((@SuppressWarnings("rawtypes") ObjectProcessor p) -> { - Object responseObj = p.process(p.getInputClass().cast(obj)); - if (responseObj != null) { - // Create message targeted at the client - Message response = writeProxy.getMessage(); - response.socketId = message.socketId; + processors.stream().filter(p -> p.getInputClass().isInstance(obj)).forEach((@SuppressWarnings("rawtypes") ObjectProcessor p) -> { + Object responseObj = p.process(p.getInputClass().cast(obj)); + if (responseObj != null) { + // Create message targeted at the client + Message response = writeProxy.getMessage(); + response.socketId = message.socketId; - // Serialize object to byte array - ByteArrayOutputStream baos = new ByteArrayOutputStream(); - try (ObjectOutputStream oout = new ObjectOutputStream(baos)) { - oout.writeObject(responseObj); - } catch (IOException e) { - e.printStackTrace(); - } - byte[] objBytes = baos.toByteArray(); - response.writeToMessage(objBytes); - writeProxy.enqueue(response); + // Serialize object to byte array + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + try (ObjectOutputStream oout = new ObjectOutputStream(baos)) { + oout.writeObject(responseObj); + } catch (IOException e) { + e.printStackTrace(); } - }); + byte[] objBytes = baos.toByteArray(); + response.writeToMessage(objBytes); + writeProxy.enqueue(response); + } + }); } catch (IOException | ClassNotFoundException e) { e.printStackTrace(); } diff --git a/src/main/java/envoy/server/ObjectMessageReader.java b/src/main/java/envoy/server/ObjectMessageReader.java index 9a20c7f..f0fa73a 100644 --- a/src/main/java/envoy/server/ObjectMessageReader.java +++ b/src/main/java/envoy/server/ObjectMessageReader.java @@ -11,10 +11,12 @@ import com.jenkov.nioserver.MessageBuffer; import com.jenkov.nioserver.Socket; /** + * This {@link IMessageReader} decodes serialized Java objects.
+ *
* Project: envoy-server-standalone
* File: ObjectMessageReader.java
* Created: 28.12.2019
- * + * * @author Kai S. K. Engelbart * @since Envoy Server Standalone v0.1-alpha */ @@ -24,6 +26,14 @@ public class ObjectMessageReader implements IMessageReader { private Message nextMessage; private MessageBuffer messageBuffer; + private int fromByteArray(byte[] bytes, int offset) { + return ((bytes[offset] & 0xFF) << 24) | ((bytes[offset + 1] & 0xFF) << 16) | ((bytes[offset + 2] & 0xFF) << 8) + | ((bytes[offset + 3] & 0xFF) << 0); + } + + @Override + public List getMessages() { return completeMessages; } + @Override public void init(MessageBuffer messageBuffer) { this.messageBuffer = messageBuffer; @@ -55,12 +65,4 @@ public class ObjectMessageReader implements IMessageReader { buffer.clear(); } - - private int fromByteArray(byte[] bytes, int offset) { - return ((bytes[offset] & 0xFF) << 24) | ((bytes[offset + 1] & 0xFF) << 16) | ((bytes[offset + 2] & 0xFF) << 8) - | ((bytes[offset + 3] & 0xFF) << 0); - } - - @Override - public List getMessages() { return completeMessages; } } \ No newline at end of file diff --git a/src/main/java/envoy/server/ObjectProcessor.java b/src/main/java/envoy/server/ObjectProcessor.java index a056d64..44c07e1 100644 --- a/src/main/java/envoy/server/ObjectProcessor.java +++ b/src/main/java/envoy/server/ObjectProcessor.java @@ -1,17 +1,30 @@ package envoy.server; - /** + * This interface defines methods for processing objects of a specific + * type incoming from a client.
+ *
* Project: envoy-server-standalone
* File: ObjectProcessor.java
* Created: 30.12.2019
- * + * * @author Kai S. K. Engelbart + * @param type of the request object + * @param type of the response object * @since Envoy Server Standalone v0.1-alpha */ public interface ObjectProcessor { - U process(T input); - + /** + * @return the Class of the request object + * @since Envoy Server Standalone v0.1-alpha + */ Class getInputClass(); + + /** + * @param input the request object + * @return the response object + * @since Envoy Server Standalone v0.1-alpha + */ + U process(T input); } \ No newline at end of file diff --git a/src/main/java/envoy/server/Startup.java b/src/main/java/envoy/server/Startup.java index b389320..58a8366 100644 --- a/src/main/java/envoy/server/Startup.java +++ b/src/main/java/envoy/server/Startup.java @@ -7,15 +7,24 @@ import java.util.Set; import com.jenkov.nioserver.Server; /** + * Starts the server.
+ *
* Project: envoy-server-standalone
* File: Startup.java
* Created: 24.12.2019
- * + * * @author Kai S. K. Engelbart * @since Envoy Server Standalone v0.1-alpha */ public class Startup { + /** + * Starts the server. + * + * @param args the run configuration. Currently unused. + * @throws IOException if the server crashes + * @since Envoy Server Standalone v0.1-alpha + */ public static void main(String[] args) throws IOException { Set> processors = new HashSet<>(); processors.add(new LoginCredentialProcessor());