82 lines
16 KiB
HTML
82 lines
16 KiB
HTML
<!doctype html><html lang=en class="js csstransforms3d"><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=generator content="Hugo 0.80.0"><meta name=description content="Strolch is a parameterized framework for use on servers and IoT"><meta name=author content="Strolch"><link rel=icon href=/favicon.ico type=image/ico><title>Realms - Strolch</title><link href=/css/nucleus.css?1626091328 rel=stylesheet><link href=/css/fontawesome-all.min.css?1626091328 rel=stylesheet><link href=/css/hybrid.css?1626091328 rel=stylesheet><link href=/css/featherlight.min.css?1626091328 rel=stylesheet><link href=/css/perfect-scrollbar.min.css?1626091328 rel=stylesheet><link href=/css/auto-complete.css?1626091328 rel=stylesheet><link href=/css/atom-one-dark-reasonable.css?1626091328 rel=stylesheet><link href=/css/theme.css?1626091328 rel=stylesheet><link href=/css/hugo-theme.css?1626091328 rel=stylesheet><link href=/css/theme-green.css?1626091328 rel=stylesheet><script src=/js/jquery-3.3.1.min.js?1626091328></script><style>:root #header+#content>#left>#rlblock_left{display:none!important}</style></head><body data-url=/documentation/realms/><nav id=sidebar><div id=header-wrapper><div id=header><a id=logo href=/><img src=/logo.png></a></div><div class=searchbox><label for=search-by><i class="fas fa-search"></i></label><input data-search-input id=search-by type=search placeholder=Search...>
|
|
<span data-search-clear><i class="fas fa-times"></i></span></div><script type=text/javascript src=/js/lunr.min.js?1626091328></script><script type=text/javascript src=/js/auto-complete.js?1626091328></script><script type=text/javascript>var baseurl="https:\/\/strolch.li\/";</script><script type=text/javascript src=/js/search.js?1626091328></script></div><section id=homelinks><ul><li><a class=padding href=/><i class="fas fa-home"></i>Home</a></li></ul></section><div class=highlightable><ul class=topics><li data-nav-id=/api/ title=API class=dd-item><a href=/api/>API</a></li><li data-nav-id=/history/ title=History class=dd-item><a href=/history/>History</a></li><li data-nav-id=/documentation/ title=Documentation class="dd-item
|
|
parent"><a href=/documentation/>Documentation</a><ul><li data-nav-id=/documentation/architecture/ title=Architecture class=dd-item><a href=/documentation/architecture/>Architecture</a></li><li data-nav-id=/documentation/model/ title=Model class=dd-item><a href=/documentation/model/>Model</a></li><li data-nav-id=/documentation/do-and-donts/ title="Do and Don't" class=dd-item><a href=/documentation/do-and-donts/>Do and Don't</a></li><li data-nav-id=/documentation/runtime-configuration/ title="Runtime Configuration" class=dd-item><a href=/documentation/runtime-configuration/>Runtime Configuration</a></li><li data-nav-id=/documentation/realms/ title=Realms class="dd-item active"><a href=/documentation/realms/>Realms</a></li><li data-nav-id=/documentation/components/ title=Components class=dd-item><a href=/documentation/components/>Components</a></li><li data-nav-id=/documentation/services-and-commands/ title="Services and Commands" class=dd-item><a href=/documentation/services-and-commands/>Services and Commands</a></li><li data-nav-id=/documentation/searches/ title=Searches class=dd-item><a href=/documentation/searches/>Searches</a></li><li data-nav-id=/documentation/queries/ title=Queries class=dd-item><a href=/documentation/queries/>Queries</a></li><li data-nav-id=/documentation/transactions/ title=Transactions class=dd-item><a href=/documentation/transactions/>Transactions</a></li><li data-nav-id=/documentation/policies/ title=Policies class=dd-item><a href=/documentation/policies/>Policies</a></li><li data-nav-id=/documentation/observers/ title=Observers class=dd-item><a href=/documentation/observers/>Observers</a></li><li data-nav-id=/documentation/versioning/ title=Versioning class=dd-item><a href=/documentation/versioning/>Versioning</a></li><li data-nav-id=/documentation/reports/ title=Reports class=dd-item><a href=/documentation/reports/>Reports</a></li><li data-nav-id=/documentation/priviles/ title=Privileges class=dd-item><a href=/documentation/priviles/>Privileges</a></li></ul></li><li data-nav-id=/plc/ title=PLC class=dd-item><a href=/plc/>PLC</a><ul><li data-nav-id=/plc/architecture/ title=Architecture class=dd-item><a href=/plc/architecture/>Architecture</a></li><li data-nav-id=/plc/example-set-up/ title="Example Set-Up" class=dd-item><a href=/plc/example-set-up/>Example Set-Up</a></li></ul></li><li data-nav-id=/tutorial/ title=Tutorial class=dd-item><a href=/tutorial/>Tutorial</a><ul><li data-nav-id=/tutorial/configuration/ title=Configuration class=dd-item><a href=/tutorial/configuration/>Configuration</a></li><li data-nav-id=/tutorial/model/ title=Model class=dd-item><a href=/tutorial/model/>Model</a></li><li data-nav-id=/tutorial/crud-book/ title="CRUD Book" class=dd-item><a href=/tutorial/crud-book/>CRUD Book</a></li></ul></li><li data-nav-id=/download/ title=Download class=dd-item><a href=/download/>Download</a></li><li data-nav-id=/development/ title=Development class=dd-item><a href=/development/>Development</a></li></ul><section id=shortcuts><h3>More</h3><ul><li><a class=padding href=https://strolch.li/tags><i class="fas fa-tags"></i>Tags</a></li><li><a class=padding href=https://github.com/strolch-li><i class="fab fa-github"></i>GitHub project</a></li></ul></section><section id=footer><p>Built with <a href=https://github.com/matcornic/hugo-theme-learn><i class="fas fa-heart"></i></a>from <a href=https://getgrav.org>Grav</a> and <a href=https://gohugo.io/>Hugo</a></p></section></div></nav><section id=body><div id=overlay></div><div class="padding highlightable"><div><div id=top-bar><div id=top-github-link><a class=github-link title="Edit this page" href=https://github.com/Pi4J/pi4j.github.io/tree/main/contentdocumentation/realms.md target=blank><i class="fas fa-code-branch"></i><span id=top-github-link-text>Edit this page</span></a></div><div id=breadcrumbs itemscope itemtype=http://data-vocabulary.org/Breadcrumb><span id=sidebar-toggle-span><a href=# id=sidebar-toggle data-sidebar-toggle><i class="fas fa-bars"></i></a></span><span id=toc-menu><i class="fas fa-list-alt"></i></span><span class=links><a href=/>Strolch Overview</a> > <a href=/documentation/>Documentation</a> > Realms</span></div><div class=progress><div class=wrapper><nav id=TableOfContents><ul><li><a href=#realms>Realms</a></li><li><a href=#multi-realm>Multi-Realm</a></li><li><a href=#access-realm>Access realm</a></li></ul></nav></div></div></div></div><div id=head-tags></div><div id=body-inner><h1>Realms</h1><h2 id=realms>Realms</h2><p>Realms implement multi-tenant capabilities. A Strolch agent can have an
|
|
arbitrary number of realms configured and each realm has its own persistence
|
|
configuration, allowing to separate mandates completely.</p><p>A realm can run in one of the following modes:</p><ul><li>EMPTY
|
|
This is a transient data store mode, where no model changes are
|
|
persisted - they are only kept in memory. When the Strolch agent is
|
|
started, this realm is empty as no data is loaded.</li><li>TRANSIENT
|
|
This is the same as EMPTY, but with the difference that when the Strolch
|
|
agent is started, a model file is parsed and the in-memory realm is
|
|
populated with the elements parsed from the model file.</li><li>CACHED
|
|
In this mode, all data is stored in-memory, and any changes made are
|
|
written back to the persistence layer. This allows for fast in-memory
|
|
qeuries, but makes sure no data is lost when the agent is restarted.</li></ul><p>Realms are mostly hidden from a developer as a <code>StrolchTransaction</code> exposes
|
|
all important operations needed to access Strolch objects. A developer will
|
|
however need to configure the realms for their specific project. If the
|
|
project only requires one realm, then the <code>defaultRealm</code> can be used, where the
|
|
developer only is required to configure the mode and any relevant model file.</p><p>If the mode is <code>CACHED</code>, then the <code>PersistenceHandler</code> component is required to be
|
|
configured, so that the DAOs know how to access the underlying database.</p><p>The configuration in the <code>StrolchConfiguration.xml</code> file is as follows:</p><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=color:#f92672><StrolchConfiguration></span>
|
|
<span style=color:#f92672><env</span> <span style=color:#a6e22e>id=</span><span style=color:#e6db74>"dev"</span><span style=color:#f92672>></span>
|
|
...
|
|
<span style=color:#f92672><Component></span>
|
|
<span style=color:#f92672><name></span>RealmHandler<span style=color:#f92672></name></span>
|
|
<span style=color:#f92672><api></span>li.strolch.agent.api.RealmHandler<span style=color:#f92672></api></span>
|
|
<span style=color:#f92672><impl></span>li.strolch.agent.impl.DefaultRealmHandler<span style=color:#f92672></impl></span>
|
|
<span style=color:#f92672><depends></span>PrivilegeHandler<span style=color:#f92672></depends></span>
|
|
<span style=color:#75715e><!-- if CACHED: --></span>
|
|
<span style=color:#75715e><!--depends>PersistenceHandler</depends--></span>
|
|
<span style=color:#f92672><Properties></span>
|
|
<span style=color:#f92672><dataStoreMode></span>EMPTY|TRANSIENT|CACHED<span style=color:#f92672></dataStoreMode></span>
|
|
<span style=color:#f92672><dataStoreFile></span>StrolchModel.xml<span style=color:#f92672></dataStoreFile></span>
|
|
<span style=color:#f92672></Properties></span>
|
|
<span style=color:#f92672></Component></span>
|
|
...
|
|
<span style=color:#f92672></env></span>
|
|
<span style=color:#f92672></StrolchConfiguration></span>
|
|
</code></pre></div><h2 id=multi-realm>Multi-Realm</h2><p>A multi-realm configuration would be as follows.</p><div class="notices tip"><p>Note how the defaultRealm is still enabled, and has its configuration as
|
|
before. Further the PostgreSQL PersistenceHandler is configured to show how the
|
|
realms are connected to the persistence handler:</p></div><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=color:#f92672><StrolchConfiguration></span>
|
|
<span style=color:#f92672><env</span> <span style=color:#a6e22e>id=</span><span style=color:#e6db74>"dev"</span><span style=color:#f92672>></span>
|
|
...
|
|
<span style=color:#f92672><Component></span>
|
|
<span style=color:#f92672><name></span>RealmHandler<span style=color:#f92672></name></span>
|
|
<span style=color:#f92672><api></span>li.strolch.agent.api.RealmHandler<span style=color:#f92672></api></span>
|
|
<span style=color:#f92672><impl></span>li.strolch.agent.impl.DefaultRealmHandler<span style=color:#f92672></impl></span>
|
|
<span style=color:#f92672><depends></span>PrivilegeHandler<span style=color:#f92672></depends></span>
|
|
<span style=color:#f92672><depends></span>PersistenceHandler<span style=color:#f92672></depends></span>
|
|
<span style=color:#f92672><Properties></span>
|
|
<span style=color:#f92672><realms></span>defaultRealm, cachedRealm<span style=color:#f92672></realms></span>
|
|
<span style=color:#f92672><dataStoreMode></span>TRANSIENT<span style=color:#f92672></dataStoreMode></span>
|
|
<span style=color:#f92672><dataStoreFile></span>DefaultRealm.xml<span style=color:#f92672></dataStoreFile></span>
|
|
<span style=color:#f92672><dataStoreMode.cachedRealm></span>CACHED<span style=color:#f92672></dataStoreMode.cachedRealm></span>
|
|
<span style=color:#f92672><dataStoreMode.emptyRealm></span>EMPTY<span style=color:#f92672></dataStoreMode.emptyRealm></span>
|
|
<span style=color:#f92672></Properties></span>
|
|
<span style=color:#f92672></Component></span>
|
|
|
|
<span style=color:#f92672><Component></span>
|
|
<span style=color:#f92672><name></span>PersistenceHandler<span style=color:#f92672></name></span>
|
|
<span style=color:#f92672><api></span>li.strolch.persistence.api.PersistenceHandler<span style=color:#f92672></api></span>
|
|
<span style=color:#f92672><impl></span>li.strolch.persistence.postgresql.PostgreSqlPersistenceHandler<span style=color:#f92672></impl></span>
|
|
<span style=color:#f92672><Properties></span>
|
|
<span style=color:#f92672><allowSchemaCreation></span>true<span style=color:#f92672></allowSchemaCreation></span>
|
|
<span style=color:#f92672><allowSchemaDrop></span>true<span style=color:#f92672></allowSchemaDrop></span>
|
|
|
|
<span style=color:#f92672><db.url.cachedRealm></span>jdbc:postgresql://localhost/testdb2<span style=color:#f92672></db.url.cachedRealm></span>
|
|
<span style=color:#f92672><db.username.cachedRealm></span>testuser2<span style=color:#f92672></db.username.cachedRealm></span>
|
|
<span style=color:#f92672><db.password.cachedRealm></span>test<span style=color:#f92672></db.password.cachedRealm></span>
|
|
<span style=color:#f92672><db.pool.maximumPoolSize.cachedRealm></span>1<span style=color:#f92672></db.pool.maximumPoolSize.cachedRealm></span>
|
|
<span style=color:#f92672></Properties></span>
|
|
<span style=color:#f92672></Component></span>
|
|
...
|
|
<span style=color:#f92672></env></span>
|
|
<span style=color:#f92672></StrolchConfiguration></span>
|
|
</code></pre></div><h2 id=access-realm>Access realm</h2><p>Accessing a realm is done in multiple ways. Important is to note, that a user
|
|
should use the <code>StrolchTransaction</code> object, instead of accessing the Realm directly.</p><p>Opening a transaction is done from a <code>Service</code> by calling one of the
|
|
<code>openTx()</code>-methods. Nevertheless, the realm can be accessed as follows:</p><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java>ComponentContainer container <span style=color:#f92672>=</span> getAgent<span style=color:#f92672>().</span><span style=color:#a6e22e>getContainer</span><span style=color:#f92672>();</span>
|
|
StrolchRealm realm <span style=color:#f92672>=</span> container<span style=color:#f92672>.</span><span style=color:#a6e22e>getRealm</span><span style=color:#f92672>(</span>StrolchConstants<span style=color:#f92672>.</span><span style=color:#a6e22e>DEFAULT_REALM</span><span style=color:#f92672>);</span>
|
|
<span style=color:#66d9ef>try</span><span style=color:#f92672>(</span>StrolchTransaction tx <span style=color:#f92672>=</span> realm<span style=color:#f92672>.</span><span style=color:#a6e22e>openTx</span><span style=color:#f92672>())</span> <span style=color:#f92672>{</span>
|
|
Resource resource <span style=color:#f92672>=</span> tx<span style=color:#f92672>.</span><span style=color:#a6e22e>getResourceBy</span><span style=color:#f92672>(</span><span style=color:#e6db74>"TestType"</span><span style=color:#f92672>,</span> <span style=color:#e6db74>"MyTestResource"</span><span style=color:#f92672>);</span>
|
|
<span style=color:#f92672>...</span>
|
|
<span style=color:#f92672>}</span>
|
|
</code></pre></div><footer class=footline></footer></div></div><div id=navigation><a class="nav nav-prev" href=/documentation/runtime-configuration/ title="Runtime Configuration"><i class="fa fa-chevron-left"></i></a><a class="nav nav-next" href=/documentation/components/ title=Components style=margin-right:0><i class="fa fa-chevron-right"></i></a></div></section><div style=left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px><div style=border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px></div></div><script src=/js/clipboard.min.js?1626091328></script><script src=/js/perfect-scrollbar.min.js?1626091328></script><script src=/js/perfect-scrollbar.jquery.min.js?1626091328></script><script src=/js/jquery.sticky.js?1626091328></script><script src=/js/featherlight.min.js?1626091328></script><script src=/js/highlight.pack.js?1626091328></script><script>hljs.initHighlightingOnLoad();</script><script src=/js/modernizr.custom-3.6.0.js?1626091328></script><script src=/js/learn.js?1626091328></script><script src=/js/hugo-learn.js?1626091328></script><script src=/mermaid/mermaid.js?1626091328></script><script>mermaid.initialize({startOnLoad:true});</script></body></html> |