blob: 5ce06c495d97e77ebc8c2ee09b7b2bce76e7b1f4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<head>
<title>Apache Felix - Apache Felix User Admin - File Store</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
<div class="logo">
<a href="https://felix.apache.org/">
<img border="0" alt="Apache Felix" src="/res/logo.png">
</a>
</div>
<div class="header">
<a href="https://www.apache.org/">
<img border="0" alt="Apache" src="/res/apache.png">
</a>
</div>
</div>
<div class="menu">
<style type="text/css">
/* The following code is added by mdx_elementid.py
It was originally lifted from http://subversion.apache.org/style/site.css */
/*
* Hide class="elementid-permalink", except when an enclosing heading
* has the :hover property.
*/
.headerlink, .elementid-permalink {
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
<p><a href="/news.html">News</a> <br />
<a href="/license.html">License</a> <br />
<a href="/downloads.cgi">Downloads</a> <br />
<a href="/documentation.html">Documentation</a> <br />
<a href="/documentation/community/project-info.html">Project Info</a> <br />
<a href="/documentation/community/contributing.html">Contributing</a> <br />
<a href="/sitemap.html">Site Map</a> <br />
<a href="https://www.apache.org/">ASF</a> <br />
<a href="https://www.apache.org/security/">Security</a> <br />
<a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
<a href="https://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="https://www.apache.org/ads/button.html"
style="border-width:0; float: left"
frameborder="0"
scrolling="no"
width="135"
height="135">
</iframe>
</div>
<div class="main">
<div class="breadcrump" style="font-size: 80%;">
<a href="/">Home</a>&nbsp;&raquo&nbsp;<a href="/documentation.html">Documentation</a>&nbsp;&raquo&nbsp;<a href="/documentation/subprojects/apache-felix-user-admin.html">Apache Felix User Admin</a>
</div>
<h1>Apache Felix User Admin - File Store</h1>
<style type="text/css">
/* The following code is added by mdx_elementid.py
It was originally lifted from http://subversion.apache.org/style/site.css */
/*
* Hide class="elementid-permalink", except when an enclosing heading
* has the :hover property.
*/
.headerlink, .elementid-permalink {
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
<p>The Apache Felix User Admin file store provides a file-based store for use with the Felix UserAdmin service. It uses a binary file-format to persist the role information. This file will always be written in the data area of the bundle and be called "<code>ua_repo.dat</code>".</p>
<p>The file-based store service this bundle provides can be configured at runtime by using the service PID "<code>org.apache.felix.useradmin.filestore</code>". The configuration options recognized by this service are:</p>
<ul>
<li>"<code>background.write.disabled</code>"; by default, all changes made to the UserAdmin repository are flushed to disk. By setting this value to "<code>true</code>", this no longer will happen for each change, but only when the file-store service is stopped. This value is optional and defaults to "<code>false</code>";</li>
<li>"<code>background.write.delay.value</code>"; denotes the period after which the changes should be persisted to disk. If other changes to the repository occur during this period, the period will start over. This value is optional and defaults to "<code>500</code>";</li>
<li>"<code>background.write.delay.timeunit</code>"; denotes the time unit for "background.write.delay.value". This value is optional and defaults to "<code>milliseconds</code>". Possible values are: "<code>days</code>", "<code>hours</code>", "<code>minutes</code>", "<code>seconds</code>", "<code>milliseconds</code>", "<code>microseconds</code>" and "<code>nanoseconds</code>".</li>
</ul>
<p>Alternatively, one can also supply the above mentioned configuration keys prefixed with "<code>org.apache.felix.useradmin.filestore.</code>" as system properties. For example by adding <code>-Dorg.apache.felix.useradmin.filestore.background.write.disabled=true</code> to your JVM arguments will disable persisting the changes upon each change. However, using system properties will imply that only a single store can be configured on a system (which could be a sensible default for some situations)!</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
logo are trademarks of The Apache Software Foundation. All other marks mentioned
may be trademarks or registered trademarks of their respective owners.
</div>
</div>
</body>
</html>