Modernize project structure, update Maven config, move sources, add logging config, update README and .gitignore

4 files changed, 443 insertions, 0 deletions

diff --git a/src/main/java/events/internal/VSAbstractInternalEvent.java b/src/main/java/events/internal/VSAbstractInternalEvent.java
new file mode 100644
index 0000000..33e3763
--- /dev/null
+++ b/src/main/java/events/internal/VSAbstractInternalEvent.java
@@ -0,0 +1,58 @@
+package events.internal;
+
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+
+import events.VSAbstractEvent;
+import serialize.VSSerialize;
+
+/**
+ * The class VSAbstractInternalEvent, this class if for destinguishing between
+ * internal and non-internal events. Internal usage only.
+ *
+ * @author Paul C. Buetow
+ */
+abstract public class VSAbstractInternalEvent extends VSAbstractEvent {
+    /* (non-Javadoc)
+     * @see events.VSAbstractEvent#createShortname()()
+     */
+    protected String createShortname(String savedShortname) {
+        return savedShortname;
+    }
+
+    /* (non-Javadoc)
+     * @see serialize.VSSerializable#serialize(serialize.VSSerialize,
+     *	java.io.ObjectOutputStream)
+     */
+    public synchronized void serialize(VSSerialize serialize,
+                                       ObjectOutputStream objectOutputStream)
+    throws IOException {
+        super.serialize(serialize, objectOutputStream);
+
+        /** For later backwards compatibility, to add more stuff */
+        objectOutputStream.writeObject(Boolean.valueOf(false));
+
+        /** For later backwards compatibility, to add more stuff */
+        objectOutputStream.writeObject(Boolean.valueOf(false));
+    }
+
+    /* (non-Javadoc)
+     * @see serialize.VSSerializable#deserialize(serialize.VSSerialize,
+     *	java.io.ObjectInputStream)
+     */
+    public synchronized void deserialize(VSSerialize serialize,
+                                         ObjectInputStream objectInputStream)
+    throws IOException, ClassNotFoundException {
+        super.deserialize(serialize, objectInputStream);
+
+        if (VSSerialize.DEBUG)
+            System.out.println("Deserializing: VSAbstractInternalEvent");
+
+        /** For later backwards compatibility, to add more stuff */
+        objectInputStream.readObject();
+
+        /** For later backwards compatibility, to add more stuff */
+        objectInputStream.readObject();
+    }
+}
diff --git a/src/main/java/events/internal/VSMessageReceiveEvent.java b/src/main/java/events/internal/VSMessageReceiveEvent.java
new file mode 100644
index 0000000..51ae926
--- /dev/null
+++ b/src/main/java/events/internal/VSMessageReceiveEvent.java
@@ -0,0 +1,84 @@
+package events.internal;
+
+import core.VSMessage;
+import protocols.VSAbstractProtocol;
+import serialize.VSNotSerializable;
+
+/**
+ * The class VSMessageReceiveEvent, this event is used if a process receives
+ * a message.
+ *
+ * @author Paul C. Buetow
+ */
+public class VSMessageReceiveEvent extends VSAbstractInternalEvent
+    implements VSNotSerializable {
+
+    /** The message. */
+    private VSMessage message;
+
+    /**
+     * Instantiates a new message receive event.
+     *
+     * @param message the message
+     */
+    public VSMessageReceiveEvent(VSMessage message) {
+        this.message = message;
+    }
+
+    /* (non-Javadoc)
+     * @see events.VSAbstractEvent#onInit()
+     */
+    public void onInit() {
+        setClassname(getClass().toString());
+    }
+
+    /* (non-Javadoc)
+     * @see events.VSAbstractEvent#onStart()
+     */
+    public void onStart() {
+        boolean onlyRelevantMessages = process.getPrefs().getBoolean("sim.messages.relevant");
+
+        //String eventName = message.getName();
+        String protocolClassname = message.getProtocolClassname();
+
+        if (onlyRelevantMessages && !isRelevantMessage())
+            return;
+
+        Object protocolObj = null;
+
+        if (process.objectExists(protocolClassname))
+            protocolObj = process.getObject(protocolClassname);
+
+        process.updateLamportTime(message.getLamportTime()+1);
+        process.updateVectorTime(message.getVectorTime());
+
+        StringBuffer buffer = new StringBuffer();
+        buffer.append(prefs.getString("lang.message.recv"));
+        buffer.append("; ");
+        buffer.append(message);;
+        log(buffer.toString());
+
+        if (protocolObj != null)
+            ((VSAbstractProtocol) protocolObj).onMessageRecvStart(message);
+    }
+
+    /**
+     * Checks if the message delivering is relevant.
+     *
+     * @return true, if relevant
+     */
+    public boolean isRelevantMessage() {
+        String protocolClassname = message.getProtocolClassname();
+        Object protocolObj = null;
+
+        if (process.objectExists(protocolClassname))
+            protocolObj = process.getObject(protocolClassname);
+        else
+            return false;
+
+        if (!((VSAbstractProtocol) protocolObj).isRelevantMessage(message))
+            return false;
+
+        return true;
+    }
+}
diff --git a/src/main/java/events/internal/VSProtocolEvent.java b/src/main/java/events/internal/VSProtocolEvent.java
new file mode 100644
index 0000000..de630e3
--- /dev/null
+++ b/src/main/java/events/internal/VSProtocolEvent.java
@@ -0,0 +1,175 @@
+package events.internal;
+
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+
+import core.VSInternalProcess;
+import events.VSAbstractEvent;
+import events.VSCopyableEvent;
+import events.VSRegisteredEvents;
+import protocols.VSAbstractProtocol;
+import serialize.VSSerialize;
+
+/**
+ * The class VSProtocolEvent, this event is used if a protocol (server or
+ * client part) of a process gets enabled or disabled, an object of this class
+ * can be for 4 different purporses! Activation of the client protocol,
+ * deactivation of the client protocol, activation of the server protocol,
+ * deactivation of the server protocol.
+ *
+ * @author Paul C. Buetow
+ */
+public class VSProtocolEvent extends VSAbstractInternalEvent
+    implements VSCopyableEvent {
+    /** The protocol classname. */
+    private String protocolClassname;
+
+    /** The event is a client protocol if true. Else it is a server protocol */
+    private boolean isClientProtocol;
+
+    /** The event is a protocol activation if true. Else it is a deactivation */
+    private boolean isProtocolActivation;
+
+    /* (non-Javadoc)
+     * @see events.VSCopyableEvent#initCopy(events.VSAbstractEvent)
+     */
+    public void initCopy(VSAbstractEvent copy) {
+        VSProtocolEvent protocolEventCopy = (VSProtocolEvent) copy;
+        protocolEventCopy.isClientProtocol(isClientProtocol);
+        protocolEventCopy.isProtocolActivation(isProtocolActivation);
+        protocolEventCopy.setProtocolClassname(protocolClassname);
+    }
+
+    /* (non-Javadoc)
+     * @see events.VSAbstractEvent#onInit()
+     */
+    public void onInit() {
+        setClassname(getClass().toString());
+    }
+
+    /**
+     * Sets if it is a client protocol activation/deactivation.
+     *
+     * @param isClientProtocol the event is client protocol if true. the event
+     * is a server protocol if false.
+     */
+    public void isClientProtocol(boolean isClientProtocol) {
+        this.isClientProtocol = isClientProtocol;
+    }
+
+    /**
+     * Checks if it is a client protocol activation/deactivation.
+     *
+     * @return the event is client protocol if true. the event
+     * is a server protocol if false.
+     */
+    public boolean isClientProtocol() {
+        return isClientProtocol;
+    }
+
+    /**
+     * Sets if it is protocol activation.
+     *
+     * @param isProtocolActivation true, if it is a protocol activation. false,
+     *	if it is a protocol deactivation.
+     */
+    public void isProtocolActivation(boolean isProtocolActivation) {
+        this.isProtocolActivation = isProtocolActivation;
+    }
+
+    /**
+     * Checks if it is protocol activation.
+     *
+     * @return true, if it is a protocol activation. false, if it is a protocol
+     *	deactivation.
+     */
+    public boolean isProtocolActivation() {
+        return isProtocolActivation;
+    }
+
+    /**
+     * Sets the protocol classname.
+     *
+     * @param protocolClassname the new protocol classname
+     */
+    public void setProtocolClassname(String protocolClassname) {
+        this.protocolClassname = protocolClassname;
+    }
+
+    /* (non-Javadoc)
+     * @see events.VSAbstractEvent#onStart()
+     */
+    public void onStart() {
+        VSInternalProcess internalProcess = (VSInternalProcess) process;
+        VSAbstractProtocol protocol =
+            internalProcess.getProtocolObject(protocolClassname);
+
+        if (isClientProtocol)
+            protocol.isClient(isProtocolActivation);
+        else
+            protocol.isServer(isProtocolActivation);
+
+        StringBuffer buffer = new StringBuffer();
+        buffer.append(VSRegisteredEvents.getShortnameByClassname(
+                          protocolClassname));
+
+        buffer.append(" ");
+        buffer.append(isClientProtocol
+                      ? prefs.getString("lang.client")
+                      : prefs.getString("lang.server"));
+
+        buffer.append(" ");
+        buffer.append(isProtocolActivation
+                      ? prefs.getString("lang.activated")
+                      : prefs.getString("langactivated"));
+
+        log(buffer.toString());
+    }
+
+    /* (non-Javadoc)
+     * @see serialize.VSSerializable#serialize(serialize.VSSerialize,
+     *	java.io.ObjectOutputStream)
+     */
+    public synchronized void serialize(VSSerialize serialize,
+                                       ObjectOutputStream objectOutputStream)
+    throws IOException {
+        super.serialize(serialize, objectOutputStream);
+
+        /** For later backwards compatibility, to add more stuff */
+        objectOutputStream.writeObject(Boolean.valueOf(false));
+
+        objectOutputStream.writeObject(protocolClassname);
+        objectOutputStream.writeObject(Boolean.valueOf(isClientProtocol));
+        objectOutputStream.writeObject(Boolean.valueOf(isProtocolActivation));
+
+        /** For later backwards compatibility, to add more stuff */
+        objectOutputStream.writeObject(Boolean.valueOf(false));
+    }
+
+    /* (non-Javadoc)
+     * @see serialize.VSSerializable#deserialize(serialize.VSSerialize,
+     *	java.io.ObjectInputStream)
+     */
+    public synchronized void deserialize(VSSerialize serialize,
+                                         ObjectInputStream objectInputStream)
+    throws IOException, ClassNotFoundException {
+        super.deserialize(serialize, objectInputStream);
+
+        if (VSSerialize.DEBUG)
+            System.out.println("Deserializing: VSProtocolEvent");
+
+        /** For later backwards compatibility, to add more stuff */
+        objectInputStream.readObject();
+
+        protocolClassname = (String) objectInputStream.readObject();
+
+        isClientProtocol = ((Boolean)
+                            objectInputStream.readObject()).booleanValue();;
+        isProtocolActivation = ((Boolean)
+                                objectInputStream.readObject()).booleanValue();;
+
+        /** For later backwards compatibility, to add more stuff */
+        objectInputStream.readObject();
+    }
+}
diff --git a/src/main/java/events/internal/VSProtocolScheduleEvent.java b/src/main/java/events/internal/VSProtocolScheduleEvent.java
new file mode 100644
index 0000000..c940212
--- /dev/null
+++ b/src/main/java/events/internal/VSProtocolScheduleEvent.java
@@ -0,0 +1,126 @@
+package events.internal;
+
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+
+import protocols.VSAbstractProtocol;
+import serialize.VSNotSerializable;
+import serialize.VSSerialize;
+
+/**
+ * The class VSProtocolScheduleEvent, this event is used if a protocol (which
+ * is a subclass of VSAbstractProtocol) reschedules itself to run again on a
+ * specific time.
+ *
+ * @author Paul C. Buetow
+ */
+public class VSProtocolScheduleEvent extends VSAbstractInternalEvent
+    implements VSNotSerializable {
+    /** The event is a server protocol schedule. */
+    private boolean isServerSchedule; /* true = server, false = client */
+
+    /** The reference to the protocol object to schedule. */
+    private VSAbstractProtocol protocol;
+
+    /**
+     * Create a VSProtocolScheduleEvent object
+     *
+     * @param protocol the protocol
+     * @param isServerSchedule the event is a client protocol schedule if
+     *	false, else server schedule
+     */
+    public VSProtocolScheduleEvent(VSAbstractProtocol protocol,
+                                   boolean isServerSchedule) {
+        this.protocol = protocol;
+        this.isServerSchedule = isServerSchedule;
+    }
+
+    /* (non-Javadoc)
+     * @see events.VSAbstractEvent#onInit()
+     */
+    public void onInit() {
+        setClassname(getClass().toString());
+    }
+
+    /**
+     * Sets if it is client protocol schedule.
+     *
+     * @param isServerSchedule false, if the event is a client protocol
+     * schedule. true, if server.
+     */
+    public void isServerSchedule(boolean isServerSchedule) {
+        this.isServerSchedule = isServerSchedule;
+    }
+
+    /**
+     * Sets if it is client protocol schedule.
+     *
+     * @return false, if the event is a client protocol schedule. true, if
+     *	server.
+     */
+    public boolean isServerSchedule() {
+        return isServerSchedule;
+    }
+
+    /**
+     * Sets the protocol.
+     *
+     * @param protocol the protocol
+     */
+    public void setProtocol(VSAbstractProtocol protocol) {
+        this.protocol = protocol;
+    }
+
+    /**
+     * Gets the protocol.
+     *
+     * @return the protocol
+     */
+    public VSAbstractProtocol getProtocol() {
+        return protocol;
+    }
+
+    /* (non-Javadoc)
+     * @see events.VSAbstractEvent#onStart()
+     */
+    public void onStart() {
+        if (isServerSchedule)
+            protocol.onServerScheduleStart();
+        else
+            protocol.onClientScheduleStart();
+    }
+
+    /* (non-Javadoc)
+     * @see serialize.VSSerializable#serialize(serialize.VSSerialize,
+     *	java.io.ObjectOutputStream)
+     */
+    public synchronized void serialize(VSSerialize serialize,
+                                       ObjectOutputStream objectOutputStream)
+    throws IOException {
+        super.serialize(serialize, objectOutputStream);
+
+        /** For later backwards compatibility, to add more stuff */
+        objectOutputStream.writeObject(Boolean.valueOf(false));
+
+        /** For later backwards compatibility, to add more stuff */
+        objectOutputStream.writeObject(Boolean.valueOf(false));
+    }
+
+    /* (non-Javadoc)
+     * @see serialize.VSSerializable#deserialize(serialize.VSSerialize,
+     *	java.io.ObjectInputStream)
+     */
+    public synchronized void deserialize(VSSerialize serialize,
+                                         ObjectInputStream objectInputStream)
+    throws IOException, ClassNotFoundException {
+        super.deserialize(serialize, objectInputStream);
+
+        if (VSSerialize.DEBUG)
+            System.out.println("Deserializing: VSProtocolEvent");
+
+        /** For later backwards compatibility, to add more stuff */
+        objectInputStream.readObject();
+
+    }
+}