| Jan Willem Janssen | e66cedb | 2012-11-30 12:36:31 +0000 | [diff] [blame] | 1 | Apache Felix User Admin File-based store |
| 2 | Copyright 2012 The Apache Software Foundation |
| 3 | |
| 4 | This bundle provides a file-based store for use with the Felix UserAdmin |
| 5 | service. It uses a binary file-format to persist the role information. This |
| 6 | file will always be written in the data area of the bundle and be called |
| 7 | "ua_repo.dat". |
| 8 | |
| 9 | The file-based store service this bundle provides can be configured at |
| 10 | runtime by using the service PID "org.apache.felix.useradmin.filestore". The |
| 11 | configuration options recognized by this service are: |
| 12 | |
| 13 | "background.write.disabled" |
| 14 | by default, all changes made to the UserAdmin repository are flushed to |
| 15 | disk. By setting this value to "false", this no longer will happen for each |
| 16 | change, but only upon stopping of the service. This value is optional and |
| 17 | defaults to "false"; |
| 18 | "background.write.delay.value" |
| 19 | denotes the period after which the changes should be persisted to disk. If |
| 20 | other changes to the repository occur during this period, the period will |
| 21 | start over. This value is optional and defaults to "500"; |
| 22 | "background.write.delay.timeunit" |
| 23 | denotes the time unit for "background.write.delay.value". This value is |
| 24 | optional and defaults to "milliseconds". Possible values are: "days", |
| 25 | "hours", "minutes", "seconds", "milliseconds", "microseconds" and |
| 26 | "nanoseconds". |
| 27 | |
| 28 | Alternatively, one can also supply the above mentioned configuration keys |
| 29 | prefixed with "org.apache.felix.useradmin.filestore." as system properties. |
| 30 | For example by adding the following to your JVM arguments: |
| 31 | |
| 32 | -Dorg.apache.felix.useradmin.filestore.background.write.disabled=true |
| 33 | |
| 34 | will disable persisting the changes on each change of the UserAdmin roles. |
| 35 | |
| 36 | However, using system properties will imply that only a single store can be |
| 37 | configured on a system (which could be a sensible default for some |
| 38 | situations)! |