ipaacalib/cpp/test/src/testipaaca.cc

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2022 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+#include <ipaaca/ipaaca.h>
+#include <typeinfo>
+
+#define BOOST_TEST_MODULE TestIpaacaCpp
+#include <boost/test/unit_test.hpp>
+
+using namespace ipaaca;
+
+class TestReceiver {
+	public:
+		InputBuffer::ptr  _ib;
+		std::string received_info;
+		TestReceiver();
+		void inbuffer_handle_iu_event(IUInterface::ptr iu, IUEventType event_type, bool local);
+};
+
+TestReceiver::TestReceiver()
+{
+	_ib = ipaaca::InputBuffer::create("TestReceiver", "cppTestCategory");
+	_ib->register_handler(boost::bind(&TestReceiver::inbuffer_handle_iu_event, this, _1, _2, _3));
+	received_info = "NOTHING RECEIVED YET";
+}
+
+void TestReceiver::inbuffer_handle_iu_event(IUInterface::ptr iu, IUEventType event_type, bool local)
+{
+	if (event_type == IU_ADDED) {
+		received_info = (std::string) iu->payload()["word"];
+		{
+			ipaaca::Locker locker(iu->payload());
+			iu->payload()["replyVector"] = std::vector<double> { 1.0, 2.0, 3.0 };
+			iu->payload()["replyComment"] = "OK";
+		}
+	}
+}
+
+
+class TestSender {
+	public:
+		OutputBuffer::ptr _ob;
+		std::vector<double> double_vec;
+		std::string comment;
+		long num_replies;
+		TestSender();
+		void publish_one_message();
+		void outbuffer_handle_iu_event(IUInterface::ptr iu, IUEventType event_type, bool local);
+};
+
+TestSender::TestSender() {
+	_ob = OutputBuffer::create("TestSender");
+	_ob->register_handler(boost::bind(&TestSender::outbuffer_handle_iu_event, this, _1, _2, _3));
+	comment = "NO COMMENT YET";
+	num_replies = 0;
+}
+
+void TestSender::outbuffer_handle_iu_event(IUInterface::ptr iu, IUEventType event_type, bool local)
+{
+	if (event_type == IU_UPDATED) {
+		num_replies++;
+		double_vec = iu->payload()["replyVector"];
+		comment = (std::string) iu->payload()["replyComment"];
+	}
+}
+
+void TestSender::publish_one_message()
+{
+	ipaaca::IU::ptr iu = ipaaca::IU::create("cppTestCategory");
+	iu->payload()["word"] = "OK";
+	_ob->add(iu);
+}
+
+BOOST_AUTO_TEST_SUITE (testIpaacaCpp)
+
+
+BOOST_AUTO_TEST_CASE( testIpaacaCpp01 )
+{
+	TestSender sender;
+	TestReceiver receiver;
+	std::cout << "Publishing one message and waiting 1s for replies from other module." << std::endl;
+	sender.publish_one_message();
+	sleep(1);
+	std::cout << "Checking for changes." << std::endl;
+	BOOST_CHECK( receiver.received_info == "OK" );
+	BOOST_CHECK( sender.num_replies == 1 );
+	BOOST_CHECK( sender.comment == "OK" );
+	BOOST_CHECK( sender.double_vec.size() == 3 );
+	std::cout << "Complete." << std::endl;
+}
+
+BOOST_AUTO_TEST_SUITE_END( )
+

java/.gitignore → ipaacalib/java/.gitignore

@@ -6,3 +6,4 @@ dist
 privateprops
 .project
 .classpath
+/bin/

ipaacalib/java/build.properties

+language=java
+resolve.status=beta
+resource.path=
+publish.resolver=soa.core.repository
+run.jvmargs= -Xms128m -Xmx512m  -Xss5M
+rebuild.list=
+publish.resolver=asap.sftp.publish
+dist.dir=../../dist
+javac.source=1.8
+javac.target=1.8
+

ipaacalib/java/build.xml.DISABLED

+<?xml version="1.0" encoding="UTF-8"?>
+<project name="ipaaca-java"  default="run">
+   <import file="../../../hmibuild/build.xml" />
+
+   <target name="-pre-compilation">
+     <echo message="Compiling protobuf file" />
+     <mkdir dir="generatedsrc"/>
+     <exec executable="protoc">
+        <arg value="--proto_path=../proto" />
+        <arg value="../proto/ipaaca.proto" />
+        <arg value="--java_out=generatedsrc/" />
+     </exec>
+   </target>
+   
+</project>

java/ivy.xml → ipaacalib/java/ivy.xml

-<ivy-module version="2.0">
-   <info organisation="Herwin" module="scrapbook"/>
-   <configurations>
-      <include file="${ivy.settings.dir}/configurations.xml"/>
-   </configurations>
-   <dependencies>
-      <dependency org="slf4j"   name="slf4j-api"              rev="latest.release"  />
-      <dependency org="google"  name="guava"                  rev="latest.release"  />
-   </dependencies>
-</ivy-module>
+<ivy-module version="2.0">
+   <info organisation="ipaaca" module="ipaaca-java"/>
+   <configurations>
+      <include file="${ivy.settings.dir}/configurations.xml"/>
+   </configurations>
+   <dependencies>
+      <dependency org="slf4j"   name="slf4j-api"              rev="latest.release"  />
+      <dependency org="google"  name="guava"                  rev="latest.release"  />
+      <dependency org="google"  name="protobuf-java"          rev="2.6.1"  />
+      <dependency org="rsb"     name="rsb"                    rev="latest.release"  />
+      <dependency org="lombok"  name="lombok"                 rev="latest.release"  />
+      <dependency org="apache"  name="commons-lang"           rev="latest.release"  />
+   </dependencies>
+</ivy-module>

java/src/ipaaca/AbstractIU.java → ipaacalib/java/src/ipaaca/AbstractIU.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
 package ipaaca;
 
-import ipaaca.Ipaaca.PayloadItem;
+import ipaaca.protobuf.Ipaaca.IU;
+import ipaaca.protobuf.Ipaaca.PayloadItem;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -25,10 +58,13 @@ public abstract class AbstractIU
     protected Payload payload;
     protected String category;
     protected boolean committed = false;
+    protected boolean retracted = false;
     private String uid;
-    protected int revision;
+    protected long revision;
     private boolean readOnly = false;
 
+    public abstract IU.AccessMode getAccessMode();
+    
     protected SetMultimap<String, String> links = HashMultimap.create();
     private final SetMultimap<String, String> EMPTYLINKS = HashMultimap.create();
 
@@ -114,7 +150,7 @@ public abstract class AbstractIU
         this.readOnly = readOnly;
     }
 
-    public void setRevision(int revision)
+    public void setRevision(long revision)
     {
         this.revision = revision;
     }
@@ -154,7 +190,7 @@ public abstract class AbstractIU
         return buffer;
     }
 
-    public int getRevision()
+    public long getRevision()
     {
         return revision;
     }
@@ -169,6 +205,11 @@ public abstract class AbstractIU
         return committed;
     }
 
+    public boolean isRetracted()
+    {
+        return retracted;
+    }
+
     public void setBuffer(Buffer buffer)
     {
         this.buffer = buffer;
@@ -184,13 +225,10 @@ public abstract class AbstractIU
         return uid;
     }
 
-    public void setUid(String uid)
-    {
-        this.uid = uid;
-    }
-
     public abstract void commit();
 
+    public abstract void retract();
+
     // XXX: might not be valid for all types of IUs
     public abstract void commit(String writerName);
 
@@ -204,7 +242,7 @@ public abstract class AbstractIU
         List<PayloadItem> items = new ArrayList<PayloadItem>();
         for (Entry<String, String> entry : newPayload.entrySet())
         {
-            PayloadItem item = PayloadItem.newBuilder().setKey(entry.getKey()).setValue(entry.getValue()).setType("") // TODO:default type?
+            PayloadItem item = PayloadItem.newBuilder().setKey(entry.getKey()).setValue(entry.getValue()).setType("STR")
                     .build();
             items.add(item);
         }
@@ -214,6 +252,8 @@ public abstract class AbstractIU
     abstract void setPayload(List<PayloadItem> newItems, String writerName);
 
     abstract void putIntoPayload(String key, String value, String writer);
+    
+    abstract void putIntoPayload(Map<? extends String, ? extends String> newItems, String writer);
 
     abstract void removeFromPayload(Object key, String writer);
 

ipaacalib/java/src/ipaaca/Buffer.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+import java.util.ArrayList;
+import java.util.EnumSet;
+import java.util.List;
+import java.util.Set;
+import java.util.UUID;
+
+import ipaaca.Initializer;
+
+/**
+ * Base class for InputBuffer and OutputBuffer.
+ */
+public abstract class Buffer
+{
+    private final String owningComponentName;
+
+    private List<IUEventHandler> eventHandlers = new ArrayList<IUEventHandler>();
+    protected final String uuid = UUID.randomUUID().toString().replaceAll("-", "").substring(0, 8);
+    protected String uniqueName;
+
+    public String getUniqueShortName()
+    {
+    	return owningComponentName + "ID" + uuid;
+    }
+
+    public String getUniqueName()
+    {
+        return uniqueName;
+    }
+
+    public String getOwningComponentName()
+    {
+        return owningComponentName;
+    }
+
+    // def __init__(self, owning_component_name, participant_config=None):
+    // '''Create a Buffer.
+    //
+    // Keyword arguments:
+    // owning_compontent_name --
+    // participant_config -- RSB configuration
+    // '''
+    // super(Buffer, self).__init__()
+    // self._owning_component_name = owning_component_name
+    // self._participant_config = participant_config #rsb.ParticipantConfig.fromDefaultSources() if participant_config is None else participant_config
+    // self._uuid = str(uuid.uuid4())[0:8]
+    // # Initialise with a temporary, but already unique, name
+    // self._unique_name = "undef-"+self._uuid
+    // self._iu_store = IUStore()
+    // self._iu_event_handlers = []
+    /**
+     * @param owningComponentName name of the entity that owns this Buffer
+     * @param participantConfig RSB configuration
+     */
+    public Buffer(String owningComponentName)
+    {
+        Initializer.initializeIpaacaRsb();
+        this.owningComponentName = owningComponentName;
+        uniqueName = "undef-" + uuid;
+    }
+
+    // def register_handler(self, handler_function, for_event_types=None, for_categories=None):
+    // """Register a new IU event handler function.
+    //
+    // Keyword arguments:
+    // handler_function -- a function with the signature (IU, event_type, local)
+    // for_event_types -- a list of event types or None if handler should
+    // be called for all event types
+    // for_categories -- a list of category names or None if handler should
+    // be called for all categoires
+    //
+    // """
+    // handler = IUEventHandler(handler_function=handler_function, for_event_types=for_event_types, for_categories=for_categories)
+    // self._iu_event_handlers.append(handler)
+
+    public void registerHandler(IUEventHandler handler)
+    {
+        eventHandlers.add(handler);
+    }
+    
+    public void removeHandler(IUEventHandler handler)
+    {
+        eventHandlers.remove(handler);
+    }
+
+    public void registerHandler(HandlerFunctor func) {
+    	IUEventHandler handler;
+    	handler = new IUEventHandler(func);
+    	registerHandler(handler);
+    }
+
+    public void registerHandler(HandlerFunctor func, Set<String> categories) {
+    	IUEventHandler handler;
+    	handler = new IUEventHandler(func, categories);
+    	registerHandler(handler);
+    }
+
+    public void registerHandler(HandlerFunctor func, EnumSet<IUEventType> eventTypes) {
+    	IUEventHandler handler;
+    	handler = new IUEventHandler(func, eventTypes);
+    	registerHandler(handler);
+    }
+
+    public void registerHandler(HandlerFunctor func, EnumSet<IUEventType> eventTypes, Set<String> categories) {
+    	IUEventHandler handler;
+    	handler = new IUEventHandler(func, eventTypes, categories);
+    	registerHandler(handler);
+    }
+
+    // def call_iu_event_handlers(self, uid, local, event_type, category):
+    // """Call registered IU event handler functions registered for this event_type and category."""
+    // for h in self._iu_event_handlers:
+    // # print('calling an update handler for '+event_type+' -> '+str(h))
+    // h.call(self, uid, local=local, event_type=event_type, category=category)
+    /**
+     * Call registered IU event handler functions registered for this event_type and category.
+     */
+    protected void callIuEventHandlers(String uid, boolean local, IUEventType type, String category)
+    {
+        for (IUEventHandler h : eventHandlers)
+        {
+            h.call(this, uid, local, type, category);
+        }
+    }
+
+    public abstract AbstractIU getIU(String iuid);
+}

ipaacalib/java/src/ipaaca/BufferConfiguration.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+
+import java.util.HashSet;
+import java.util.Set;
+
+
+class BufferConfiguration {
+	String _owningComponentName;
+	Set<String> _category_interests;
+	String _channel;
+	boolean _resendActive;
+	// protected:
+	// 	IPAACA_MEMBER_VAR_EXPORT std::string _basename;
+	// 	IPAACA_MEMBER_VAR_EXPORT std::vector<std::string> _category_interests;
+	// 	IPAACA_MEMBER_VAR_EXPORT std::string _channel;
+
+	public BufferConfiguration(String owningComponentName) {
+		this._owningComponentName = owningComponentName;
+		this._channel = "default";
+		this._resendActive = false;
+		this._category_interests = new HashSet<String>();
+	}
+
+	public String getOwningComponentName() {
+		return this._owningComponentName;
+	}
+
+	public Set<String> getCategoryInterests() {
+		return this._category_interests;
+	}
+
+	public String getChannel() {
+		return this._channel;
+	}
+
+	public boolean getResendActive() {
+		return this._resendActive;
+	}
+	// public:
+	// 	IPAACA_HEADER_EXPORT inline BufferConfiguration(const std::string basename) { _basename = basename; }
+	// 	IPAACA_HEADER_EXPORT const std::string get_basename() const { return _basename; }
+	// 	IPAACA_HEADER_EXPORT const std::vector<std::string> get_category_interests() const { return _category_interests; }
+	// 	IPAACA_HEADER_EXPORT const std::string get_channel() const { return _channel; }
+
+}

ipaacalib/java/src/ipaaca/BufferConfigurationBuilder.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+
+package ipaaca;
+
+public class BufferConfigurationBuilder extends BufferConfiguration {
+
+	public BufferConfigurationBuilder(String owningComponentName) {
+		super(owningComponentName);
+	}
+
+	public void setOwningComponentName(String owningComponentName) {
+		this._owningComponentName = owningComponentName;
+	}
+
+	public void addCategoryInterest(String category) {
+		this._category_interests.add(category);
+	}
+
+	public void setChannel(String channel) {
+		this._channel = channel;
+	}
+
+	public void setResendActive(boolean resendActive) {
+		this._resendActive = resendActive;
+	}
+
+	public BufferConfiguration getBufferConfiguration() {
+		return this;
+	}
+
+	// public:
+	// 	IPAACA_HEADER_EXPORT inline BufferConfigurationBuilder(const std::string basename):BufferConfiguration(basename) {}
+	// 	IPAACA_HEADER_EXPORT inline void set_basename(const std::string& basename)
+	// 	{
+	// 		_basename = basename;
+	// 	}
+	// 	IPAACA_HEADER_EXPORT inline void add_category_interest(const std::string& category)
+	// 	{
+	// 		_category_interests.push_back(category);
+	// 	}
+	// 	IPAACA_HEADER_EXPORT inline void set_channel(const std::string& channel)
+	// 	{
+	// 		_channel = channel;
+	// 	}
+
+	// 	IPAACA_HEADER_EXPORT const BufferConfiguration& get_BufferConfiguration() { return *this; }
+}

ipaacalib/java/src/ipaaca/HandlerFunctor.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+public interface HandlerFunctor
+{
+    void handle(AbstractIU iu, IUEventType type, boolean local);
+}

ipaacalib/java/src/ipaaca/IUAccessMode.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+public enum IUAccessMode
+{
+    PUSH, REMOTE, MESSAGE;
+}

ipaacalib/java/src/ipaaca/IUCommittedException.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+/**
+ * Error indicating that an IU is immutable because it has been committed to.
+ * @author hvanwelbergen
+ * 
+ */
+public class IUCommittedException extends RuntimeException
+{
+    private static final long serialVersionUID = 1L;
+    private final AbstractIU iu;
+
+    public AbstractIU getIU()
+    {
+        return iu;
+    }
+
+    public IUCommittedException(AbstractIU iu)
+    {
+        super("Writing to IU " + iu.getUid() + " failed -- it has been committed to.");
+        this.iu = iu;
+    }
+}

java/src/ipaaca/IUConverter.java → ipaacalib/java/src/ipaaca/IUConverter.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
 package ipaaca;
+
+import ipaaca.protobuf.Ipaaca.IU;
+import ipaaca.protobuf.Ipaaca.LinkSet;
+import ipaaca.protobuf.Ipaaca.PayloadItem;
+
 import java.nio.ByteBuffer;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
 import java.util.Map.Entry;
 
-import com.google.common.collect.HashMultimap;
-import com.google.common.collect.SetMultimap;
-import com.google.protobuf.InvalidProtocolBufferException;
-
 import rsb.converter.ConversionException;
 import rsb.converter.Converter;
 import rsb.converter.ConverterSignature;
 import rsb.converter.UserData;
 import rsb.converter.WireContents;
-import ipaaca.Ipaaca.IU;
-import ipaaca.Ipaaca.LinkSet;
-import ipaaca.Ipaaca.PayloadItem;
+
+import com.google.common.collect.HashMultimap;
+import com.google.common.collect.SetMultimap;
+import com.google.protobuf.InvalidProtocolBufferException;
 
 /**
  * Serializes AbstractIUs into protocolbuffer IUs and vice versa.
@@ -26,12 +60,12 @@ import ipaaca.Ipaaca.PayloadItem;
 public class IUConverter implements Converter<ByteBuffer>
 {
     private final ConverterSignature signature;
-    
+
     public IUConverter(ConverterSignature signature)
     {
         this.signature = signature;
     }
-    
+
     @Override
     public ConverterSignature getSignature()
     {
@@ -41,38 +75,28 @@ public class IUConverter implements Converter<ByteBuffer>
     @Override
     public WireContents<ByteBuffer> serialize(Class<?> typeInfo, Object obj) throws ConversionException
     {
-        AbstractIU iua = (AbstractIU)obj;
+        AbstractIU iua = (AbstractIU) obj;
         List<PayloadItem> payloadItems = new ArrayList<PayloadItem>();
-        for(Entry<String, String> entry:iua.getPayload().entrySet())
+        for (Entry<String, String> entry : iua.getPayload().entrySet())
         {
-            payloadItems.add(PayloadItem.newBuilder()
-                    .setKey(entry.getKey())
-                    .setValue(entry.getValue())
-                    .setType("")
-                    .build());
+            payloadItems.add(PayloadItem.newBuilder().setKey(entry.getKey()).setValue(entry.getValue()).setType("STR").build());
         }
-        
+
         List<LinkSet> links = new ArrayList<LinkSet>();
-        for (Entry<String, Collection<String>> entry:iua.getAllLinks().asMap().entrySet())
+        for (Entry<String, Collection<String>> entry : iua.getAllLinks().asMap().entrySet())
         {
             links.add(LinkSet.newBuilder().setType(entry.getKey()).addAllTargets(entry.getValue()).build());
         }
-        
-        IU iu = IU.newBuilder()
-                .setUid(iua.getUid())
-                .setRevision(iua.getRevision())
-                .setCategory(iua.getCategory())
-                .setOwnerName(iua.getOwnerName())
-                .setCommitted(iua.isCommitted())
-                .setAccessMode(IU.AccessMode.PUSH) //TODO for other access modes (also in Python version)
-                .setReadOnly(iua.isReadOnly())
-                .setPayloadType("MAP")
-                .addAllPayload(payloadItems)
-                .addAllLinks(links)
-                .build();
-        return new WireContents<ByteBuffer>(ByteBuffer.wrap(iu.toByteArray()),"ipaaca-remotepushiu");        
+
+        IU.AccessMode accessMode = iua.getAccessMode();
+        IU iu = IU.newBuilder().setUid(iua.getUid()).setRevision((int) iua.getRevision()).setCategory(iua.getCategory())
+                .setOwnerName(iua.getOwnerName()).setCommitted(iua.isCommitted()).setAccessMode(accessMode)
+                .setReadOnly(iua.isReadOnly()).setPayloadType("STR").addAllPayload(payloadItems).addAllLinks(links).build();
+        String wireFormat = (accessMode == IU.AccessMode.MESSAGE) ? "ipaaca-messageiu" : "ipaaca-iu";
+        return new WireContents<ByteBuffer>(ByteBuffer.wrap(iu.toByteArray()), wireFormat);
     }
 
+
     @Override
     public UserData<?> deserialize(String wireSchema, ByteBuffer buffer) throws ConversionException
     {
@@ -80,33 +104,51 @@ public class IUConverter implements Converter<ByteBuffer>
         try
         {
             iu = IU.newBuilder().mergeFrom(buffer.array()).build();
+            // If there are rsb buffer read-only issues in some build, use this code instead of the above line:
+            //int size = buffer.capacity();
+            //byte[] array = new byte[size];
+            //buffer.get(array, 0, size);
+            //iu = IU.newBuilder().mergeFrom(array).build();
+
         }
         catch (InvalidProtocolBufferException e)
         {
             throw new RuntimeException(e);
         }
 
-        if(iu.getAccessMode() == IU.AccessMode.PUSH)
+        if (iu.getAccessMode() == IU.AccessMode.PUSH)
         {
             RemotePushIU iuout = new RemotePushIU(iu.getUid());
-            iuout.setCategory(iu.getCategory());
-            iuout.committed = iu.getCommitted();
-            iuout.setOwnerName(iu.getOwnerName());
-            iuout.setRevision(iu.getRevision());
-            iuout.setReadOnly(iu.getReadOnly());            
-            iuout.payload = new Payload(iuout,iu.getPayloadList());            
-            SetMultimap<String, String> links = HashMultimap.create();
-            for(LinkSet ls: iu.getLinksList())
-            {
-                links.putAll(ls.getType(),ls.getTargetsList());
-            }
-            iuout.setLinksLocally(links);
-            return new UserData<RemotePushIU>(iuout, RemotePushIU.class);            
+            copyIU(iu, iuout);
+            return new UserData<RemotePushIU>(iuout, RemotePushIU.class);
+        }
+        else if(iu.getAccessMode() == IU.AccessMode.MESSAGE)
+        {
+            RemoteMessageIU iuout = new RemoteMessageIU(iu.getUid());
+            copyIU(iu,iuout);
+            return new UserData<RemoteMessageIU>(iuout, RemoteMessageIU.class);
         }
         else
         {
-            throw new RuntimeException("We can only handle IUs with access mode 'PUSH' for now!");
+            throw new RuntimeException("Trying to deserialize IU with accesmode: "+iu.getAccessMode()+". " +
+            		"We can only handle IUs with access mode 'PUSH' or 'MESSAGE' for now!");
+        }
+    }
+
+    private void copyIU(IU iu, AbstractIU iuout)
+    {
+        iuout.setCategory(iu.getCategory());
+        iuout.committed = iu.getCommitted();
+        iuout.setOwnerName(iu.getOwnerName());
+        iuout.setRevision(iu.getRevision());
+        iuout.setReadOnly(iu.getReadOnly());
+        iuout.payload = new Payload(iuout, iu.getPayloadList());
+        SetMultimap<String, String> links = HashMultimap.create();
+        for (LinkSet ls : iu.getLinksList())
+        {
+            links.putAll(ls.getType(), ls.getTargetsList());
         }
+        iuout.setLinksLocally(links);
     }
 
 }

ipaacalib/java/src/ipaaca/IUEventHandler.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+import java.util.EnumSet;
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * Wrapper for IU event handling functions.
+ * @author hvanwelbergen
+ */
+public class IUEventHandler
+{
+    private final EnumSet<IUEventType> eventTypes;
+    private Set<String> categories;
+    private final HandlerFunctor handleFunctor;
+
+    // def __init__(self, handler_function, for_event_types=None, for_categories=None):
+    // """Create an IUEventHandler.
+    //
+    // Keyword arguments:
+    // handler_function -- the handler function with the signature
+    // (IU, event_type, local)
+    // for_event_types -- a list of event types or None if handler should
+    // be called for all event types
+    // for_categories -- a list of category names or None if handler should
+    // be called for all categoires
+    // """
+    // super(IUEventHandler, self).__init__()
+    // self._handler_function = handler_function
+    // self._for_event_types = (
+    // None if for_event_types is None else
+    // (for_event_types[:] if hasattr(for_event_types, '__iter__') else [for_event_types]))
+    // self._for_categories = (
+    // None if for_categories is None else
+    // (for_categories[:] if hasattr(for_categories, '__iter__') else [for_categories]))
+    
+    public IUEventHandler(HandlerFunctor func)
+    {
+        this.handleFunctor = func;
+        this.categories = new HashSet<String>();
+        this.eventTypes = EnumSet.allOf(IUEventType.class);
+    }
+    
+    public IUEventHandler(HandlerFunctor func, Set<String> categories)
+    {
+        this.handleFunctor = func;
+        this.categories = categories;
+        this.eventTypes = EnumSet.allOf(IUEventType.class);
+    }
+    
+    public IUEventHandler(HandlerFunctor func, EnumSet<IUEventType> eventTypes)
+    {
+        this.handleFunctor = func;
+        this.eventTypes = eventTypes;
+        this.categories = new HashSet<String>();
+    }
+
+    public IUEventHandler(HandlerFunctor func, EnumSet<IUEventType> eventTypes, Set<String> categories)
+    {
+        this.eventTypes = eventTypes;
+        this.categories = categories;
+        this.handleFunctor = func;
+    }
+
+    // def condition_met(self, event_type, category):
+    // """Check whether this IUEventHandler should be called.
+    //
+    // Keyword arguments:
+    // event_type -- type of the IU event
+    // category -- category of the IU which triggered the event
+    // """
+    // type_condition_met = (self._for_event_types is None or event_type in self._for_event_types)
+    // cat_condition_met = (self._for_categories is None or category in self._for_categories)
+    // return type_condition_met and cat_condition_met
+    /**
+     * Check whether this IUEventHandler should be called.
+     * @param type type of the IU event
+     * @param category category of the IU which triggered the event
+     */
+    private boolean conditionMet(IUEventType type, String category)
+    {
+    	if (this.categories.isEmpty()) { // match any category
+    		return this.eventTypes.contains(type);
+    	}
+    	else
+    	{
+    		return this.eventTypes.contains(type) && this.categories.contains(category);
+    	}
+    }
+
+    // def call(self, buffer, iu_uid, local, event_type, category):
+    // """Call this IUEventHandler's function, if it applies.
+    //
+    // Keyword arguments:
+    // buffer -- the buffer in which the IU is stored
+    // iu_uid -- the uid of the IU
+    // local -- is the IU local or remote to this component? @RAMIN: Is this correct?
+    // event_type -- IU event type
+    // category -- category of the IU
+    // """
+    // if self.condition_met(event_type, category):
+    // iu = buffer._iu_store[iu_uid]
+    // self._handler_function(iu, event_type, local)
+    public void call(Buffer buf, String iuUid, boolean local, IUEventType type, String category)
+    {
+        if (conditionMet(type, category))
+        {
+            AbstractIU iu = buf.getIU(iuUid);
+            handleFunctor.handle(iu, type, local);
+        }
+    }
+}

ipaacalib/java/src/ipaaca/IUEventType.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+public enum IUEventType
+{
+    ADDED, COMMITTED, DELETED, RETRACTED, UPDATED, LINKSUPDATED, MESSAGE;
+}

ipaacalib/java/src/ipaaca/IUPublishedException.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+/**
+ * IUPublishedException exceptions occur when publishing (=putting it in an output buffer) an already published IU.
+ * @author hvanwelbergen
+ * 
+ */
+public class IUPublishedException extends RuntimeException
+{
+    private static final long serialVersionUID = 1L;
+    private final AbstractIU iu;
+
+    public AbstractIU getIU()
+    {
+        return iu;
+    }
+
+    public IUPublishedException(AbstractIU iu)
+    {
+        super("IU " + iu.getUid() + " is already present in the output buffer.");
+        this.iu = iu;
+    }
+
+}

ipaacalib/java/src/ipaaca/IUReadOnlyException.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+/**
+ * IUReadOnlyException's occur when writing to a read-only IU
+ * @author hvanwelbergen
+ * 
+ */
+public class IUReadOnlyException extends RuntimeException
+{
+    private static final long serialVersionUID = 1L;
+    private final AbstractIU iu;
+
+    public AbstractIU getIU()
+    {
+        return iu;
+    }
+
+    public IUReadOnlyException(AbstractIU iu)
+    {
+        super("Writing to IU " + iu.getUid() + " failed -- it is read-only.");
+        this.iu = iu;
+    }
+}

ipaacalib/java/src/ipaaca/IUResendFailedException.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+/**
+ * Error indicating that an IU is immutable because it has been committed to.
+ * @author hvanwelbergen
+ * 
+ */
+public class IUResendFailedException extends RuntimeException
+{
+    private static final long serialVersionUID = 1L;
+    private final AbstractIU iu;
+
+    public AbstractIU getIU()
+    {
+        return iu;
+    }
+
+    public IUResendFailedException(AbstractIU iu)
+    {
+        super("Resending IU " + iu.getUid() + " failed.");
+        this.iu = iu;
+    }
+}

ipaacalib/java/src/ipaaca/IURetractedException.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2015 Social Cognitive Systems Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+/**
+ * Error indicating that an IU is immutable because it has been retracted.
+ * 
+ */
+public class IURetractedException extends RuntimeException
+{
+    private static final long serialVersionUID = 1L;
+    private final AbstractIU iu;
+
+    public AbstractIU getIU()
+    {
+        return iu;
+    }
+
+    public IURetractedException(AbstractIU iu)
+    {
+        super("Writing to IU " + iu.getUid() + " failed -- it has been retracted.");
+        this.iu = iu;
+    }
+}

ipaacalib/java/src/ipaaca/IUStore.java

+/*
+ * This file is part of IPAACA, the
+ *  "Incremental Processing Architecture
+ *   for Artificial Conversational Agents".  
+ *
+ * Copyright (c) 2009-2013 Sociable Agents Group
+ *                         CITEC, Bielefeld University   
+ *
+ * http://opensource.cit-ec.de/projects/ipaaca/
+ * http://purl.org/net/ipaaca
+ *
+ * This file may be licensed under the terms of of the
+ * GNU Lesser General Public License Version 3 (the ``LGPL''),
+ * or (at your option) any later version.
+ *
+ * Software distributed under the License is distributed
+ * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
+ * express or implied. See the LGPL for the specific language
+ * governing rights and limitations.
+ *
+ * You should have received a copy of the LGPL along with this
+ * program. If not, go to http://www.gnu.org/licenses/lgpl.html
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
+ *
+ * The development of this software was supported by the
+ * Excellence Cluster EXC 277 Cognitive Interaction Technology.
+ * The Excellence Cluster EXC 277 is a grant of the Deutsche
+ * Forschungsgemeinschaft (DFG) in the context of the German
+ * Excellence Initiative.
+ */
+
+package ipaaca;
+
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * An IUStore maps an IUid to an IU
+ * @author hvanwelbergen
+ *
+ * @param <X> type of AbstractIU stored in the store
+ */
+public class IUStore<X extends AbstractIU> extends ConcurrentHashMap<String, X>
+{
+    private static final long serialVersionUID = 1L;
+}