Merge lp:~michihenning/unity-scopes-api/scope-metadata into lp:unity-scopes-api

[Michi Henning]

Added scope metadata to config and registry. Optional fields that are not set throw on an attempt to access them. This allows us to distinguish "not set all" from "set to default value".

Simplified configuration. Factory.ini no longer exists. Client can now run without Runtime.ini, but still needs Registry.ini and Zmq.ini. (It looks for those in the current directory.) Will fix this next.

Various minor clean-up in tests and doc comments.

Added scope metadata to config and registry. Optional fields that are not set throw on an attempt to access them. This allows us to distinguish "not set all" from "set to default value".

Simplified configuration. Factory.ini no longer exists. Client can now run without Runtime.ini, but still needs Registry.ini and Zmq.ini. (It looks for those in the current directory.) Will fix this next.

Various minor clean-up in tests and doc comments.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:72
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/37/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-trusty-amd64-ci/37
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-trusty-armhf-ci/37
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-trusty-armhf-ci/37/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-trusty-i386-ci/37

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/37/rebuild

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

295 + ScopeMetadata find(std::string const& scope_name) const;

As we discussed can we please rename this to get_metadata()? find() throwing an exception if something is not found feels as if a contains() method threw an exception if a container doesn't contain the item.

25 + 'art' : string

I don't think we want "art" in categories too, "art" is called art for results because they can be camera pictures, product images, comic strips... anything. A category should indeed have an "icon", not a picture of your friends.

31 + 'art' : string

For scope metadata, I think we should have both art and icon - art would be used for the branded scope pages, and icons for the navigation bar (both optional I suppose).

review: Needs Fixing

[Michal Hruby (mhr3)]

2134 +dictionary<string, VariantMap> ScopeMap;

Got me really confused, we do have ScopeMap in the public API, perhaps using a different name would make things clearer.

[Michal Hruby (mhr3)]

399 +class UNITY_API ScopeMetadata final

No UNITY_DEFINES_PTRS for ScopeMetadata?

[Michi Henning (michihenning)]

Thanks for the feedback, I agree with all of this. Will change!

Sorry about the "art" thing. I noticed that ResultItem had changed from "icon" to "arg" and figured we had better be consistent. My misunderstanding...

[Paweł Stołowski (stolowski)]

2857 +TEST(ScopeMetadataImpl, serialize_exceptions)
2858 +{
2859 + ZmqMiddleware mw("testscope", TEST_BUILD_ROOT "/gtest/unity/api/scopes/internal/ScopeMetadataImpl/Zmq.ini",
2860 + (RuntimeImpl*)0x1);
2861 +
2862 + ScopeMetadataImpl mi(&mw);
2863 + try
2864 + {
2865 + mi.serialize();
2866 + }
2867 + catch (InvalidArgumentException const&e)
2868 + {
2869 + EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadata: required attribute 'scope_name' is empty",
2870 + e.to_string());
2871 + }

Those kind of test should check if the exception was actually thrown.

review: Needs Fixing

[Paweł Stołowski (stolowski)]

Since ScopeMetadataImpl::serialize() can throw InvalidArgumentException (on empty scope_name or art), is it OK that we don't catch it in RegistryI::find_() and RegistryI::list_()? Also, only for NotFoundException in find_() we set status to (capnproto::ResponseStatus::USER_EXCEPTION), otherwise it is capnproto::ResponseStatus::SUCCESS in both find_() and list_(), is this intended?

I'm sorry, I couldn't easily find out how the exceptions propagate, but from the observation Michal and I have it seems that if "art" attribute of ScopeMetadata is empty (and the assert on that is removed from ctor, which is the case in release code), then the problem is only discovered in deserialize() in the client code, not in the serialize() on registry side, e.g. client gives:

./client A a
unity::api::scopes::MiddlewareException: unity::InvalidArgumentException: ScopeMetadata: required attribute 'art' is empty

review: Needs Information

[Michi Henning (michihenning)]

> Those kind of test should check if the exception was actually thrown.

Thanks for catching this! I've just added the missing FAIL() statements.

[Michi Henning (michihenning)]

> Since ScopeMetadataImpl::serialize() can throw InvalidArgumentException (on
> empty scope_name or art), is it OK that we don't catch it in
> RegistryI::find_() and RegistryI::list_()? Also, only for NotFoundException in
> find_() we set status to (capnproto::ResponseStatus::USER_EXCEPTION),
> otherwise it is capnproto::ResponseStatus::SUCCESS in both find_() and
> list_(), is this intended?

Yes, that's OK. Not all exceptions are marshalled as specific exception types over the wire. If the implementation of a method throws something that isn't expected as an exception that is to be marshalled, that is caught in safe_dispatch_() in ServantBase, and the exception response will be UNKNOWN_EXCEPTION over the wire.

> I'm sorry, I couldn't easily find out how the exceptions propagate, but from
> the observation Michal and I have it seems that if "art" attribute of
> ScopeMetadata is empty (and the assert on that is removed from ctor, which is
> the case in release code), then the problem is only discovered in
> deserialize() in the client code, not in the serialize() on registry side,
> e.g. client gives:
>
> ./client A a
> unity::api::scopes::MiddlewareException: unity::InvalidArgumentException:
> ScopeMetadata: required attribute 'art' is empty

From a previous message from Michal, both art and icon should be optional:

> For scope metadata, I think we should have both art and icon - art would be used for the branded > scope pages, and icons for the navigation bar (both optional I suppose).

That's what I implemented (and what I'm about to push).

[lp:~michihenning/unity-scopes-api/scope-metadata]

73. By Michi Henning on 2013-11-29

Renamed ScopeMap -> MetadataMap

74. By Michi Henning on 2013-11-29

Added Ptr definitions to ScopeMetadata.

75. By Michi Henning on 2013-11-29

Renamed find() -> get_metadata()

76. By Michi Henning on 2013-11-29

Added icon attribute to ScopeMetadata and made art attribute optional.

77. By Michi Henning on 2013-11-30

Addming missing FAIL() calls for tests that expect an exception when no exception is in fact thrown.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:77
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/41/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-trusty-amd64-ci/41
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-trusty-armhf-ci/41
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-trusty-armhf-ci/41/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-trusty-i386-ci/41

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/41/rebuild

review: Approve (continuous-integration)

[Paweł Stołowski (stolowski)]

1828 + // For optional values, we store them in a unique_ptr so we can distinguish the "not set at all" case
1829 + // from the "explicitly set to empty string" case.
1830 + try
1831 + {
1832 + string art = parser()->get_string(SCOPE_CONFIG_GROUP, art_str);
1833 + art_.reset(new string(art));
1834 + }
1835 + catch (LogicException const&)
1836 + {
1837 + }

Just a small nitpick - can you a add comment saying that these exceptions are ignored deliberately as they are for optional values? Otherwise looking good to me.

[Michal Hruby (mhr3)]

20 +Category (returned by serialize()):

Missing the new 'art'.

431 + std::string localized_name() const; // localized

Shouldn't this be just "name()"? I don't think we want i18n details to be visible in the API, do we? Also for consistency we'd then want "localized_description()", "locallized_search_hint()" etc. Was the concern that if it was just a "name()", it'd be confusing to have both name() and scope_name()? If so, perhaps we should rename the scope_name() to scope_id()? Afterall it's a unique id, isn't it?

689 + bool add(std::string const& scope_name, ScopeMetadata const scope);

Passing metadata by value? Is that desired?

review: Needs Fixing

[Michi Henning (michihenning)]

> Just a small nitpick - can you a add comment saying that these exceptions are ignored
> deliberately as they are for optional values? Otherwise looking good to me.

Fixed, thanks!

> 20 +Category (returned by serialize()):
>
> Missing the new 'art'.

Are you sure about this? Categories don't have art, as far as I can see.

> 431 + std::string localized_name() const; // localized
>
> Shouldn't this be just "name()"? I don't think we want i18n details to be
> visible in the API, do we? Also for consistency we'd then want
> "localized_description()", "locallized_search_hint()" etc. Was the concern
> that if it was just a "name()", it'd be confusing to have both name() and
> scope_name()? If so, perhaps we should rename the scope_name() to scope_id()?
> Afterall it's a unique id, isn't it?

Yes. Unfortunately, renaming "scope_name' to "scope_id" would be rather disruptive. It's all through the existing code. How about "display_name" for what is now "localised_name"? That would be much less intrusive a change.

> 689 + bool add(std::string const& scope_name, ScopeMetadata const
> scope);
>
> Passing metadata by value? Is that desired?

Yes, that was intentional. It's a sink function, and the implementation moves the value into place in the map. There are a few corner cases where that avoids a copy. But then, the efficiency gain is minor and basically not noticeable, so I changed it to const reference for consistency.

Please let me know about the "display_name" suggestion.

[Michi Henning (michihenning)]

Come to think of it, just "name" would work too, I think.

[Michal Hruby (mhr3)]

> > 20 +Category (returned by serialize()):
> >
> > Missing the new 'art'.
>
> Are you sure about this? Categories don't have art, as far as I can see.

Ah, right, that's for scopes themselves, nevermind then.

> > 431 + std::string localized_name() const; // localized
> >
> > Shouldn't this be just "name()"? I don't think we want i18n details to be
> > visible in the API, do we? Also for consistency we'd then want
> > "localized_description()", "locallized_search_hint()" etc. Was the concern
> > that if it was just a "name()", it'd be confusing to have both name() and
> > scope_name()? If so, perhaps we should rename the scope_name() to
> scope_id()?
> > Afterall it's a unique id, isn't it?
>
> Yes. Unfortunately, renaming "scope_name' to "scope_id" would be rather
> disruptive. It's all through the existing code. How about "display_name" for
> what is now "localised_name"? That would be much less intrusive a change.
>

display_name() works for me.

[lp:~michihenning/unity-scopes-api/scope-metadata]

78. By Michi Henning on 2013-12-03

Changed localized_name to display_name. Improved comment for catching exceptions for optional attributes.

[Michal Hruby (mhr3)]

LGTM.

review: Approve

=== modified file 'STRUCTS'
--- STRUCTS	2013-11-18 11:32:10 +0000
+++ STRUCTS	2013-12-03 14:09:20 +0000
@@ -19,22 +19,35 @@
 middleware.
 -----------------------------------------------------------------------------
 
-ResultItem (returned by variant_map()):
+ResultItem (returned by serialize()):
 =======================================
  'uri' : string
  'title' : string
- 'icon' : string
+ 'art' : string
  'dnd_uri' : string
  'cat_id' : string
  + any custom key-value attribute added by scope author.
 
-Category (returned by variant_map()):
+Category (returned by serialize()):
 =====================================
  'id' : string
  'title' : string
  'icon' : string
  'renderer_template' : string
 
+ScopeMetadata (returned by serialize()):
+=====================================
+ 'scope_name'   : string
+ 'proxy'        : dictionary
+    'identity'  : string
+    'endpoint'  : string
+ 'display_name' : string
+ 'description'  : string
+ 'art'          : string, optional
+ 'icon'         : string, optional
+ 'search_hint'  : string, optional
+ 'hot_key'      : string, optional
+
 PushRequest (capnproto structure)
 =================================
  result : ValueDict with "category" and/or "result" key and serialized Category / ResultItem respectively.
 
=== modified file 'demo/CMakeLists.txt'
--- demo/CMakeLists.txt	2013-11-19 02:51:46 +0000
+++ demo/CMakeLists.txt	2013-12-03 14:09:20 +0000
@@ -1,7 +1,6 @@
 add_subdirectory(scopes)
 add_subdirectory(scope-groups)
 
-configure_file(Factory.ini.in Factory.ini)
 configure_file(Runtime.ini.in Runtime.ini)
 configure_file(Registry.ini.in Registry.ini)
 configure_file(Zmq.ini.in Zmq.ini)
 
=== removed file 'demo/Factory.ini.in'
--- demo/Factory.ini.in	2013-11-19 02:51:46 +0000
+++ demo/Factory.ini.in	1970-01-01 00:00:00 +0000
@@ -1,2 +0,0 @@
-[MiddlewareFactory]
-Zmq.Configfile = @CMAKE_CURRENT_BINARY_DIR@/Zmq.ini
 
=== modified file 'demo/Zmq.ini.in'
--- demo/Zmq.ini.in	2013-11-19 02:51:46 +0000
+++ demo/Zmq.ini.in	2013-12-03 14:09:20 +0000
@@ -1,3 +1,3 @@
 [Zmq]
 EndpointDir.Public = /tmp
-EndpointDir.Private = @CMAKE_CURRENT_BINARY_DIR@
+EndpointDir.Private = /tmp
 
=== modified file 'demo/client.cpp'
--- demo/client.cpp	2013-11-26 16:08:29 +0000
+++ demo/client.cpp	2013-12-03 14:09:20 +0000
@@ -16,12 +16,13 @@
  * Authored by: Michi Henning <[e-mail]>
  */
 
+#include <scopes/CategoryRenderer.h>
 #include <scopes/QueryCtrl.h>
 #include <scopes/Registry.h>
 #include <scopes/ReceiverBase.h>
 #include <scopes/Runtime.h>
 #include <scopes/ResultItem.h>
-#include <scopes/CategoryRenderer.h>
+#include <scopes/ScopeExceptions.h>
 #include <unity/UnityExceptions.h>
 
 #include <condition_variable>
@@ -91,15 +92,52 @@
         Runtime::UPtr rt = Runtime::create("dash");
 
         RegistryProxy r = rt->registry();
-        ScopeProxy s = r->find(scope_name);
+        auto meta = r->get_metadata(scope_name);
+        cout << "Scope metadata:   " << endl;
+        cout << "\tscope_name:     " << meta.scope_name() << endl;
+        cout << "\tdisplay_name:   " << meta.display_name() << endl;
+        cout << "\tdescription:    " << meta.description() << endl;
+        string tmp;
+        try
+        {
+            tmp = meta.art();
+            cout << "\tart:            " << meta.art() << endl;
+        }
+        catch (NotFoundException const& e)
+        {
+        }
+        try
+        {
+            tmp = meta.icon();
+            cout << "\ticon:           " << meta.icon() << endl;
+        }
+        catch (NotFoundException const& e)
+        {
+        }
+        try
+        {
+            tmp = meta.search_hint();
+            cout << "\tsearch_hint:    " << meta.search_hint() << endl;
+        }
+        catch (NotFoundException const& e)
+        {
+        }
+        try
+        {
+            tmp = meta.hot_key();
+            cout << "\thot_key:        " << meta.hot_key() << endl;
+        }
+        catch (NotFoundException const& e)
+        {
+        }
         shared_ptr<Receiver> reply(new Receiver);
         VariantMap vm;
         vm["cardinality"] = 10;
         vm["locale"] = "C";
-        auto ctrl = s->create_query(search_string, vm, reply);     // Returns (almost) immediately
-        cerr << "client: created query" << endl;
+        auto ctrl = meta.proxy()->create_query(search_string, vm, reply);     // Returns (almost) immediately
+        cout << "client: created query" << endl;
         reply->wait_until_finished();
-        cerr << "client: wait returned" << endl;
+        cout << "client: wait returned" << endl;
     }
 
     catch (unity::Exception const& e)
 
=== modified file 'demo/scopes/scope-A/scope-A.cpp'
--- demo/scopes/scope-A/scope-A.cpp	2013-11-26 16:08:29 +0000
+++ demo/scopes/scope-A/scope-A.cpp	2013-12-03 14:09:20 +0000
@@ -73,7 +73,6 @@
     }
 
     virtual void stop() override {}
-    virtual void run() override {}
 
     virtual QueryBase::UPtr create_query(string const& q, VariantMap const&) override
     {
 
=== modified file 'demo/scopes/scope-A/scope-A.ini.in'
--- demo/scopes/scope-A/scope-A.ini.in	2013-11-19 02:51:46 +0000
+++ demo/scopes/scope-A/scope-A.ini.in	2013-12-03 14:09:20 +0000
@@ -1,1 +1,7 @@
 [ScopeConfig]
+DisplayName = scope-A.DisplayName
+Description = scope-A.Description
+Art = scope-A.Art
+Icon = scope-A.Icon
+SearchHint = scope-A.SearchHint
+HotKey = scope-A.HotKey
 
=== modified file 'demo/scopes/scope-B/scope-B.cpp'
--- demo/scopes/scope-B/scope-B.cpp	2013-11-26 16:08:29 +0000
+++ demo/scopes/scope-B/scope-B.cpp	2013-12-03 14:09:20 +0000
@@ -128,16 +128,16 @@
         scope_name_ = scope_name;
 
         // Lock up scopes C and D in the registry and remember their proxies.
-        scope_c_ = registry->find("scope-C");
-        scope_d_ = registry->find("scope-D");
+        auto meta_c = registry->get_metadata("scope-C");
+        scope_c_ = meta_c.proxy();
+        auto meta_d = registry->get_metadata("scope-D");
+        scope_d_ = meta_d.proxy();
 
         return VERSION;
     }
 
     virtual void stop() override {}
 
-    virtual void run() override {}
-
     virtual QueryBase::UPtr create_query(string const& q, VariantMap const&) override
     {
         QueryBase::UPtr query(new MyQuery(scope_name_, q, scope_c_, scope_d_));
 
=== modified file 'demo/scopes/scope-B/scope-B.ini.in'
--- demo/scopes/scope-B/scope-B.ini.in	2013-11-19 02:51:46 +0000
+++ demo/scopes/scope-B/scope-B.ini.in	2013-12-03 14:09:20 +0000
@@ -1,1 +1,3 @@
 [ScopeConfig]
+DisplayName = scope-B.DisplayName
+Description = scope-B.Description
 
=== modified file 'demo/scopes/scope-C/scope-C.ini.in'
--- demo/scopes/scope-C/scope-C.ini.in	2013-11-19 02:51:46 +0000
+++ demo/scopes/scope-C/scope-C.ini.in	2013-12-03 14:09:20 +0000
@@ -1,1 +1,3 @@
 [ScopeConfig]
+DisplayName = scope-C.DisplayName
+Description = scope-C.Description
 
=== modified file 'demo/scopes/scope-D/scope-D.ini.in'
--- demo/scopes/scope-D/scope-D.ini.in	2013-11-19 02:51:46 +0000
+++ demo/scopes/scope-D/scope-D.ini.in	2013-12-03 14:09:20 +0000
@@ -1,1 +1,3 @@
 [ScopeConfig]
+DisplayName = scope-D.DisplayName
+Description = scope-D.Description
 
=== modified file 'demo/scopes/scope-N/scope-N.cpp'
--- demo/scopes/scope-N/scope-N.cpp	2013-11-21 21:44:00 +0000
+++ demo/scopes/scope-N/scope-N.cpp	2013-12-03 14:09:20 +0000
@@ -62,7 +62,6 @@
     }
 
     virtual void stop() override {}
-    virtual void run() override {}
 
     virtual QueryBase::UPtr create_query(string const&, VariantMap const&) override
     {
 
=== modified file 'demo/scopes/scope-N/scope-N.ini.in'
--- demo/scopes/scope-N/scope-N.ini.in	2013-11-19 02:51:46 +0000
+++ demo/scopes/scope-N/scope-N.ini.in	2013-12-03 14:09:20 +0000
@@ -1,1 +1,3 @@
 [ScopeConfig]
+DisplayName = scope-N.DisplayName
+Description = scope-N.Description
 
=== modified file 'demo/scopes/scope-S/scope-S.cpp'
--- demo/scopes/scope-S/scope-S.cpp	2013-11-26 16:08:29 +0000
+++ demo/scopes/scope-S/scope-S.cpp	2013-12-03 14:09:20 +0000
@@ -77,7 +77,6 @@
     }
 
     virtual void stop() override {}
-    virtual void run() override {}
 
     virtual QueryBase::UPtr create_query(string const& q, VariantMap const& hints) override
     {
 
=== modified file 'demo/scopes/scope-S/scope-S.ini.in'
--- demo/scopes/scope-S/scope-S.ini.in	2013-11-19 02:51:46 +0000
+++ demo/scopes/scope-S/scope-S.ini.in	2013-12-03 14:09:20 +0000
@@ -1,1 +1,3 @@
 [ScopeConfig]
+DisplayName = scope-S.DisplayName
+Description = scope-S.Description
 
=== modified file 'include/scopes/ObjectProxy.h'
--- include/scopes/ObjectProxy.h	2013-11-25 19:05:41 +0000
+++ include/scopes/ObjectProxy.h	2013-12-03 14:09:20 +0000
@@ -42,6 +42,9 @@
     ObjectProxy();
     virtual ~ObjectProxy() noexcept;
 
+    std::string endpoint() const;
+    std::string identity() const;
+
 protected:
     internal::ObjectProxyImpl* pimpl() const noexcept; // Non-virtual because we can't use covariance with incomplete types
                                                        // Each derived proxy type implements a non-virtual fwd() method
 
=== modified file 'include/scopes/Registry.h'
--- include/scopes/Registry.h	2013-11-25 19:05:41 +0000
+++ include/scopes/Registry.h	2013-12-03 14:09:20 +0000
@@ -21,7 +21,7 @@
 
 #include <scopes/ObjectProxy.h>
 #include <scopes/RegistryProxyFwd.h>
-#include <scopes/Scope.h>
+#include <scopes/ScopeMetadata.h>
 
 #include <map>
 
@@ -40,9 +40,9 @@
 }
 
 /**
-\brief Map for scope name and proxy pairs.
+\brief Map for scope name and metadata pairs.
 */
-typedef std::map<std::string, ScopeProxy> ScopeMap;
+typedef std::map<std::string, ScopeMetadata> MetadataMap;
 
 /**
 \brief RegistryProxy provides access to the available scopes.
@@ -57,15 +57,22 @@
     /// @endcond
 
     /**
-    \brief Returns a ScopeProxy for the scope with the given name.
-    @return If no scope with the given name exists, find() throws NotFoundException.
-    */
-    ScopeProxy find(std::string const& scope_name) const;
-
-    /**
-    \brief Returns a map containing the name/proxy pairs for all available scopes.
-    */
-    ScopeMap list() const;
+    \brief Returns the metadata for the scope with the given name.
+    @return The metadata for the scope. If no scope with the given name exists, get_metadata() throws NotFoundException.
+    */
+    ScopeMetadata get_metadata(std::string const& scope_name) const;
+
+    /**
+    \brief Returns a map containing the metadata for all scopes.
+    */
+    MetadataMap list() const;
+
+    /**
+    \brief Returns a map containing only those scopes for which predicate returns true.
+    \param predicate a function object the must return true for each metadata item to be include in the map.
+    \return The metadata items for which the predicate returned true.
+    */
+    MetadataMap list_if(std::function<bool(ScopeMetadata const& item)> predicate) const;
 
 protected:
     Registry(internal::RegistryImpl* impl);          // Instantiated only by RegistryImpl
 
=== modified file 'include/scopes/ResultItem.h'
--- include/scopes/ResultItem.h	2013-11-27 02:08:11 +0000
+++ include/scopes/ResultItem.h	2013-12-03 14:09:20 +0000
@@ -87,7 +87,7 @@
 
     /**
        \brief Returns a dictionary of all attributes of this ResultItem instance.
-       \return dictionary of all base attributes and custom attributes set with add_metadata call.
+       \return Dictionary of all base attributes and custom attributes set with add_metadata call.
     */
     VariantMap serialize() const;
 
 
=== modified file 'include/scopes/Runtime.h'
--- include/scopes/Runtime.h	2013-11-25 16:22:12 +0000
+++ include/scopes/Runtime.h	2013-12-03 14:09:20 +0000
@@ -58,11 +58,6 @@
     /// @endcond
 
     /**
-    \brief The default configuration file (relative to the current directory) if none is passed to create().
-    */
-    static constexpr char const* DFLT_CONFIGFILE = "Runtime.ini";
-
-    /**
     \brief Instantiates the scopes run time for the scope with the given name and (optional) configuration file.
 
     The life time of the run time is under control of the caller. Letting the returned `unique_ptr` go out
@@ -71,8 +66,13 @@
     You _must not_ create a Runtime instance until after `main()` is entered, and you _must_ destroy it
     before leaving `main()` (either by explicitly calling destroy(), or by letting the returned
     `unique_ptr` go out of scope). Failure to do so causes undefined behavior.
+
+    \param configfile The path name of the configuration file to use.
+
+    If configfile is the empty string, a default configuration is used.
     */
-    static UPtr create(std::string const& scope_name, std::string const& configfile = DFLT_CONFIGFILE);
+    // TODO: Update above to state what the default configuration is exactly
+    static UPtr create(std::string const& scope_name, std::string const& configfile = "");
 
     /**
     \brief Shuts down the run time, reclaiming all associated resources.
 
=== added file 'include/scopes/ScopeMetadata.h'
--- include/scopes/ScopeMetadata.h	1970-01-01 00:00:00 +0000
+++ include/scopes/ScopeMetadata.h	2013-12-03 14:09:20 +0000
@@ -0,0 +1,78 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Lesser GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Michi Henning <[e-mail]>
+ */
+
+#ifndef UNITY_API_SCOPES_SCOPEMETADATA_H
+#define UNITY_API_SCOPES_SCOPEMETADATA_H
+
+#include <scopes/Scope.h>
+
+namespace unity
+{
+
+namespace api
+{
+
+namespace scopes
+{
+
+namespace internal
+{
+class ScopeMetadataImpl;
+} // namespace internal
+
+class UNITY_API ScopeMetadata final
+{
+public:
+    UNITY_DEFINES_PTRS(ScopeMetadata);
+
+    ScopeMetadata(ScopeMetadata const& other);
+    ScopeMetadata(ScopeMetadata&&);
+    ~ScopeMetadata();
+
+    ScopeMetadata& operator=(ScopeMetadata const& other);
+    ScopeMetadata& operator=(ScopeMetadata&&);
+
+    std::string scope_name() const;
+    ScopeProxy proxy() const;
+    std::string display_name() const; // localized
+    std::string description() const;    // localized
+    std::string art() const;            // optional
+    std::string icon() const;           // optional
+    std::string search_hint() const;    // localized, optional
+    std::string hot_key() const;        // localized, optional
+
+    /**
+       \brief Returns a dictionary of all attributes of this ScopeMetadata instance.
+       \return Dictionary of all metadata attributes.
+    */
+    VariantMap serialize() const;
+
+private:
+    ScopeMetadata(std::unique_ptr<internal::ScopeMetadataImpl>);           // Instantiable only by ScopeMetadataImpl
+    std::unique_ptr<internal::ScopeMetadataImpl> p;
+
+    friend class internal::ScopeMetadataImpl;
+};
+
+} // namespace scopes
+
+} // namespace api
+
+} // namespace unity
+
+#endif
 
=== modified file 'include/scopes/internal/ConfigBase.h'
--- include/scopes/internal/ConfigBase.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/ConfigBase.h	2013-12-03 14:09:20 +0000
@@ -41,6 +41,7 @@
 class ConfigBase
 {
 public:
+    ConfigBase();
     ConfigBase(std::string const& configfile);
     virtual ~ConfigBase() noexcept;
 
@@ -53,6 +54,7 @@
     virtual void throw_ex(::std::string const& reason) const;
 
 private:
+    unity::util::IniParser::SPtr p() const;
     unity::util::IniParser::SPtr parser_;
     std::string configfile_;
 };
 
=== modified file 'include/scopes/internal/MWObjectProxy.h'
--- include/scopes/internal/MWObjectProxy.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/MWObjectProxy.h	2013-12-03 14:09:20 +0000
@@ -37,8 +37,6 @@
 
 // Base class for the MW<something>Proxy hierarchy. We store the pointer to the middleware here,
 // which is needed to, for example, register callback objects (such as a Reply object) with the middleware.
-// We also keep a pointer to the run time, so we can get at other relevant deatils, such as a scope name,
-// reply object reaper, etc.
 
 class MWObjectProxy
 {
@@ -47,6 +45,9 @@
 
     virtual MiddlewareBase* mw_base() const noexcept = 0;
 
+    virtual std::string identity() const = 0;
+    virtual std::string endpoint() const = 0;
+
 protected:
     MWObjectProxy(MiddlewareBase* mw_base);
 
 
=== modified file 'include/scopes/internal/MWRegistry.h'
--- include/scopes/internal/MWRegistry.h	2013-11-25 16:22:12 +0000
+++ include/scopes/internal/MWRegistry.h	2013-12-03 14:09:20 +0000
@@ -21,6 +21,7 @@
 
 #include <scopes/internal/MWObjectProxy.h>
 #include <scopes/Registry.h>
+#include <scopes/ScopeMetadata.h>
 
 namespace unity
 {
@@ -38,8 +39,8 @@
 {
 public:
     // Remote operation implementation
-    virtual ScopeProxy find(std::string const& scope_name) = 0;
-    virtual ScopeMap list() = 0;
+    virtual ScopeMetadata get_metadata(std::string const& scope_name) = 0;
+    virtual MetadataMap list() = 0;
 
     virtual ~MWRegistry() noexcept;
 
 
=== modified file 'include/scopes/internal/MiddlewareBase.h'
--- include/scopes/internal/MiddlewareBase.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/MiddlewareBase.h	2013-12-03 14:09:20 +0000
@@ -19,6 +19,7 @@
 #ifndef UNITY_API_SCOPES_INTERNAL_MIDDLEWAREBASE_H
 #define UNITY_API_SCOPES_INTERNAL_MIDDLEWAREBASE_H
 
+#include <scopes/internal/MWObjectProxyFwd.h>
 #include <scopes/internal/MWQueryCtrlProxyFwd.h>
 #include <scopes/internal/MWQueryProxyFwd.h>
 #include <scopes/internal/MWRegistryProxyFwd.h>
@@ -61,6 +62,8 @@
     virtual void stop() = 0;
     virtual void wait_for_shutdown() = 0;
 
+    virtual MWProxy create_proxy(std::string const& identity, std::string const& endpoint) = 0;
+
     virtual MWRegistryProxy create_registry_proxy(std::string const& identity, std::string const& endpoint) = 0;
     virtual MWScopeProxy create_scope_proxy(std::string const& identity) = 0;
     virtual MWScopeProxy create_scope_proxy(std::string const& identity, std::string const& endpoint) = 0;
 
=== modified file 'include/scopes/internal/MiddlewareFactory.h'
--- include/scopes/internal/MiddlewareFactory.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/MiddlewareFactory.h	2013-12-03 14:09:20 +0000
@@ -44,7 +44,7 @@
 public:
     UNITY_DEFINES_PTRS(MiddlewareFactory);
 
-    MiddlewareFactory(std::string const& configfile, RuntimeImpl* runtime);
+    MiddlewareFactory(RuntimeImpl* runtime);
     ~MiddlewareFactory() noexcept;
 
     // Returns the middleware with the given name and kind. If that middleware hasn't been created yet,
 
=== removed file 'include/scopes/internal/MiddlewareFactoryConfig.h'
--- include/scopes/internal/MiddlewareFactoryConfig.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/MiddlewareFactoryConfig.h	1970-01-01 00:00:00 +0000
@@ -1,60 +0,0 @@
-/*
- * Copyright (C) 2013 Canonical Ltd
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License version 3 as
- * published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- * Authored by: Michi Henning <[e-mail]>
- */
-
-#ifndef UNITY_API_SCOPES_INTERNAL_MIDDLEWAREFACTORYCONFIG_H
-#define UNITY_API_SCOPES_INTERNAL_MIDDLEWAREFACTORYCONFIG_H
-
-#include <scopes/internal/ConfigBase.h>
-
-namespace unity
-{
-
-namespace api
-{
-
-namespace scopes
-{
-
-namespace internal
-{
-
-class MiddlewareFactoryConfig : public ConfigBase
-{
-public:
-    static const char* MIDDLEWARE_FACTORY_CONFIG_GROUP;
-
-    MiddlewareFactoryConfig(std::string const& configfile);
-    ~MiddlewareFactoryConfig() noexcept;
-
-    std::string zmq_configfile() const;
-    std::string rest_configfile() const;
-
-private:
-    std::string zmq_configfile_;
-    std::string rest_configfile_;
-};
-
-} // namespace internal
-
-} // namespace scopes
-
-} // namespace api
-
-} // namespace unity
-
-#endif
 
=== modified file 'include/scopes/internal/ObjectProxyImpl.h'
--- include/scopes/internal/ObjectProxyImpl.h	2013-11-25 19:05:41 +0000
+++ include/scopes/internal/ObjectProxyImpl.h	2013-12-03 14:09:20 +0000
@@ -40,10 +40,13 @@
     ObjectProxyImpl(MWProxy const& mw_proxy);
     virtual ~ObjectProxyImpl() noexcept;
 
+    virtual std::string identity() const;
+    virtual std::string endpoint() const;
+
 protected:
-    MWProxy proxy() const;                          // Non-virtual because we cannot use covariance with incomplete types.
-                                                    // Each derived proxy implements a non-virtual fwd() method
-                                                    // that is called from within each operation to down-cast the MWProxy.
+    MWProxy proxy() const;                  // Non-virtual because we cannot use covariance with incomplete types.
+                                            // Each derived proxy implements a non-virtual fwd() method
+                                            // that is called from within each operation to down-cast the MWProxy.
 
 private:
     static Proxy create(MWProxy const& mw_proxy);
 
=== modified file 'include/scopes/internal/RegistryImpl.h'
--- include/scopes/internal/RegistryImpl.h	2013-11-25 19:05:41 +0000
+++ include/scopes/internal/RegistryImpl.h	2013-12-03 14:09:20 +0000
@@ -43,8 +43,9 @@
     RegistryImpl(MWRegistryProxy const& mw_proxy, RuntimeImpl* runtime);
     ~RegistryImpl() noexcept;
 
-    ScopeProxy find(std::string const& scope_name);
-    ScopeMap list();
+    ScopeMetadata get_metadata(std::string const& scope_name);
+    MetadataMap list();
+    MetadataMap list_if(std::function<bool(ScopeMetadata const& item)> predicate);
 
     static RegistryProxy create(MWRegistryProxy const& mw_proxy, RuntimeImpl* runtime);
 
 
=== modified file 'include/scopes/internal/RegistryObject.h'
--- include/scopes/internal/RegistryObject.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/RegistryObject.h	2013-12-03 14:09:20 +0000
@@ -20,9 +20,8 @@
 #define UNITY_API_SCOPES_INTERNAL_REGISTRYOBJECT_H
 
 #include <scopes/internal/AbstractObject.h>
-#include <scopes/internal/MWScope.h>
+#include <scopes/Registry.h>
 
-#include <map>
 #include <mutex>
 
 namespace unity
@@ -48,16 +47,15 @@
     virtual ~RegistryObject() noexcept;
 
     // Remote operation implementations
-    MWScopeProxy find(std::string const& scope_name);
-
-    typedef std::map<std::string, MWScopeProxy> MWScopeMap;
-    MWScopeMap list();
-
-    bool add(std::string const& scope_name, MWScopeProxy const& scope);
+    ScopeMetadata get_metadata(std::string const& scope_name);
+
+    MetadataMap list();
+
+    bool add(std::string const& scope_name, ScopeMetadata const& scope);
     bool remove(std::string const& scope_name);
 
 private:
-    mutable MWScopeMap scopes_;
+    mutable MetadataMap scopes_;
     mutable std::mutex mutex_;
 };
 
 
=== modified file 'include/scopes/internal/RuntimeConfig.h'
--- include/scopes/internal/RuntimeConfig.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/RuntimeConfig.h	2013-12-03 14:09:20 +0000
@@ -39,7 +39,7 @@
 public:
     static const char* RUNTIME_CONFIG_GROUP;
 
-    RuntimeConfig(std::string const& configfile = Runtime::DFLT_CONFIGFILE);
+    RuntimeConfig(std::string const& configfile);
     ~RuntimeConfig() noexcept;
 
     std::string registry_identity() const;
 
=== modified file 'include/scopes/internal/RuntimeImpl.h'
--- include/scopes/internal/RuntimeImpl.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/RuntimeImpl.h	2013-12-03 14:09:20 +0000
@@ -43,7 +43,7 @@
 public:
     UNITY_DEFINES_PTRS(RuntimeImpl);
 
-    static UPtr create(std::string const& scope_name, std::string const& configfile = Runtime::DFLT_CONFIGFILE);
+    static UPtr create(std::string const& scope_name, std::string const& configfile = "");
     void destroy();
 
     std::string scope_name() const;
 
=== modified file 'include/scopes/internal/ScopeConfig.h'
--- include/scopes/internal/ScopeConfig.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/ScopeConfig.h	2013-12-03 14:09:20 +0000
@@ -41,10 +41,22 @@
     ScopeConfig(std::string const& configfile);
     ~ScopeConfig() noexcept;
 
-    bool overrideable() const;
+    bool overrideable() const;      // Optional, returns false if not present
+    std::string display_name() const;
+    std::string description() const;
+    std::string art() const;             // Optional, throws NotFoundException if not present
+    std::string icon() const;            // Optional, throws NotFoundException if not present
+    std::string search_hint() const;     // Optional, throws NotFoundException if not present
+    std::string hot_key() const;         // Optional, throws NotFoundException if not present
 
 private:
     bool overrideable_;
+    std::string display_name_;
+    std::string description_;
+    std::unique_ptr<std::string> art_;
+    std::unique_ptr<std::string> icon_;
+    std::unique_ptr<std::string> search_hint_;
+    std::unique_ptr<std::string> hot_key_;
 };
 
 } // namespace internal
 
=== added file 'include/scopes/internal/ScopeMetadataImpl.h'
--- include/scopes/internal/ScopeMetadataImpl.h	1970-01-01 00:00:00 +0000
+++ include/scopes/internal/ScopeMetadataImpl.h	2013-12-03 14:09:20 +0000
@@ -0,0 +1,94 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Lesser GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the Lesser GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Michi Henning <[e-mail]>
+ */
+
+#ifndef UNITY_API_SCOPES_INTERNAL_SCOPEMETADATAIMPL_H
+#define UNITY_API_SCOPES_INTERNAL_SCOPEMETADATAIMPL_H
+
+#include <scopes/internal/MWScope.h>
+#include <scopes/ScopeMetadata.h>
+
+#include <unordered_set>
+
+namespace unity
+{
+
+namespace api
+{
+
+namespace scopes
+{
+
+namespace internal
+{
+
+class ScopeMetadataImpl
+{
+public:
+    ScopeMetadataImpl(MiddlewareBase* mw);
+    ScopeMetadataImpl(VariantMap const& variant_map, MiddlewareBase* mw);
+    ScopeMetadataImpl(ScopeMetadataImpl const&);
+    ScopeMetadataImpl(ScopeMetadataImpl&&) = default;
+    ScopeMetadataImpl& operator=(ScopeMetadataImpl const&);
+    ScopeMetadataImpl& operator=(ScopeMetadataImpl&&) = default;
+
+    std::string scope_name() const;
+    ScopeProxy proxy() const;
+    std::string display_name() const; // localized
+    std::string description() const;    // localized
+    std::string art() const;            // optional
+    std::string icon() const;           // optional
+    std::string search_hint() const;    // localized, optional
+    std::string hot_key() const;        // localized, optional
+
+    void set_scope_name(std::string const& scope_name);
+    void set_proxy(ScopeProxy const& proxy);
+    void set_display_name(std::string const& display_name);
+    void set_description(std::string const& description);
+    void set_art(std::string const& art);
+    void set_icon(std::string const& icon);
+    void set_search_hint(std::string const& search_hint);
+    void set_hot_key(std::string const& hot_key);
+
+    VariantMap serialize() const;
+    void deserialize(VariantMap const& var);
+
+    static ScopeMetadata create(std::unique_ptr<ScopeMetadataImpl> impl);
+
+private:
+
+    MiddlewareBase* mw_;
+    std::string scope_name_;
+    ScopeProxy proxy_;
+    std::string display_name_;
+    std::string description_;
+    std::unique_ptr<std::string> art_;          // Optional, hence a pointer
+    std::unique_ptr<std::string> icon_;         // Optional, hence a pointer
+    std::unique_ptr<std::string> search_hint_;  // Optional, hence a pointer
+    std::unique_ptr<std::string> hot_key_;      // Optional, hence a pointer
+};
+
+} // namespace internal
+
+} // namespace scopes
+
+} // namespace api
+
+} // namespace unity
+
+
+#endif
 
=== modified file 'include/scopes/internal/zmq_middleware/RegistryI.h'
--- include/scopes/internal/zmq_middleware/RegistryI.h	2013-11-21 21:46:36 +0000
+++ include/scopes/internal/zmq_middleware/RegistryI.h	2013-12-03 14:09:20 +0000
@@ -51,7 +51,7 @@
     virtual ~RegistryI() noexcept;
 
 private:
-    virtual void find_(Current const& current,
+    virtual void get_metadata_(Current const& current,
                        capnp::ObjectPointer::Reader& in_params,
                        capnproto::Response::Builder& r);
 
 
=== modified file 'include/scopes/internal/zmq_middleware/RequestType.h'
--- include/scopes/internal/zmq_middleware/RequestType.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/zmq_middleware/RequestType.h	2013-12-03 14:09:20 +0000
@@ -36,7 +36,7 @@
 namespace zmq_middleware
 {
 
-enum RequestType { Oneway, Twoway };
+enum RequestType { Unknown, Oneway, Twoway };
 
 std::string to_string(RequestType);
 
 
=== modified file 'include/scopes/internal/zmq_middleware/ZmqConfig.h'
--- include/scopes/internal/zmq_middleware/ZmqConfig.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/zmq_middleware/ZmqConfig.h	2013-12-03 14:09:20 +0000
@@ -21,8 +21,6 @@
 
 #include <scopes/internal/ConfigBase.h>
 
-#include <mutex>
-
 namespace unity
 {
 
@@ -48,8 +46,7 @@
 
 private:
     std::string public_dir_;
-    mutable std::string private_dir_;
-    mutable std::mutex mutex_;
+    std::string private_dir_;
 };
 
 } // namespace internal
 
=== modified file 'include/scopes/internal/zmq_middleware/ZmqMiddleware.h'
--- include/scopes/internal/zmq_middleware/ZmqMiddleware.h	2013-11-21 21:44:00 +0000
+++ include/scopes/internal/zmq_middleware/ZmqMiddleware.h	2013-12-03 14:09:20 +0000
@@ -61,6 +61,8 @@
     virtual void stop() override;
     virtual void wait_for_shutdown() override;
 
+    virtual MWProxy create_proxy(std::string const& identity, std::string const& endpoint) override;
+
     virtual MWRegistryProxy create_registry_proxy(std::string const& identity, std::string const& endpoint) override;
     virtual MWScopeProxy create_scope_proxy(std::string const& identity) override;
     virtual MWScopeProxy create_scope_proxy(std::string const& identity, std::string const& endpoint) override;
 
=== modified file 'include/scopes/internal/zmq_middleware/ZmqObjectProxy.h'
--- include/scopes/internal/zmq_middleware/ZmqObjectProxy.h	2013-11-25 16:22:12 +0000
+++ include/scopes/internal/zmq_middleware/ZmqObjectProxy.h	2013-12-03 14:09:20 +0000
@@ -45,11 +45,12 @@
 
 class ZmqReceiver;
 
-// An Zmq proxy that points at some Zmq object, but without a specific type.
+// A Zmq proxy that points at some Zmq object, but without a specific type.
 
 class ZmqObjectProxy : public virtual MWObjectProxy
 {
 public:
+    ZmqObjectProxy(ZmqMiddleware* mw_base, std::string const& endpoint, std::string const& identity);
     ZmqObjectProxy(ZmqMiddleware* mw_base, std::string const& endpoint, std::string const& identity, RequestType t);
     virtual ~ZmqObjectProxy() noexcept;
 
@@ -63,43 +64,12 @@
     capnproto::Request::Builder make_request_(capnp::MessageBuilder& b, std::string const& operation_name) const;
     std::unique_ptr<ZmqReceiver> invoke_(capnp::MessageBuilder& out_params);
 
-    // TODO: commented out for now (see below)
-#if 0
-    template<typename F>
-    std::unique_ptr<capnp::SegmentArrayMessageReader> submit_request_(F f);
-#endif
-
 private:
     std::string endpoint_;
     std::string identity_;
     RequestType type_;
 };
 
-// TODO: Ideally, we would use this template because this is type-independent work, instead of having the
-// body of this method repeated in each operation of the derived proxy. But, for some reason, the getRoot
-// call below causes a syntax error. Need to try with clang to see whether there is a better error message.
-// Or maybe it's a gcc bug...
-
-#if 0
-template<typename F>
-std::unique_ptr<capnp::SegmentArrayMessageReader> ZmqObjectProxy::submit_request_(F f)
-{
-    try
-    {
-        auto future = mw_base()->invoke_pool()->submit(f);
-        future.wait();
-        auto reader = future.get();
-        auto response = reader->getRoot<capnproto::Response>();
-        throw_if_runtime_exception(response);
-        return reader;
-    }
-    catch (...)
-    {
-        throw; // TODO: what to do here?
-    }
-}
-#endif
-
 } // namespace zmq_middleware
 
 } // namespace internal
 
=== modified file 'include/scopes/internal/zmq_middleware/ZmqRegistry.h'
--- include/scopes/internal/zmq_middleware/ZmqRegistry.h	2013-11-25 16:22:12 +0000
+++ include/scopes/internal/zmq_middleware/ZmqRegistry.h	2013-12-03 14:09:20 +0000
@@ -48,8 +48,8 @@
     virtual ~ZmqRegistry() noexcept;
 
     // Remote operations.
-    virtual ScopeProxy find(std::string const& scope_name) override;
-    virtual ScopeMap list() override;
+    virtual ScopeMetadata get_metadata(std::string const& scope_name) override;
+    virtual MetadataMap list() override;
 };
 
 } // namespace zmq_middleware
 
=== modified file 'scoperegistry/scoperegistry.cpp'
--- scoperegistry/scoperegistry.cpp	2013-11-21 21:44:00 +0000
+++ scoperegistry/scoperegistry.cpp	2013-12-03 14:09:20 +0000
@@ -25,6 +25,9 @@
 #include <scopes/internal/RuntimeConfig.h>
 #include <scopes/internal/RuntimeImpl.h>
 #include <scopes/internal/ScopeConfig.h>
+#include <scopes/internal/ScopeMetadataImpl.h>
+#include <scopes/internal/ScopeImpl.h>
+#include <scopes/ScopeExceptions.h>
 #include <unity/UnityExceptions.h>
 #include <unity/util/ResourcePtr.h>
 
@@ -94,7 +97,7 @@
             }
             catch (FileException const& e)
             {
-                error(e.to_string() + ": scope group file ignored");
+                error("scope group config file ignored:\n" + e.to_string());
                 continue;
             }
 
@@ -105,7 +108,7 @@
             }
             catch (LogicException const& e)
             {
-                error("group file \"" + file + ": file ignored: " + e.to_string());
+                error("group file \"" + file + ": file ignored:\n" + e.to_string());
                 continue;
             }
 
@@ -148,6 +151,62 @@
     return scope_groups;
 }
 
+// For each scope, open the config file for each scope, create the metadata info from the config,
+// and add an entry to the RegistryObject.
+
+void add_metadata(RegistryObject::SPtr const& registry,
+                  map<string, string> const& all_scopes,
+                  MiddlewareBase::SPtr const& mw)
+{
+    for (auto pair : all_scopes)
+    {
+        try
+        {
+            unique_ptr<ScopeMetadataImpl> mi(new ScopeMetadataImpl(mw.get()));
+            ScopeConfig sc(pair.second);
+            mi->set_scope_name(pair.first);
+            mi->set_display_name(sc.display_name());
+            mi->set_description(sc.description());
+            try
+            {
+                mi->set_art(sc.art());
+            }
+            catch (NotFoundException const&)
+            {
+            }
+            try
+            {
+                mi->set_icon(sc.icon());
+            }
+            catch (NotFoundException const&)
+            {
+            }
+            try
+            {
+                mi->set_search_hint(sc.search_hint());
+            }
+            catch (NotFoundException const&)
+            {
+            }
+            try
+            {
+                mi->set_hot_key(sc.hot_key());
+            }
+            catch (NotFoundException const&)
+            {
+            }
+            ScopeProxy proxy = ScopeImpl::create(mw->create_scope_proxy(pair.first), mw->runtime());
+            mi->set_proxy(proxy);
+            auto meta = ScopeMetadataImpl::create(move(mi));
+            registry->add(pair.first, move(meta));
+        }
+        catch (unity::Exception const& e)
+        {
+            error("ignoring scope \"" + pair.first + "\": cannot create metadata: " + e.to_string());
+        }
+    }
+}
+
 void run_scopes(SignalThread& sigthread,
                 string const& scoperunner_path,
                 string const& config_file,
@@ -200,7 +259,7 @@
     }
     char const* const config_file = argv[1];
 
-    int exit_status = 0;
+    int exit_status = 1;
 
     // Run a separate thread to deal with SIGCHLD. This allows us to report when a scope process exits abnormally.
     SignalThread signal_thread;
@@ -246,14 +305,21 @@
         {
             string file_name = basename(const_cast<char*>(string(path).c_str()));    // basename() modifies its argument
             string scope_name = strip_suffix(file_name, ".ini");
-            ScopeConfig config(path);
-            if (config.overrideable())
+            try
             {
-                overrideable_scopes[scope_name] = path;
+                ScopeConfig config(path);
+                if (config.overrideable())
+                {
+                    overrideable_scopes[scope_name] = path;
+                }
+                else
+                {
+                    fixed_scopes[scope_name] = path;
+                }
             }
-            else
+            catch (unity::Exception const& e)
             {
-                fixed_scopes[scope_name] = path;
+                error("ignoring scope \"" + scope_name + "\": configuration error:\n" + e.to_string());
             }
         }
 
@@ -297,13 +363,10 @@
         RegistryObject::SPtr registry(new RegistryObject);
         middleware->add_registry_object(runtime->registry_identity(), registry);
 
-        // Add a proxy for each scope to the lookup table.
+        // Add the metadata for each scope to the lookup table.
         // We do this before starting any of the scopes, so aggregating scopes don't get a lookup failure if
         // they look for another scope in the registry.
-        for (auto pair : all_scopes)
-        {
-            registry->add(pair.first, middleware->create_scope_proxy(pair.first));
-        }
+        add_metadata(registry, all_scopes, middleware);
 
         // Start a scoperunner for each Canonical scope group and add the corresponding proxies to the registry
         run_scopes(signal_thread, scoperunner_path, config_file, canonical_groups);
@@ -313,31 +376,27 @@
 
         // Wait until we are done.
         middleware->wait_for_shutdown();
+        exit_status = 0;
     }
     catch (unity::Exception const& e)
     {
         error(e.to_string());
-        exit_status = 1;
     }
     catch (std::exception const& e)
     {
         error(e.what());
-        exit_status = 1;
     }
     catch (string const& e)
     {
         error("fatal error: " + e);
-        exit_status = 1;
     }
     catch (char const* e)
     {
         error(string("fatal error: ") + e);
-        exit_status = 1;
     }
     catch (...)
     {
         error("terminated due to unknown exception");
-        exit_status = 1;
     }
 
     return exit_status;
 
=== modified file 'scoperunner/scoperunner.cpp'
--- scoperunner/scoperunner.cpp	2013-11-21 21:44:00 +0000
+++ scoperunner/scoperunner.cpp	2013-12-03 14:09:20 +0000
@@ -200,7 +200,7 @@
     }
     char const* const runtime_config = argv[1];
 
-    int exit_status = 0;
+    int exit_status = 1;
     try
     {
         vector<string> config_files;
@@ -218,27 +218,22 @@
     catch (unity::Exception const& e)
     {
         error(e.to_string());
-        exit_status = 1;
     }
     catch (std::exception const& e)
     {
         error(e.what());
-        exit_status = 1;
     }
     catch (string const& e)
     {
         error("fatal error: " + e);
-        exit_status = 1;
     }
     catch (char const* e)
     {
         error(string("fatal error: ") + e);
-        exit_status = 1;
     }
     catch (...)
     {
         error("terminated due to unknown exception");
-        exit_status = 1;
     }
 
     return exit_status;
 
=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2013-11-26 15:35:46 +0000
+++ src/CMakeLists.txt	2013-12-03 14:09:20 +0000
@@ -16,6 +16,7 @@
     ${CMAKE_CURRENT_SOURCE_DIR}/Scope.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ScopeBase.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ScopeExceptions.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/ScopeMetadata.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/Variant.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/Version.cpp
 )
 
=== modified file 'src/ObjectProxy.cpp'
--- src/ObjectProxy.cpp	2013-11-25 19:05:41 +0000
+++ src/ObjectProxy.cpp	2013-12-03 14:09:20 +0000
@@ -20,6 +20,8 @@
 
 #include <scopes/internal/ObjectProxyImpl.h>
 
+using namespace std;
+
 namespace unity
 {
 
@@ -51,6 +53,16 @@
 {
 }
 
+string ObjectProxy::identity() const
+{
+    return p->identity();
+}
+
+string ObjectProxy::endpoint() const
+{
+    return p->endpoint();
+}
+
 internal::ObjectProxyImpl* ObjectProxy::pimpl() const noexcept
 {
     return p.get();
 
=== modified file 'src/ReceiverBase.cpp'
--- src/ReceiverBase.cpp	2013-11-25 19:05:41 +0000
+++ src/ReceiverBase.cpp	2013-12-03 14:09:20 +0000
@@ -42,8 +42,9 @@
 {
 }
 
-void ReceiverBase::push(Category::SCPtr category)
+void ReceiverBase::push(Category::SCPtr /* category */)
 {
+    // Intentionally empty: "do nothing" default implementation.
 }
 
 // Possibly overkill, but safer than using the enum as the index into an array,
 
=== modified file 'src/Registry.cpp'
--- src/Registry.cpp	2013-11-25 19:05:41 +0000
+++ src/Registry.cpp	2013-12-03 14:09:20 +0000
@@ -42,16 +42,21 @@
 
 //! @endcond
 
-ScopeProxy Registry::find(std::string const& scope_name) const
+ScopeMetadata Registry::get_metadata(std::string const& scope_name) const
 {
-    return fwd()->find(scope_name);
+    return fwd()->get_metadata(scope_name);
 }
 
-ScopeMap Registry::list() const
+MetadataMap Registry::list() const
 {
     return fwd()->list();
 }
 
+MetadataMap Registry::list_if(std::function<bool(ScopeMetadata const& item)> predicate) const
+{
+    return fwd()->list_if(predicate);
+}
+
 internal::RegistryImpl* Registry::fwd() const
 {
     return dynamic_cast<internal::RegistryImpl*>(pimpl());
 
=== modified file 'src/Runtime.cpp'
--- src/Runtime.cpp	2013-11-25 16:22:12 +0000
+++ src/Runtime.cpp	2013-12-03 14:09:20 +0000
@@ -31,8 +31,6 @@
 namespace scopes
 {
 
-constexpr char const* Runtime::DFLT_CONFIGFILE;
-
 //! @cond
 
 Runtime::Runtime(string const& scope_name, string const& configfile) :
 
=== added file 'src/ScopeMetadata.cpp'
--- src/ScopeMetadata.cpp	1970-01-01 00:00:00 +0000
+++ src/ScopeMetadata.cpp	2013-12-03 14:09:20 +0000
@@ -0,0 +1,123 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Lesser GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Michi Henning <[e-mail]>
+ */
+
+#include <scopes/ScopeMetadata.h>
+#include <scopes/internal/ScopeMetadataImpl.h>
+
+#include <cassert>
+
+using namespace std;
+
+namespace unity
+{
+
+namespace api
+{
+
+namespace scopes
+{
+
+//! @cond
+
+ScopeMetadata::ScopeMetadata(unique_ptr<internal::ScopeMetadataImpl> impl) :
+    p(move(impl))
+{
+    // The only way to create a ScopeMetadata instance is to first intialize
+    // a ScopeMetadataImpl, fill it in, and then call this constructor.
+    // We check here that all mandatory fields are present. If not
+    // we have an internal logic error.
+    assert(!p->scope_name().empty());
+    assert(p->proxy());
+    assert(!p->display_name().empty());
+    assert(!p->description().empty());
+}
+
+ScopeMetadata::ScopeMetadata(ScopeMetadata const& other) :
+    p(new internal::ScopeMetadataImpl(*(other.p)))
+{
+}
+
+ScopeMetadata::ScopeMetadata(ScopeMetadata&&) = default;
+
+ScopeMetadata::~ScopeMetadata()
+{
+}
+
+ScopeMetadata& ScopeMetadata::operator=(ScopeMetadata const& other)
+{
+    if (this != &other)
+    {
+        p.reset(new internal::ScopeMetadataImpl(*(other.p)));
+    }
+    return *this;
+}
+
+ScopeMetadata& ScopeMetadata::operator=(ScopeMetadata&&) = default;
+
+string ScopeMetadata::scope_name() const
+{
+    return p->scope_name();
+}
+
+ScopeProxy ScopeMetadata::proxy() const
+{
+    return p->proxy();
+}
+
+string ScopeMetadata::display_name() const
+{
+    return p->display_name();
+}
+
+string ScopeMetadata::description() const
+{
+    return p->description();
+}
+
+string ScopeMetadata::art() const
+{
+    return p->art();
+}
+
+string ScopeMetadata::icon() const
+{
+    return p->icon();
+}
+
+string ScopeMetadata::search_hint() const
+{
+    return p->search_hint();
+}
+
+string ScopeMetadata::hot_key() const
+{
+    return p->hot_key();
+}
+
+VariantMap ScopeMetadata::serialize() const
+{
+    return p->serialize();
+}
+
+//! @endcond
+
+} // namespace scopes
+
+} // namespace api
+
+} // namespace unity
 
=== modified file 'src/internal/CMakeLists.txt'
--- src/internal/CMakeLists.txt	2013-11-26 15:35:46 +0000
+++ src/internal/CMakeLists.txt	2013-12-03 14:09:20 +0000
@@ -11,7 +11,6 @@
     ${CMAKE_CURRENT_SOURCE_DIR}/DynamicLoader.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/MiddlewareBase.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/MiddlewareFactory.cpp
-    ${CMAKE_CURRENT_SOURCE_DIR}/MiddlewareFactoryConfig.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/MWObject.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/MWQuery.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/MWQueryCtrl.cpp
@@ -35,6 +34,7 @@
     ${CMAKE_CURRENT_SOURCE_DIR}/ScopeConfig.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ScopeImpl.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ScopeLoader.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/ScopeMetadataImpl.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ScopeObject.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ThreadPool.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/UniqueID.cpp
 
=== modified file 'src/internal/ConfigBase.cpp'
--- src/internal/ConfigBase.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/ConfigBase.cpp	2013-12-03 14:09:20 +0000
@@ -22,7 +22,6 @@
 #include <unity/UnityExceptions.h>
 #include <unity/util/IniParser.h>
 
-#include <sstream>
 
 using namespace std;
 
@@ -38,24 +37,30 @@
 namespace internal
 {
 
+// If configfile is the empty string, we create a default instance that returns "Zmq" for the middleware
+// and throws for the other methods.
+
 ConfigBase::ConfigBase(string const& configfile) :
-    parser_(make_shared<util::IniParser>(configfile.c_str())),
     configfile_(configfile)
 {
+    if (!configfile.empty())
+    {
+        parser_ = make_shared<util::IniParser>(configfile.c_str());
+    }
 }
 
 ConfigBase::~ConfigBase() noexcept
 {
 }
 
-shared_ptr<util::IniParser> ConfigBase::parser() const noexcept
+util::IniParser::SPtr ConfigBase::parser() const noexcept
 {
-    return parser_;
+    return p();
 }
 
 string ConfigBase::get_string(string const& group, string const& key) const
 {
-    string val = parser_->get_string(group, key);
+    string val = p()->get_string(group, key);
     if (val.empty())
     {
         throw_ex("Illegal empty value for " + key);
@@ -67,7 +72,7 @@
 {
     try
     {
-        return parser_->get_string(group, key);
+        return p()->get_string(group, key);
     }
     catch (unity::LogicException const&)
     {
@@ -77,6 +82,10 @@
 
 string ConfigBase::get_middleware(string const& group, string const& key) const
 {
+    if (!parser_)
+    {
+        return "Zmq";
+    }
     string val = get_string(group, key);
     if (val != "Zmq" && val != "REST")
     {
@@ -88,9 +97,17 @@
 
 void ConfigBase::throw_ex(string const& reason) const
 {
-    ostringstream s;
-    s << "\"" << configfile_ << "\": " << reason;
-    throw ConfigException(s.str());
+    string s = "\"" + configfile_ + "\": " + reason;
+    throw ConfigException(s);
+}
+
+util::IniParser::SPtr ConfigBase::p() const
+{
+    if (!parser_)
+    {
+        throw LogicException("ConfigBase: no parser available with default config");
+    }
+    return parser_;
 }
 
 } // namespace internal
 
=== modified file 'src/internal/MiddlewareFactory.cpp'
--- src/internal/MiddlewareFactory.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/MiddlewareFactory.cpp	2013-12-03 14:09:20 +0000
@@ -18,8 +18,6 @@
 
 #include <scopes/internal/MiddlewareFactory.h>
 
-// #include <scopes/internal/ice_middleware/IceMiddleware.h>
-#include <scopes/internal/MiddlewareFactoryConfig.h>
 #include <scopes/internal/zmq_middleware/ZmqMiddleware.h>
 #include <scopes/ScopeExceptions.h>
 
@@ -40,19 +38,10 @@
 namespace internal
 {
 
-MiddlewareFactory::MiddlewareFactory(string const& configfile, RuntimeImpl* runtime) :
+MiddlewareFactory::MiddlewareFactory(RuntimeImpl* runtime) :
     runtime_(runtime)
 {
     assert(runtime);
-
-    try
-    {
-        MiddlewareFactoryConfig config(configfile);
-    }
-    catch (unity::Exception const& e)
-    {
-        throw ConfigException("cannot instantiate MiddlewareFactory: config file: " + configfile);
-    }
 }
 
 MiddlewareFactory::~MiddlewareFactory() noexcept
 
=== modified file 'src/internal/ObjectProxyImpl.cpp'
--- src/internal/ObjectProxyImpl.cpp	2013-11-25 19:05:41 +0000
+++ src/internal/ObjectProxyImpl.cpp	2013-12-03 14:09:20 +0000
@@ -49,6 +49,16 @@
     return make_shared<ObjectProxy>();
 }
 
+string ObjectProxyImpl::identity() const
+{
+    return mw_proxy_->identity();
+}
+
+string ObjectProxyImpl::endpoint() const
+{
+    return mw_proxy_->endpoint();
+}
+
 MWProxy ObjectProxyImpl::proxy() const
 {
     return mw_proxy_;
 
=== modified file 'src/internal/RegistryImpl.cpp'
--- src/internal/RegistryImpl.cpp	2013-11-25 19:05:41 +0000
+++ src/internal/RegistryImpl.cpp	2013-12-03 14:09:20 +0000
@@ -45,16 +45,30 @@
 {
 }
 
-ScopeProxy RegistryImpl::find(std::string const& scope_name)
+ScopeMetadata RegistryImpl::get_metadata(std::string const& scope_name)
 {
-    return fwd()->find(scope_name);
+    return fwd()->get_metadata(scope_name);
 }
 
-ScopeMap RegistryImpl::list()
+MetadataMap RegistryImpl::list()
 {
     return fwd()->list();
 }
 
+MetadataMap RegistryImpl::list_if(std::function<bool(ScopeMetadata const& item)> predicate)
+{
+    auto scope_map = list();
+    MetadataMap matching_entries;
+    for (auto& pair : scope_map)
+    {
+        if (predicate(pair.second))
+        {
+            matching_entries.emplace(pair);
+        }
+    }
+    return matching_entries;
+}
+
 RegistryProxy RegistryImpl::create(MWRegistryProxy const& mw_proxy, RuntimeImpl* runtime)
 {
     return RegistryProxy(new Registry(new RegistryImpl(mw_proxy, runtime)));
 
=== modified file 'src/internal/RegistryObject.cpp'
--- src/internal/RegistryObject.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/RegistryObject.cpp	2013-12-03 14:09:20 +0000
@@ -43,7 +43,7 @@
 {
 }
 
-MWScopeProxy RegistryObject::find(std::string const& scope_name)
+ScopeMetadata RegistryObject::get_metadata(std::string const& scope_name)
 {
     // If the name is empty, it was sent as empty by the remote client.
     if (scope_name.empty())
@@ -56,33 +56,34 @@
     auto const& it = scopes_.find(scope_name);
     if (it == scopes_.end())
     {
-        throw NotFoundException("Registry::find(): no such scope",  scope_name);
+        throw NotFoundException("Registry::get_metadata(): no such scope",  scope_name);
     }
     return it->second;
 }
 
-RegistryObject::MWScopeMap RegistryObject::list()
+MetadataMap RegistryObject::list()
 {
     lock_guard<decltype(mutex_)> lock(mutex_);
     return scopes_;
 }
 
-bool RegistryObject::add(std::string const& scope_name, MWScopeProxy const& scope)
+bool RegistryObject::add(std::string const& scope_name, ScopeMetadata const& metadata)
 {
-    // TODO: also check for names containing a slash, because that won't work if we use
+    if (scope_name.empty())
+    {
+        throw unity::InvalidArgumentException("Registry: Cannot add scope with empty name");
+    }
+    // TODO: check for names containing a slash, because that won't work if we use
     //       the name for a socket in the file system.
-    if (scope_name.empty())
-    {
-        throw unity::InvalidArgumentException("Registry: Cannot add scope with empty name");
-    }
 
     lock_guard<decltype(mutex_)> lock(mutex_);
 
-    auto const& pair = scopes_.insert(make_pair(scope_name, scope));
+    auto const& pair = scopes_.insert(make_pair(scope_name, metadata));
     if (!pair.second)
     {
+        // Replace already existing entry with this one
         scopes_.erase(pair.first);
-        scopes_.insert(make_pair(scope_name, scope));
+        scopes_.insert(make_pair(scope_name, metadata));
         return false;
     }
     return true;
 
=== modified file 'src/internal/ResultItemImpl.cpp'
--- src/internal/ResultItemImpl.cpp	2013-11-27 02:08:11 +0000
+++ src/internal/ResultItemImpl.cpp	2013-12-03 14:09:20 +0000
@@ -19,7 +19,6 @@
 #include <scopes/internal/ResultItemImpl.h>
 #include <unity/UnityExceptions.h>
 #include <scopes/Category.h>
-#include <sstream>
 
 namespace unity
 {
@@ -113,9 +112,7 @@
 {
     if (value.empty())
     {
-        std::ostringstream s;
-        s << "Required attribute " << name << " is empty";
-        throw InvalidArgumentException(s.str());
+        throw InvalidArgumentException("ResultItem: invalid empty attribute: " + name);
     }
 }
 
@@ -139,9 +136,8 @@
         {
             if (var.find(kv.first) != var.end())
             {
-                std::ostringstream s;
-                s << "Can't overwrite internal attribute: " << kv.first;
-                throw InvalidArgumentException(s.str());
+                throw InvalidArgumentException("ResultItemImpl::serialize(): Can't overwrite internal attribute: "
+                                               + kv.first);
             }
             var[kv.first] = kv.second;
         }
 
=== modified file 'src/internal/RuntimeConfig.cpp'
--- src/internal/RuntimeConfig.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/RuntimeConfig.cpp	2013-12-03 14:09:20 +0000
@@ -46,22 +46,29 @@
 RuntimeConfig::RuntimeConfig(string const& configfile) :
     ConfigBase(configfile)
 {
-    registry_identity_ = get_string(RUNTIME_CONFIG_GROUP, registry_identity_str);
-    auto pos = registry_identity_.find_first_of("@:/");
-    if (pos != string::npos)
-    {
-        throw_ex("Illegal character in value for " + registry_identity_str + ": \"" + registry_identity_ +
-                 "\": identity cannot contain '" + registry_identity_[pos] + "'");
-    }
-
-    registry_configfile_ = get_string(RUNTIME_CONFIG_GROUP, registry_configfile_str);
-
-    default_middleware_ = get_middleware(RUNTIME_CONFIG_GROUP, default_middleware_str);
-
-    default_middleware_configfile_ = get_string(RUNTIME_CONFIG_GROUP,
-                                                default_middleware_ + "." + default_middleware_configfile_str);
-
-    factory_configfile_ = get_string(RUNTIME_CONFIG_GROUP, factory_configfile_str);
+    if (configfile.empty())  // Default config
+    {
+        registry_identity_ = "Registry";
+        registry_configfile_ = "Registry.ini";
+        default_middleware_ = "Zmq";
+        default_middleware_configfile_ = "";
+        factory_configfile_ = "Factory.ini";
+    }
+    else
+    {
+        registry_identity_ = get_string(RUNTIME_CONFIG_GROUP, registry_identity_str);
+        auto pos = registry_identity_.find_first_of("@:/");
+        if (pos != string::npos)
+        {
+            throw_ex("Illegal character in value for " + registry_identity_str + ": \"" + registry_identity_ +
+                     "\": identity cannot contain '" + registry_identity_[pos] + "'");
+        }
+        registry_configfile_ = get_string(RUNTIME_CONFIG_GROUP, registry_configfile_str);
+        default_middleware_ = get_middleware(RUNTIME_CONFIG_GROUP, default_middleware_str);
+        default_middleware_configfile_ = get_string(RUNTIME_CONFIG_GROUP,
+                                                    default_middleware_ + "." + default_middleware_configfile_str);
+        factory_configfile_ = get_string(RUNTIME_CONFIG_GROUP, factory_configfile_str);
+    }
 }
 
 RuntimeConfig::~RuntimeConfig() noexcept
 
=== modified file 'src/internal/RuntimeImpl.cpp'
--- src/internal/RuntimeImpl.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/RuntimeImpl.cpp	2013-12-03 14:09:20 +0000
@@ -56,8 +56,7 @@
         RuntimeConfig config(configfile);
         string default_middleware = config.default_middleware();
         string middleware_configfile = config.default_middleware_configfile();
-        string factory_configfile = config.factory_configfile();
-        middleware_factory_.reset(new MiddlewareFactory(factory_configfile, this));
+        middleware_factory_.reset(new MiddlewareFactory(this));
         registry_configfile_ = config.registry_configfile();
         registry_identity_ = config.registry_identity();
         assert(!registry_identity_.empty());
 
=== modified file 'src/internal/ScopeConfig.cpp'
--- src/internal/ScopeConfig.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/ScopeConfig.cpp	2013-12-03 14:09:20 +0000
@@ -18,6 +18,7 @@
 
 #include <scopes/internal/ScopeConfig.h>
 
+#include <scopes/ScopeExceptions.h>
 #include <unity/UnityExceptions.h>
 
 using namespace std;
@@ -37,6 +38,12 @@
 namespace
 {
     const string overrideable_str = "Override";
+    const string scope_name_str = "DisplayName";
+    const string description_str = "Description";
+    const string art_str = "Art";
+    const string icon_str = "Icon";
+    const string search_hint_str = "SearchHint";
+    const string hot_key_str = "HotKey";
 }
 
 ScopeConfig::ScopeConfig(string const& configfile) :
@@ -50,6 +57,44 @@
     {
         overrideable_ = false;
     }
+    display_name_ = parser()->get_string(SCOPE_CONFIG_GROUP, scope_name_str);
+    description_ = parser()->get_string(SCOPE_CONFIG_GROUP, description_str);
+
+    // For optional values, we store them in a unique_ptr so we can distinguish the "not set at all" case
+    // from the "explicitly set to empty string" case. parser()->get_string throws LogicException if
+    // the key is not present, so we ignore the exception for optional values.
+    try
+    {
+        string art = parser()->get_string(SCOPE_CONFIG_GROUP, art_str);
+        art_.reset(new string(art));
+    }
+    catch (LogicException const&)
+    {
+    }
+    try
+    {
+        string icon = parser()->get_string(SCOPE_CONFIG_GROUP, icon_str);
+        icon_.reset(new string(icon));
+    }
+    catch (LogicException const&)
+    {
+    }
+    try
+    {
+        string hint = parser()->get_string(SCOPE_CONFIG_GROUP, search_hint_str);
+        search_hint_.reset(new string(hint));
+    }
+    catch (LogicException const&)
+    {
+    }
+    try
+    {
+        string key = parser()->get_string(SCOPE_CONFIG_GROUP, hot_key_str);
+        hot_key_.reset(new string(key));
+    }
+    catch (LogicException const&)
+    {
+    }
 }
 
 ScopeConfig::~ScopeConfig() noexcept
@@ -61,6 +106,52 @@
     return overrideable_;
 }
 
+string ScopeConfig::display_name() const
+{
+    return display_name_;
+}
+
+string ScopeConfig::description() const
+{
+    return description_;
+}
+
+string ScopeConfig::art() const
+{
+    if (!art_)
+    {
+        throw NotFoundException("Art not set", art_str);
+    }
+    return *art_;
+}
+
+string ScopeConfig::icon() const
+{
+    if (!icon_)
+    {
+        throw NotFoundException("Icon not set", icon_str);
+    }
+    return *icon_;
+}
+
+string ScopeConfig::search_hint() const
+{
+    if (!search_hint_)
+    {
+        throw NotFoundException("Hint not set", search_hint_str);
+    }
+    return *search_hint_;
+}
+
+string ScopeConfig::hot_key() const
+{
+    if (!hot_key_)
+    {
+        throw NotFoundException("Key not set", hot_key_str);
+    }
+    return *hot_key_;
+}
+
 } // namespace internal
 
 } // namespace scopes
 
=== modified file 'src/internal/ScopeImpl.cpp'
--- src/internal/ScopeImpl.cpp	2013-11-25 19:05:41 +0000
+++ src/internal/ScopeImpl.cpp	2013-12-03 14:09:20 +0000
@@ -19,6 +19,7 @@
 #include <scopes/internal/ScopeImpl.h>
 
 #include <scopes/internal/MiddlewareBase.h>
+#include <scopes/internal/MWScope.h>
 #include <scopes/internal/QueryCtrlImpl.h>
 #include <scopes/Scope.h>
 #include <unity/Exception.h>
 
=== added file 'src/internal/ScopeMetadataImpl.cpp'
--- src/internal/ScopeMetadataImpl.cpp	1970-01-01 00:00:00 +0000
+++ src/internal/ScopeMetadataImpl.cpp	2013-12-03 14:09:20 +0000
@@ -0,0 +1,325 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Lesser GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the Lesser GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Michi Henning <[e-mail]>
+ */
+
+#include <scopes/internal/ScopeMetadataImpl.h>
+
+#include <scopes/internal/MiddlewareBase.h>
+#include <scopes/internal/ScopeImpl.h>
+#include <scopes/ScopeExceptions.h>
+#include <unity/UnityExceptions.h>
+
+using namespace std;
+using namespace unity;
+
+namespace unity
+{
+
+namespace api
+{
+
+namespace scopes
+{
+
+namespace internal
+{
+
+ScopeMetadataImpl::ScopeMetadataImpl(MiddlewareBase* mw) :
+    mw_(mw)
+{
+}
+
+ScopeMetadataImpl::ScopeMetadataImpl(const VariantMap& variant_map, MiddlewareBase* mw) :
+    mw_(mw)
+{
+    deserialize(variant_map);
+}
+
+ScopeMetadataImpl::ScopeMetadataImpl(ScopeMetadataImpl const& other) :
+    scope_name_(other.scope_name_),
+    proxy_(other.proxy_),
+    display_name_(other.display_name_),
+    description_(other.description_)
+{
+    if (other.art_)
+    {
+        art_.reset(new string(*other.art_));
+    }
+    if (other.icon_)
+    {
+        icon_.reset(new string(*other.icon_));
+    }
+    if (other.search_hint_)
+    {
+        search_hint_.reset(new string(*other.search_hint_));
+    }
+    if (other.hot_key_)
+    {
+        hot_key_.reset(new string(*other.hot_key_));
+    }
+}
+
+ScopeMetadataImpl& ScopeMetadataImpl::operator=(ScopeMetadataImpl const& rhs)
+{
+    if (this != &rhs)
+    {
+        scope_name_ = rhs.scope_name_;
+        proxy_ = rhs.proxy_;
+        display_name_ = rhs.display_name_;
+        description_ = rhs.description_;
+        art_.reset(rhs.art_ ? new string(*rhs.art_) : nullptr);
+        icon_.reset(rhs.icon_ ? new string(*rhs.icon_) : nullptr);
+        search_hint_.reset(rhs.search_hint_ ? new string(*rhs.search_hint_) : nullptr);
+        hot_key_.reset(rhs.hot_key_ ? new string(*rhs.hot_key_) : nullptr);
+    }
+    return *this;
+}
+
+std::string ScopeMetadataImpl::scope_name() const
+{
+    return scope_name_;
+}
+
+ScopeProxy ScopeMetadataImpl::proxy() const
+{
+    return proxy_;
+}
+
+std::string ScopeMetadataImpl::display_name() const
+{
+    return display_name_;
+}
+
+std::string ScopeMetadataImpl::description() const
+{
+    return description_;
+}
+
+std::string ScopeMetadataImpl::art() const
+{
+    if (art_)
+    {
+        return *art_;
+    }
+    throw NotFoundException("attribute not set", "art");
+}
+
+std::string ScopeMetadataImpl::icon() const
+{
+    if (icon_)
+    {
+        return *icon_;
+    }
+    throw NotFoundException("attribute not set", "icon");
+}
+
+std::string ScopeMetadataImpl::search_hint() const
+{
+    if (search_hint_)
+    {
+        return *search_hint_;
+    }
+    throw NotFoundException("attribute not set", "search_hint");
+}
+
+std::string ScopeMetadataImpl::hot_key() const
+{
+    if (hot_key_)
+    {
+        return *hot_key_;
+    }
+    throw NotFoundException("attribute not set", "hot_key");
+}
+
+void ScopeMetadataImpl::set_scope_name(std::string const& scope_name)
+{
+    scope_name_ = scope_name;
+}
+
+void ScopeMetadataImpl::set_proxy(ScopeProxy const& proxy)
+{
+    proxy_ = proxy;
+}
+
+void ScopeMetadataImpl::set_display_name(std::string const& display_name)
+{
+    display_name_ = display_name;
+}
+
+void ScopeMetadataImpl::set_description(std::string const& description)
+{
+    description_ = description;
+}
+
+void ScopeMetadataImpl::set_art(std::string const& art)
+{
+    art_.reset(new string(art));
+}
+
+void ScopeMetadataImpl::set_icon(std::string const& icon)
+{
+    icon_.reset(new string(icon));
+}
+
+void ScopeMetadataImpl::set_search_hint(std::string const& search_hint)
+{
+    search_hint_.reset(new string(search_hint));
+}
+
+void ScopeMetadataImpl::set_hot_key(std::string const& hot_key)
+{
+    hot_key_.reset(new string(hot_key));
+}
+
+namespace
+{
+
+void throw_on_empty(std::string const& name, std::string const& value)
+{
+    if (value.empty())
+    {
+        throw InvalidArgumentException("ScopeMetadata: required attribute '" + name + "' is empty");
+    }
+}
+
+} // namespace
+
+VariantMap ScopeMetadataImpl::serialize() const
+{
+    throw_on_empty("scope_name", scope_name_);
+    if (!proxy_)
+    {
+        throw InvalidArgumentException("ScopeMetadataImpl::serialize(): required attribute 'proxy' is null");
+    }
+    throw_on_empty("display_name", display_name_);
+    throw_on_empty("description", description_);
+
+    VariantMap var;
+    var["scope_name"] = scope_name_;
+    VariantMap proxy;
+    proxy["identity"] = proxy_->identity();
+    proxy["endpoint"] = proxy_->endpoint();
+    var["proxy"] = proxy;
+    var["display_name"] = display_name_;
+    var["description"] = description_;
+
+    // Optional fields
+    if (art_)
+    {
+        var["art"] = *art_;
+    }
+    if (icon_)
+    {
+        var["icon"] = *icon_;
+    }
+    if (search_hint_)
+    {
+        var["search_hint"] = *search_hint_;
+    }
+    if (hot_key_)
+    {
+        var["hot_key"] = *hot_key_;
+    }
+
+    return var;
+}
+
+namespace
+{
+
+VariantMap::const_iterator find_or_throw(VariantMap const& var, std::string const& name)
+{
+    auto it = var.find(name);
+    if (it == var.end())
+    {
+        throw InvalidArgumentException("ScopeMetadata::deserialize(): required attribute '" + name + "' is missing");
+    }
+    return it;
+}
+
+} // namespace
+
+void ScopeMetadataImpl::deserialize(VariantMap const& var)
+{
+    auto it = find_or_throw(var, "scope_name");
+    scope_name_ = it->second.get_string();
+    throw_on_empty("scope_name", scope_name_);
+
+    it = find_or_throw(var, "proxy");
+    auto proxy = it->second.get_dict();
+    auto it2 = proxy.find("identity");
+    if (it2 == proxy.end())
+    {
+        throw InvalidArgumentException("ScopeMetadataImpl::deserialize(): missing 'proxy.identity'");
+    }
+    auto identity = it2->second.get_string();
+    throw_on_empty("proxy.identity", identity);
+    it2 = proxy.find("endpoint");
+    if (it2 == proxy.end())
+    {
+        throw InvalidArgumentException("ScopeMetadataImpl::deserialize(): missing 'proxy.endpoint'");
+    }
+    auto endpoint = it2->second.get_string();
+    throw_on_empty("proxy.endpoint", endpoint);
+    auto mw_proxy = mw_->create_scope_proxy(identity, endpoint);
+    proxy_ = ScopeImpl::create(mw_proxy, mw_->runtime());
+
+    it = find_or_throw(var, "display_name");
+    display_name_ = it->second.get_string();
+
+    it = find_or_throw(var, "description");
+    description_ = it->second.get_string();
+
+    // Optional fields
+
+    it = var.find("art");
+    if (it != var.end())
+    {
+        art_.reset(new string(it->second.get_string()));
+    }
+
+    it = var.find("icon");
+    if (it != var.end())
+    {
+        icon_.reset(new string(it->second.get_string()));
+    }
+
+    it = var.find("search_hint");
+    if (it != var.end())
+    {
+        search_hint_.reset(new string(it->second.get_string()));
+    }
+
+    it = var.find("hot_key");
+    if (it != var.end())
+    {
+        hot_key_.reset(new string(it->second.get_string()));
+    }
+}
+
+ScopeMetadata ScopeMetadataImpl::create(unique_ptr<ScopeMetadataImpl> impl)
+{
+    return ScopeMetadata(move(impl));
+}
+
+} // namespace internal
+
+} // namespace scopes
+
+} // namespace api
+
+} // namespace unity
 
=== modified file 'src/internal/zmq_middleware/RegistryI.cpp'
--- src/internal/zmq_middleware/RegistryI.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/zmq_middleware/RegistryI.cpp	2013-12-03 14:09:20 +0000
@@ -21,6 +21,7 @@
 #include <internal/zmq_middleware/capnproto/Registry.capnp.h>
 #include <internal/zmq_middleware/capnproto/Scope.capnp.h>
 #include <scopes/internal/zmq_middleware/ObjectAdapter.h>
+#include <scopes/internal/zmq_middleware/VariantConverter.h>
 #include <scopes/internal/zmq_middleware/ZmqScope.h>
 #include <scopes/internal/RegistryObject.h>
 #include <scopes/ScopeExceptions.h>
@@ -48,7 +49,7 @@
 
 interface Scope;
 
-dictionary<string, Scope*> ScopeDictMap;
+dictionary<string, VariantMap> MetadataMap;
 
 exception NotFoundException
 {
@@ -57,8 +58,8 @@
 
 interface Registry
 {
-    Scope* find(string name) throws NotFoundException;
-    ScopeDict list();
+    Scope* get_metadata(string name) throws NotFoundException;
+    ScopeMap list();
 };
 
 */
@@ -66,7 +67,7 @@
 using namespace std::placeholders;
 
 RegistryI::RegistryI(RegistryObject::SPtr const& ro) :
-    ServantBase(ro, { { "find", bind(&RegistryI::find_, this, _1, _2, _3) },
+    ServantBase(ro, { { "get_metadata", bind(&RegistryI::get_metadata_, this, _1, _2, _3) },
                       { "list", bind(&RegistryI::list_, this, _1, _2, _3) } })
 
 {
@@ -76,28 +77,26 @@
 {
 }
 
-void RegistryI::find_(Current const&,
+void RegistryI::get_metadata_(Current const&,
                       capnp::ObjectPointer::Reader& in_params,
                       capnproto::Response::Builder& r)
 {
-    auto req = in_params.getAs<capnproto::Registry::FindRequest>();
+    auto req = in_params.getAs<capnproto::Registry::GetMetadataRequest>();
     string name = req.getName().cStr();
     auto delegate = dynamic_pointer_cast<RegistryObject>(del());
     try
     {
-        auto proxy = dynamic_pointer_cast<ZmqObjectProxy>(delegate->find(name));
-        assert(proxy);
+        auto meta = delegate->get_metadata(name);
         r.setStatus(capnproto::ResponseStatus::SUCCESS);
-        auto find_response = r.initPayload().getAs<capnproto::Registry::FindResponse>().initResponse();
-        auto p = find_response.initReturnValue();
-        p.setEndpoint(proxy->endpoint().c_str());
-        p.setIdentity(proxy->identity().c_str());
+        auto get_metadata_response = r.initPayload().getAs<capnproto::Registry::GetMetadataResponse>().initResponse();
+        auto dict = get_metadata_response.initReturnValue();
+        to_value_dict(meta.serialize(), dict);
     }
     catch (NotFoundException const& e)
     {
         r.setStatus(capnproto::ResponseStatus::USER_EXCEPTION);
-        auto find_response = r.initPayload().getAs<capnproto::Registry::FindResponse>().initResponse();
-        find_response.initNotFoundException().setName(e.name().c_str());
+        auto get_metadata_response = r.initPayload().getAs<capnproto::Registry::GetMetadataResponse>().initResponse();
+        get_metadata_response.initNotFoundException().setName(e.name().c_str());
     }
 }
 
@@ -106,18 +105,14 @@
                       capnproto::Response::Builder& r)
 {
     auto delegate = dynamic_pointer_cast<RegistryObject>(del());
-    auto scope_map = delegate->list();
+    auto metadata_map = delegate->list();
     r.setStatus(capnproto::ResponseStatus::SUCCESS);
-    auto rv = r.initPayload().getAs<capnproto::Registry::ListResponse>().initReturnValue();
-    auto list = rv.initPairs(scope_map.size());
+    auto rv = r.initPayload().getAs<capnproto::Registry::ListResponse>().initReturnValue(metadata_map.size());
     int i = 0;
-    for (auto const& pair : scope_map)
+    for (auto& pair : metadata_map)
     {
-        list[i].setName(pair.first.c_str());
-        auto p = list[i].initScopeProxy();
-        auto sp = dynamic_pointer_cast<ZmqScope>(pair.second);
-        p.setEndpoint(sp->endpoint().c_str());
-        p.setIdentity(sp->identity().c_str());
+        auto dict = rv[i];
+        to_value_dict(pair.second.serialize(), dict);
         ++i;
     }
 }
 
=== modified file 'src/internal/zmq_middleware/ZmqConfig.cpp'
--- src/internal/zmq_middleware/ZmqConfig.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/zmq_middleware/ZmqConfig.cpp	2013-12-03 14:09:20 +0000
@@ -43,10 +43,16 @@
 ZmqConfig::ZmqConfig(string const& configfile) :
     ConfigBase(configfile)
 {
-    public_dir_ = get_string(ZMQ_CONFIG_GROUP, public_dir_str);
-
-    // Private directory is not needed by all processes. It is retrieved
-    // on demand during adapter creation.
+    if (configfile.empty())
+    {
+        public_dir_ = "/tmp";
+        private_dir_ = "/tmp";
+    }
+    else
+    {
+        public_dir_ = get_string(ZMQ_CONFIG_GROUP, public_dir_str);
+        private_dir_ = get_string(ZMQ_CONFIG_GROUP, private_dir_str);
+    }
 }
 
 ZmqConfig::~ZmqConfig() noexcept
@@ -60,11 +66,6 @@
 
 string ZmqConfig::private_dir() const
 {
-    lock_guard<mutex> lock(mutex_);
-    if (private_dir_.empty())    // Initialize first time only
-    {
-        private_dir_ = get_string(ZMQ_CONFIG_GROUP, private_dir_str);
-    }
     return private_dir_;
 }
 
 
=== modified file 'src/internal/zmq_middleware/ZmqMiddleware.cpp'
--- src/internal/zmq_middleware/ZmqMiddleware.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/zmq_middleware/ZmqMiddleware.cpp	2013-12-03 14:09:20 +0000
@@ -164,6 +164,20 @@
     state_changed_.wait(lock, [this] { return state_ == Stopped; }); // LCOV_EXCL_LINE
 }
 
+MWProxy ZmqMiddleware::create_proxy(string const& identity, string const& endpoint)
+{
+    MWProxy proxy;
+    try
+    {
+        proxy.reset(new ZmqObjectProxy(this, endpoint, identity));
+    }
+    catch (zmqpp::exception const& e)
+    {
+        rethrow_zmq_ex(e);
+    }
+    return proxy;
+}
+
 MWRegistryProxy ZmqMiddleware::create_registry_proxy(string const& identity, string const& endpoint)
 {
     MWRegistryProxy proxy;
 
=== modified file 'src/internal/zmq_middleware/ZmqObject.cpp'
--- src/internal/zmq_middleware/ZmqObject.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/zmq_middleware/ZmqObject.cpp	2013-12-03 14:09:20 +0000
@@ -44,6 +44,16 @@
 
 #define MONITOR_ENDPOINT "ipc:///tmp/scopes-monitor"
 
+ZmqObjectProxy::ZmqObjectProxy(ZmqMiddleware* mw_base, string const& endpoint, string const& identity) :
+    MWObjectProxy(mw_base),
+    endpoint_(endpoint),
+    identity_(identity),
+    type_(Unknown)
+{
+    assert(!endpoint.empty());
+    assert(!identity.empty());
+}
+
 ZmqObjectProxy::ZmqObjectProxy(ZmqMiddleware* mw_base, string const& endpoint, string const& identity, RequestType t) :
     MWObjectProxy(mw_base),
     endpoint_(endpoint),
@@ -52,6 +62,7 @@
 {
     assert(!endpoint.empty());
     assert(!identity.empty());
+    assert(t != Unknown);
 }
 
 ZmqObjectProxy::~ZmqObjectProxy() noexcept
 
=== modified file 'src/internal/zmq_middleware/ZmqRegistry.cpp'
--- src/internal/zmq_middleware/ZmqRegistry.cpp	2013-11-21 21:44:00 +0000
+++ src/internal/zmq_middleware/ZmqRegistry.cpp	2013-12-03 14:09:20 +0000
@@ -19,9 +19,11 @@
 #include <scopes/internal/zmq_middleware/ZmqRegistry.h>
 
 #include <internal/zmq_middleware/capnproto/Registry.capnp.h>
+#include <scopes/internal/zmq_middleware/VariantConverter.h>
 #include <scopes/internal/zmq_middleware/ZmqException.h>
 #include <scopes/internal/zmq_middleware/ZmqScope.h>
 #include <scopes/internal/ScopeImpl.h>
+#include <scopes/internal/ScopeMetadataImpl.h>
 #include <scopes/ScopeExceptions.h>
 
 #include <capnp/message.h>
@@ -47,7 +49,7 @@
 
 interface Scope;
 
-dictionary<string, Scope*> ScopeDictMap;
+dictionary<string, ScopeMetadata> MetadataMap;
 
 exception NotFoundException
 {
@@ -56,7 +58,7 @@
 
 interface Registry
 {
-    Scope* find(string name) throws NotFoundException;
+    ScopeMetadata get_metadata(string name) throws NotFoundException;
     ScopeDict list();
 };
 
@@ -73,11 +75,11 @@
 {
 }
 
-ScopeProxy ZmqRegistry::find(std::string const& scope_name)
+ScopeMetadata ZmqRegistry::get_metadata(std::string const& scope_name)
 {
     capnp::MallocMessageBuilder request_builder;
-    auto request = make_request_(request_builder, "find");
-    auto in_params = request.initInParams().getAs<capnproto::Registry::FindRequest>();
+    auto request = make_request_(request_builder, "get_metadata");
+    auto in_params = request.initInParams().getAs<capnproto::Registry::GetMetadataRequest>();
     in_params.setName(scope_name.c_str());
 
     auto future = mw_base()->invoke_pool()->submit([&] { return this->invoke_(request_builder); });
@@ -88,28 +90,30 @@
     auto response = reader.getRoot<capnproto::Response>();
     throw_if_runtime_exception(response);
 
-    auto find_response = response.getPayload().getAs<capnproto::Registry::FindResponse>().getResponse();
-    switch (find_response.which())
+    auto get_metadata_response = response.getPayload().getAs<capnproto::Registry::GetMetadataResponse>().getResponse();
+    switch (get_metadata_response.which())
     {
-        case capnproto::Registry::FindResponse::Response::RETURN_VALUE:
+        case capnproto::Registry::GetMetadataResponse::Response::RETURN_VALUE:
         {
-            auto proxy = find_response.getReturnValue();
-            ZmqScopeProxy p(new ZmqScope(mw_base(), proxy.getEndpoint().cStr(), proxy.getIdentity().cStr()));
-            return ScopeImpl::create(p, mw_base()->runtime());
+            auto md = get_metadata_response.getReturnValue();
+            VariantMap m = to_variant_map(md);
+            unique_ptr<ScopeMetadataImpl> smdi(new ScopeMetadataImpl(mw_base()));
+            smdi->deserialize(m);
+            return ScopeMetadata(ScopeMetadataImpl::create(move(smdi)));
         }
-        case capnproto::Registry::FindResponse::Response::NOT_FOUND_EXCEPTION:
+        case capnproto::Registry::GetMetadataResponse::Response::NOT_FOUND_EXCEPTION:
         {
-            auto ex = find_response.getNotFoundException();
-            throw NotFoundException("Registry::find(): no such scope", ex.getName().cStr());
+            auto ex = get_metadata_response.getNotFoundException();
+            throw NotFoundException("Registry::get_metadata(): no such scope", ex.getName().cStr());
         }
         default:
         {
-            throw MiddlewareException("Registry::find(): unknown user exception");
+            throw MiddlewareException("Registry::get_metadata(): unknown user exception");
         }
     }
 }
 
-ScopeMap ZmqRegistry::list()
+MetadataMap ZmqRegistry::list()
 {
     capnp::MallocMessageBuilder request_builder;
     make_request_(request_builder, "list");
@@ -123,13 +127,16 @@
     throw_if_runtime_exception(response);
 
     auto list_response = response.getPayload().getAs<capnproto::Registry::ListResponse>();
-    auto pairs = list_response.getReturnValue().getPairs();
-    ScopeMap sm;
-    for (size_t i = 0; i < pairs.size(); ++i)
+    auto list = list_response.getReturnValue();
+    MetadataMap sm;
+    for (size_t i = 0; i < list.size(); ++i)
     {
-        auto proxy = pairs[i].getScopeProxy();
-        ZmqScopeProxy p(new ZmqScope(mw_base(), proxy.getEndpoint().cStr(), proxy.getIdentity().cStr()));
-        sm[pairs[i].getName().cStr()] = ScopeImpl::create(p, mw_base()->runtime());
+        VariantMap m = to_variant_map(list[i]);
+        string scope_name = m["scope_name"].get_string();
+        unique_ptr<ScopeMetadataImpl> smdi(new ScopeMetadataImpl(mw_base()));
+        smdi->deserialize(m);
+        ScopeMetadata d(ScopeMetadataImpl::create(move(smdi)));
+        sm.emplace(make_pair(move(scope_name), move(d)));
     }
     return sm;
 }
 
=== modified file 'src/internal/zmq_middleware/capnproto/Registry.capnp'
--- src/internal/zmq_middleware/capnproto/Registry.capnp	2013-09-17 08:02:23 +0000
+++ src/internal/zmq_middleware/capnproto/Registry.capnp	2013-12-03 14:09:20 +0000
@@ -22,31 +22,31 @@
 
 $Cxx.namespace("unity::api::scopes::internal::zmq_middleware::capnproto::Registry");
 
-using ScopeDict = import "ScopeDict.capnp";
+using ValueDict = import "ValueDict.capnp";
 using Proxy = import "Proxy.capnp";
 
 # Registry interface
 #
 # Operations:
 #
-# Proxy find(string name) throws NotFoundException;
-# ScopeDict list();
+# ValueDict get_metadata(string name) throws NotFoundException;
+# map<string, ScopeMetadata> list();
 
 struct NotFoundException
 {
     name @0 : Text;
 }
 
-struct FindRequest
+struct GetMetadataRequest
 {
     name @0 : Text;
 }
 
-struct FindResponse
+struct GetMetadataResponse
 {
     response : union
     {
-        returnValue         @0 : Proxy.Proxy;
+        returnValue         @0 : ValueDict.ValueDict;
         notFoundException   @1 : NotFoundException;
     }
 }
@@ -57,5 +57,5 @@
 
 struct ListResponse
 {
-    returnValue @0 : ScopeDict.ScopeDict;
+    returnValue @0 : List(ValueDict.ValueDict);
 }
 
=== modified file 'test/gtest/unity/api/scopes/ResultItem/ResultItem_test.cpp'
--- test/gtest/unity/api/scopes/ResultItem/ResultItem_test.cpp	2013-11-27 10:44:35 +0000
+++ test/gtest/unity/api/scopes/ResultItem/ResultItem_test.cpp	2013-12-03 14:09:20 +0000
@@ -116,6 +116,15 @@
         EXPECT_EQ("dnd_uri b", copy.dnd_uri());
         EXPECT_EQ("xyz", copy.serialize()["foo"].get_string());
         EXPECT_EQ("1", copy.category()->id());
+
+        ResultItem copy2(cat);
+        copy2 = copy;
+        EXPECT_EQ("uri b", copy2.uri());
+        EXPECT_EQ("title b", copy2.title());
+        EXPECT_EQ("icon b", copy2.art());
+        EXPECT_EQ("dnd_uri b", copy2.dnd_uri());
+        EXPECT_EQ("xyz", copy2.serialize()["foo"].get_string());
+        EXPECT_EQ("1", copy2.category()->id());
     }
 }
 
 
=== modified file 'test/gtest/unity/api/scopes/Runtime/CMakeLists.txt'
--- test/gtest/unity/api/scopes/Runtime/CMakeLists.txt	2013-11-19 02:51:46 +0000
+++ test/gtest/unity/api/scopes/Runtime/CMakeLists.txt	2013-12-03 14:09:20 +0000
@@ -1,4 +1,3 @@
-configure_file(Factory.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Factory.ini)
 configure_file(Registry.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Registry.ini)
 configure_file(Runtime.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Runtime.ini)
 configure_file(Zmq.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Zmq.ini)
 
=== removed file 'test/gtest/unity/api/scopes/Runtime/Factory.ini.in'
--- test/gtest/unity/api/scopes/Runtime/Factory.ini.in	2013-09-17 08:02:23 +0000
+++ test/gtest/unity/api/scopes/Runtime/Factory.ini.in	1970-01-01 00:00:00 +0000
@@ -1,2 +0,0 @@
-[MiddlewareFactory]
-Zmq.Configfile =
 
=== modified file 'test/gtest/unity/api/scopes/Variant/Variant_test.cpp'
--- test/gtest/unity/api/scopes/Variant/Variant_test.cpp	2013-11-19 15:35:07 +0000
+++ test/gtest/unity/api/scopes/Variant/Variant_test.cpp	2013-12-03 14:09:20 +0000
@@ -106,6 +106,9 @@
         v = 99;
         EXPECT_EQ(99, v.get_int());
 
+        v = 10.5f;
+        EXPECT_TRUE(v.get_double() - 10.5f < 0.00001f);
+
         v = false;
         EXPECT_FALSE(v.get_bool());
 
 
=== modified file 'test/gtest/unity/api/scopes/internal/CMakeLists.txt'
--- test/gtest/unity/api/scopes/internal/CMakeLists.txt	2013-11-18 08:14:46 +0000
+++ test/gtest/unity/api/scopes/internal/CMakeLists.txt	2013-12-03 14:09:20 +0000
@@ -3,12 +3,12 @@
 add_subdirectory(DynamicLoader)
 add_subdirectory(lttng)
 add_subdirectory(MiddlewareFactory)
-add_subdirectory(MiddlewareFactoryConfig)
 add_subdirectory(Reaper)
 add_subdirectory(RegistryConfig)
 add_subdirectory(RuntimeConfig)
 add_subdirectory(RuntimeImpl)
 add_subdirectory(ScopeLoader)
+add_subdirectory(ScopeMetadataImpl)
 add_subdirectory(ThreadPool)
 add_subdirectory(ThreadSafeQueue)
 add_subdirectory(UniqueID)
 
=== modified file 'test/gtest/unity/api/scopes/internal/MiddlewareFactory/CMakeLists.txt'
--- test/gtest/unity/api/scopes/internal/MiddlewareFactory/CMakeLists.txt	2013-09-23 06:13:06 +0000
+++ test/gtest/unity/api/scopes/internal/MiddlewareFactory/CMakeLists.txt	2013-12-03 14:09:20 +0000
@@ -1,5 +1,3 @@
-configure_file(Factory.ini.in Factory.ini)
-
 add_executable(MiddlewareFactory_test MiddlewareFactory_test.cpp)
 target_link_libraries(MiddlewareFactory_test ${TESTLIBS})
 
 
=== removed file 'test/gtest/unity/api/scopes/internal/MiddlewareFactory/Factory.ini.in'
--- test/gtest/unity/api/scopes/internal/MiddlewareFactory/Factory.ini.in	2013-08-06 01:51:26 +0000
+++ test/gtest/unity/api/scopes/internal/MiddlewareFactory/Factory.ini.in	1970-01-01 00:00:00 +0000
@@ -1,3 +0,0 @@
-[MiddlewareFactory]
-Ice.Configfile = Ice.Config
-REST.Configfile = REST.Config
 
=== modified file 'test/gtest/unity/api/scopes/internal/MiddlewareFactory/MiddlewareFactory_test.cpp'
--- test/gtest/unity/api/scopes/internal/MiddlewareFactory/MiddlewareFactory_test.cpp	2013-11-01 12:44:48 +0000
+++ test/gtest/unity/api/scopes/internal/MiddlewareFactory/MiddlewareFactory_test.cpp	2013-12-03 14:09:20 +0000
@@ -27,10 +27,10 @@
 
 TEST(MiddlewareFactory, basic)
 {
-    MiddlewareFactory f("Factory.ini", (RuntimeImpl*)0x1);
-    EXPECT_EQ(nullptr, f.find("nosuchscope", "Ice"));
+    MiddlewareFactory f((RuntimeImpl*)0x1);
+    EXPECT_EQ(nullptr, f.find("nosuchscope", "Zmq"));
     MiddlewareBase::SPtr not_found;
-    MiddlewareBase::SPtr mw = f.find("testscope", "Ice");
+    MiddlewareBase::SPtr mw = f.find("testscope", "Zmq");
     EXPECT_EQ(not_found, mw);
     mw = f.find("testscope", "NoSuchMiddleware");
     EXPECT_EQ(not_found, mw);
@@ -40,8 +40,8 @@
 {
     try
     {
-        MiddlewareFactory f("Factory.ini", (RuntimeImpl*)0x1);
-        f.create("somescope", "NoSuchMiddleware", "Ice.Config");
+        MiddlewareFactory f((RuntimeImpl*)0x1);
+        f.create("somescope", "NoSuchMiddleware", "Zmq.ini");
         FAIL();
     }
     catch (ConfigException const& e)
@@ -49,20 +49,3 @@
         EXPECT_EQ("unity::api::scopes::ConfigException: Invalid middleware kind: NoSuchMiddleware", e.to_string());
     }
 }
-
-TEST(MiddlewareFactory, BadIniFile)
-{
-    try
-    {
-        MiddlewareFactory f("NoSuchFile.ini", (RuntimeImpl*)0x1);
-        FAIL();
-    }
-    catch (ConfigException const& e)
-    {
-        EXPECT_EQ("unity::api::scopes::ConfigException: cannot instantiate MiddlewareFactory: "
-                  "config file: NoSuchFile.ini:\n"
-                  "    unity::FileException: Could not load ini file NoSuchFile.ini: "
-                  "No such file or directory (errno = 4)",
-                  e.to_string());
-    }
-}
 
=== removed directory 'test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig'
=== removed file 'test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig/CMakeLists.txt'
--- test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig/CMakeLists.txt	2013-08-06 01:51:26 +0000
+++ test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig/CMakeLists.txt	1970-01-01 00:00:00 +0000
@@ -1,6 +0,0 @@
-configure_file(Factory.ini.in Factory.ini)
-
-add_executable(MiddlewareFactoryConfig_test MiddlewareFactoryConfig_test.cpp)
-target_link_libraries(MiddlewareFactoryConfig_test ${TESTLIBS})
-
-add_test(MiddlewareFactoryConfig MiddlewareFactoryConfig_test)
 
=== removed file 'test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig/Factory.ini.in'
--- test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig/Factory.ini.in	2013-11-19 02:51:46 +0000
+++ test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig/Factory.ini.in	1970-01-01 00:00:00 +0000
@@ -1,3 +0,0 @@
-[MiddlewareFactory]
-Zmq.ConfigFile = Zmq.ini
-REST.ConfigFile = REST.ini
 
=== removed file 'test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig/MiddlewareFactoryConfig_test.cpp'
--- test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig/MiddlewareFactoryConfig_test.cpp	2013-11-19 02:51:46 +0000
+++ test/gtest/unity/api/scopes/internal/MiddlewareFactoryConfig/MiddlewareFactoryConfig_test.cpp	1970-01-01 00:00:00 +0000
@@ -1,31 +0,0 @@
-/*
- * Copyright (C) 2013 Canonical Ltd
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License version 3 as
- * published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- * Authored by: Michi Henning <[e-mail]>
- */
-
-#include <scopes/internal/MiddlewareFactoryConfig.h>
-
-#include <gtest/gtest.h>
-
-using namespace std;
-using namespace unity::api::scopes::internal;
-
-TEST(MiddlewareFactoryConfig, basic)
-{
-    MiddlewareFactoryConfig c("Factory.ini");
-    EXPECT_EQ("Zmq.ini", c.zmq_configfile());
-    EXPECT_EQ("REST.ini", c.rest_configfile());
-}
 
=== modified file 'test/gtest/unity/api/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp'
--- test/gtest/unity/api/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp	2013-11-19 02:51:46 +0000
+++ test/gtest/unity/api/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp	2013-12-03 14:09:20 +0000
@@ -27,7 +27,7 @@
 
 TEST(RuntimeConfig, basic)
 {
-    RuntimeConfig c;
+    RuntimeConfig c("");
     EXPECT_EQ("Registry", c.registry_identity());
     EXPECT_EQ("Registry.ini", c.registry_configfile());
     EXPECT_EQ("Zmq", c.default_middleware());
 
=== modified file 'test/gtest/unity/api/scopes/internal/RuntimeImpl/CMakeLists.txt'
--- test/gtest/unity/api/scopes/internal/RuntimeImpl/CMakeLists.txt	2013-11-19 02:51:46 +0000
+++ test/gtest/unity/api/scopes/internal/RuntimeImpl/CMakeLists.txt	2013-12-03 14:09:20 +0000
@@ -1,4 +1,3 @@
-configure_file(Factory.ini.in Factory.ini)
 configure_file(Zmq.ini.in Zmq.ini)
 configure_file(Registry.ini.in Registry.ini)
 configure_file(Runtime.ini.in Runtime.ini)
 
=== removed file 'test/gtest/unity/api/scopes/internal/RuntimeImpl/Factory.ini.in'
--- test/gtest/unity/api/scopes/internal/RuntimeImpl/Factory.ini.in	2013-08-05 06:02:03 +0000
+++ test/gtest/unity/api/scopes/internal/RuntimeImpl/Factory.ini.in	1970-01-01 00:00:00 +0000
@@ -1,2 +0,0 @@
-[MiddlewareFactory]
-Ice.Configfile =
 
=== modified file 'test/gtest/unity/api/scopes/internal/RuntimeImpl/RuntimeImpl_test.cpp'
--- test/gtest/unity/api/scopes/internal/RuntimeImpl/RuntimeImpl_test.cpp	2013-11-19 02:51:46 +0000
+++ test/gtest/unity/api/scopes/internal/RuntimeImpl/RuntimeImpl_test.cpp	2013-12-03 14:09:20 +0000
@@ -29,7 +29,6 @@
 
 TEST(RuntimeImpl, basic)
 {
-try{
     RuntimeImpl::UPtr rt = RuntimeImpl::create("testscope");
 
     EXPECT_TRUE(rt->registry().get() != nullptr);
@@ -61,11 +60,6 @@
                   e.to_string());
     }
 }
-catch(unity::Exception const& e)
-{
-    cout << e.to_string() << endl;
-}
-}
 
 TEST(RuntimeImpl, error)
 {
 
=== added directory 'test/gtest/unity/api/scopes/internal/ScopeMetadataImpl'
=== added file 'test/gtest/unity/api/scopes/internal/ScopeMetadataImpl/CMakeLists.txt'
--- test/gtest/unity/api/scopes/internal/ScopeMetadataImpl/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ test/gtest/unity/api/scopes/internal/ScopeMetadataImpl/CMakeLists.txt	2013-12-03 14:09:20 +0000
@@ -0,0 +1,6 @@
+configure_file(Zmq.ini.in Zmq.ini)
+
+add_executable(ScopeMetadataImpl_test ScopeMetadataImpl_test.cpp)
+target_link_libraries(ScopeMetadataImpl_test ${TESTLIBS})
+
+add_test(ScopeMetadataImpl ScopeMetadataImpl_test)
 
=== added file 'test/gtest/unity/api/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp'
--- test/gtest/unity/api/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp	1970-01-01 00:00:00 +0000
+++ test/gtest/unity/api/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp	2013-12-03 14:09:20 +0000
@@ -0,0 +1,388 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/lzmqnses/>.
+ *
+ * Authored by: Michi Henning <[e-mail]>
+ */
+
+#include <scopes/internal/ScopeMetadataImpl.h>
+
+#include <scopes/internal/ScopeImpl.h>
+#include <scopes/internal/zmq_middleware/ZmqMiddleware.h>
+#include <scopes/ScopeExceptions.h>
+#include <unity/UnityExceptions.h>
+
+#include <boost/regex.hpp>  // Use Boost implementation until http://gcc.gnu.org/bugzilla/show_bug.cgi?id=53631 is fixed.
+#include <gtest/gtest.h>
+#include <scope-api-testconfig.h>
+
+using namespace std;
+using namespace unity;
+using namespace unity::api::scopes;
+using namespace unity::api::scopes::internal;
+using namespace unity::api::scopes::internal::zmq_middleware;
+
+TEST(ScopeMetadataImpl, basic)
+{
+    ZmqMiddleware mw("testscope", TEST_BUILD_ROOT "/gtest/unity/api/scopes/internal/ScopeMetadataImpl/Zmq.ini",
+                     (RuntimeImpl*)0x1);
+
+    unique_ptr<ScopeMetadataImpl> mi(new ScopeMetadataImpl(&mw));
+    mi->set_scope_name("scope_name");
+    auto mw_proxy = mw.create_scope_proxy("identity", "endpoint");
+    mi->set_proxy(ScopeImpl::create(mw_proxy, mw.runtime()));
+    mi->set_display_name("display_name");
+    mi->set_description("description");
+
+    // Keep a copy for tests below
+    unique_ptr<ScopeMetadataImpl> mi2(new ScopeMetadataImpl(*mi));
+
+    // Create the public instance and check that the values match
+    auto m = ScopeMetadataImpl::create(move(mi));
+    EXPECT_EQ("scope_name", m.scope_name());
+    EXPECT_EQ("identity", m.proxy()->identity());
+    EXPECT_EQ("endpoint", m.proxy()->endpoint());
+    EXPECT_EQ("display_name", m.display_name());
+    EXPECT_EQ("description", m.description());
+
+    // Check that optional fields that are not set throw
+    try
+    {
+        m.art();
+        FAIL();
+    }
+    catch (NotFoundException const& e)
+    {
+        EXPECT_EQ("unity::api::scopes::NotFoundException: attribute not set (name = art)", e.to_string());
+    }
+
+    try
+    {
+        m.icon();
+        FAIL();
+    }
+    catch (NotFoundException const& e)
+    {
+        EXPECT_EQ("unity::api::scopes::NotFoundException: attribute not set (name = icon)", e.to_string());
+    }
+
+    try
+    {
+        m.search_hint();
+        FAIL();
+    }
+    catch (NotFoundException const& e)
+    {
+        EXPECT_EQ("unity::api::scopes::NotFoundException: attribute not set (name = search_hint)", e.to_string());
+    }
+
+    try
+    {
+        m.hot_key();
+        FAIL();
+    }
+    catch (NotFoundException const& e)
+    {
+        EXPECT_EQ("unity::api::scopes::NotFoundException: attribute not set (name = hot_key)", e.to_string());
+    }
+
+    // Check that the copy has the same values as the original
+    EXPECT_EQ("scope_name", mi2->scope_name());
+    EXPECT_EQ("identity", mi2->proxy()->identity());
+    EXPECT_EQ("endpoint", mi2->proxy()->endpoint());
+    EXPECT_EQ("display_name", mi2->display_name());
+    EXPECT_EQ("description", mi2->description());
+
+    // Set optional fields on copy.
+    mi2->set_art("art");
+    mi2->set_icon("icon");
+    mi2->set_search_hint("search_hint");
+    mi2->set_hot_key("hot_key");
+
+    // Make another copy, so we get coverage on the entire copy constructor
+    unique_ptr<ScopeMetadataImpl> mi3(new ScopeMetadataImpl(*mi2));
+
+    // Check that optional fields are set correctly
+    m = ScopeMetadataImpl::create(move(mi2));
+    EXPECT_EQ("search_hint", m.search_hint());
+    EXPECT_EQ("hot_key", m.hot_key());
+
+    // Make another value
+    unique_ptr<ScopeMetadataImpl> ti(new ScopeMetadataImpl(&mw));
+    ti->set_scope_name("tmp scope_name");
+    mw_proxy = mw.create_scope_proxy("tmp identity", "tmp endpoint");
+    ti->set_proxy(ScopeImpl::create(mw_proxy, mw.runtime()));
+    ti->set_display_name("tmp display_name");
+    ti->set_description("tmp description");
+    ti->set_art("tmp art");
+    ti->set_icon("tmp icon");
+    ti->set_search_hint("tmp search_hint");
+    ti->set_hot_key("tmp hot_key");
+
+    // Check impl assignment operator
+    ScopeMetadataImpl ci(&mw);
+    ci = *ti;
+    EXPECT_EQ("tmp scope_name", ci.scope_name());
+    EXPECT_EQ("tmp identity", ci.proxy()->identity());
+    EXPECT_EQ("tmp endpoint", ci.proxy()->endpoint());
+    EXPECT_EQ("tmp display_name", ci.display_name());
+    EXPECT_EQ("tmp description", ci.description());
+    EXPECT_EQ("tmp art", ci.art());
+    EXPECT_EQ("tmp icon", ci.icon());
+    EXPECT_EQ("tmp search_hint", ci.search_hint());
+    EXPECT_EQ("tmp hot_key", ci.hot_key());
+
+    // Check public assignment operator
+    auto tmp = ScopeMetadataImpl::create(move(ti));
+    m = tmp;
+    EXPECT_EQ("tmp scope_name", m.scope_name());
+    EXPECT_EQ("tmp identity", m.proxy()->identity());
+    EXPECT_EQ("tmp endpoint", m.proxy()->endpoint());
+    EXPECT_EQ("tmp display_name", m.display_name());
+    EXPECT_EQ("tmp description", m.description());
+    EXPECT_EQ("tmp art", m.art());
+    EXPECT_EQ("tmp icon", m.icon());
+    EXPECT_EQ("tmp search_hint", m.search_hint());
+    EXPECT_EQ("tmp hot_key", m.hot_key());
+
+    // Self-assignment
+    tmp = tmp;
+    EXPECT_EQ("tmp scope_name", tmp.scope_name());
+    EXPECT_EQ("tmp identity", tmp.proxy()->identity());
+    EXPECT_EQ("tmp endpoint", tmp.proxy()->endpoint());
+    EXPECT_EQ("tmp display_name", tmp.display_name());
+    EXPECT_EQ("tmp description", tmp.description());
+    EXPECT_EQ("tmp art", tmp.art());
+    EXPECT_EQ("tmp icon", tmp.icon());
+    EXPECT_EQ("tmp search_hint", tmp.search_hint());
+    EXPECT_EQ("tmp hot_key", tmp.hot_key());
+
+    // Copy constructor
+    ScopeMetadata tmp2(tmp);
+    EXPECT_EQ("tmp scope_name", tmp2.scope_name());
+    EXPECT_EQ("tmp identity", tmp2.proxy()->identity());
+    EXPECT_EQ("tmp endpoint", tmp2.proxy()->endpoint());
+    EXPECT_EQ("tmp display_name", tmp2.display_name());
+    EXPECT_EQ("tmp description", tmp2.description());
+    EXPECT_EQ("tmp art", tmp2.art());
+    EXPECT_EQ("tmp icon", tmp2.icon());
+    EXPECT_EQ("tmp search_hint", tmp2.search_hint());
+    EXPECT_EQ("tmp hot_key", tmp2.hot_key());
+}
+
+TEST(ScopeMetadataImpl, serialize)
+{
+    ZmqMiddleware mw("testscope", TEST_BUILD_ROOT "/gtest/unity/api/scopes/internal/ScopeMetadataImpl/Zmq.ini",
+                     (RuntimeImpl*)0x1);
+
+    unique_ptr<ScopeMetadataImpl> mi(new ScopeMetadataImpl(&mw));
+    mi->set_scope_name("scope_name");
+    auto mw_proxy = mw.create_scope_proxy("identity", "endpoint");
+    mi->set_proxy(ScopeImpl::create(mw_proxy, mw.runtime()));
+    mi->set_display_name("display_name");
+    mi->set_description("description");
+    mi->set_art("art");
+    mi->set_icon("icon");
+    mi->set_search_hint("search_hint");
+    mi->set_hot_key("hot_key");
+
+    // Check that serialize() sets the map values correctly
+    auto m = ScopeMetadataImpl::create(move(mi));
+    auto var = m.serialize();
+    EXPECT_EQ(8, var.size());
+    EXPECT_EQ("scope_name", var["scope_name"].get_string());
+    EXPECT_EQ("display_name", var["display_name"].get_string());
+    EXPECT_EQ("description", var["description"].get_string());
+    EXPECT_EQ("art", var["art"].get_string());
+    EXPECT_EQ("icon", var["icon"].get_string());
+    EXPECT_EQ("search_hint", var["search_hint"].get_string());
+    EXPECT_EQ("hot_key", var["hot_key"].get_string());
+
+    // Make another instance from the VariantMap and check its fields
+    ScopeMetadataImpl c(var, &mw);
+    EXPECT_EQ("scope_name", c.scope_name());
+    EXPECT_EQ("identity", c.proxy()->identity());
+    EXPECT_EQ("endpoint", c.proxy()->endpoint());
+    EXPECT_EQ("display_name", c.display_name());
+    EXPECT_EQ("description", c.description());
+    EXPECT_EQ("art", c.art());
+    EXPECT_EQ("icon", c.icon());
+    EXPECT_EQ("search_hint", c.search_hint());
+    EXPECT_EQ("hot_key", c.hot_key());
+}
+
+TEST(ScopeMetadataImpl, serialize_exceptions)
+{
+    ZmqMiddleware mw("testscope", TEST_BUILD_ROOT "/gtest/unity/api/scopes/internal/ScopeMetadataImpl/Zmq.ini",
+                     (RuntimeImpl*)0x1);
+
+    ScopeMetadataImpl mi(&mw);
+    try
+    {
+        mi.serialize();
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadata: required attribute 'scope_name' is empty",
+                   e.to_string());
+    }
+
+    try
+    {
+        mi.set_scope_name("scope_name");
+        mi.serialize();
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadataImpl::serialize(): required attribute 'proxy' is null",
+                   e.to_string());
+    }
+
+    try
+    {
+        auto mw_proxy = mw.create_scope_proxy("identity", "endpoint");
+        mi.set_proxy(ScopeImpl::create(mw_proxy, mw.runtime()));
+        mi.serialize();
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadata: required attribute 'display_name' is empty",
+                   e.to_string());
+    }
+
+    try
+    {
+        mi.set_display_name("display_name");
+        mi.serialize();
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadata: required attribute 'description' is empty",
+                   e.to_string());
+    }
+}
+
+TEST(ScopeMetadataImpl, deserialize_exceptions)
+{
+    ZmqMiddleware mw("testscope", TEST_BUILD_ROOT "/gtest/unity/api/scopes/internal/ScopeMetadataImpl/Zmq.ini",
+                     (RuntimeImpl*)0x1);
+
+    VariantMap m;
+    try
+    {
+        ScopeMetadataImpl mi(m, &mw);
+        mi.deserialize(m);
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadata::deserialize(): required attribute "
+                  "'scope_name' is missing",
+                   e.to_string());
+    }
+
+    m["scope_name"] = "scope_name";
+    try
+    {
+        ScopeMetadataImpl mi(m, &mw);
+        mi.deserialize(m);
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadata::deserialize(): required attribute "
+                  "'proxy' is missing",
+                   e.to_string());
+    }
+
+    VariantMap proxy;
+    m["proxy"] = proxy;
+    try
+    {
+        ScopeMetadataImpl mi(m, &mw);
+        mi.deserialize(m);
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadataImpl::deserialize(): missing 'proxy.identity'",
+                   e.to_string());
+    }
+
+    proxy["identity"] = "identity";
+    m["proxy"] = proxy;
+    try
+    {
+        ScopeMetadataImpl mi(m, &mw);
+        mi.deserialize(m);
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadataImpl::deserialize(): missing 'proxy.endpoint'",
+                   e.to_string());
+    }
+
+    proxy["endpoint"] = "endpoint";
+    m["proxy"] = proxy;
+    try
+    {
+        ScopeMetadataImpl mi(m, &mw);
+        mi.deserialize(m);
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadata::deserialize(): required attribute "
+                  "'display_name' is missing",
+                   e.to_string());
+    }
+
+    m["display_name"] = "display_name";
+    try
+    {
+        ScopeMetadataImpl mi(m, &mw);
+        mi.deserialize(m);
+        FAIL();
+    }
+    catch (InvalidArgumentException const&e)
+    {
+        EXPECT_EQ("unity::InvalidArgumentException: ScopeMetadata::deserialize(): required attribute "
+                  "'description' is missing",
+                   e.to_string());
+    }
+    m["description"] = "description";
+
+    // Optional attributes
+    m["art"] = "art";
+    m["icon"] = "icon";
+    m["search_hint"] = "search_hint";
+    m["hot_key"] = "hot_key";
+
+    ScopeMetadataImpl mi(m, &mw);
+    mi.deserialize(m);
+    EXPECT_EQ("scope_name", mi.scope_name());
+    EXPECT_EQ("identity", mi.proxy()->identity());
+    EXPECT_EQ("endpoint", mi.proxy()->endpoint());
+    EXPECT_EQ("display_name", mi.display_name());
+    EXPECT_EQ("description", mi.description());
+    EXPECT_EQ("art", mi.art());
+    EXPECT_EQ("icon", mi.icon());
+    EXPECT_EQ("search_hint", mi.search_hint());
+    EXPECT_EQ("hot_key", mi.hot_key());
+}
 
=== added file 'test/gtest/unity/api/scopes/internal/ScopeMetadataImpl/Zmq.ini.in'
--- test/gtest/unity/api/scopes/internal/ScopeMetadataImpl/Zmq.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/unity/api/scopes/internal/ScopeMetadataImpl/Zmq.ini.in	2013-12-03 14:09:20 +0000
@@ -0,0 +1,3 @@
+[Zmq]
+EndpointDir.Public = /tmp
+EndpointDir.Private = /tmp
 
=== modified file 'test/gtest/unity/api/scopes/internal/zmq_middleware/ObjectAdapter/Zmq.ini.in'
--- test/gtest/unity/api/scopes/internal/zmq_middleware/ObjectAdapter/Zmq.ini.in	2013-11-19 02:51:46 +0000
+++ test/gtest/unity/api/scopes/internal/zmq_middleware/ObjectAdapter/Zmq.ini.in	2013-12-03 14:09:20 +0000
@@ -1,2 +1,3 @@
 [Zmq]
 EndpointDir.Public = /tmp
+EndpointDir.Private = /tmp
 
=== modified file 'test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/CMakeLists.txt'
--- test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/CMakeLists.txt	2013-11-19 02:51:46 +0000
+++ test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/CMakeLists.txt	2013-12-03 14:09:20 +0000
@@ -1,4 +1,3 @@
-configure_file(Factory.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Factory.ini)
 configure_file(Registry.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Registry.ini)
 configure_file(Runtime.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Runtime.ini)
 configure_file(Zmq.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Zmq.ini)
 
=== removed file 'test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/Factory.ini.in'
--- test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/Factory.ini.in	2013-09-23 06:13:06 +0000
+++ test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/Factory.ini.in	1970-01-01 00:00:00 +0000
@@ -1,3 +0,0 @@
-[MiddlewareFactory]
-Zmq.Configfile = Zmq.ini
-REST.Configfile = REST.ini
 
=== modified file 'test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/RegistryI_test.cpp'
--- test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/RegistryI_test.cpp	2013-11-21 21:46:36 +0000
+++ test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/RegistryI_test.cpp	2013-12-03 14:09:20 +0000
@@ -20,6 +20,8 @@
 
 #include <scopes/internal/RegistryConfig.h>
 #include <scopes/internal/RuntimeImpl.h>
+#include <scopes/internal/ScopeMetadataImpl.h>
+#include <scopes/internal/ScopeImpl.h>
 #include <scopes/internal/UniqueID.h>
 #include <internal/zmq_middleware/capnproto/Message.capnp.h>
 #include <scopes/ScopeExceptions.h>
@@ -37,33 +39,48 @@
 using namespace unity::api::scopes::internal;
 using namespace unity::api::scopes::internal::zmq_middleware;
 
-TEST(RegistryI, find)
-{
-try
-{
-    RuntimeImpl::UPtr runtime = RuntimeImpl::create(
-        "Registry", TEST_BUILD_ROOT "/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/Runtime.ini");
-
-    string identity = runtime->registry_identity();
-    RegistryConfig c(identity, runtime->registry_configfile());
-    string mw_kind = c.mw_kind();
-    string mw_endpoint = c.endpoint();
-    string mw_configfile = c.mw_configfile();
-
-    MiddlewareBase::SPtr middleware = runtime->factory()->create(identity, mw_kind, mw_configfile);
-    RegistryObject::SPtr ro(make_shared<RegistryObject>());
-    auto registry = middleware->add_registry_object(identity, ro);
-    auto proxy = middleware->create_scope_proxy("scope1", "ipc:///tmp/scope1");
-    EXPECT_TRUE(ro->add("scope1", proxy));
-
-    auto r = runtime->registry();
-    auto scope = r->find("scope1");
-    EXPECT_TRUE(scope.get());
-}
-catch(unity::Exception const& e)
-{
-    cout << e.to_string() << endl;
-}
+ScopeMetadata make_meta(const string& name, MWScopeProxy const& proxy, MiddlewareBase::SPtr const& mw)
+{
+    unique_ptr<ScopeMetadataImpl> mi(new ScopeMetadataImpl(mw.get()));
+    mi->set_scope_name(name);
+    mi->set_art("art " + name);
+    mi->set_display_name("display name " + name);
+    mi->set_description("description " + name);
+    mi->set_search_hint("search hint " + name);
+    mi->set_hot_key("hot key " + name);
+    ScopeProxy p = ScopeImpl::create(proxy, mw->runtime());
+    mi->set_proxy(p);
+    return ScopeMetadataImpl::create(move(mi));
+}
+
+TEST(RegistryI, get_metadata)
+{
+    try
+    {
+        RuntimeImpl::UPtr runtime = RuntimeImpl::create(
+            "Registry", TEST_BUILD_ROOT "/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/Runtime.ini");
+
+        string identity = runtime->registry_identity();
+        RegistryConfig c(identity, runtime->registry_configfile());
+        string mw_kind = c.mw_kind();
+        string mw_endpoint = c.endpoint();
+        string mw_configfile = c.mw_configfile();
+
+        MiddlewareBase::SPtr middleware = runtime->factory()->create(identity, mw_kind, mw_configfile);
+        RegistryObject::SPtr ro(make_shared<RegistryObject>());
+        auto registry = middleware->add_registry_object(identity, ro);
+        auto p = middleware->create_scope_proxy("scope1", "ipc:///tmp/scope1");
+        EXPECT_TRUE(ro->add("scope1", move(make_meta("scope1", p, middleware))));
+
+        auto r = runtime->registry();
+        auto scope = r->get_metadata("scope1");
+        EXPECT_EQ("scope1", scope.scope_name());
+    }
+    catch (unity::Exception const& e)
+    {
+        cerr << e.to_string() << endl;
+        FAIL();
+    }
 }
 
 TEST(RegistryI, list)
@@ -86,7 +103,7 @@
     EXPECT_TRUE(scopes.empty());
 
     auto proxy = middleware->create_scope_proxy("scope1", "ipc:///tmp/scope1");
-    EXPECT_TRUE(ro->add("scope1", proxy));
+    EXPECT_TRUE(ro->add("scope1", move(make_meta("scope1", proxy, middleware))));
     scopes = r->list();
     EXPECT_EQ(1, scopes.size());
     EXPECT_NE(scopes.end(), scopes.find("scope1"));
@@ -96,14 +113,14 @@
     EXPECT_EQ(0, scopes.size());
 
     set<string> ids;
-    for (int i = 0; i < 1000; ++i)
+    for (int i = 0; i < 10; ++i)
     {
         string long_id = "0000000000000000000000000000000000000000000000" + to_string(i);
-        EXPECT_TRUE(ro->add(long_id, proxy));
+        EXPECT_TRUE(ro->add(long_id, move(make_meta(long_id, proxy, middleware))));
         ids.insert(long_id);
     }
     scopes = r->list();
-    EXPECT_EQ(1000, scopes.size());
+    EXPECT_EQ(10, scopes.size());
     for (auto& id : ids)
     {
         auto it = scopes.find(id);
@@ -132,11 +149,11 @@
     EXPECT_TRUE(scopes.empty());
 
     auto proxy = middleware->create_scope_proxy("scope1", "ipc:///tmp/scope1");
-    EXPECT_TRUE(ro->add("scope1", proxy));
+    EXPECT_TRUE(ro->add("scope1", move(make_meta("scope1", proxy, middleware))));
     scopes = r->list();
     EXPECT_EQ(1, scopes.size());
     EXPECT_NE(scopes.end(), scopes.find("scope1"));
-    EXPECT_FALSE(ro->add("scope1", proxy));
+    EXPECT_FALSE(ro->add("scope1", move(make_meta("scope1", proxy, middleware))));
 
     EXPECT_TRUE(ro->remove("scope1"));
     scopes = r->list();
@@ -144,14 +161,14 @@
     EXPECT_FALSE(ro->remove("scope1"));
 
     set<string> ids;
-    for (int i = 0; i < 1000; ++i)
+    for (int i = 0; i < 10; ++i)
     {
         string long_id = "0000000000000000000000000000000000000000000000" + to_string(i);
-        ro->add(long_id, proxy);
+        ro->add(long_id, move(make_meta(long_id, proxy, middleware)));
         ids.insert(long_id);
     }
     scopes = r->list();
-    EXPECT_EQ(1000, scopes.size());
+    EXPECT_EQ(10, scopes.size());
     for (auto& id : ids)
     {
         auto it = scopes.find(id);
@@ -175,24 +192,24 @@
     RegistryObject::SPtr ro(make_shared<RegistryObject>());
     auto registry = middleware->add_registry_object(identity, ro);
     auto proxy = middleware->create_scope_proxy("scope1", "ipc:///tmp/scope1");
-    ro->add("scope1", proxy);
+    ro->add("scope1", move(make_meta("scope1", proxy, middleware)));
 
     auto r = runtime->registry();
 
     try
     {
-        r->find("fred");
+        r->get_metadata("fred");
         FAIL();
     }
     catch (NotFoundException const& e)
     {
-        EXPECT_EQ("unity::api::scopes::NotFoundException: Registry::find(): no such scope (name = fred)",
+        EXPECT_EQ("unity::api::scopes::NotFoundException: Registry::get_metadata(): no such scope (name = fred)",
                   e.to_string());
     }
 
     try
     {
-        r->find("");
+        r->get_metadata("");
         FAIL();
     }
     catch (MiddlewareException const& e)
@@ -205,7 +222,7 @@
     try
     {
         auto proxy = middleware->create_scope_proxy("scope1", "ipc:///tmp/scope1");
-        ro->add("", proxy);
+        ro->add("", move(make_meta("blah", proxy, middleware)));
         FAIL();
     }
     catch (InvalidArgumentException const& e)
 
=== modified file 'test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/Zmq.ini.in'
--- test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/Zmq.ini.in	2013-11-19 21:12:39 +0000
+++ test/gtest/unity/api/scopes/internal/zmq_middleware/RegistryI/Zmq.ini.in	2013-12-03 14:09:20 +0000
@@ -1,2 +1,3 @@
 [Zmq]
 EndpointDir.Public = /tmp
+EndpointDir.Private = /tmp
 
=== modified file 'test/gtest/unity/api/scopes/internal/zmq_middleware/ServantBase/Zmq.ini.in'
--- test/gtest/unity/api/scopes/internal/zmq_middleware/ServantBase/Zmq.ini.in	2013-11-19 21:12:39 +0000
+++ test/gtest/unity/api/scopes/internal/zmq_middleware/ServantBase/Zmq.ini.in	2013-12-03 14:09:20 +0000
@@ -1,2 +1,3 @@
 [Zmq]
 EndpointDir.Public = /tmp
+EndpointDir.Private = /tmp
 
=== modified file 'test/gtest/unity/api/scopes/internal/zmq_middleware/ZmqMiddleware/Zmq.ini.in'
--- test/gtest/unity/api/scopes/internal/zmq_middleware/ZmqMiddleware/Zmq.ini.in	2013-11-19 21:12:39 +0000
+++ test/gtest/unity/api/scopes/internal/zmq_middleware/ZmqMiddleware/Zmq.ini.in	2013-12-03 14:09:20 +0000
@@ -1,2 +1,3 @@
 [Zmq]
 EndpointDir.Public = /tmp
+EndpointDir.Private = /tmp
 
=== modified file 'test/gtest/unity/api/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp'
--- test/gtest/unity/api/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp	2013-11-21 21:46:36 +0000
+++ test/gtest/unity/api/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp	2013-12-03 14:09:20 +0000
@@ -21,6 +21,7 @@
 #include <gtest/gtest.h>
 #include <scope-api-testconfig.h>
 
+using namespace std;
 using namespace unity::api::scopes::internal;
 using namespace unity::api::scopes::internal::zmq_middleware;