From do-not-reply at jboss.org Thu Feb 18 08:26:14 2010 Content-Type: multipart/mixed; boundary="===============8232167730966820636==" MIME-Version: 1.0 From: do-not-reply at jboss.org To: exo-jcr-commits at lists.jboss.org Subject: [exo-jcr-commits] exo-jcr SVN: r1899 - in jcr/trunk/docs/reference/en/src/main/docbook/en-US: modules and 1 other directory. Date: Thu, 18 Feb 2010 08:26:14 -0500 Message-ID: <201002181326.o1IDQE64022826@svn01.web.mwc.hst.phx2.redhat.com> --===============8232167730966820636== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: sergiykarpenko Date: 2010-02-18 08:26:13 -0500 (Thu, 18 Feb 2010) New Revision: 1899 Added: jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/jdbc-data-con= tainer-config.xml Modified: jcr/trunk/docs/reference/en/src/main/docbook/en-US/master.xml jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/configuration= .xml jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/external-valu= e-storages.xml jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/search-config= uration.xml Log: EXOJCR-490: jdbc-data-container-config.xml added links updated Modified: jcr/trunk/docs/reference/en/src/main/docbook/en-US/master.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- jcr/trunk/docs/reference/en/src/main/docbook/en-US/master.xml 2010-02-1= 8 13:25:20 UTC (rev 1898) +++ jcr/trunk/docs/reference/en/src/main/docbook/en-US/master.xml 2010-02-1= 8 13:26:13 UTC (rev 1899) @@ -75,6 +75,9 @@ = + + = Modified: jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/config= uration.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/configuratio= n.xml 2010-02-18 13:25:20 UTC (rev 1898) +++ jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/configuratio= n.xml 2010-02-18 13:26:13 UTC (rev 1899) @@ -1,435 +1,436 @@ - - - - - - eXo JCR configuration - -
- Related documents - - - - - - Search Configuration - - - - JDBC Data Container config - - - - External Value Storages - - -
- -
- Portal and Standalone configuration - - Like other eXo services eXo JCR can be configured and used in po= rtal - or embedded mode (as a service embedded in eXo Portal) and in standalo= ne - mode. - - In Embedded mode, JCR services are registered in the Portal - container and the second option is to use a Standalone container. The = main - difference between these container types is that the first one is inte= nded - to be used in a Portal (Web) environment, while the second one can be = used - standalone (TODO see the comprehensive page Service Configuration for - Beginners for more details). - - The following setup procedure is used to obtain a Standalone - configuration (TODO find more in Container configuration): - - - - Configuration that is set explicitly using - StandaloneContainer.addConfigurationURL(String url) or - StandaloneContainer.addConfigurationPath(String path) before - getInstance() - - - - Configuration from $base:directory/exo-configuration.xml or - $base:directory/conf/exo-configuration.xml file. Where $base:direc= tory - is either AS's home directory in case of J2EE AS environment or ju= st - the current directory in case of a standalone application. - - - - /conf/exo-configuration.xml in the current classloader (e.g. - war, ear archive) - - - - Configuration from - $service_jar_file/conf/portal/configuration.xml. WARNING: do not r= ely - on some concrete jar's configuration if you have more than one jar - containing conf/portal/configuration.xml file. In this case choosi= ng a - configuration is unpredictable. - - - - JCR service configuration looks like: - - <component> - <key>org.exoplatform.services.jcr.RepositoryService</key> - <type>org.exoplatform.services.jcr.impl.RepositoryServiceImpl<= ;/type> - </component> - <component> - <key>org.exoplatform.services.jcr.config.RepositoryServiceConfig= uration</key> - <type>org.exoplatform.services.jcr.impl.config.RepositoryService= ConfigurationImpl</type> - <init-params> - <value-param> - <name>conf-path</name> - <description>JCR repositories configuration file</descrip= tion> - <value>jar:/conf/standalone/exo-jcr-config.xml</value> - </value-param> - <properties-param> - <name>working-conf</name> - <description>working-conf</description> - <property name=3D"source-name" value=3D"jdbcjcr" /> - <property name=3D"dialect" value=3D"hsqldb" /> - <property name=3D"persister-class-name" value=3D"org.exoplatfor= m.services.jcr.impl.config.JDBCConfigurationPersister" /> - </properties-param> - </init-params> - </component> - - conf-path : a path to a RepositoryService JCR Configuration - - working-conf : optional; JCR configuration persister configurati= on. - If there isn't a working-conf the persister will be disabled - -
- JCR Configuration - - The Configuration is defined in an XML file (see DTD - below). - - JCR Service can use multiple Repositories and each repository = can - have multiple Workspaces. - - Repositories configuration parameters support human-readable - formats of values. They are all case-insensitive: - - - - Numbers formats: K,KB - kilobytes, M,MB - megabytes, G,GB - - gigabytes, T,TB - terabytes. - - Examples: 100.5 - digit 100.5, 200k - 200 Kbytes, 4m - 4 - Mbytes, 1.4G - 1.4 Gbytes, 10T - 10 Tbytes - - - - Time format endings: ms - milliseconds, s - seconds, m - - minutes, h - hours, d - days, w - weeks, if no ending - - seconds. - - Examples: 500ms - 500 milliseconds, 20 or 20s - 20 seconds, - 30m - 30 minutes, 12h - 12 hours, 5d - 5 days, 4w - 4 weeks. - - - - -
- -
- Repository service configuration - - Default configuration of the Repository Service located in - jar:/conf/portal/exo-jcr-config.xml, it will be available for portal= and - standalone modes. - - In portal mode it is overriden and located in the portal web - application portal/WEB-INF/conf/jcr/repository-configuration.xml. - - Example of Repository Service configuration for standalone - mode: - - <repository-service default-repository=3D"reposit= ory"> - <repositories> - <repository name=3D"db1" system-workspace=3D"ws" default-workspac= e=3D"ws"> - <security-domain>exo-domain</security-domain> - <access-control>optional</access-control> - <session-max-age>1h</session-max-age> - <authentication-policy>org.exoplatform.services.jcr.impl.co= re.access.JAASAuthenticator</authentication-policy> - <workspaces> - <workspace name=3D"production"> - <!-- for system storage --> - <container class=3D"org.exoplatform.services.jcr.impl.st= orage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"> - <properties> - <property name=3D"source-name" value=3D"jdbcjcr" /= > - <property name=3D"multi-db" value=3D"false" /> - <property name=3D"update-storage" value=3D"false" = /> - <property name=3D"max-buffer-size" value=3D"200k" = /> - <property name=3D"swap-directory" value=3D"../temp= /swap/production" /> - </properties> - <value-storages> - <value-storage id=3D"system" class=3D"org.exoplatf= orm.services.jcr.impl.storage.value.fs.TreeFileValueStorage"> - <properties> - <property name=3D"path" value=3D"../temp/val= ues/production" /> - </properties> - <filters> - <filter property-type=3D"Binary" /> - </filters> - </value-storage> - </value-storages> - </container> - <initializer class=3D"org.exoplatform.services.jcr.impl.= core.ScratchWorkspaceInitializer"> - <properties> - <property name=3D"root-nodetype" value=3D"nt:unstr= uctured" /> - </properties> - </initializer> - <cache enabled=3D"true" class=3D"org.exoplatform.service= s.jcr.impl.dataflow.persistent.LinkedWorkspaceStorageCacheImpl"> - <properties> - <property name=3D"max-size" value=3D"10k" /> - <property name=3D"live-time" value=3D"1h" /> - </properties> - </cache> - <query-handler class=3D"org.exoplatform.services.jcr.imp= l.core.query.lucene.SearchIndex"> - <properties> - <property name=3D"index-dir" value=3D"../temp/jcrl= ucenedb/production" /> - </properties> - </query-handler> - <lock-manager> - <time-out>15m</time-out> - <persister class=3D"org.exoplatform.services.jcr.impl= .core.lock.FileSystemLockPersister"> - <properties> - <property name=3D"path" value=3D"../temp/lock/s= ystem" /> - </properties> - </persister> - </lock-manager> - </workspace> - - <workspace name=3D"backup"> - <container class=3D"org.exoplatform.services.jcr.impl.st= orage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"> - <properties> - <property name=3D"source-name" value=3D"jdbcjcr" /= > - <property name=3D"multi-db" value=3D"false" /> - <property name=3D"update-storage" value=3D"false" = /> - <property name=3D"max-buffer-size" value=3D"200k" = /> - <property name=3D"swap-directory" value=3D"../temp= /swap/backup" /> - </properties> - <value-storages> - <value-storage id=3D"draft" class=3D"org.exoplatfo= rm.services.jcr.impl.storage.value.fs.TreeFileValueStorage"> - <properties> - <property name=3D"path" value=3D"../temp/val= ues/backup" /> - </properties> - <filters> - <filter property-type=3D"Binary" /> - </filters> - </value-storage> - </value-storages> - </container> - <initializer class=3D"org.exoplatform.services.jcr.impl.= core.ScratchWorkspaceInitializer"> - <properties> - <property name=3D"root-nodetype" value=3D"nt:unstr= uctured" /> - </properties> - </initializer> - <cache enabled=3D"true" class=3D"org.exoplatform.service= s.jcr.impl.dataflow.persistent.LinkedWorkspaceStorageCacheImpl"> - <properties> - <property name=3D"max-size" value=3D"10k" /> - <property name=3D"live-time" value=3D"1h" /> - </properties> - </cache> - <query-handler class=3D"org.exoplatform.services.jcr.imp= l.core.query.lucene.SearchIndex"> - <properties> - <property name=3D"index-dir" value=3D"../temp/jcrl= ucenedb/backup" /> - </properties> - </query-handler> - </workspace> - </workspaces> - </repository> - </repositories> -</repository-service> - - - Repository Service configuration: - - default-repository - the name of a default repository (one - returned by RepositoryService.getRepository()) - - repositories - the list of repositories - - Repository configuration: - - name - the name of a repository - - default-workspace - the name of a workspace obtained using - Session's login() or login(Credentials) methods (ones without an - explicit workspace name) - - system-workspace - name of workspace where /jcr:system node is - placed - - security-domain - the name of a security domain for JAAS - authentication - - access-control - the name of an access control policy. There c= an - be 3 types: optional - ACL is created on-demand(default), disable - = no - access control, mandatory - an ACL is created for each added node(not - supported yet) - - authentication-policy - the name of an authentication policy - class - - workspaces - the list of workspaces - - session-max-age - the time after which an idle session will be - removed (called logout). If not set, the idle session will never be - removed. - - Workspace configuration: - - name - the name of a workspace - - auto-init-root-nodetype - DEPRECATED in JCR 1.9 (use initializ= er). - The node type for root node initialization - - container - workspace data container (physical storage) - configuration - - initializer - workspace initializer configuration - - cache - workspace storage cache configuration - - query-handler - query handler configuration - - Workspace data container configuration: - - class - A workspace data container class name - - properties - the list of properties (name-value pairs) for the - concrete Workspace data container - - value-storages - the list of value storage plugins - - Value Storage plugin configuration (optional feature): - - - The value-storage element is optional. If you don't include = it, - the values will be stored as BLOBs inside the database. - - - value-storage - Optional value Storage plugin definition - - class- a value storage plugin class name (attribute) - - properties - the list of properties (name-value pairs) for a - concrete Value Storage plugin - - filters - the list of filters defining conditions when this pl= ugin - is applicable - - Initializer configuration (optional): - - class - initializer implementation class. - - properties - the list of properties (name-value pairs). Proper= ties - are supported: - - root-nodetype - The node type for root node initialization - - root-permissions - Default permissions of the root node. It is - defined as a set of semicolon-delimited permissions containing a gro= up - of space-delimited identities (user, group etc, see Organization ser= vice - documentation for details) and the type of permission. For example a= ny - read;:/admin read;:/admin add_node;:/admin set_property;:/admin remo= ve - means that users from group admin have all permissions and other use= rs - have only a 'read' permission. - - Configurable initializer adds a capability to override workspa= ce - initial startup procedure. - - Cache configuration: - - enabled - if workspace cache is enabled - - class - cache implementation class, optional from 1.9. Default - value is - org.exoplatform.services.jcr.impl.dataflow.persistent.LinkedWorkspac= eStorageCacheImpl. - - Cache can be configured to use concrete implementation of - WorkspaceStorageCache interface. JCR core has two implementation to = use: - * LinkedWorkspaceStorageCacheImpl - default, with configurable read - behavior and statistic. * WorkspaceStorageCacheImpl - pre 1.9, still= can - be used. - - properties - the list of properties (name-value pairs) for - Workspace cache: - - max-size - cache maximum size. - - live-time - cached item live time. - - LinkedWorkspaceStorageCacheImpl supports additional optional - parameters TODO - - Query Handler configuration: - - class - A Query Handler class name - - properties - the list of properties (name-value pairs) for a Q= uery - Handler (indexDir) properties and advanced features described in *Se= arch - Configuration* - - Lock Manager configuration: - - time-out - time after which the unused global lock will be - removed. - - persister - a class for storing lock information for future us= e. - For example, remove lock after jcr restart. - - path - a lock folder, each workspace has its own. - - - - Configuration definition: - - <!ELEMENT repository-service (repositories)> - <!ATTLIST repository-service default-repository NMTOKEN #REQUIRED> - <!ELEMENT repositories (repository)> - <!ELEMENT repository (security-domain,access-control,session-max-age,= authentication-policy,workspaces)> - <!ATTLIST repository - default-workspace NMTOKEN #REQUIRED - name NMTOKEN #REQUIRED - system-workspace NMTOKEN #REQUIRED - > - <!ELEMENT security-domain (#PCDATA)> - <!ELEMENT access-control (#PCDATA)> - <!ELEMENT session-max-age (#PCDATA)> - <!ELEMENT authentication-policy (#PCDATA)> - <!ELEMENT workspaces (workspace+)> - <!ELEMENT workspace (container,initializer,cache,query-handler)> - <!ATTLIST workspace name NMTOKEN #REQUIRED> - <!ELEMENT container (properties,value-storages)> - <!ATTLIST container class NMTOKEN #REQUIRED> - <!ELEMENT value-storages (value-storage+)> - <!ELEMENT value-storage (properties,filters)> - <!ATTLIST value-storage class NMTOKEN #REQUIRED> - <!ELEMENT filters (filter+)> - <!ELEMENT filter EMPTY> - <!ATTLIST filter property-type NMTOKEN #REQUIRED> - <!ELEMENT initializer (properties)> - <!ATTLIST initializer class NMTOKEN #REQUIRED> - <!ELEMENT cache (properties)> - <!ATTLIST cache = - enabled NMTOKEN #REQUIRED - class NMTOKEN #REQUIRED - > - <!ELEMENT query-handler (properties)> - <!ATTLIST query-handler class NMTOKEN #REQUIRED> - <!ELEMENT access-manager (properties)> - <!ATTLIST access-manager class NMTOKEN #REQUIRED> - <!ELEMENT lock-manager (time-out,persister)> - <!ELEMENT time-out (#PCDATA)> - <!ELEMENT persister (properties)> - <!ELEMENT properties (property+)> - <!ELEMENT property EMPTY> -
-
- + + + + + + eXo JCR configuration + +
+ Related documents + + + + Search + Configuration + + + + JDBC Data Container + config + + + + External Value + Storages + + +
+ +
+ Portal and Standalone configuration + + Like other eXo services eXo JCR can be configured and used in po= rtal + or embedded mode (as a service embedded in eXo Portal) and in standalo= ne + mode. + + In Embedded mode, JCR services are registered in the Portal + container and the second option is to use a Standalone container. The = main + difference between these container types is that the first one is inte= nded + to be used in a Portal (Web) environment, while the second one can be = used + standalone (TODO see the comprehensive page Service Configuration for + Beginners for more details). + + The following setup procedure is used to obtain a Standalone + configuration (TODO find more in Container configuration): + + + + Configuration that is set explicitly using + StandaloneContainer.addConfigurationURL(String url) or + StandaloneContainer.addConfigurationPath(String path) before + getInstance() + + + + Configuration from $base:directory/exo-configuration.xml or + $base:directory/conf/exo-configuration.xml file. Where $base:direc= tory + is either AS's home directory in case of J2EE AS environment or ju= st + the current directory in case of a standalone application. + + + + /conf/exo-configuration.xml in the current classloader (e.g. + war, ear archive) + + + + Configuration from + $service_jar_file/conf/portal/configuration.xml. WARNING: do not r= ely + on some concrete jar's configuration if you have more than one jar + containing conf/portal/configuration.xml file. In this case choosi= ng a + configuration is unpredictable. + + + + JCR service configuration looks like: + + <component> + <key>org.exoplatform.services.jcr.RepositoryService</key> + <type>org.exoplatform.services.jcr.impl.RepositoryServiceImpl<= ;/type> + </component> + <component> + <key>org.exoplatform.services.jcr.config.RepositoryServiceConfig= uration</key> + <type>org.exoplatform.services.jcr.impl.config.RepositoryService= ConfigurationImpl</type> + <init-params> + <value-param> + <name>conf-path</name> + <description>JCR repositories configuration file</descrip= tion> + <value>jar:/conf/standalone/exo-jcr-config.xml</value> + </value-param> + <properties-param> + <name>working-conf</name> + <description>working-conf</description> + <property name=3D"source-name" value=3D"jdbcjcr" /> + <property name=3D"dialect" value=3D"hsqldb" /> + <property name=3D"persister-class-name" value=3D"org.exoplatfor= m.services.jcr.impl.config.JDBCConfigurationPersister" /> + </properties-param> + </init-params> + </component> + + conf-path : a path to a RepositoryService JCR Configuration + + working-conf : optional; JCR configuration persister configurati= on. + If there isn't a working-conf the persister will be disabled + +
+ JCR Configuration + + The Configuration is defined in an XML file (see DTD + below). + + JCR Service can use multiple Repositories and each repository = can + have multiple Workspaces. + + Repositories configuration parameters support human-readable + formats of values. They are all case-insensitive: + + + + Numbers formats: K,KB - kilobytes, M,MB - megabytes, G,GB - + gigabytes, T,TB - terabytes. + + Examples: 100.5 - digit 100.5, 200k - 200 Kbytes, 4m - 4 + Mbytes, 1.4G - 1.4 Gbytes, 10T - 10 Tbytes + + + + Time format endings: ms - milliseconds, s - seconds, m - + minutes, h - hours, d - days, w - weeks, if no ending - + seconds. + + Examples: 500ms - 500 milliseconds, 20 or 20s - 20 seconds, + 30m - 30 minutes, 12h - 12 hours, 5d - 5 days, 4w - 4 weeks. + + + + +
+ +
+ Repository service configuration + + Default configuration of the Repository Service located in + jar:/conf/portal/exo-jcr-config.xml, it will be available for portal= and + standalone modes. + + In portal mode it is overriden and located in the portal web + application portal/WEB-INF/conf/jcr/repository-configuration.xml. + + Example of Repository Service configuration for standalone + mode: + + <repository-service default-repository=3D"reposit= ory"> + <repositories> + <repository name=3D"db1" system-workspace=3D"ws" default-workspac= e=3D"ws"> + <security-domain>exo-domain</security-domain> + <access-control>optional</access-control> + <session-max-age>1h</session-max-age> + <authentication-policy>org.exoplatform.services.jcr.impl.co= re.access.JAASAuthenticator</authentication-policy> + <workspaces> + <workspace name=3D"production"> + <!-- for system storage --> + <container class=3D"org.exoplatform.services.jcr.impl.st= orage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"> + <properties> + <property name=3D"source-name" value=3D"jdbcjcr" /= > + <property name=3D"multi-db" value=3D"false" /> + <property name=3D"update-storage" value=3D"false" = /> + <property name=3D"max-buffer-size" value=3D"200k" = /> + <property name=3D"swap-directory" value=3D"../temp= /swap/production" /> + </properties> + <value-storages> + <value-storage id=3D"system" class=3D"org.exoplatf= orm.services.jcr.impl.storage.value.fs.TreeFileValueStorage"> + <properties> + <property name=3D"path" value=3D"../temp/val= ues/production" /> + </properties> + <filters> + <filter property-type=3D"Binary" /> + </filters> + </value-storage> + </value-storages> + </container> + <initializer class=3D"org.exoplatform.services.jcr.impl.= core.ScratchWorkspaceInitializer"> + <properties> + <property name=3D"root-nodetype" value=3D"nt:unstr= uctured" /> + </properties> + </initializer> + <cache enabled=3D"true" class=3D"org.exoplatform.service= s.jcr.impl.dataflow.persistent.LinkedWorkspaceStorageCacheImpl"> + <properties> + <property name=3D"max-size" value=3D"10k" /> + <property name=3D"live-time" value=3D"1h" /> + </properties> + </cache> + <query-handler class=3D"org.exoplatform.services.jcr.imp= l.core.query.lucene.SearchIndex"> + <properties> + <property name=3D"index-dir" value=3D"../temp/jcrl= ucenedb/production" /> + </properties> + </query-handler> + <lock-manager> + <time-out>15m</time-out> + <persister class=3D"org.exoplatform.services.jcr.impl= .core.lock.FileSystemLockPersister"> + <properties> + <property name=3D"path" value=3D"../temp/lock/s= ystem" /> + </properties> + </persister> + </lock-manager> + </workspace> + + <workspace name=3D"backup"> + <container class=3D"org.exoplatform.services.jcr.impl.st= orage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"> + <properties> + <property name=3D"source-name" value=3D"jdbcjcr" /= > + <property name=3D"multi-db" value=3D"false" /> + <property name=3D"update-storage" value=3D"false" = /> + <property name=3D"max-buffer-size" value=3D"200k" = /> + <property name=3D"swap-directory" value=3D"../temp= /swap/backup" /> + </properties> + <value-storages> + <value-storage id=3D"draft" class=3D"org.exoplatfo= rm.services.jcr.impl.storage.value.fs.TreeFileValueStorage"> + <properties> + <property name=3D"path" value=3D"../temp/val= ues/backup" /> + </properties> + <filters> + <filter property-type=3D"Binary" /> + </filters> + </value-storage> + </value-storages> + </container> + <initializer class=3D"org.exoplatform.services.jcr.impl.= core.ScratchWorkspaceInitializer"> + <properties> + <property name=3D"root-nodetype" value=3D"nt:unstr= uctured" /> + </properties> + </initializer> + <cache enabled=3D"true" class=3D"org.exoplatform.service= s.jcr.impl.dataflow.persistent.LinkedWorkspaceStorageCacheImpl"> + <properties> + <property name=3D"max-size" value=3D"10k" /> + <property name=3D"live-time" value=3D"1h" /> + </properties> + </cache> + <query-handler class=3D"org.exoplatform.services.jcr.imp= l.core.query.lucene.SearchIndex"> + <properties> + <property name=3D"index-dir" value=3D"../temp/jcrl= ucenedb/backup" /> + </properties> + </query-handler> + </workspace> + </workspaces> + </repository> + </repositories> +</repository-service> + + + Repository Service configuration: + + default-repository - the name of a default repository (one + returned by RepositoryService.getRepository()) + + repositories - the list of repositories + + Repository configuration: + + name - the name of a repository + + default-workspace - the name of a workspace obtained using + Session's login() or login(Credentials) methods (ones without an + explicit workspace name) + + system-workspace - name of workspace where /jcr:system node is + placed + + security-domain - the name of a security domain for JAAS + authentication + + access-control - the name of an access control policy. There c= an + be 3 types: optional - ACL is created on-demand(default), disable - = no + access control, mandatory - an ACL is created for each added node(not + supported yet) + + authentication-policy - the name of an authentication policy + class + + workspaces - the list of workspaces + + session-max-age - the time after which an idle session will be + removed (called logout). If not set, the idle session will never be + removed. + + Workspace configuration: + + name - the name of a workspace + + auto-init-root-nodetype - DEPRECATED in JCR 1.9 (use initializ= er). + The node type for root node initialization + + container - workspace data container (physical storage) + configuration + + initializer - workspace initializer configuration + + cache - workspace storage cache configuration + + query-handler - query handler configuration + + Workspace data container configuration: + + class - A workspace data container class name + + properties - the list of properties (name-value pairs) for the + concrete Workspace data container + + value-storages - the list of value storage plugins + + Value Storage plugin configuration (optional feature): + + + The value-storage element is optional. If you don't include = it, + the values will be stored as BLOBs inside the database. + + + value-storage - Optional value Storage plugin definition + + class- a value storage plugin class name (attribute) + + properties - the list of properties (name-value pairs) for a + concrete Value Storage plugin + + filters - the list of filters defining conditions when this pl= ugin + is applicable + + Initializer configuration (optional): + + class - initializer implementation class. + + properties - the list of properties (name-value pairs). Proper= ties + are supported: + + root-nodetype - The node type for root node initialization + + root-permissions - Default permissions of the root node. It is + defined as a set of semicolon-delimited permissions containing a gro= up + of space-delimited identities (user, group etc, see Organization ser= vice + documentation for details) and the type of permission. For example a= ny + read;:/admin read;:/admin add_node;:/admin set_property;:/admin remo= ve + means that users from group admin have all permissions and other use= rs + have only a 'read' permission. + + Configurable initializer adds a capability to override workspa= ce + initial startup procedure. + + Cache configuration: + + enabled - if workspace cache is enabled + + class - cache implementation class, optional from 1.9. Default + value is + org.exoplatform.services.jcr.impl.dataflow.persistent.LinkedWorkspac= eStorageCacheImpl. + + Cache can be configured to use concrete implementation of + WorkspaceStorageCache interface. JCR core has two implementation to = use: + * LinkedWorkspaceStorageCacheImpl - default, with configurable read + behavior and statistic. * WorkspaceStorageCacheImpl - pre 1.9, still= can + be used. + + properties - the list of properties (name-value pairs) for + Workspace cache: + + max-size - cache maximum size. + + live-time - cached item live time. + + LinkedWorkspaceStorageCacheImpl supports additional optional + parameters TODO + + Query Handler configuration: + + class - A Query Handler class name + + properties - the list of properties (name-value pairs) for a Q= uery + Handler (indexDir) properties and advanced features described in *Se= arch + Configuration* + + Lock Manager configuration: + + time-out - time after which the unused global lock will be + removed. + + persister - a class for storing lock information for future us= e. + For example, remove lock after jcr restart. + + path - a lock folder, each workspace has its own. + + + + Configuration definition: + + <!ELEMENT repository-service (repositories)> + <!ATTLIST repository-service default-repository NMTOKEN #REQUIRED> + <!ELEMENT repositories (repository)> + <!ELEMENT repository (security-domain,access-control,session-max-age,= authentication-policy,workspaces)> + <!ATTLIST repository + default-workspace NMTOKEN #REQUIRED + name NMTOKEN #REQUIRED + system-workspace NMTOKEN #REQUIRED + > + <!ELEMENT security-domain (#PCDATA)> + <!ELEMENT access-control (#PCDATA)> + <!ELEMENT session-max-age (#PCDATA)> + <!ELEMENT authentication-policy (#PCDATA)> + <!ELEMENT workspaces (workspace+)> + <!ELEMENT workspace (container,initializer,cache,query-handler)> + <!ATTLIST workspace name NMTOKEN #REQUIRED> + <!ELEMENT container (properties,value-storages)> + <!ATTLIST container class NMTOKEN #REQUIRED> + <!ELEMENT value-storages (value-storage+)> + <!ELEMENT value-storage (properties,filters)> + <!ATTLIST value-storage class NMTOKEN #REQUIRED> + <!ELEMENT filters (filter+)> + <!ELEMENT filter EMPTY> + <!ATTLIST filter property-type NMTOKEN #REQUIRED> + <!ELEMENT initializer (properties)> + <!ATTLIST initializer class NMTOKEN #REQUIRED> + <!ELEMENT cache (properties)> + <!ATTLIST cache = + enabled NMTOKEN #REQUIRED + class NMTOKEN #REQUIRED + > + <!ELEMENT query-handler (properties)> + <!ATTLIST query-handler class NMTOKEN #REQUIRED> + <!ELEMENT access-manager (properties)> + <!ATTLIST access-manager class NMTOKEN #REQUIRED> + <!ELEMENT lock-manager (time-out,persister)> + <!ELEMENT time-out (#PCDATA)> + <!ELEMENT persister (properties)> + <!ELEMENT properties (property+)> + <!ELEMENT property EMPTY> +
+
+ Modified: jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/extern= al-value-storages.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/external-val= ue-storages.xml 2010-02-18 13:25:20 UTC (rev 1898) +++ jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/external-val= ue-storages.xml 2010-02-18 13:26:13 UTC (rev 1899) @@ -1,7 +1,7 @@ - + External Value Storages = Added: jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/jdbc-data= -container-config.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/jdbc-data-co= ntainer-config.xml (rev 0) +++ jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/jdbc-data-co= ntainer-config.xml 2010-02-18 13:26:13 UTC (rev 1899) @@ -0,0 +1,14 @@ + + + + + + JDBC Data Container Config + +
+ Introduction + + +
+ Modified: jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/search= -configuration.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/search-confi= guration.xml 2010-02-18 13:25:20 UTC (rev 1898) +++ jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/search-confi= guration.xml 2010-02-18 13:26:13 UTC (rev 1899) @@ -1,7 +1,7 @@ - + = Search Configuration --===============8232167730966820636==--