Apache Entityhub
The Entityhub is the Stanbol component responsible for providing the information about Entities relevant to the users domain. The following figure tries to provide an overview about the features of the Entityhub.
The main Features are the:
- Entityhub (
/entityhub
): Allows to manage local entities as well as import entities from Sites or to define mappings from local Entities to Entities managed by Sites. An Apache Stanbol instance can only have a single Entityhub so if you want to manage multiple controlled vocabularies you should preferable use ManagedSite instead. - Site Manager (
/entityhub/sites
): The SiteManager provides a unified access to all currently active Sites - your Entity Network. Requests sent to this endpoint will be forwarded to all currently active Sites. Users should note that queries (requests to the/entityhub/sites/find
and/entityhub/sites/query
endpoints) might be slow as remote services might need to be called for answering those requests. Retrieval of Entities (requests to the/entityhub/sites/entity
endpoint) and also LDpath requests should perform reasonable well. - Sites (
/entityhub/site/{siteId}
): Sites represent entity sources that are integrated with the Stanbol Entityhub. There are two different types of Sites- ReferencedSite: This site allows to refer remote services to dereference (Entity id based retrieval) and query entities. It also supports local caches and indexes. A local cache allows to locally store retrieved Entity data to speed-up retrieval on subsequent requests. A local index is a locally available index over all/some of the data of the remote dataset. If such an index is available all requests will be processed using the index. The remote services are only used as a fallback. Local Indexes are created by the Entityhub Indexing tool. The usage scenario Working with Custom Vocabularies provides a good overview on how to use this feature.
- ManagedSite: ManagedSites allow users to manage their own entity by using the RESTful API of the Entityhub. They are very similar to the
/entityhub
endpoint but do not allow to manage mappings are to import Entities from other Sites.
RESTful services
The documentation of the RESTful services provided by the Stanbol Entityhub is served by the Web UI of your Stanbol instance. If you do not have a running Stanbol server this introduction provides you with all necessary information. You can also try to access the documentation on the Stanbol demo server available on the IKS development server at http://dev.iks-project.eu:8081/entityhub.