Author: smumford
Date: 2011-11-24 20:13:48 -0500 (Thu, 24 Nov 2011)
New Revision: 8142
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/Author_Group.xml
epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml
epp/docs/branches/5.2/Reference_Guide/en-US/Preface.xml
epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml
epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Conventions.xml
epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Feedback.xml
epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Legal_Notice.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Advanced_Concepts.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Config_Retrieval.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Containers.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Extensions_And_Multiple_Portals.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Management.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Profiles.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Requests.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Specific_Services.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/System_Properties.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration/DatabaseConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration/EMailServiceConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/Gadgets.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Introduction.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/overview.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/RH-WSRP.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/conversationstate-when-membership-changed.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/core.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-configuration-hibernate.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-creator-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-schema-creator-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/digest-auth.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/ldap-configuration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service-initalizer.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service-listener.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/security-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/spring-security-integration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/tika-document-reader-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/faq.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/faq/jcr-faq.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gatein.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/api-extensions.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/backup-client.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/backup-clonsole-dist.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/use-external-backup-tool.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-advantages.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-applications.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-compatibility-levels.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-exo-implementation.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-extensions.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-namespace-altering.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-registry-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-usage.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/nodetype-registration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/why-jcr.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/configuration-persister.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/rest-services-on-groovy.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/data-container-howto.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/data-container.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/db-cleaner-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/intro.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jbosscache-configuration-templates.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jbossts-transaction-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jca.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jta.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/acl-ext.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/acl.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/binary-values-processing.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/jcr-resources.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/link-producer.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/performance-tuning-guide.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/protocols/ftp.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/protocols/webdav.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/query-handler-config.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-check-controller.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-creation-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/aggregation-rule.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/and-constraint.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/child-node-constraint.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/date-property-comparison.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/escaping-like-statements.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/exact-path-constraint.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-all-descendant-nodes.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-all-nodes.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-by-mixin-type.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-by-primary-type.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-case-insensitive.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-similar-nodes.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-by-all-properties.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-by-property.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/higlight.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/ignore-accent-symbols.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/index-boost-value.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/like-constraint.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/multivalue-property-comparison.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/node-name-constraint.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/node-scope-index.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/not-constraint.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/offset-and-limit.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/or-constraint.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-descendant.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-path-or-name.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-property.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-score.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/property-comparison.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/property-existance-constraint.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/regexp-indexing-rule.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/spell-checker.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/synonim-provider.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/tip-nodename-with-number.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/statistics.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/transaction-manager-lookup.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/framework-for-cross-domain-ajax.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/groovy-scripts-as-rest-services.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/introduction-to-rest.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/overwrite-default-providers.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/restservicelist-service.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/ws.xml
epp/docs/branches/5.2/Reference_Guide/publican.cfg
Log:
Internal book changes for to remove eXo_JCR_1.14 from name and ids
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Author_Group.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/Author_Group.xml 2011-11-25 00:48:53 UTC
(rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/Author_Group.xml 2011-11-25 01:13:48 UTC
(rev 8142)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<authorgroup>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml 2011-11-25 00:48:53 UTC (rev
8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml 2011-11-25 01:13:48 UTC (rev
8142)
@@ -1,15 +1,15 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<bookinfo
id="book-Reference_Guide_eXo_JCR_1.14-Reference_Guide_eXo_JCR_1.14">
- <title>Reference Guide eXo JCR 1.14</title>
+<bookinfo id="book-Reference_Guide-Reference_Guide">
+ <title>Reference Guide</title>
<subtitle>An in-depth guide to Enterprise Portal Platform
&VZ;</subtitle>
<productname>JBoss Enterprise Portal Platform</productname>
<productnumber>5.2</productnumber>
<edition>5.2.0</edition>
- <pubsnumber>9</pubsnumber>
+ <pubsnumber>10</pubsnumber>
<abstract>
<para>
This Reference Guide is a high-level usage document. It deals with more
advanced topics than the Installation and User Guides, adding new content or taking
concepts discussed in the earlier documents further. It aims to provide supporting
documentation for advanced users of the JBoss Enterprise Portal Platform product. Its
primary focus is on advanced use of the product and it assumes an intermediate or advanced
knowledge of the technology and terms.
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Preface.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/Preface.xml 2011-11-25 00:48:53 UTC (rev
8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/Preface.xml 2011-11-25 01:13:48 UTC (rev
8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<preface id="pref-Reference_Guide_eXo_JCR_1.14-Preface">
+<preface id="pref-Reference_Guide-Preface">
<title>Preface</title>
<!-- FOR PUBLICAN --> <xi:include
href="Common_Content/Conventions.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"> <!-- FOR JDOCBOOK:
--> <xi:fallback
xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:include href="fallback_content/Conventions.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</xi:fallback>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml 2011-11-25 00:48:53
UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml 2011-11-25 01:13:48
UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<appendix id="appe-Reference_Guide_eXo_JCR_1.14-Revision_History">
+<appendix id="appe-Reference_Guide-Revision_History">
<title>Revision History</title>
<simpara>
<revhistory>
<revision>
- <revnumber>5.2.0-9</revnumber>
+ <revnumber>5.2.0-10</revnumber>
<date>Fri Nov 25 2011</date>
<author>
<firstname>Scott</firstname>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Conventions.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Conventions.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Conventions.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Document_Conventions">
+<section id="sect-Reference_Guide-Document_Conventions">
<title>Document Conventions</title>
<para>
This manual uses several conventions to highlight certain words and phrases and draw
attention to specific pieces of information.
@@ -11,7 +11,7 @@
<para>
In PDF and paper editions, this manual uses typefaces drawn from the <ulink
url="https://fedorahosted.org/liberation-fonts/">Liberation
Fonts</ulink> set. The Liberation Fonts set is also used in HTML editions if the set
is installed on your system. If not, alternative but equivalent typefaces are displayed.
Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Document_Conventions-Typographic_Conventions">
+ <section
id="sect-Reference_Guide-Document_Conventions-Typographic_Conventions">
<title>Typographic Conventions</title>
<para>
Four typographic conventions are used to call attention to specific words and phrases.
These conventions, and the circumstances they apply to, are as follows.
@@ -109,7 +109,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Document_Conventions-Pull_quote_Conventions">
+ <section
id="sect-Reference_Guide-Document_Conventions-Pull_quote_Conventions">
<title>Pull-quote Conventions</title>
<para>
Terminal output and source code listings are set off visually from the surrounding
text.
@@ -144,7 +144,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Document_Conventions-Notes_and_Warnings">
+ <section
id="sect-Reference_Guide-Document_Conventions-Notes_and_Warnings">
<title>Notes and Warnings</title>
<para>
Finally, we use three visual styles to draw attention to information that might
otherwise be overlooked.
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Feedback.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Feedback.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Feedback.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-We_Need_Feedback">
+<section id="sect-Reference_Guide-We_Need_Feedback">
<title>We Need Feedback!</title>
<indexterm>
<primary>feedback</primary>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Legal_Notice.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Legal_Notice.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/fallback_content/Legal_Notice.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<legalnotice>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Advanced_Concepts.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Advanced_Concepts.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Advanced_Concepts.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_concepts_for_the_PortalContainers">
+<section
id="sect-Reference_Guide-Advanced_concepts_for_the_PortalContainers">
<title>Advanced concepts for the
<emphasis>PortalContainers</emphasis></title>
<para>
Since eXo JCR 1.12, we added a set of new features that have been designed to extend
portal applications such as GateIn.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_concepts_for_the_PortalContainers-Add_new_configuration_files_from_a_WAR_file">
+ <section
id="sect-Reference_Guide-Advanced_concepts_for_the_PortalContainers-Add_new_configuration_files_from_a_WAR_file">
<title>Add new configuration files from a WAR file</title>
<para>
A <envar>ServletContextListener</envar> called
<envar>org.exoplatform.container.web.PortalContainerConfigOwner</envar> has
been added in order to notify the application that a given web application provides some
configuration to the portal container, and this configuration file is the file
<emphasis>WEB-INF/conf/configuration.xml</emphasis> available in the web
application itself.
@@ -33,7 +33,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_concepts_for_the_PortalContainers-Creating_your_PortalContainers_from_a_WAR_file">
+ <section
id="sect-Reference_Guide-Advanced_concepts_for_the_PortalContainers-Creating_your_PortalContainers_from_a_WAR_file">
<title>Creating your <emphasis>PortalContainers</emphasis> from a WAR
file</title>
<para>
A <envar>ServletContextListener</envar> called
<envar>org.exoplatform.container.web.PortalContainerCreator</envar> has been
added in order to create the current portal containers that have been registered. We
assume that all the web applications have already been loaded before calling
<envar>PortalContainerCreator.contextInitialized.</envar>
@@ -50,7 +50,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_concepts_for_the_PortalContainers-Defining_a_PortalContainer_with_its_dependencies_and_its_settings">
+ <section
id="sect-Reference_Guide-Advanced_concepts_for_the_PortalContainers-Defining_a_PortalContainer_with_its_dependencies_and_its_settings">
<title>Defining a <emphasis>PortalContainer</emphasis> with its
dependencies and its settings</title>
<para>
Now we can define precisely a portal container and its dependencies and settings
thanks to the <envar>PortalContainerDefinition</envar> that currently contains
the name of the portal container, the name of the rest context, the name of the realm, the
web application dependencies ordered by loading priority (i.e. the first dependency must
be loaded at first and so on..) and the settings.
@@ -139,7 +139,7 @@
</object-param>
</init-params>
</component></programlisting>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Defining_a_PortalContainer_with_its_dependencies_and_its_settings-Descriptions_of_the_fields_of_PortalContainerConfig">
+ <table
id="tabl-Reference_Guide-Defining_a_PortalContainer_with_its_dependencies_and_its_settings-Descriptions_of_the_fields_of_PortalContainerConfig">
<title>Descriptions of the fields of
<envar>PortalContainerConfig</envar></title>
<tgroup cols="2">
<tbody>
@@ -314,7 +314,7 @@
</init-params>
</component-plugin>
</external-component-plugins></programlisting>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Defining_a_PortalContainer_with_its_dependencies_and_its_settings-Descriptions_of_the_fields_of_a_PortalContainerDefinition_when_it_is_used_to_define_a_new_portal_container">
+ <table
id="tabl-Reference_Guide-Defining_a_PortalContainer_with_its_dependencies_and_its_settings-Descriptions_of_the_fields_of_a_PortalContainerDefinition_when_it_is_used_to_define_a_new_portal_container">
<title>Descriptions of the fields of a
<envar>PortalContainerDefinition</envar> when it is used to define a new
portal container</title>
<tgroup cols="2">
<tbody>
@@ -441,7 +441,7 @@
</tgroup>
</table>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Defining_a_PortalContainer_with_its_dependencies_and_its_settings-Descriptions_of_the_fields_of_a_PortalContainerDefinition_when_it_is_used_to_define_the_default_portal_container">
+ <table
id="tabl-Reference_Guide-Defining_a_PortalContainer_with_its_dependencies_and_its_settings-Descriptions_of_the_fields_of_a_PortalContainerDefinition_when_it_is_used_to_define_the_default_portal_container">
<title>Descriptions of the fields of a
<envar>PortalContainerDefinition</envar> when it is used to define the default
portal container</title>
<tgroup cols="2">
<tbody>
@@ -663,12 +663,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_concepts_for_the_PortalContainers-PortalContainer_settings">
+ <section
id="sect-Reference_Guide-Advanced_concepts_for_the_PortalContainers-PortalContainer_settings">
<title><envar>PortalContainer</envar> settings</title>
<para>
We can inject the value of the portal container settings into the portal container
configuration files thanks to the variables which name start with
"<emphasis>portal.container.</emphasis>", so to get the value of a
setting called "<emphasis>foo</emphasis>", just use the following
syntax <emphasis>${portal.container.foo}</emphasis>. You can also use internal
variables, such as:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-PortalContainer_settings-Definition_of_the_internal_variables">
+ <table
id="tabl-Reference_Guide-PortalContainer_settings-Definition_of_the_internal_variables">
<title>Definition of the internal variables</title>
<tgroup cols="2">
<tbody>
@@ -766,7 +766,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_concepts_for_the_PortalContainers-Adding_dynamically_settings_andor_dependencies_to_a_PortalContainer">
+ <section
id="sect-Reference_Guide-Advanced_concepts_for_the_PortalContainers-Adding_dynamically_settings_andor_dependencies_to_a_PortalContainer">
<title>Adding dynamically settings and/or dependencies to a
<envar>PortalContainer</envar></title>
<para>
It is possible to use <envar>component-plugin</envar> elements in order to
dynamically change a PortalContainerDefinition. In the example below, we add the
dependency <envar>foo</envar> to the default portal container and to the
portal containers called <envar>foo1</envar> and
<envar>foo2</envar>:
@@ -808,7 +808,7 @@
</init-params>
</component-plugin>
</external-component-plugins></programlisting>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Adding_dynamically_settings_andor_dependencies_to_a_PortalContainer-Descriptions_of_the_fields_of_a_PortalContainerDefinitionChangePlugin">
+ <table
id="tabl-Reference_Guide-Adding_dynamically_settings_andor_dependencies_to_a_PortalContainer-Descriptions_of_the_fields_of_a_PortalContainerDefinitionChangePlugin">
<title>Descriptions of the fields of a
<envar>PortalContainerDefinitionChangePlugin</envar></title>
<tgroup cols="2">
<tbody>
@@ -896,17 +896,17 @@
</listitem>
</orderedlist>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Adding_dynamically_settings_andor_dependencies_to_a_PortalContainer-The_existing_implementations_of_PortalContainerDefinitionChange">
+ <section
id="sect-Reference_Guide-Adding_dynamically_settings_andor_dependencies_to_a_PortalContainer-The_existing_implementations_of_PortalContainerDefinitionChange">
<title>The existing implementations of
<envar>PortalContainerDefinitionChange</envar></title>
<para>
The modifications that can be applied to a
<envar>PortalContainerDefinition</envar> must be a class of type
<envar>PortalContainerDefinitionChange</envar>. The product proposes out of
the box some implementations that we describe in the next sub sections.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_existing_implementations_of_PortalContainerDefinitionChange-AddDependencies">
+ <section
id="sect-Reference_Guide-The_existing_implementations_of_PortalContainerDefinitionChange-AddDependencies">
<title><envar>AddDependencies</envar></title>
<para>
This modification adds a list of dependencies at the end of the list of dependencies
defined into the <envar>PortalContainerDefinition</envar>. The full qualified
name is
<emphasis>org.exoplatform.container.definition.PortalContainerDefinitionChange$AddDependencies</emphasis>.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-AddDependencies-Descriptions_of_the_fields_of_an_AddDependencies">
+ <table
id="tabl-Reference_Guide-AddDependencies-Descriptions_of_the_fields_of_an_AddDependencies">
<title>Descriptions of the fields of an
<envar>AddDependencies</envar></title>
<tgroup cols="2">
<tbody>
@@ -963,12 +963,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_existing_implementations_of_PortalContainerDefinitionChange-AddDependenciesBefore">
+ <section
id="sect-Reference_Guide-The_existing_implementations_of_PortalContainerDefinitionChange-AddDependenciesBefore">
<title><envar>AddDependenciesBefore</envar></title>
<para>
This modification adds a list of dependencies before a given target dependency
defined into the list of dependencies of the
<envar>PortalContainerDefinition</envar>. The full qualified name is
<emphasis>org.exoplatform.container.definition.PortalContainerDefinitionChange$AddDependenciesBefore</emphasis>.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-AddDependenciesBefore-Descriptions_of_the_fields_of_an_AddDependenciesBefore">
+ <table
id="tabl-Reference_Guide-AddDependenciesBefore-Descriptions_of_the_fields_of_an_AddDependenciesBefore">
<title>Descriptions of the fields of an
<envar>AddDependenciesBefore</envar></title>
<tgroup cols="2">
<tbody>
@@ -1038,12 +1038,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_existing_implementations_of_PortalContainerDefinitionChange-AddDependenciesAfter">
+ <section
id="sect-Reference_Guide-The_existing_implementations_of_PortalContainerDefinitionChange-AddDependenciesAfter">
<title><envar>AddDependenciesAfter</envar></title>
<para>
This modification adds a list of dependencies before a given target dependency
defined into the list of dependencies of the
<envar>PortalContainerDefinition</envar>. The full qualified name is
<emphasis>org.exoplatform.container.definition.PortalContainerDefinitionChange$AddDependenciesAfter</emphasis>.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-AddDependenciesAfter-Descriptions_of_the_fields_of_an_AddDependenciesAfter">
+ <table
id="tabl-Reference_Guide-AddDependenciesAfter-Descriptions_of_the_fields_of_an_AddDependenciesAfter">
<title>Descriptions of the fields of an
<envar>AddDependenciesAfter</envar></title>
<tgroup cols="2">
<tbody>
@@ -1113,12 +1113,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_existing_implementations_of_PortalContainerDefinitionChange-AddSettings">
+ <section
id="sect-Reference_Guide-The_existing_implementations_of_PortalContainerDefinitionChange-AddSettings">
<title><envar>AddSettings</envar></title>
<para>
This modification adds new settings to a
<envar>PortalContainerDefinition</envar>. The full qualified name is
<emphasis>org.exoplatform.container.definition.PortalContainerDefinitionChange$AddSettings</emphasis>.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-AddSettings-Descriptions_of_the_fields_of_an_AddSettings">
+ <table
id="tabl-Reference_Guide-AddSettings-Descriptions_of_the_fields_of_an_AddSettings">
<title>Descriptions of the fields of an
<envar>AddSettings</envar></title>
<tgroup cols="2">
<tbody>
@@ -1194,7 +1194,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_concepts_for_the_PortalContainers-Disable_dynamically_a_portal_container">
+ <section
id="sect-Reference_Guide-Advanced_concepts_for_the_PortalContainers-Disable_dynamically_a_portal_container">
<title>Disable dynamically a portal container</title>
<para>
It is possible to use <envar>component-plugin</envar> elements in order to
dynamically disable one or several portal containers. In the example below, we disable the
portal container named <envar>foo</envar>:
@@ -1219,7 +1219,7 @@
</init-params>
</component-plugin>
</external-component-plugins></programlisting>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Disable_dynamically_a_portal_container-Descriptions_of_the_fields_of_a_PortalContainerDefinitionDisablePlugin">
+ <table
id="tabl-Reference_Guide-Disable_dynamically_a_portal_container-Descriptions_of_the_fields_of_a_PortalContainerDefinitionDisablePlugin">
<title>Descriptions of the fields of a
<envar>PortalContainerDefinitionDisablePlugin</envar></title>
<tgroup cols="2">
<tbody>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Config_Retrieval.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Config_Retrieval.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Config_Retrieval.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Configuration_Retrieval">
+<section id="sect-Reference_Guide-Configuration_Retrieval">
<title>Configuration Retrieval</title>
<para>
The container performs the following steps for configuration retrieval, depending on
the container type.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Containers.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Containers.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Containers.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_portal_container">
+<section id="sect-Reference_Guide-Configuring_a_portal_container">
<title>Configuring a portal container</title>
<para>
A <literal>portal container</literal> is defined by several attributes:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_Services">
+<section id="sect-Reference_Guide-Configuring_Services">
<title>Configuring Services</title>
<para>
The eXo Kernel uses dependency injection to create services based on
<filename>configuration.xml</filename> configuration files. The location of
the configuration files determines if services are placed into the
<literal>RootContainer</literal> scope, or into the
<literal>PortalContainer</literal> scope.
@@ -32,9 +32,9 @@
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_Services-Configuration_syntax">
+ <section
id="sect-Reference_Guide-Configuring_Services-Configuration_syntax">
<title>Configuration syntax</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration_syntax-Components">
+ <section
id="sect-Reference_Guide-Configuration_syntax-Components">
<title>Components</title>
<para>
A service component is defined in
<filename>configuration.xml</filename> by using a <emphasis
role="bold"><component></emphasis> element.
@@ -130,7 +130,7 @@
<para>
Many other examples exist such as for the Scheduler Service where you can
add a job with a simple XML configuration or the JCR Service where you can add a NodeType
from your own configuration.xml file.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Components-RootContainer">
+ <section
id="sect-Reference_Guide-Components-RootContainer">
<title>RootContainer</title>
<para>
As PortalContainer depends on the RootContainer, we will start by
looking into this one.
@@ -180,7 +180,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Components-PortalContainer">
+ <section
id="sect-Reference_Guide-Components-PortalContainer">
<title>PortalContainer</title>
<para>
The PortalContainer takes the hashtable filled by the RootContainer
and continues to look in some more places. Here you get the opportunity to replace
RootContainer configurations by those which are specific to your portal. Again, the
configurations are overridden whenever necessary.
@@ -236,7 +236,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Components-External_Plug_ins">
+ <section
id="sect-Reference_Guide-Components-External_Plug_ins">
<title>External Plug-ins</title>
<para>
The eXo Kernel supports non-component objects that can be configured,
instantiated, and injected into registered components using method calls. This
'<emphasis>plugin</emphasis>' method allows portal extensions to add
additional configurations to core services.
@@ -282,7 +282,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Components-Service_instantiation">
+ <section
id="sect-Reference_Guide-Components-Service_instantiation">
<title>Service instantiation</title>
<para>
As you have already learned the services are all singletons, so that
the container creates only one single instance of each container. The services are created
by calling the constructors (called <emphasis>constructor
injection</emphasis>). If there are only zero-arguments constructors
(<code>Foo public Foo(){}</code>) there are no problems to be expected.
That's easy.
@@ -310,7 +310,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Components-Service_Access">
+ <section
id="sect-Reference_Guide-Components-Service_Access">
<title>Service Access</title>
<para>
As you want to follow the principle of <emphasis
role="bold">Inversion of Control,</emphasis> you <emphasis
role="bold">must not</emphasis> access the service directly. You need a
<emphasis role="bold">Container</emphasis> to access the service.
@@ -382,7 +382,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Components-Includes_and_special_URLs">
+ <section
id="sect-Reference_Guide-Components-Includes_and_special_URLs">
<title>Includes, and special URLs</title>
<para>
It is possible to divide the
<filename>configuration.xml</filename> file into many smaller files, which are
then included into the main configuration file.
@@ -395,13 +395,13 @@
</para>
<programlistingco>
<areaspec>
- <area coords="6"
id="area-Reference_Guide_eXo_JCR_1.14-Components-Includes_and_special_URLs-url_schema"
/>
+ <area coords="6"
id="area-Reference_Guide-Components-Includes_and_special_URLs-url_schema" />
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/Advanced_Development_Foundations/default2.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Components-Includes_and_special_URLs-url_schema">
+ <callout
arearefs="area-Reference_Guide-Components-Includes_and_special_URLs-url_schema">
<para>
This line is being used to reference another
configuration file. The <code>war:</code> URL schema indicates that the
following path is to be resolved relative to the current
<literal>PortalContainer</literal>'s servlet context resource path,
starting with <emphasis role="bold">WEB-INF</emphasis> as a root.
</para>
@@ -427,7 +427,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Components-Special_variables">
+ <section
id="sect-Reference_Guide-Components-Special_variables">
<title>Special variables</title>
<para>
Configuration files may contain a <emphasis
role="bold">special variable</emphasis> reference
<emphasis>${container.name.suffix}</emphasis>. This variable resolves to the
name of the current portal container, prefixed by underscore (_).
@@ -449,7 +449,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration_syntax-InitParams_configuration_element">
+ <section
id="sect-Reference_Guide-Configuration_syntax-InitParams_configuration_element">
<title>InitParams configuration element</title>
<para>
<parameter>InitParams</parameter> is a configuration element
that is essentially a map of key-value pairs, where <emphasis
role="bold">key</emphasis> is always a
<literal>String</literal>, and <emphasis
role="bold">value</emphasis> can be any type that can be described
using the kernel XML configuration.
@@ -535,7 +535,7 @@
<para>
The <parameter>InitParams</parameter> structure (the names
and types of entries) is specific for each service, as it is the code inside a service
components' class that defines which entry names to look up and what types it expects
to find.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-InitParams_configuration_element-Value_Param">
+ <section
id="sect-Reference_Guide-InitParams_configuration_element-Value_Param">
<title>Value-Param</title>
<para>
There is an value-param example:
@@ -568,7 +568,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-InitParams_configuration_element-Properties_Param">
+ <section
id="sect-Reference_Guide-InitParams_configuration_element-Properties_Param">
<title>Properties-Param</title>
<para>
Properties are name-value pairs. Both the name and the value are Java
Strings.
@@ -606,7 +606,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-InitParams_configuration_element-Object_Param">
+ <section
id="sect-Reference_Guide-InitParams_configuration_element-Object_Param">
<title>Object-Param</title>
<para>
Let's have a look at the configuration of the LDAPService.
It's not important to know LDAP, we only discuss the parameters.
@@ -682,7 +682,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-InitParams_configuration_element-Collection">
+ <section
id="sect-Reference_Guide-InitParams_configuration_element-Collection">
<title>Collection</title>
<para>
You also can use java collections to configure your service. In order
to see an example, let's open the database-organization-configuration.xml file. This
file defines a default user organization (users, groups, memberships/roles) of your
portal. They use component-plugins which are explained later. You will see that
object-param is used again.
@@ -760,7 +760,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration_syntax-Component_Plugin_Priority">
+ <section
id="sect-Reference_Guide-Configuration_syntax-Component_Plugin_Priority">
<title>Component Plugin Priority</title>
<para>
Since kernel version 2.0.6 it is possible to setup order of loading for
ComponentPlugin. Use the ' <emphasis
role="bold">priority</emphasis>' tag to define plugin's load
priority. By <emphasis role="bold">default</emphasis> all plugins
get <emphasis role="bold">priority '0'</emphasis>; they will
be loaded in the container's natural way. If you want one plugin to be loaded later
than the others then just set priority for it <emphasis role="bold">higher
than zero</emphasis>.
@@ -811,7 +811,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration_syntax-Configuration_Logging">
+ <section
id="sect-Reference_Guide-Configuration_syntax-Configuration_Logging">
<title>Configuration Logging</title>
<para>
In case you need to solve problems with your service configuration, you
have to know from which JAR/WAR causes your troubles. Add the JVM system property
<parameter>org.exoplatform.container.configuration.debug</parameter> to your
eXo.bat or eXo.sh file (exo-tomcat/bin/).
@@ -832,7 +832,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration_syntax-Import">
+ <section id="sect-Reference_Guide-Configuration_syntax-Import">
<title>Import</title>
<para>
The import tag allows to link to other configuration files. These
imported files can be placed anywhere. If you write a default configuration which is part
of your jar file you should not import files from outside your jar.
@@ -877,7 +877,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration_syntax-System_properties">
+ <section
id="sect-Reference_Guide-Configuration_syntax-System_properties">
<title>System properties</title>
<para>
Since kernel 2.0.7 and 2.1, it is possible to use system properties in
literal values of component configuration meta data. This makes it possible to resolve
properties at runtime instead of providing a value at packaging time.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Extensions_And_Multiple_Portals.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Extensions_And_Multiple_Portals.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Extensions_And_Multiple_Portals.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-The_Extension_Mechanism_and_Portal_Extensions">
+<section
id="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions">
<title>The Extension Mechanism and Portal Extensions</title>
<para>
The <emphasis role="bold">Extension mechanism</emphasis> makes it
possible to override portal resources in a way similar to hardware plug-and-play
functionalities.
@@ -14,7 +14,7 @@
<para>
These archives, packaged for use through the extension mechanism, are called
<emphasis role="bold">portal extensions</emphasis>.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-The_Extension_Mechanism_and_Portal_Extensions-Creating_a_portal_extension">
+ <procedure
id="proc-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions-Creating_a_portal_extension">
<title>Creating a portal extension</title>
<step>
<para>
@@ -48,11 +48,11 @@
<note>
<title>Example</title>
<para>
- Refer to the code extract in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_portal_container" />
for an example of a <literal>PortalContainerDefinition</literal> that has
<emphasis role="bold">sample-ext</emphasis> in its list of
dependencies.
+ Refer to the code extract in <xref
linkend="sect-Reference_Guide-Configuring_a_portal_container" /> for an
example of a <literal>PortalContainerDefinition</literal> that has
<emphasis role="bold">sample-ext</emphasis> in its list of
dependencies.
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_Extension_Mechanism_and_Portal_Extensions-Running_Multiple_Portals">
+ <section
id="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions-Running_Multiple_Portals">
<title>Running Multiple Portals</title>
<!-- DOC TODO: This section requires more work to structure the
information effectively. Consider sub-sections --> <para>
It is possible to run several independent portal containers, each bound to a different
URL context, within the same JVM instance.
@@ -79,7 +79,7 @@
A servlet in this instance should extend the
<literal>org.exoplatform.container.web.AbstractHttpServlet</literal> class so
as to properly initialize the current <literal>PortalContainer</literal>.
</para>
<para>
- This will also set the current thread's context Classloader to one that looks for
resources in associated web applications in the order specified by the <emphasis
role="bold">dependencies</emphasis> configuration (as seen in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-The_Extension_Mechanism_and_Portal_Extensions"
/>).
+ This will also set the current thread's context Classloader to one that looks for
resources in associated web applications in the order specified by the <emphasis
role="bold">dependencies</emphasis> configuration (as seen in <xref
linkend="sect-Reference_Guide-The_Extension_Mechanism_and_Portal_Extensions"
/>).
</para>
<para>
Filter classes need to extend the
<literal>org.exoplatform.container.web.AbstractFilter</literal>.
@@ -120,7 +120,7 @@
<para>
This method exists on both <literal>AbstractHttpServlet</literal> and
<literal>AbstractFilter</literal>. This is a default implementation that
automatically returns <emphasis>true</emphasis> when it detects there is a
current <literal>PortalContainer</literal> present and
<emphasis>false</emphasis> otherwise.
</para>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Running_Multiple_Portals-ServletContextListener_based_initialization_access_to_PortalContainer">
+ <formalpara
id="form-Reference_Guide-Running_Multiple_Portals-ServletContextListener_based_initialization_access_to_PortalContainer">
<title>ServletContextListener-based initialization access to
PortalContainer</title>
<para>
JBoss Enterprise Portal Platform has no direct control over the deployment of
application archives (<code>.war</code> and <code>.ear</code>
files); it is the application server that performs the deployment.
@@ -153,7 +153,7 @@
<para>
Use <emphasis
role="bold">PortalContainerPostCreateTask</emphasis> if initialization
is required <emphasis>after</emphasis> all the
<code>post-init</code> tasks have been executed.
</para>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Running_Multiple_Portals-LoginModules">
+ <formalpara
id="form-Reference_Guide-Running_Multiple_Portals-LoginModules">
<title>LoginModules</title>
<para>
If some custom <literal>LoginModules</literal> require the current
<literal>eXoContainer</literal> for initialization ensure they extend
<emphasis
role="bold">org.exoplatform.services.security.jaas.AbstractLoginModule</emphasis>.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-The_eXo_Kernel">
+<section id="sect-Reference_Guide-The_eXo_Kernel">
<title>The eXo Kernel</title>
<para>
JBoss Enterprise Portal Platform is built as a set of services on top of a dependency
injection kernel. The kernel provides configuration, life-cycle handling, component scopes
and some core services.
@@ -106,7 +106,7 @@
</para>
</important>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_eXo_Kernel-Kernel_configuration_namespace">
+ <section
id="sect-Reference_Guide-The_eXo_Kernel-Kernel_configuration_namespace">
<title>Kernel configuration namespace</title>
<para>
To be effective, the namespace URI
<
uri>http://www.exoplaform.org/xml/ns/kernel_1_2.xsd</uri> must be target
namespace of the XML configuration file.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Management.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Management.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Management.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Manageability">
+<section id="sect-Reference_Guide-Manageability">
<title>Manageability</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Manageability-Introduction">
+ <section id="sect-Reference_Guide-Manageability-Introduction">
<title>Introduction</title>
<para>
The kernel has a framework for exposing a management view of the various sub systems
of the platform. The management view is a lose term for defining how we can access
relevant information about the system and how we can apply management operations. JMX is
the de facto standard for exposing a management view in the Java Platform but we take in
consideration other kind of views such as REST web services. Therefore, the framework is
not tied to JMX, yet it provides a JMX part to define more precisely details related to
the JMX management view. The legacy framework is still in use but is deprecated in favor
of the new framework as it is less tested and less efficient. It will be removed by
sanitization in the future.
@@ -13,14 +13,14 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Manageability-Managed_framework_API">
+ <section
id="sect-Reference_Guide-Manageability-Managed_framework_API">
<title>Managed framework API</title>
<para>
The managed frameworks defines an API for exposing a management view of objects. The
API is targeted for internal use and is not a public API. The framework leverages Java 5
annotations to describe the management view from an object.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Managed_framework_API-Annotations">
+ <section id="sect-Reference_Guide-Managed_framework_API-Annotations">
<title>Annotations</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Annotations-org.exoplatform.management.annotations.Managed_annotation">
+ <section
id="sect-Reference_Guide-Annotations-org.exoplatform.management.annotations.Managed_annotation">
<title>(a)org.exoplatform.management.annotations.Managed
annotation</title>
<para>
The @Managed annotates elements that wants to expose a management view to a
management layer.
@@ -46,7 +46,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Annotations-org.exoplatform.management.annotations.ManagedDescription">
+ <section
id="sect-Reference_Guide-Annotations-org.exoplatform.management.annotations.ManagedDescription">
<title>(a)org.exoplatform.management.annotations.ManagedDescription</title>
<para>
The @ManagedDescription annotation provides a description of a managed element. It
is valid to annotated object or methods. It takes as sole argument a string that is the
description value.
@@ -54,7 +54,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Annotations-org.exoplatform.management.annotations.ManagedName">
+ <section
id="sect-Reference_Guide-Annotations-org.exoplatform.management.annotations.ManagedName">
<title>(a)org.exoplatform.management.annotations.ManagedName</title>
<para>
The @ManagedName annotation provides an alternative name for managed properties. It
is used to accomodate legacy methods of an object that can be renamed for compatibility
reasons. It takes as sole argument a string that is the name value.
@@ -62,7 +62,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Annotations-org.exoplatform.management.annotations.ManagedBy">
+ <section
id="sect-Reference_Guide-Annotations-org.exoplatform.management.annotations.ManagedBy">
<title>(a)org.exoplatform.management.annotations.ManagedBy</title>
<para>
The @ManagedBy annotation defines a delegate class for exposing a management view.
The sole argument of the annotation are class literals. The delegate class must provide a
constructor with the managed object as argument.
@@ -76,11 +76,11 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Manageability-JMX_Management_View">
+ <section id="sect-Reference_Guide-Manageability-JMX_Management_View">
<title>JMX Management View</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JMX_Management_View-JMX_Annotations">
+ <section
id="sect-Reference_Guide-JMX_Management_View-JMX_Annotations">
<title>JMX Annotations</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JMX_Annotations-org.exoplatform.management.jmx.annotations.Property_annotation">
+ <section
id="sect-Reference_Guide-JMX_Annotations-org.exoplatform.management.jmx.annotations.Property_annotation">
<title>(a)org.exoplatform.management.jmx.annotations.Property
annotation</title>
<para>
The @Property annotation is used to within other annotations such as @NameTemplate
or @NamingContext. It should be seen as a structural way for a list of properties. A
property is made of a key and a value. The value can either be a string literal or it can
be surrounded by curly brace to be a dynamic property. A dynamic property is resolved
against the instance of the object at runtime.
@@ -88,7 +88,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JMX_Annotations-org.exoplatform.management.jmx.annotations.NameTemplate_annotation">
+ <section
id="sect-Reference_Guide-JMX_Annotations-org.exoplatform.management.jmx.annotations.NameTemplate_annotation">
<title>(a)org.exoplatform.management.jmx.annotations.NameTemplate
annotation</title>
<para>
The @NameTemplate defines a template that is used at registration time of a managed
object to create the JMX object name. The template is formed of properties.
@@ -100,7 +100,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JMX_Annotations-org.exoplatform.management.jmx.annotations.NamingContext_annotation">
+ <section
id="sect-Reference_Guide-JMX_Annotations-org.exoplatform.management.jmx.annotations.NamingContext_annotation">
<title>(a)org.exoplatform.management.jmx.annotations.NamingContext
annotation</title>
<para>
The @NamingContext annotations defines a set of properties which are used within a
management context. It allows to propagate properties down to managed objects which are
defined by an object implementing the ManagementAware interface. The goal is to scope
different instances of the same class that would have the same object name otherwise.
@@ -116,9 +116,9 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Manageability-Example">
+ <section id="sect-Reference_Guide-Manageability-Example">
<title>Example</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Example-CacheService_example">
+ <section id="sect-Reference_Guide-Example-CacheService_example">
<title>CacheService example</title>
<para>
The cache service delegates most of the work to the CacheServiceManaged class by
using the @ManagedBy annotation. At runtime when a new cache is created, it calls the
CacheServiceManaged class in order to let the CacheServiceManaged object register the
cache.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Profiles.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Profiles.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Profiles.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Runtime_configuration_profiles">
+<section id="sect-Reference_Guide-Runtime_configuration_profiles">
<title>Runtime configuration profiles</title>
<para>
The kernel configuration is able to handle configuration profiles at runtime (as
opposed to packaging time).
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Runtime_configuration_profiles-Profiles_activation">
+ <section
id="sect-Reference_Guide-Runtime_configuration_profiles-Profiles_activation">
<title>Profiles activation</title>
<para>
An active profile list is obtained during the boot of the root container and is
composed of the system property <emphasis>exo.profiles</emphasis> sliced
according the "," delimiter and also a server specific profile value (tomcat for
tomcat, jboss for jboss, etc...).
@@ -22,12 +22,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Runtime_configuration_profiles-Profiles_configuration">
+ <section
id="sect-Reference_Guide-Runtime_configuration_profiles-Profiles_configuration">
<title>Profiles configuration</title>
<para>
Profiles are configured in the configuration files of the eXo kernel.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Profiles_configuration-Profiles_definition">
+ <section
id="sect-Reference_Guide-Profiles_configuration-Profiles_definition">
<title>Profiles definition</title>
<para>
Profile activation occurs at XML to configuration object unmarshalling time. It is
based on an "profile" attribute that is present on some of the XML element of
the configuration files. To enable this, the kernel configuration schema has been upgraded
to kernel_1_2.xsd. The configuration is based on the following rules:
@@ -62,12 +62,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Profiles_configuration-Profiles_capable_configuration_elements">
+ <section
id="sect-Reference_Guide-Profiles_configuration-Profiles_capable_configuration_elements">
<title>Profiles capable configuration elements</title>
<para>
A configuration element is <emphasis>profiles</emphasis> capable when it
carries a profiles element.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Profiles_capable_configuration_elements-Component_element">
+ <section
id="sect-Reference_Guide-Profiles_capable_configuration_elements-Component_element">
<title>Component element</title>
<para>
The component element declares a component when activated. It will shadow any
element with the same key declared before in the same configuration file:
@@ -85,7 +85,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Profiles_capable_configuration_elements-Component_plugin_element">
+ <section
id="sect-Reference_Guide-Profiles_capable_configuration_elements-Component_plugin_element">
<title>Component plugin element</title>
<para>
The component-plugin element is used to dynamically extend the configuration of a
given component. Thanks to the profiles the component-plugins could be enabled or
disabled:
@@ -108,7 +108,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Profiles_capable_configuration_elements-Import_element">
+ <section
id="sect-Reference_Guide-Profiles_capable_configuration_elements-Import_element">
<title>Import element</title>
<para>
The import element imports a referenced configuration file when activated:
@@ -120,7 +120,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Profiles_capable_configuration_elements-Init_param_element">
+ <section
id="sect-Reference_Guide-Profiles_capable_configuration_elements-Init_param_element">
<title>Init param element</title>
<para>
The init param element configures the parameter argument of the construction of a
component service:
@@ -147,7 +147,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Profiles_capable_configuration_elements-Value_collection_element">
+ <section
id="sect-Reference_Guide-Profiles_capable_configuration_elements-Value_collection_element">
<title>Value collection element</title>
<para>
The value collection element configures one of the value of collection data:
@@ -165,7 +165,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Profiles_capable_configuration_elements-Field_configuration_element">
+ <section
id="sect-Reference_Guide-Profiles_capable_configuration_elements-Field_configuration_element">
<title>Field configuration element</title>
<para>
The field configuration element configures the field of an object:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Requests.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Requests.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Requests.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Component_request_life_cycle">
+<section id="sect-Reference_Guide-Component_request_life_cycle">
<title>Component request life cycle</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Component_request_life_cycle-Component_request_life_cycle_contract">
+ <section
id="sect-Reference_Guide-Component_request_life_cycle-Component_request_life_cycle_contract">
<title>Component request life cycle contract</title>
<para>
The component request life cycle is an interface that defines a contract for a
component for being involved into a request:
@@ -34,12 +34,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Component_request_life_cycle-Request_life_cycle">
+ <section
id="sect-Reference_Guide-Component_request_life_cycle-Request_life_cycle">
<title>Request life cycle</title>
<para>
The <envar>RequestLifeCycle</envar> class has several statics methods that
are used to schedule the component request life cycle of components. Its main
responsibility is to perform scheduling while respecting the constraint to execute the
request life cycle of a component only once even if it can be scheduled several times.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Request_life_cycle-Scheduling_a_component_request_life_cycle">
+ <section
id="sect-Reference_Guide-Request_life_cycle-Scheduling_a_component_request_life_cycle">
<title>Scheduling a component request life cycle</title>
<programlisting language="Java"
role="Java">RequestLifeCycle.begin(component);
@@ -54,7 +54,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Request_life_cycle-Scheduling_a_container_request_life_cycle">
+ <section
id="sect-Reference_Guide-Request_life_cycle-Scheduling_a_container_request_life_cycle">
<title>Scheduling a container request life cycle</title>
<para>
Scheduling a container triggers the component request life cycle of all the
components that implement the interface
<envar>ComponentRequestLifeCycle</envar>. If one of the component has already
been scheduled before and then that component will not be scheduled again. When the local
value is true, then the looked components will be those of the container, when it is false
then the scheduler will also look at the components in the ancestor containers.
@@ -72,9 +72,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Request_life_cycle-When_request_life_cycle_is_triggered">
+ <section
id="sect-Reference_Guide-Request_life_cycle-When_request_life_cycle_is_triggered">
<title>When request life cycle is triggered</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-When_request_life_cycle_is_triggered-Portal_request_life_cycle">
+ <section
id="sect-Reference_Guide-When_request_life_cycle_is_triggered-Portal_request_life_cycle">
<title>Portal request life cycle</title>
<para>
Each portal request triggers the life cycle of the associated portal container.
@@ -82,7 +82,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-When_request_life_cycle_is_triggered-JMX_request_Life_Cycle">
+ <section
id="sect-Reference_Guide-When_request_life_cycle_is_triggered-JMX_request_Life_Cycle">
<title>JMX request Life Cycle</title>
<para>
When a JMX bean is invoked, the request life cycle of the container to which it
belongs it scheduled. Indeed JMX is an entry point of the system that may need component
to have a request life cycle triggered.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Specific_Services.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Specific_Services.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/Specific_Services.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,13 +1,13 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Specific_Services">
+<section id="sect-Reference_Guide-Specific_Services">
<title>Specific Services</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Specific_Services-ListenerService">
+ <section id="sect-Reference_Guide-Specific_Services-ListenerService">
<title>ListenerService</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-ListenerService-Asynchronous_Event_Broadcast">
+ <section
id="sect-Reference_Guide-ListenerService-Asynchronous_Event_Broadcast">
<title>Asynchronous Event Broadcast</title>
<para>
Basically, ListenerService used to store Listeners and broadcast events to them.
@@ -62,9 +62,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Specific_Services-Understanding_the_ListenerService">
+ <section
id="sect-Reference_Guide-Specific_Services-Understanding_the_ListenerService">
<title>Understanding the ListenerService</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Understanding_the_ListenerService-Objectives">
+ <section
id="sect-Reference_Guide-Understanding_the_ListenerService-Objectives">
<title>Objectives</title>
<para>
This article will first describe how the ListenerService works and then it will show
you how to configure the ListenerService.
@@ -72,7 +72,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Understanding_the_ListenerService-What_is_the_ListenerService_">
+ <section
id="sect-Reference_Guide-Understanding_the_ListenerService-What_is_the_ListenerService_">
<title>What is the ListenerService ?</title>
<para>
Inside eXo, an event mechanism allows to trigger and listen to events under specific
conditions. This mechanism is used in several places in eXo such as login/logout time.
@@ -80,12 +80,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Understanding_the_ListenerService-How_does_it_work">
+ <section
id="sect-Reference_Guide-Understanding_the_ListenerService-How_does_it_work">
<title>How does it work?</title>
<para>
Listeners must be subclasses of org.exoplatform.services.listener.Listener registered
by the ListenerService.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_does_it_work-Registering_a_listener">
+ <section
id="sect-Reference_Guide-How_does_it_work-Registering_a_listener">
<title>Registering a listener</title>
<para>
To register a listener, you need to call the addListener() method.
@@ -108,7 +108,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_does_it_work-Triggering_an_event">
+ <section
id="sect-Reference_Guide-How_does_it_work-Triggering_an_event">
<title>Triggering an event</title>
<para>
To trigger an event, an application can call one of the broadcast() methods of
ListenerService.
@@ -187,7 +187,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Understanding_the_ListenerService-How_to_configure_a_listener">
+ <section
id="sect-Reference_Guide-Understanding_the_ListenerService-How_to_configure_a_listener">
<title>How to configure a listener?</title>
<para>
All listeners are in fact a ComponentPlugin so it must be configured as below:
@@ -214,7 +214,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Understanding_the_ListenerService-Concrete_Example">
+ <section
id="sect-Reference_Guide-Understanding_the_ListenerService-Concrete_Example">
<title>Concrete Example</title>
<para>
The org.exoplatform.services.security.ConversationRegistry uses the ListenerService
to notify that a user has just signed in or just left the application. For example, when a
new user signs in, the following code is called:
@@ -253,9 +253,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Specific_Services-Job_Schedule">
+ <section id="sect-Reference_Guide-Specific_Services-Job_Schedule">
<title>Job Schedule</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Job_Schedule-What_is_Job_Scheduler">
+ <section
id="sect-Reference_Guide-Job_Schedule-What_is_Job_Scheduler">
<title>What is Job Scheduler?</title>
<para>
<emphasis role="bold">Job scheduler</emphasis> defines a job to
execute a given number of times during a given period. It is a service that is in charge
of unattended background executions, commonly known for historical reasons as batch
processing. It is used to create and run jobs automatically and continuously, to schedule
event-driven jobs and reports.
@@ -263,7 +263,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Job_Schedule-How_does_Job_Scheduler_work">
+ <section
id="sect-Reference_Guide-Job_Schedule-How_does_Job_Scheduler_work">
<title>How does Job Scheduler work?</title>
<para>
Jobs are scheduled to run when a given Trigger occurs. Triggers can be created with
nearly any combination of the following directives:
@@ -346,7 +346,7 @@
<para>
(Source:
quartz-scheduler.org)
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_does_Job_Scheduler_work-How_can_Job_Scheduler_Service_be_used_in_Kernel">
+ <section
id="sect-Reference_Guide-How_does_Job_Scheduler_work-How_can_Job_Scheduler_Service_be_used_in_Kernel">
<title>How can Job Scheduler Service be used in Kernel?</title>
<para>
Kernel leverages <ulink
url="http://www.quartz-scheduler.org">Quartz</ulink> for its scheduler
service and wraps <classname>org.quartz.Scheduler</classname> in
<classname>org.exoplatform.services.scheduler.impl.QuartzSheduler</classname>
for easier service wiring and configuration like any other services. To work with Quartz
in Kernel, you will mostly work with
<classname>org.exoplatform.services.scheduler.JobSchedulerService</classname>
(implemented by
<classname>org.exoplatform.services.scheduler.impl.JobSchedulerServiceImpl</classname>.
@@ -378,7 +378,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_does_Job_Scheduler_work-Samples">
+ <section
id="sect-Reference_Guide-How_does_Job_Scheduler_work-Samples">
<title>Samples</title>
<note>
<para>
@@ -459,7 +459,7 @@
<para>
eXo Kernel makes it easier to work with job scheduler service. All you need is just
to define your "job" class to be performed by implementing <emphasis
role="italic">org.quartz.Job</emphasis> interface and add configuration
for it.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Samples-Define_a_job">
+ <section id="sect-Reference_Guide-Samples-Define_a_job">
<title>Define a job</title>
<para>
To define a job, do as follows:
@@ -502,7 +502,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Samples-Job_configuration">
+ <section id="sect-Reference_Guide-Samples-Job_configuration">
<title>Job configuration</title>
<para>
After defining the "job", the only next step is to configure it by using
<emphasis role="italic">external-component-plugin</emphasis>
configuration for <emphasis
role="italic">org.exoplatform.services.scheduler.JobSchedulerService</emphasis>.
You can use these methods below for setting component plugin:
@@ -578,7 +578,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Samples-Run_the_project">
+ <section id="sect-Reference_Guide-Samples-Run_the_project">
<title>Run the project</title>
<para>
Create <emphasis role="italic">conf.portal</emphasis> package
in your sample project. Add the configuration.xml file with the content as follows:
@@ -639,7 +639,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Job_Schedule-Reference">
+ <section id="sect-Reference_Guide-Job_Schedule-Reference">
<title>Reference</title>
<para>
To further understand about Job Scheduler, you can refer the following links:
@@ -677,15 +677,15 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Specific_Services-The_data_source_provider">
+ <section
id="sect-Reference_Guide-Specific_Services-The_data_source_provider">
<title>The data source provider</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_data_source_provider-Description">
+ <section
id="sect-Reference_Guide-The_data_source_provider-Description">
<title>Description</title>
<para>
The <emphasis>DataSourceProvider</emphasis> is a service used to give
access to a data source in an uniform manner in order to be able to support data sources
that are managed by the application server.
</para>
<para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Description-List_methods">
+ <table id="tabl-Reference_Guide-Description-List_methods">
<title>List methods</title>
<tgroup cols="2">
<tbody>
@@ -718,7 +718,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_data_source_provider-Configuration">
+ <section
id="sect-Reference_Guide-The_data_source_provider-Configuration">
<title>Configuration</title>
<para>
The configuration of the <emphasis>DataSourceProvider</emphasis> should
be defined only if you use managed data sources since by default all the data sources are
considered as not managed. See below the default configuration
@@ -760,7 +760,7 @@
</component>
...
</configuration></programlisting>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Configuration-Fields_description">
+ <table id="tabl-Reference_Guide-Configuration-Fields_description">
<title>Fields description</title>
<tgroup cols="2">
<tbody>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/System_Properties.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/System_Properties.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations/System_Properties.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-System_property_configuration">
+<section id="sect-Reference_Guide-System_property_configuration">
<title>System property configuration</title>
<para>
A new property configurator service has been developed for taking care of configuring
system properties from the inline kernel configuration or from specified property files.
@@ -11,7 +11,7 @@
<para>
The services is scoped at the root container level because it is used by all the
services in the different portal containers in the application runtime.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-System_property_configuration-Properties_init_param">
+ <section
id="sect-Reference_Guide-System_property_configuration-Properties_init_param">
<title>Properties init param</title>
<para>
The properties init param takes a property declared to configure various properties.
@@ -30,7 +30,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-System_property_configuration-Properties_URL_init_param">
+ <section
id="sect-Reference_Guide-System_property_configuration-Properties_URL_init_param">
<title>Properties URL init param</title>
<para>
The properties URL init param allow to load an external file by specifying its URL.
Both property and XML format are supported, see the javadoc of the
<emphasis><envar>java.util.Properties</envar></emphasis> class for
more information. When a property file is loaded the various property declarations are
loaded in the order in which the properties are declared sequentially in the file.
@@ -56,7 +56,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-System_property_configuration-System_Property_configuration_of_the_properties_URL">
+ <section
id="sect-Reference_Guide-System_property_configuration-System_Property_configuration_of_the_properties_URL">
<title>System Property configuration of the properties URL</title>
<para>
It is possible to replace the properties URL init param by a system property that
overwrites it. The name of that property is
<emphasis>exo.properties.url</emphasis>.
@@ -64,7 +64,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-System_property_configuration-Variable_Syntaxes">
+ <section
id="sect-Reference_Guide-System_property_configuration-Variable_Syntaxes">
<title>Variable Syntaxes</title>
<para>
All the variables that we described in the previous sections can be defined thanks to
2 possible syntaxes which are <emphasis>${variable-name}</emphasis> or
<emphasis>${variable-name:default-value}</emphasis>. The first syntax
doesn't define any default value so if the variable has not be set the value will be
<emphasis>${variable-name}</emphasis> to indicate that it could not be
resolved. The second syntax allows you to define the default value after the semi colon so
if the variable has not be set the value will be the given default value.
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Foundations">
+<chapter id="chap-Reference_Guide-Foundations">
<title>Foundations</title>
<xi:include href="Foundations/Kernel.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Foundations/Config_Retrieval.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced.xml 2011-11-25 00:48:53
UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/Advanced.xml 2011-11-25 01:13:48
UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<part id="part-Reference_Guide_eXo_JCR_1.14-Advanced_Development">
+<part id="part-Reference_Guide-Advanced_Development">
<title>Advanced Development</title>
<xi:include href="Advanced/Foundations.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Accessing_User_Profile">
+<section id="sect-Reference_Guide-Accessing_User_Profile">
<title>Accessing User Profile</title>
<para>
The following code retrieves the details for a logged-in user:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration">
+<section id="sect-Reference_Guide-Authentication_Token_Configuration">
<title>Authentication Token Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration-The_Token_Service">
+ <section
id="sect-Reference_Guide-Authentication_Token_Configuration-The_Token_Service">
<title>The Token Service</title>
<para>
The <emphasis>Token Service</emphasis> is used in
authentication.
@@ -19,7 +19,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration-Implementing_the_Token_Service_API">
+ <section
id="sect-Reference_Guide-Authentication_Token_Configuration-Implementing_the_Token_Service_API">
<title>Implementing the Token Service API</title>
<para>
All token services used in JBoss Enterprise Portal Platform authentication
must be implemented by subclassing an <emphasis
role="bold">AbstractTokenService</emphasis> abstract class.
@@ -35,7 +35,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration-Configuring_Token_Services">
+ <section
id="sect-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services">
<title>Configuring Token Services</title>
<para>
Token services configuration includes specifying the token validity period.
The token service is configured as a portal component using the
<filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/autologin-configuration.xml</filename>
file.
@@ -51,27 +51,27 @@
</para>
<programlistingco>
<areaspec>
- <area coords="7 50"
id="area-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration-Configuring_Token_Services-name"
/>
- <area coords="8 50"
id="area-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration-Configuring_Token_Services-time"
/>
- <area coords="9 50"
id="area-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration-Configuring_Token_Services-unit"
/>
+ <area coords="7 50"
id="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-name"
/>
+ <area coords="8 50"
id="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-time"
/>
+ <area coords="9 50"
id="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-unit"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/Authentication_Identity_AuthenticationTokenConfiguration/default95.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration-Configuring_Token_Services-name">
+ <callout
arearefs="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-name">
<para>
Service name
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration-Configuring_Token_Services-time">
+ <callout
arearefs="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-time">
<para>
Amount of time
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Authentication_Token_Configuration-Configuring_Token_Services-unit">
+ <callout
arearefs="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-unit">
<para>
Unit of time
</para>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration">
+<section id="sect-Reference_Guide-PicketLink_IDM_integration">
<title>PicketLink IDM integration</title>
<para>
JBoss Enterprise Portal Platform uses the <literal>PicketLink
IDM</literal> component to store necessary identity information about users, groups
and memberships. While legacy interfaces are still used
(<literal>org.exoplatform.services.organization</literal>) for identity
management, there is a wrapper implementation that delegates to PicketLink IDM framework.
@@ -26,21 +26,21 @@
<para>
Additionally,
<literal>org.exoplatform.services.organization</literal>
<emphasis>membership</emphasis> concept needs to be translated into the IDM
<emphasis>Role</emphasis> concept. Therefore <literal>PicketLink
IDM</literal> model is used in a limited way. All these translations are applied by
the integration layer.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files">
+ <section
id="sect-Reference_Guide-PicketLink_IDM_integration-Configuration_Files">
<title>Configuration Files</title>
<para>
The main configuration file is
<filename>02portal.war/WEB-INF/conf/organization/idm-configuration.xml</filename>:
</para>
<programlistingco>
<areaspec>
- <area coords="6 90"
id="area-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files-JBossIDMServiceImpl"
/>
- <area coords="22 80"
id="area-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files-JBossIDMOrganizationServiceImpl"
/>
+ <area coords="6 90"
id="area-Reference_Guide-PicketLink_IDM_integration-Configuration_Files-JBossIDMServiceImpl"
/>
+ <area coords="22 80"
id="area-Reference_Guide-PicketLink_IDM_integration-Configuration_Files-JBossIDMOrganizationServiceImpl"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/Authentication_Identity_BackendConfiguration/default96.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files-JBossIDMServiceImpl">
+ <callout
arearefs="area-Reference_Guide-PicketLink_IDM_integration-Configuration_Files-JBossIDMServiceImpl">
<para>
The <emphasis
role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMServiceImpl</emphasis>
service has the following options:
</para>
@@ -141,7 +141,7 @@
</variablelist>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files-JBossIDMOrganizationServiceImpl">
+ <callout
arearefs="area-Reference_Guide-PicketLink_IDM_integration-Configuration_Files-JBossIDMOrganizationServiceImpl">
<para>
The <emphasis
role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMOrganizationServiceImpl</emphasis>
key is a main entrypoint implementing <emphasis
role="bold">org.exoplatform.services.organization.OrganizationService</emphasis>
and is dependent on <emphasis
role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMService</emphasis>
</para>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -4,7 +4,7 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14_eXo_JCR_1.14-LDAP_Integration">
+<section id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Integration">
<title>LDAP Integration</title>
<note>
<title>Notational Device</title>
@@ -102,7 +102,7 @@
These examples are in the
<filename><replaceable>ID_HOME</replaceable>/picketlink-idm/examples</filename>
directory and can be deployed in a testing environment to assist in configuring LDAP.
</para>
</note>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_Set_Up">
+ <procedure id="proc-Reference_Guide-LDAP_Integration-LDAP_Set_Up">
<title>LDAP Set Up</title>
<step>
<substeps>
@@ -267,13 +267,13 @@
</step>
</procedure>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode">
+ <section
id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode">
<title>LDAP in Read-only Mode</title>
<para>
This section will show you how to add LDAP in read-only mode. This means
that user data entries (both pre-existing, and newly added through the JBoss Enterprise
Portal Platform User Interface) will be consumed though the Directory Server and LDAP
services, but written to the underlying database. The only exception is that passwords
updated via the UI will also be propagated into the appropriate LDAP entry.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_mode-Set_up_LDAP_read-only_Mode">
+ <procedure
id="proc-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_mode-Set_up_LDAP_read-only_Mode">
<title>Set up LDAP read-only Mode</title>
<step>
<para>
@@ -297,22 +297,22 @@
<itemizedlist>
<listitem>
<para>
- <xref
linkend="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-RHDS_or_OpenDS"/>
+ <xref
linkend="proc-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-RHDS_or_OpenDS"/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-MSAD"/>
+ <xref
linkend="proc-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-MSAD"/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-OpenLDAP"/>
+ <xref
linkend="proc-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-OpenLDAP"/>
</para>
</listitem>
</itemizedlist>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-RHDS_or_OpenDS">
+ <procedure
id="proc-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-RHDS_or_OpenDS">
<title>Red Hat Directory Server or OpenDS</title>
<step>
<para>
@@ -338,17 +338,17 @@
</entry>
]]></programlisting>
<para>
- Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings"/>
for more information about how these <parameter>groupTypeMappings</parameter>
operate.
+ Refer to <xref
linkend="exam-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings"/>
for more information about how these <parameter>groupTypeMappings</parameter>
operate.
</para>
</step>
<step>
<para>
- Continue to <xref
linkend="step-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-Step-4"/>.
+ Continue to <xref
linkend="step-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-Step-4"/>.
</para>
</step>
</procedure>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-MSAD">
+ <procedure
id="proc-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-MSAD">
<title>Microsoft Active Directory</title>
<step>
<para>
@@ -369,21 +369,21 @@
</entry>
]]></programlisting>
<para>
- Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings"/>
for more information about how these <parameter>groupTypeMappings</parameter>
operate.
+ Refer to <xref
linkend="exam-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings"/>
for more information about how these <parameter>groupTypeMappings</parameter>
operate.
</para>
</step>
<step>
<para>
- Continue to <xref
linkend="step-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-Step-4"/>.
+ Continue to <xref
linkend="step-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-Step-4"/>.
</para>
</step>
</procedure>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-OpenLDAP">
+ <procedure
id="proc-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-OpenLDAP">
<title>OpenLDAP</title>
<step>
<para>
- If you have not done so already, install your LDAP
server. Refer to <xref
linkend="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_Set_Up"/>
for some assistance.
+ If you have not done so already, install your LDAP
server. Refer to <xref
linkend="proc-Reference_Guide-LDAP_Integration-LDAP_Set_Up"/> for some
assistance.
</para>
</step>
<step>
@@ -409,23 +409,23 @@
</entry>
]]></programlisting>
<para>
- Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings"/>
for more information about how these <parameter>groupTypeMappings</parameter>
operate.
+ Refer to <xref
linkend="exam-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings"/>
for more information about how these <parameter>groupTypeMappings</parameter>
operate.
</para>
</step>
<step>
<para>
- Continue to <xref
linkend="step-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-Step-4"/>.
+ Continue to <xref
linkend="step-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-Step-4"/>.
</para>
</step>
</procedure>
</step>
- <step
id="step-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-Step-4">
+ <step
id="step-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_Mode-Set_up_LDAP_read-only_Mode-Step-4">
<para>
To use a different LDAP server or directory data, edit the
DS-specific <filename>.xml</filename> file you uncommented in <emphasis
role="bold">Substep 3a</emphasis> above and change the values to suit
your requirements.
</para>
<para>
- Refer to the list in <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-LDAP_configuration_options"/>
for some examples or refer to the product-specific documentation for more information.
+ Refer to the list in <xref
linkend="exam-Reference_Guide-LDAP_Integration-Examples-LDAP_configuration_options"/>
for some examples or refer to the product-specific documentation for more information.
</para>
</step>
<step>
@@ -480,11 +480,11 @@
Users defined in LDAP should be visible in "<emphasis>Users and
groups management</emphasis>" and groups from LDAP should be present as
children of <emphasis>/acme/roles</emphasis> and
<emphasis>/acme/organization_units</emphasis>.
</para>
<para>
- More information about configuration can be found in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration"/> and
in the PicketLink project <ulink type="http"
url="http://anonsvn.jboss.org/repos/picketlink/idm/downloads/docs/1....
Guide</ulink>.
+ More information about configuration can be found in <xref
linkend="sect-Reference_Guide-PicketLink_IDM_integration"/> and in the
PicketLink project <ulink type="http"
url="http://anonsvn.jboss.org/repos/picketlink/idm/downloads/docs/1....
Guide</ulink>.
</para>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14_eXo_JCR_1.14-LDAP_Integration-LDAP_as_Default_Store">
+ <section
id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_as_Default_Store">
<title>LDAP as Default Store</title>
<para>
Follow the procedure below to set LDAP up as the default identity store
for JBoss Enterprise Portal Platform. All default accounts and some of groups that comes
with JBoss Enterprise Portal Platform will be created in the LDAP store.
@@ -492,11 +492,11 @@
<para>
The LDAP server will be configured to store part of the JBoss
Enterprise Portal Platform group tree. This means that groups under specified part of the
tree will be stored in directory server while all others will be stored in database.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store">
+ <procedure
id="proc-Reference_Guide-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store">
<title>Set up LDAP as Default Indentity Store</title>
<step>
<para>
- If you have not done so already, install your LDAP server. Refer
to <xref
linkend="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_Set_Up"/>
for some assistance.
+ If you have not done so already, install your LDAP server. Refer
to <xref linkend="proc-Reference_Guide-LDAP_Integration-LDAP_Set_Up"/> for
some assistance.
</para>
</step>
<step>
@@ -528,7 +528,7 @@
</step>
<step>
<para>
- Continue to <xref
linkend="step-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store-Step-5"/>
+ Continue to <xref
linkend="step-Reference_Guide-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store-Step-5"/>
</para>
</step>
</procedure>
@@ -568,7 +568,7 @@
</step>
<step>
<para>
- Continue to <xref
linkend="step-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store-Step-5"/>
+ Continue to <xref
linkend="step-Reference_Guide-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store-Step-5"/>
</para>
</step>
</procedure>
@@ -584,12 +584,12 @@
</step>
<step>
<para>
- Continue to <xref
linkend="step-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store-Step-5"/>
+ Continue to <xref
linkend="step-Reference_Guide-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store-Step-5"/>
</para>
</step>
</procedure>
</step>
- <step
id="step-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store-Step-5">
+ <step
id="step-Reference_Guide-LDAP_Integration-LDAP_as_Default_Store-Set_up_LDAP_as_Default_Indentity_Store-Step-5">
<para>
Uncomment the
<parameter>groupTypeMappings</parameter> under "<emphasis>Uncomment
for sample LDAP configuration</emphasis>":
</para>
@@ -603,7 +603,7 @@
</entry>
]]></programlisting>
<para>
- Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Default_groupTypeMappings"/>
for more information about how these <parameter>groupTypeMappings</parameter>
operate.
+ Refer to <xref
linkend="exam-Reference_Guide-LDAP_Integration-Examples-Default_groupTypeMappings"/>
for more information about how these <parameter>groupTypeMappings</parameter>
operate.
</para>
</step>
<step>
@@ -611,7 +611,7 @@
To use a different LDAP server or directory data, edit the
DS-specific <filename>.xml</filename> file you uncommented in <emphasis
role="bold">Step 4</emphasis> above and change the values to suit your
requirements.
</para>
<para>
- Refer to the list in <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-LDAP_configuration_options"/>
for some examples or refer to the product-specific documentation for more information.
+ Refer to the list in <xref
linkend="exam-Reference_Guide-LDAP_Integration-Examples-LDAP_configuration_options"/>
for some examples or refer to the product-specific documentation for more information.
</para>
</step>
<step>
@@ -627,9 +627,9 @@
</procedure>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14_eXo_JCR_1.14-LDAP_Integration-Examples">
+ <section
id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples">
<title>Examples</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-LDAP_configuration_options">
+ <example
id="exam-Reference_Guide-LDAP_Integration-Examples-LDAP_configuration_options">
<title>LDAP configuration</title>
<para>
The following settings are stored in the Picketlink configuration
file that is nominated in the <filename>idm-configuration.xml</filename> file
of your deployment (under the <parameter>config</parameter> parameter of the
<parameter>PicketLinkIDMService</parameter> component):
@@ -645,7 +645,7 @@
</listitem>
<listitem>
<para>
- One of the three example configuration files discussed in
<xref
linkend="proc-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-LDAP_in_Read-only_mode-Set_up_LDAP_read-only_Mode"/>:
+ One of the three example configuration files discussed in
<xref
linkend="proc-Reference_Guide-LDAP_Integration-LDAP_in_Read-only_mode-Set_up_LDAP_read-only_Mode"/>:
</para>
<simplelist>
<member><filename>picketlink-idm-ldap-acme-config.xml</filename></member>
@@ -756,7 +756,7 @@
Author [w/email]: Bolesław Dawidowicz (bdawidow(a)redhat.com), Jeff Yu
License: ??
-->
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings">
+ <example
id="exam-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings">
<title>Read Only groupTypeMappings</title>
<para>
The <parameter>groupTypeMappings</parameter> exposed
in the <filename>idm-configuration.xml</filename> file correspond to
<parameter>identity-object-type</parameter> values defined in the DS-specific
configuration file (referenced in <emphasis>Sub-step 3a</emphasis> of the
DS-specific procedure above).
@@ -766,22 +766,22 @@
</para>
<programlistingco>
<areaspec>
- <areaset
id="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-opends"
coords="">
- <area coords="10 40"
id="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-users-opends"
/>
- <area coords="14 40"
id="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-groups-opends"
/>
+ <areaset
id="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-opends"
coords="">
+ <area coords="10 40"
id="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-users-opends"
/>
+ <area coords="14 40"
id="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-groups-opends"
/>
</areaset>
- <area coords="17 40"
id="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-read-only-opends"
/>
+ <area coords="17 40"
id="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-read-only-opends"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/Authentication_Identity_LDAP/readonly-opends.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
<!--#1-->
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-opends">
+ <callout
arearefs="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-opends">
<para>
The PicketLink IDM configuration file dictates that
users and those two group types be stored in LDAP.
</para>
</callout>
<!--#2-->
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-read-only-opends">
+ <callout
arearefs="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-read-only-opends">
<para>
An additional option defines that nothing else (except
password updates) should be written there.
</para>
@@ -801,7 +801,7 @@
</para>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Default_groupTypeMappings">
+ <example
id="exam-Reference_Guide-LDAP_Integration-Examples-Default_groupTypeMappings">
<title>Default groupTypeMappings</title>
<para>
The <parameter>groupTypeMappings</parameter> exposed
in the <filename>idm-configuration.xml</filename> file correspond to
<parameter>identity-object-type</parameter> values defined in the DS-specific
configuration file (referenced in <emphasis>Sub-step 3a</emphasis> of the
DS-specific procedure above).
@@ -811,15 +811,15 @@
</para>
<programlistingco>
<areaspec>
- <areaset
id="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Default_groupTypeMappings-config"
coords="">
- <area coords="10 40"
id="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Default_groupTypeMappings-config-1"
/>
- <area coords="14 40"
id="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Default_groupTypeMappings-config-2"
/>
+ <areaset
id="area-Reference_Guide-LDAP_Integration-Examples-Default_groupTypeMappings-config"
coords="">
+ <area coords="10 40"
id="area-Reference_Guide-LDAP_Integration-Examples-Default_groupTypeMappings-config-1"
/>
+ <area coords="14 40"
id="area-Reference_Guide-LDAP_Integration-Examples-Default_groupTypeMappings-config-2"
/>
</areaset>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/Authentication_Identity_LDAP/default-ldap.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
<!--#1-->
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-LDAP_Integration-Examples-Default_groupTypeMappings-config">
+ <callout
arearefs="area-Reference_Guide-LDAP_Integration-Examples-Default_groupTypeMappings-config">
<para>
The
<parameter>groupTypeMappings</parameter> define that all groups under
<parameter>/platform</parameter> should be stored in PicketLink IDM with the
<parameter>platform_type</parameter> group type name and groups under
<parameter>/organization</parameter> should be stored in PicketLink IDM with
<parameter>organization_type</parameter> group type name.
</para>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Organization_API">
+<section id="sect-Reference_Guide-Organization_API">
<title>Organization API</title>
<para>
The <literal>exo.platform.services.organization</literal> package has five
main components:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Predefined_User_Configuration">
+<section id="sect-Reference_Guide-Predefined_User_Configuration">
<title>Predefined User Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Predefined_User_Configuration-Overview">
+ <section
id="sect-Reference_Guide-Predefined_User_Configuration-Overview">
<title>Overview</title>
<para>
The initial Organization configuration should be specified by editing the content of
<filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war:/WEB-INF/conf/organization/organization-configuration.xml</filename>.
This file uses the portal XML configuration schema. It lists several configuration
plug-ins.
@@ -13,7 +13,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Predefined_User_Configuration-Plugin_for_adding_users_groups_and_membership_types">
+ <section
id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_adding_users_groups_and_membership_types">
<title>Plugin for adding users, groups and membership types</title>
<para>
The plugin type
<literal>org.exoplatform.services.organization.OrganizationDatabaseInitializer</literal>
is used to specify a list of membership types, a list of groups and a list of users to be
created.
@@ -30,7 +30,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Predefined_User_Configuration-Membership_types">
+ <section
id="sect-Reference_Guide-Predefined_User_Configuration-Membership_types">
<title>Membership types</title>
<para>
The predefined membership types are specified in the <emphasis
role="bold">membershipType</emphasis> field of the <emphasis
role="bold">OrganizationConfig</emphasis> plugin parameter.
@@ -46,7 +46,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Predefined_User_Configuration-Groups">
+ <section
id="sect-Reference_Guide-Predefined_User_Configuration-Groups">
<title>Groups</title>
<para>
The predefined groups are specified in the <emphasis
role="bold">group</emphasis> field of the <emphasis
role="bold">OrganizationConfig</emphasis> plugin parameter.
@@ -62,7 +62,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Predefined_User_Configuration-Users">
+ <section
id="sect-Reference_Guide-Predefined_User_Configuration-Users">
<title>Users</title>
<para>
The predefined users are specified in the <emphasis
role="bold">user</emphasis> field of the <emphasis
role="bold">OrganizationConfig</emphasis> plugin parameter.
@@ -78,7 +78,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Predefined_User_Configuration-Plugin_for_managing_user_creation">
+ <section
id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_managing_user_creation">
<title>Plugin for managing user creation</title>
<para>
The plugin type
<literal>org.exoplatform.services.organization.impl.NewUserEventListener</literal>
specifies which groups all newly created users should become members of.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,12 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_">
+<section id="sect-Reference_Guide-SSO_Single_Sign_On_">
<title><remark>SSO - Single Sign On</remark>
</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-Overview">
+ <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Overview">
<title>Overview</title>
<para>
JBoss Enterprise Portal Platform provides an implementation of Single Sign On
(<literal>SSO</literal>) as an integration and aggregation platform.
@@ -23,25 +23,25 @@
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-Central_Authentication_Service"
/>
+ <xref
linkend="sect-Reference_Guide-SSO_Single_Sign_On_-Central_Authentication_Service"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-Java_Open_Single_Sign_On_Project"
/>
+ <xref
linkend="sect-Reference_Guide-SSO_Single_Sign_On_-Java_Open_Single_Sign_On_Project"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-OpenSSO" />
+ <xref
linkend="sect-Reference_Guide-SSO_Single_Sign_On_-OpenSSO" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism"
/>
+ <xref
linkend="sect-Reference_Guide-SSO_Single_Sign_On_-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism"
/>
</para>
</listitem>
@@ -72,7 +72,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-Enabling_SSO_using_JBoss_SSO_Valve">
+ <section
id="sect-Reference_Guide-SSO_Single_Sign_On_-Enabling_SSO_using_JBoss_SSO_Valve">
<title>Enabling SSO using JBoss SSO Valve</title>
<!-- Source Metadata
URL:
https://issues.jboss.org/browse/JBQA-4530
@@ -111,7 +111,7 @@
<para>
To successfully implement SSO integration, do the following:
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Enabling_SSO_using_JBoss_SSO_Valve-SSO_Integration">
+ <procedure
id="proc-Reference_Guide-Enabling_SSO_using_JBoss_SSO_Valve-SSO_Integration">
<title>SSO Integration</title>
<step>
<para>
@@ -170,14 +170,14 @@
</procedure>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Enabling_SSO_using_JBoss_SSO_Valve-Testing_SSO_in_a_physical_cluster">
+ <formalpara
id="form-Reference_Guide-Enabling_SSO_using_JBoss_SSO_Valve-Testing_SSO_in_a_physical_cluster">
<title>Testing SSO in a physical cluster</title>
<para>
In this example, we will try to simulate testing on more physical
machines by simply using virtual hosts on single machine.
</para>
</formalpara>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Enabling_SSO_using_JBoss_SSO_Valve-Testing_the_SSO_Valve">
+ <procedure
id="proc-Reference_Guide-Enabling_SSO_using_JBoss_SSO_Valve-Testing_the_SSO_Valve">
<title>Testing the SSO Valve</title>
<step>
<para>
@@ -261,7 +261,7 @@
</procedure>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Enabling_SSO_using_JBoss_SSO_Valve-Enabling_SSO_with_Other_Web_Applications">
+ <formalpara
id="form-Reference_Guide-Enabling_SSO_using_JBoss_SSO_Valve-Enabling_SSO_with_Other_Web_Applications">
<title>Enabling SSO with Other Web Applications</title>
<para>
As mentioned earlier, in order to use SSO authentication between JBoss
Enterprise Portal Platform instances and other web applications, the roles defined in the
web application must match those used in the portal instance (unless you have the
<parameter>requireReauthentication</parameter> parameter set to
<literal>true</literal>).
@@ -307,14 +307,14 @@
</procedure>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Enabling_SSO_using_JBoss_SSO_Valve-Testing_SSO_With_Other_Web_Applications">
+ <formalpara
id="form-Reference_Guide-Enabling_SSO_using_JBoss_SSO_Valve-Testing_SSO_With_Other_Web_Applications">
<title>Testing SSO With Other Web Applications</title>
<para>
To test that SSO authentication is enabled from portal instances to other
web applications (in this case, the JMX Console), do the following:
</para>
</formalpara>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Enabling_SSO_using_JBoss_SSO_Valve-Test_SSO_Between_Portal_and_JMX_Console">
+ <procedure
id="proc-Reference_Guide-Enabling_SSO_using_JBoss_SSO_Valve-Test_SSO_Between_Portal_and_JMX_Console">
<title>Test SSO Between Portal and JMX Console</title>
<step>
<para>
@@ -340,7 +340,7 @@
</procedure>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Enabling_SSO_using_JBoss_SSO_Valve-Using_SSO_to_Authenticate_From_the_Public_Page">
+ <formalpara
id="form-Reference_Guide-Enabling_SSO_using_JBoss_SSO_Valve-Using_SSO_to_Authenticate_From_the_Public_Page">
<title>Using SSO to Authenticate From the Public Page</title>
<para>
The previous configuration changes in this section are useful if a user
is using a secured URL (<ulink type="http"
url="http://localhost:8080/portal/private/classic" />, for example) to log in
to the portal instance.
@@ -353,7 +353,7 @@
<para>
To enable this functionality, the <guilabel>Sign In</guilabel>
link must redirect to some secured URL, which will ensure that JAAS authentication will be
enforced directly without showing login dialog.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Enabling_SSO_using_JBoss_SSO_Valve-Redirect_to_Use_SSO_Valve_Authentication">
+ <procedure
id="proc-Reference_Guide-Enabling_SSO_using_JBoss_SSO_Valve-Redirect_to_Use_SSO_Valve_Authentication">
<title>Redirect to Use SSO Valve Authentication</title>
<step>
<para>
@@ -391,7 +391,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-Central_Authentication_Service">
+ <section
id="sect-Reference_Guide-SSO_Single_Sign_On_-Central_Authentication_Service">
<title>Central Authentication Service</title>
<para>
This Single Sign On plugin enables seamless integration between JBoss
Enterprise Portal Platform and the Central Authentication Service (<emphasis
role="bold">CAS</emphasis>) Single Sign On Framework. Details about CAS
can be found <ulink
url="http://www.ja-sig.org/cas/"> here </ulink>
.
@@ -399,7 +399,7 @@
<para>
The integration consists of two parts; the first part consists of installing
or configuring a CAS server, the second part consists of setting up the portal to use the
CAS server.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Central_Authentication_Service-CAS_server">
+ <procedure
id="proc-Reference_Guide-Central_Authentication_Service-CAS_server">
<title>CAS server</title>
<step>
<para>
@@ -443,7 +443,7 @@
<para>
In order for the plugin to function correctly, it needs to be properly
configured to connect to this service. This configuration is controlled by the
<filename>cas.war/WEB-INF/deployerConfigContext.xml </filename> file.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Central_Authentication_Service-Modifying_CAS_server">
+ <procedure
id="proc-Reference_Guide-Central_Authentication_Service-Modifying_CAS_server">
<title>Modifying CAS server</title>
<step>
<para>
@@ -536,7 +536,7 @@
</programlisting>
</note>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Central_Authentication_Service-Setup_the_CAS_client">
+ <procedure
id="proc-Reference_Guide-Central_Authentication_Service-Setup_the_CAS_client">
<title>Setup the CAS client</title>
<step>
<para>
@@ -595,7 +595,7 @@
<para>
Information about where the CAS is hosted must be properly configured within
the JBoss Enterprise Portal Platform instance. The required configuration is done by
modifying three files.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Central_Authentication_Service-Redirect_to_CAS">
+ <procedure
id="proc-Reference_Guide-Central_Authentication_Service-Redirect_to_CAS">
<title>Redirect to CAS</title>
<step>
<para>
@@ -638,7 +638,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-Java_Open_Single_Sign_On_Project">
+ <section
id="sect-Reference_Guide-SSO_Single_Sign_On_-Java_Open_Single_Sign_On_Project">
<title>Java Open Single Sign-On Project</title>
<para>
This Single Sign On plugin enables seamless integration between JBoss
Enterprise Portal Platform and the Java Open Single Sign-On Project (<emphasis
role="bold">JOSSO</emphasis>) Single Sign On Framework. Details about
JOSSO can be found at <ulink url="http://www.josso.org">
www.josso.org
</ulink> .
@@ -646,7 +646,7 @@
<para>
This section details setting up the JOSSO server to authenticate against the
JBoss Enterprise Portal Platform login module.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Java_Open_Single_Sign_On_Project-JOSSO_server">
+ <procedure
id="proc-Reference_Guide-Java_Open_Single_Sign_On_Project-JOSSO_server">
<title>JOSSO server</title>
<step>
<para>
@@ -669,7 +669,7 @@
</procedure>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Java_Open_Single_Sign_On_Project-Modifying_JOSSO_server">
+ <procedure
id="proc-Reference_Guide-Java_Open_Single_Sign_On_Project-Modifying_JOSSO_server">
<title>Modifying JOSSO server</title>
<step>
<para>
@@ -730,7 +730,7 @@
</procedure>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Java_Open_Single_Sign_On_Project-Setup_the_JOSSO_client">
+ <procedure
id="proc-Reference_Guide-Java_Open_Single_Sign_On_Project-Setup_the_JOSSO_client">
<title>Setup the JOSSO client</title>
<step>
<para>
@@ -794,7 +794,7 @@
<para>
Information about where the JOSSO server is hosted must be properly
configured within the JBoss Enterprise Portal Platform instance. The required
configuration is done by modifying four files:
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Java_Open_Single_Sign_On_Project-Setup_the_portal_to_redirect_to_JOSSO">
+ <procedure
id="proc-Reference_Guide-Java_Open_Single_Sign_On_Project-Setup_the_portal_to_redirect_to_JOSSO">
<title>Setup the portal to redirect to JOSSO</title>
<step>
<para>
@@ -837,12 +837,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-OpenSSO">
+ <section id="sect-Reference_Guide-SSO_Single_Sign_On_-OpenSSO">
<title>OpenSSO</title>
<para>
This section details the setting up of OpenSSO server to authenticate against
the JBoss Enterprise Portal Platform login module.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-OpenSSO-Obtaining_OpenSSO">
+ <procedure id="proc-Reference_Guide-OpenSSO-Obtaining_OpenSSO">
<title>Obtaining OpenSSO</title>
<step>
<para>
@@ -871,7 +871,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-Modifying_the_OpenSSO_server">
+ <section
id="sect-Reference_Guide-SSO_Single_Sign_On_-Modifying_the_OpenSSO_server">
<title>Modifying the OpenSSO server</title>
<para>
To configure the web server as required, it is simpler to directly modify the
source files.
@@ -885,7 +885,7 @@
<para>
In order for the plugin to function correctly, it needs to be properly
configured to connect to this service. This configuration is done via the
<filename>opensso.war/config/auth/default/AuthenticationPlugin.xml</filename>
file.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Modifying_the_OpenSSO_server-Modifying_OpenSSO_server">
+ <procedure
id="proc-Reference_Guide-Modifying_the_OpenSSO_server-Modifying_OpenSSO_server">
<title>Modifying OpenSSO server</title>
<step>
<para>
@@ -971,7 +971,7 @@
</procedure>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Modifying_the_OpenSSO_server-Configure_the_gatein_realm">
+ <procedure
id="proc-Reference_Guide-Modifying_the_OpenSSO_server-Configure_the_gatein_realm">
<title>Configure the "gatein" realm</title>
<step>
<para>
@@ -1090,9 +1090,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-Setup_the_OpenSSO_Client">
+ <section
id="sect-Reference_Guide-SSO_Single_Sign_On_-Setup_the_OpenSSO_Client">
<title>Setup the OpenSSO Client</title>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Setup_the_OpenSSO_Client-Setup_the_OpenSSO_client">
+ <procedure
id="proc-Reference_Guide-Setup_the_OpenSSO_Client-Setup_the_OpenSSO_client">
<title>Setup the OpenSSO client</title>
<step>
<para>
@@ -1150,7 +1150,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-Setup_the_portal_to_redirect_to_OpenSSO">
+ <section
id="sect-Reference_Guide-SSO_Single_Sign_On_-Setup_the_portal_to_redirect_to_OpenSSO">
<title>Setup the portal to redirect to OpenSSO</title>
<para>
The next part of the process is to redirect all user authentication to the
OpenSSO server.
@@ -1158,7 +1158,7 @@
<para>
Information about where the OpenSSO server is hosted must be properly
configured within the Enterprise Portal Platform instance. The required configuration is
done by modifying three files:
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Setup_the_portal_to_redirect_to_OpenSSO-Setup_the_portal_to_redirect_to_OpenSSO">
+ <procedure
id="proc-Reference_Guide-Setup_the_portal_to_redirect_to_OpenSSO-Setup_the_portal_to_redirect_to_OpenSSO">
<title>Setup the portal to redirect to OpenSSO</title>
<step>
<para>
@@ -1201,7 +1201,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On_-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism">
+ <section
id="sect-Reference_Guide-SSO_Single_Sign_On_-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism">
<title>SPNEGO - Simple and Protected GSSAPI Negotiation
Mechanism</title>
<para>
The Simple and Protected GSSAPI Negotiation Mechanism (<emphasis
role="bold">SPNEGO</emphasis>) uses desktop credentials provided during
a desktop login to transparently authenticate a portal user through a web browser.
@@ -1243,7 +1243,7 @@
</procedure>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-SPNEGO_Server_Configuration">
+ <section
id="sect-Reference_Guide-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-SPNEGO_Server_Configuration">
<title>SPNEGO Server Configuration</title>
<para>
In this section, we will describe some necessary steps for setup Kerberos
server on Linux. This server will then be used for SPNEGO authentication against JBoss
Enterprise Portal Platform.
@@ -1251,14 +1251,14 @@
<note>
<title>SPNEGO Basics</title>
<para>
- The procedure below only describes the basic steps to configure the
SPNEGO server in a Linux environment. If you are already familiar with SPNEGO, or if you
are using Windows and Active Directory domain, you can jump to the <xref
linkend="proc-Reference_Guide_eXo_JCR_1.14-JBoss_Enterprise_Portal_Platform_Configuration-Advanced_SPNEGO_Configuration"
/> to see how to integrate SPNEGO with JBoss Enterprise Portal Platform.
+ The procedure below only describes the basic steps to configure the
SPNEGO server in a Linux environment. If you are already familiar with SPNEGO, or if you
are using Windows and Active Directory domain, you can jump to the <xref
linkend="proc-Reference_Guide-JBoss_Enterprise_Portal_Platform_Configuration-Advanced_SPNEGO_Configuration"
/> to see how to integrate SPNEGO with JBoss Enterprise Portal Platform.
</para>
<para>
Please note that Kerberos setup is also dependent on your Linux
distribution and so steps can be slightly different in your environment.
</para>
</note>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-SPNEGO_Server_Configuration-SPNEGO_Basics">
+ <procedure
id="proc-Reference_Guide-SPNEGO_Server_Configuration-SPNEGO_Basics">
<title>SPNEGO Basics</title>
<step>
<para>
@@ -1509,7 +1509,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-SPNEGO_Server_Configuration-Clients">
+ <section
id="sect-Reference_Guide-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-SPNEGO_Server_Configuration-Clients">
<title>Clients</title>
<para>
After performing all configurations above, you need to enable the
<emphasis role="bold">Negotiate authentication </emphasis> of
Firefox in client machines so that clients could be authenticated by JBoss Enterprise
Portal Platform as follows:
@@ -1547,12 +1547,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-JBoss_Enterprise_Portal_Platform_Configuration">
+ <section
id="sect-Reference_Guide-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-JBoss_Enterprise_Portal_Platform_Configuration">
<title>JBoss Enterprise Portal Platform Configuration</title>
<para>
JBoss Enterprise Portal Platform uses JBoss Negotiation to enable
SPNEGO-based desktop SSO for the portal. Here are the steps to integrate SPNEGO with JBoss
Enterprise Portal Platform.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-JBoss_Enterprise_Portal_Platform_Configuration-Advanced_SPNEGO_Configuration">
+ <procedure
id="proc-Reference_Guide-JBoss_Enterprise_Portal_Platform_Configuration-Advanced_SPNEGO_Configuration">
<title>Advanced SPNEGO Configuration</title>
<step>
<para>
@@ -1561,7 +1561,7 @@
<programlisting language="XML" role="XML"><xi:include
href="../../extras/Authentication_Identity_SSO/default124.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<para>
- The '<literal>keyTab</literal>' value should
point to the keytab file that was generated by the <literal>kadmin</literal>
Kerberos tool. When using Kerberos on Linux, it should be value of parameter <emphasis
role="bold">admin_keytab</emphasis> from kdc.conf file. See the
<xref
linkend="proc-Reference_Guide_eXo_JCR_1.14-SPNEGO_Server_Configuration-SPNEGO_Basics"
/> for more details.
+ The '<literal>keyTab</literal>' value should
point to the keytab file that was generated by the <literal>kadmin</literal>
Kerberos tool. When using Kerberos on Linux, it should be value of parameter <emphasis
role="bold">admin_keytab</emphasis> from kdc.conf file. See the
<xref
linkend="proc-Reference_Guide-SPNEGO_Server_Configuration-SPNEGO_Basics" />
for more details.
</para>
</step>
@@ -1654,7 +1654,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-JBoss_Enterprise_Portal_Platform_Configuration-Clients">
+ <section
id="sect-Reference_Guide-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism-JBoss_Enterprise_Portal_Platform_Configuration-Clients">
<title>Clients</title>
<para>
After performing all configurations above, you need to enable the
<emphasis role="bold">Negotiate authentication </emphasis> of
Firefox in clients so that clients can be authenticated by JBoss Enterprise Portal
Platform as follows:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Authentication_and_Identity">
+<chapter id="chap-Reference_Guide-Authentication_and_Identity">
<title>Authentication and Identity</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Authentication_and_Identity-Password_Encryption">
+ <section
id="sect-Reference_Guide-Authentication_and_Identity-Password_Encryption">
<title>Password Encryption</title>
<!-- The warning and first listitem below were relocated from
sect-Reference_Guide-Authentication_Token_Configuration as security and plain-text
password issues were being expanded on (from JBEPP-610) --> <warning>
<title>Username and passwords stored in clear text</title>
@@ -28,7 +28,7 @@
<para>
Passwords can be encoded prior to being saved to the JCR. This option requires
administrators to provide a custom subclass of
<parameter>org.exoplatform.web.security.security.AbstractCodec</parameter> and
set up a codec implementation with <parameter>CookieTokenService</parameter>:
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Password_Encryption-Encrypt_Password_in_JCR">
+ <procedure
id="proc-Reference_Guide-Password_Encryption-Encrypt_Password_in_JCR">
<title>Encrypt Password in JCR</title>
<step>
<para>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration/DatabaseConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration/DatabaseConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration/DatabaseConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Database_Configuration">
+<section id="sect-Reference_Guide-Database_Configuration">
<title>Database Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Configuration-Overview">
+ <section id="sect-Reference_Guide-Database_Configuration-Overview">
<title>Overview</title>
<para>
JBoss Enterprise Portal Platform has two different database dependencies. One is the
identity service configuration, which depends on Hibernate. The other is Java content
repository (JCR) service, which depends on JDBC API, and can integrate with any existing
datasource implementation.
@@ -19,7 +19,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Configuration-Configuring_the_database_for_JCR">
+ <section
id="sect-Reference_Guide-Database_Configuration-Configuring_the_database_for_JCR">
<title>Configuring the database for JCR</title>
<para>
To configure the database used by JCR you will need to edit the file:
@@ -75,7 +75,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Configuration-Configuring_the_database_for_the_default_identity_store">
+ <section
id="sect-Reference_Guide-Database_Configuration-Configuring_the_database_for_the_default_identity_store">
<title>Configuring the database for the default identity store</title>
<para>
By default, users are stored in a database. To change the database in which to store
users, you will need to edit the file:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration/EMailServiceConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration/EMailServiceConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration/EMailServiceConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-E_Mail_Service_Configuration">
+<section id="sect-Reference_Guide-E_Mail_Service_Configuration">
<title>E-Mail Service Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-E_Mail_Service_Configuration-Overview">
+ <section
id="sect-Reference_Guide-E_Mail_Service_Configuration-Overview">
<title>Overview</title>
<para>
JBoss Enterprise Portal Platform includes an e-mail sending service that needs to be
configured before it can function properly. This service, for instance, is used to send
e-mails to users who forgot their password or username.
@@ -13,7 +13,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-E_Mail_Service_Configuration-Configuring_the_outgoing_e_mail_account">
+ <section
id="sect-Reference_Guide-E_Mail_Service_Configuration-Configuring_the_outgoing_e_mail_account">
<title>Configuring the outgoing e-mail account</title>
<para>
The e-mail service can use any SMTP account configured in
<replaceable>JBOSS_AS</replaceable>/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties
(or
<replaceable>TOMCAT_HOME</replaceable>/gatein/conf/configuration.properties if
you are using Tomcat).
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/Configuration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Configuration">
+<chapter id="chap-Reference_Guide-Configuration">
<title>Configuration</title>
<xi:include href="Configuration/DatabaseConfiguration.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Configuration/EMailServiceConfiguration.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/Gadgets.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/Gadgets.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/Gadgets.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Concept">
+<section id="sect-Reference_Guide-Concept">
<title>Concept</title>
<para>
A gadget is a mini web application, embedded in a web page and running on an
application server platform. These small applications help users perform various tasks.
</para>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Concept-Basic_Usage">
+ <section id="sect-Reference_Guide-Concept-Basic_Usage">
<title>Basic Usage</title>
<para>
JBoss Enterprise Portal Platform includes a Todo gadget, Calendar gadget, Calculator
gadget and RSS Reader gadget by default. Many other, third-party gadgets are also
supported. Refer to the JBoss Enterprise Portal Platform User Guide at <ulink
type="http" url="http://docs.redhat.com" />for information about
obtaining and installing gadgets.
@@ -16,7 +16,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Concept-Existing_Gadgets">
+ <section id="sect-Reference_Guide-Concept-Existing_Gadgets">
<title>Existing Gadgets</title>
<mediaobject>
<imageobject role="html">
@@ -30,7 +30,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Concept-Create_a_new_Gadget">
+ <section id="sect-Reference_Guide-Concept-Create_a_new_Gadget">
<title>Create a new Gadget</title>
<mediaobject>
<imageobject role="html">
@@ -44,7 +44,7 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Concept-Remote_Gadget">
+ <section id="sect-Reference_Guide-Concept-Remote_Gadget">
<title>Remote Gadget</title>
<para>
This is the reference to a remote gadget (stock one).
@@ -61,7 +61,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Concept-Gadget_Importing">
+ <section id="sect-Reference_Guide-Concept-Gadget_Importing">
<title>Gadget Importing</title>
<para>
After referencing the gadget successfully, then import it into the local repository.
@@ -78,7 +78,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Concept-Gadget_Web_Editing">
+ <section id="sect-Reference_Guide-Concept-Gadget_Web_Editing">
<title>Gadget Web Editing</title>
<para>
Edit it from the Web the imported Gadget to modify it:
@@ -95,7 +95,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Concept-Gadget_IDE_Editing">
+ <section id="sect-Reference_Guide-Concept-Gadget_IDE_Editing">
<title>Gadget IDE Editing</title>
<para>
Edit it from your IDE thanks to the WebDAV protocol:
@@ -112,7 +112,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Concept-Dashboard_Viewing">
+ <section id="sect-Reference_Guide-Concept-Dashboard_Viewing">
<title>Dashboard Viewing</title>
<para>
View it from the Dashboard when you drag and drop the Gadget from listing to the
dashboard.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_Gadget_Administration">
+<section id="sect-Reference_Guide-Advanced_Gadget_Administration">
<title>Advanced Gadget Administration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_Gadget_Administration-Virtual_servers_for_gadget_rendering">
+ <section
id="sect-Reference_Guide-Advanced_Gadget_Administration-Virtual_servers_for_gadget_rendering">
<title>Virtual servers for gadget rendering</title>
<para>
JBoss Enterprise Portal Platform recommends using two virtual hosts for security. If
the gadget is running on a different domain than the container, it is unable to interfere
with the portal by modifying code or cookies.
@@ -28,9 +28,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_Gadget_Administration-Configuration">
+ <section
id="sect-Reference_Guide-Advanced_Gadget_Administration-Configuration">
<title>Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Security_key">
+ <section id="sect-Reference_Guide-Configuration-Security_key">
<title>Security key</title>
<para>
In JBoss Enterprise Portal Platform, the gadget container uses three security files
for authentication and authorization of gadgets:
@@ -85,7 +85,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Gadget_proxy_and_concat_configuration">
+ <section
id="sect-Reference_Guide-Configuration-Gadget_proxy_and_concat_configuration">
<title>Gadget proxy and concat configuration</title>
<para>
These servers have to be on the same domain as the gadget server. You can configure
the container in
<filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/eXoGadgetServer.war:/WEB-INF/classes/containers/default/container.js</filename>.
@@ -96,7 +96,7 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Proxy">
+ <section id="sect-Reference_Guide-Configuration-Proxy">
<title>Proxy</title>
<para>
To allow external gadgets when the server is behind a proxy, add the following code
to the beginning of the JVM:
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Gadgets">
+<chapter id="chap-Reference_Guide-Gadgets">
<title>Gadgets</title>
<xi:include href="GadgetDevelopment/Gadgets.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="GadgetDevelopment/SetupGadgetServer.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/Introduction.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/Introduction.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/Introduction.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Introduction">
+<chapter id="chap-Reference_Guide-Introduction">
<title>Introduction</title>
<para>
JBoss Enterprise Portal Platform is based on the GateIn project which is the merge of
two mature Java projects; JBoss Portal and eXo Portal. This new community project takes
the best of both offerings and incorporates them into a single portal framework. The aim
is to provide an intuitive user-friendly portal, and a framework to address the needs of
today's Web 2.0 applications.
@@ -23,8 +23,8 @@
<note>
<title>Notational Devices</title>
<para>
- Along with the <emphasis>Document Conventions</emphasis> outlined in the
<xref linkend="pref-Reference_Guide_eXo_JCR_1.14-Preface" />, this
document will also use the following notational devices:
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Introduction-Devices">
+ Along with the <emphasis>Document Conventions</emphasis> outlined in the
<xref linkend="pref-Reference_Guide-Preface" />, this document will also
use the following notational devices:
+ <variablelist id="vari-Reference_Guide-Introduction-Devices">
<title>Devices</title>
<varlistentry>
<term><replaceable><JBOSS_HOME></replaceable></term>
@@ -61,7 +61,7 @@
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Introduction-Related_Links">
+ <section id="sect-Reference_Guide-Introduction-Related_Links">
<title>Related Links</title>
<variablelist>
<varlistentry>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Data_Import_Strategy">
+<chapter id="chap-Reference_Guide-Data_Import_Strategy">
<title>Data Import Strategy</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Data_Import_Strategy-Introduction">
+ <section id="sect-Reference_Guide-Data_Import_Strategy-Introduction">
<title>Introduction</title>
<para>
In the Portal extension mechanism, developers can define an extension that Portal data
can be customized by configurations in the extension. There are several cases which an
extension developer wants to define how to customize the Portal data, for example
modifying, overwriting or just inserting a bit into the data defined by the portal.
Therefore, GateIn also defines several modes for each case and the only thing which a
developer has to do is to clarify the usecase and reasonably configure extensions.
@@ -16,7 +16,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Data_Import_Strategy-Import_Mode">
+ <section id="sect-Reference_Guide-Data_Import_Strategy-Import_Mode">
<title>Import Mode</title>
<para>
In this section, the following modes for the import strategy are introduced:
@@ -74,12 +74,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Data_Import_Strategy-Data_Import_Strategy">
+ <section
id="sect-Reference_Guide-Data_Import_Strategy-Data_Import_Strategy">
<title>Data Import Strategy</title>
<para>
The 'Portal Data' term which has been referred in the previous sections can be
classified into three types of object data: Portal Config, Page Data and Navigation Data;
each of which has some differences in the import strategy.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Data_Import_Strategy-Navigation_Data">
+ <section
id="sect-Reference_Guide-Data_Import_Strategy-Navigation_Data">
<title>Navigation Data</title>
<para>
The navigation data import strategy will be processed to the import mode level as the
followings:
@@ -187,7 +187,7 @@
<para>
For example, the <emphasis>navigation1</emphasis> is loaded before
<emphasis>navigation2</emphasis>. The Navigation Importer processes on two
navigation definitions, depending on the Import Mode defined in portal configuration.
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Navigation_Data-Import_Mode_Cases">
+ <variablelist
id="vari-Reference_Guide-Navigation_Data-Import_Mode_Cases">
<title>Import Mode Cases</title>
<varlistentry>
<term>Case 1: <literal>CONSERVE</literal></term>
@@ -261,7 +261,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Data_Import_Strategy-Portal_Config">
+ <section
id="sect-Reference_Guide-Data_Import_Strategy-Portal_Config">
<title>Portal Config</title>
<para>
PortalConfig defines the portal name, permission, layout and some properties of a
site. These information are configured in the <emphasis>portal.xml</emphasis>,
<emphasis>group.xml</emphasis> or <emphasis>user.xml</emphasis>,
depending on the site type. The PortalConfig importer performs a strategy that is based on
the mode defined in NewPortalConfigListener, including
<literal>CONSERVE</literal>, <literal>INSERT</literal>,
<literal>MERGE</literal> or <literal>OVERWRITE</literal>.
Let's see how the import mode affects in the process of portal data performance:
@@ -290,7 +290,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Data_Import_Strategy-Page_Data">
+ <section id="sect-Reference_Guide-Data_Import_Strategy-Page_Data">
<title>Page Data</title>
<para>
The import mode affects the page data import as the same as Portal Config.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Default_Portal_Configuration">
+<chapter id="chap-Reference_Guide-Default_Portal_Configuration">
<title>Default Portal Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Default_Portal_Configuration-Overview">
+ <section
id="sect-Reference_Guide-Default_Portal_Configuration-Overview">
<title>Overview</title>
<para>
JBoss Enterprise Portal Platform's default home page URL is
<literal>http://{hostname}:{port}/portal/</literal>. There may be multiple
independent portals deployed in parallel at any given time, each of which has its root
context (<literal>http://{hostname}:{port}/sample-portal/</literal>, for
example).
@@ -19,7 +19,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Default_Portal_Configuration-Configuration">
+ <section
id="sect-Reference_Guide-Default_Portal_Configuration-Configuration">
<title>Configuration</title>
<para>
The following example configuration can be found at:
"<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>".
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration">
+<chapter id="chap-Reference_Guide-Portal_Navigation_Configuration">
<title>Portal Navigation Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview">
+ <section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Overview">
<title>Overview</title>
<para>
There are three types of navigation available to portal users:
@@ -13,19 +13,19 @@
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation"
/>
+ <xref
linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Group_Navigation"
/>
+ <xref
linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-User_Navigation"
/>
+ <xref
linkend="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation"
/>
</para>
</listitem>
@@ -47,10 +47,10 @@
</para>
<programlistingco>
<areaspec>
- <area coords="5"
id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-predifinedOwner"
/>
- <area coords="10"
id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-ownerType"
/>
- <area coords="13"
id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-templateLocation"
/>
- <area coords="16"
id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-importMode"
/>
+ <area coords="5"
id="area-Reference_Guide-Portal_Navigation_Configuration-Overview-predifinedOwner"
/>
+ <area coords="10"
id="area-Reference_Guide-Portal_Navigation_Configuration-Overview-ownerType"
/>
+ <area coords="13"
id="area-Reference_Guide-Portal_Navigation_Configuration-Overview-templateLocation"
/>
+ <area coords="16"
id="area-Reference_Guide-Portal_Navigation_Configuration-Overview-importMode"
/>
</areaspec>
@@ -79,25 +79,25 @@
</programlistingco>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-predifinedOwner">
+ <callout
arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Overview-predifinedOwner">
<para>
<parameter>predefinedOwner</parameter> defines the
navigation owner, portal will look for the configuration files in folder with this name,
if there is no suitable folder, a default portal will be created with name is this value.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-ownerType">
+ <callout
arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Overview-ownerType">
<para>
<parameter>ownerType</parameter> define the type of
portal navigation. It may be a portal, group or user
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-templateLocation">
+ <callout
arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Overview-templateLocation">
<para>
<parameter>templateLocation</parameter> the classpath
where contains all portal configuration files
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-importMode">
+ <callout
arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Overview-importMode">
<para>
<parameter>importMode</parameter> The mode for navigation
import. There are 4 types of import mode:
</para>
@@ -144,7 +144,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation">
+ <section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation">
<title>Portal Navigation</title>
<!-- Updated based on Gatein revision 6987 --> <para>
The portal navigation incorporates the pages that can be accessed even when a
user is not logged in (assuming the applicable permissions allow public access). For
example; several portal navigations could be used when a company has multiple trademarks,
and websites are set up for each of them.
@@ -215,13 +215,13 @@
</para>
<programlistingco>
<areaspec>
- <area coords="9 40"
id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation-subpage"
/>
+ <area coords="9 40"
id="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation-subpage">
+ <callout
arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage">
<para>
This element defines the parent/child relationship
between a page and a subnode.
</para>
@@ -256,13 +256,13 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Group_Navigation">
+ <section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation">
<title>Group Navigation</title>
<para>
Group navigations are dynamically added to the user navigation at login. This
allows users to see the pages assigned to any groups they belong to in the menu.
</para>
<para>
- The group navigation menu is configured by two XML files
(<filename>navigation.xml</filename> and
<filename>pages.xml</filename>). The syntax used in these files is the same as
those covered in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation"
/>.
+ The group navigation menu is configured by two XML files
(<filename>navigation.xml</filename> and
<filename>pages.xml</filename>). The syntax used in these files is the same as
those covered in <xref
linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation"
/>.
</para>
<para>
They are located in
<filename>02portal.war/WEB-INF/conf/portal/group<replaceable>/group-name-path/</replaceable></filename>
directory (For example;
<filename>02portal.war/WEB-INF/conf/portal/group/platform/administrators/</filename>).
@@ -270,7 +270,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-User_Navigation">
+ <section
id="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation">
<title>User Navigation</title>
<para>
User navigation is the set of nodes and pages that are owned by a user. They
are part of the user's dashboard.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Portal_Default_Permission_Configuration">
+<chapter
id="chap-Reference_Guide-Portal_Default_Permission_Configuration">
<title>Portal Default Permission Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Default_Permission_Configuration-Overview">
+ <section
id="sect-Reference_Guide-Portal_Default_Permission_Configuration-Overview">
<title>Overview</title>
<para>
The default permission configuration for the portal is defined through the
<literal>org.exoplatform.portal.config.UserACL</literal> component
configuration in the
<filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>
file.
@@ -101,7 +101,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Default_Permission_Configuration-Overwrite_Portal_Default_Permissions">
+ <section
id="sect-Reference_Guide-Portal_Default_Permission_Configuration-Overwrite_Portal_Default_Permissions">
<title>Overwrite Portal Default Permissions</title>
<para>
When creating custom portals and portal extensions it is possible to override the
default configuration by using
<literal>org.exoplatform.portal.config.PortalACLPlugin</literal>, configuring
it as an external-plugin of
<literal>org.exoplatform.portal.config.UserACL</literal> service:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration">
+<chapter id="chap-Reference_Guide-Internationalization_Configuration">
<title>Internationalization Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Overview">
+ <section
id="sect-Reference_Guide-Internationalization_Configuration-Overview">
<title>Overview</title>
<note>
<title>Assumed Knowledge</title>
@@ -51,14 +51,14 @@
Property files have to be ISO 8859-1 encoded, while the XML file can
define its encoding. As a result it's easier for a human being to read a translation
in XML instead of having to decode and encode the property file.
</para>
<para>
- For more information refer to: <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-XML_Resources_Bundles" />
+ For more information refer to: <xref
linkend="chap-Reference_Guide-XML_Resources_Bundles" />
</para>
</note>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration">
+ <section
id="sect-Reference_Guide-Internationalization_Configuration-Locales_Configuration">
<title>Locales Configuration</title>
<para>
Various languages are available in the portal package. The configuration
below will define which languages are shown in the "<emphasis
role="bold">Change Language</emphasis>" section and made available
to users.
@@ -76,43 +76,43 @@
</para>
<programlistingco>
<areaspec>
- <area coords="4"
id="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-locale"
/>
- <area coords="5"
id="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-output-encoding"
/>
- <area coords="6"
id="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-input-encoding"
/>
- <area coords="7"
id="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-description"
/>
- <area coords="22"
id="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-orientation"
/>
+ <area coords="4"
id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-locale"
/>
+ <area coords="5"
id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-output-encoding"
/>
+ <area coords="6"
id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-input-encoding"
/>
+ <area coords="7"
id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-description"
/>
+ <area coords="22"
id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-orientation"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/PortalDevelopment_InternationalizationConfiguration/default150.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-locale">
+ <callout
arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-locale">
<para>
<emphasis>locale</emphasis>: The locale has to be
defined as per the codes defined <ulink type="http"
url="http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt"&g...;.
In this example "<emphasis>ar</emphasis>" is Arabic.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-output-encoding">
+ <callout
arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-output-encoding">
<para>
<emphasis>output-encoding</emphasis>: deals with
character encoding. It is recommended that <emphasis
role="bold">UTF-8</emphasis> be used.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-input-encoding">
+ <callout
arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-input-encoding">
<para>
<emphasis>input-encoding</emphasis>: In the Java
implementation, the encoding parameters will be used for the request response stream. The
input-encoding parameter will be used for request
<literal>setCharacterEncoding(..)</literal>.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-description">
+ <callout
arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-description">
<para>
<emphasis>description</emphasis>: A description of
the language
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration-orientation">
+ <callout
arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-orientation">
<para>
- <emphasis>orientation</emphasis>: Although the
default orientation of text and images is Left-To-Right, JBoss Enterprise Portal Platform
supports <emphasis role="bold">Right-To-Left</emphasis> orientation.
Modifying text orientation is explained in <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Right_To_Left_RTL_Framework" />.
+ <emphasis>orientation</emphasis>: Although the
default orientation of text and images is Left-To-Right, JBoss Enterprise Portal Platform
supports <emphasis role="bold">Right-To-Left</emphasis> orientation.
Modifying text orientation is explained in <xref
linkend="chap-Reference_Guide-Right_To_Left_RTL_Framework" />.
</para>
</callout>
@@ -124,27 +124,27 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-ResourceBundleService">
+ <section
id="sect-Reference_Guide-Internationalization_Configuration-ResourceBundleService">
<title>ResourceBundleService</title>
<para>
The resource bundle service is configured in:
<filename>02portal.war:/WEB-INF/conf/common/common-configuration.xml</filename>:
</para>
<programlistingco>
<areaspec>
- <area coords="6 60"
id="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-ResourceBundleService-classpath_resources"
/>
- <area coords="24 60"
id="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-ResourceBundleService-portal_resource_names"
/>
+ <area coords="6 60"
id="area-Reference_Guide-Internationalization_Configuration-ResourceBundleService-classpath_resources"
/>
+ <area coords="24 60"
id="area-Reference_Guide-Internationalization_Configuration-ResourceBundleService-portal_resource_names"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/PortalDevelopment_InternationalizationConfiguration/default151.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-ResourceBundleService-classpath_resources">
+ <callout
arearefs="area-Reference_Guide-Internationalization_Configuration-ResourceBundleService-classpath_resources">
<para>
<emphasis>classpath.resources</emphasis>: These are
discussed in a later section.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-ResourceBundleService-portal_resource_names">
+ <callout
arearefs="area-Reference_Guide-Internationalization_Configuration-ResourceBundleService-portal_resource_names">
<para>
<emphasis>portal.resource.names</emphasis>: Defines
all resources that belong to the <emphasis>Portal Resource Bundle</emphasis>.
</para>
@@ -161,7 +161,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Navigation_Resource_Bundles">
+ <section
id="sect-Reference_Guide-Internationalization_Configuration-Navigation_Resource_Bundles">
<title>Navigation Resource Bundles</title>
<para>
There is a resource bundle for each navigation. A navigation can exist for
user, groups, and portal.
@@ -189,7 +189,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Portlets">
+ <section
id="sect-Reference_Guide-Internationalization_Configuration-Portlets">
<title>Portlets</title>
<para>
Portlets are independent applications and deliver their own resource files.
@@ -197,7 +197,7 @@
<para>
All shipped portlet resources are located in the <emphasis
role="bold">locale/portlet</emphasis> subfolder. The
ResourceBundleService parameter <emphasis
role="bold">classpath.resources</emphasis> defines this subfolder.
<!-- Doing so the resource file that are in ~~locale/portlet~~ will never be
stored in the JCR and reloaded at each start of the application server. -->
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Portlets-To_add_a_Spanish_translation_to_the_GadgetPortlet">
+ <procedure
id="proc-Reference_Guide-Portlets-To_add_a_Spanish_translation_to_the_GadgetPortlet">
<title>To add a Spanish translation to the
<parameter>GadgetPortlet</parameter></title>
<step>
<para>
@@ -221,7 +221,7 @@
<para>
See the portlet specification for more details about portlet
internationalization.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portlets-Standard_Portlet_Resource_Keys">
+ <section
id="sect-Reference_Guide-Portlets-Standard_Portlet_Resource_Keys">
<title>Standard Portlet Resource Keys</title>
<para>
The portlet specification defines three standard keys:
<emphasis>Title</emphasis>, <emphasis>Short Title</emphasis> and
<emphasis>Keywords</emphasis>. Keywords is formatted as a comma-separated list
of tags.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Javascript_Configuration">
+<chapter id="chap-Reference_Guide-Javascript_Configuration">
<!-- This section removed as per instruction from Thomas Heute. ix:include
commented in PortalDevelopment.xml --> <title>Javascript
Configuration</title>
<para>
Managing Javascript scripts in an application like JBoss Enterprise Portal Platform is
a critical part of the configuration work. Configuring the scripts correctly will result
in a faster response time from the portal.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-JavaScript_Inter_Application_Communication">
+<chapter
id="chap-Reference_Guide-JavaScript_Inter_Application_Communication">
<title>JavaScript Inter Application Communication</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JavaScript_Inter_Application_Communication-Overview">
+ <section
id="sect-Reference_Guide-JavaScript_Inter_Application_Communication-Overview">
<title>Overview</title>
<para>
JavaScript Inter Application Communication is designed to allow applications within a
page to exchange data. This library is made for broadcasting messages on topic.
@@ -37,7 +37,7 @@
<para>
A subscription to a topic will receive any subtopic messages. For example, an
application subscribed to "<literal>/eXo/application</literal>" will
receive messages sent on the
"<literal>/eXo/application/map</literal>" topic. A message sent on
"<literal>/eXo</literal>", however, would not be received.
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Overview-Subscription_Topics">
+ <variablelist id="vari-Reference_Guide-Overview-Subscription_Topics">
<title>Subscription Topics</title>
<varlistentry>
<term>/eXo</term>
@@ -64,7 +64,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JavaScript_Inter_Application_Communication-Library">
+ <section
id="sect-Reference_Guide-JavaScript_Inter_Application_Communication-Library">
<title>Library</title>
<para>
The Inter Application Communication library is found in
<filename>01eXoResources.war:/javascript/eXo/core/Topic.js</filename>
@@ -74,7 +74,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JavaScript_Inter_Application_Communication-Syntax">
+ <section
id="sect-Reference_Guide-JavaScript_Inter_Application_Communication-Syntax">
<title>Syntax</title>
<para>
The three messaging functions require particular objects and definitions in their
syntax:
@@ -201,7 +201,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JavaScript_Inter_Application_Communication-Example_of_Javascript_events_usage">
+ <section
id="sect-Reference_Guide-JavaScript_Inter_Application_Communication-Example_of_Javascript_events_usage">
<title>Example of Javascript events usage</title>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/PortalDevelopment_JavascriptInterApplicationCommunication/default157.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Localization_Configuration">
+<chapter id="chap-Reference_Guide-Localization_Configuration">
<title>Localization Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Localization_Configuration-Pluggable_Locale_Policy">
+ <section
id="sect-Reference_Guide-Localization_Configuration-Pluggable_Locale_Policy">
<title>Pluggable Locale Policy</title>
<para>
Every request processed by every portlet is invoked within a context of the current
<literal>Locale</literal>.
@@ -25,7 +25,7 @@
<para>
As there is more than one way to determine the <literal>Locale</literal>
to be used for displaying a portal page, the mechanism for determining the current
<literal>Locale</literal> of the request is pluggable in JBoss Enterprise
Portal Platform, and the exact algorithm can be customized.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Pluggable_Locale_Policy-LocalePolicy_API">
+ <section
id="sect-Reference_Guide-Pluggable_Locale_Policy-LocalePolicy_API">
<title>LocalePolicy API</title>
<para>
Customization is achieved by using LocalePolicy API, which is a simple API consisting
of one interface, and one class:
@@ -61,7 +61,7 @@
The returned <literal>Locale</literal> has to be one of the locales
supported by portal, otherwise it will fall back to the portal default
<literal>Locale</literal>.
</para>
<para>
- The supported locales are listed in
<filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/locales-config.xml</filename>
file as described in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Internationalization_Configuration-Locales_Configuration"
/> .
+ The supported locales are listed in
<filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/locales-config.xml</filename>
file as described in <xref
linkend="sect-Reference_Guide-Internationalization_Configuration-Locales_Configuration"
/> .
</para>
<para>
The <literal>determineLocale()</literal> method takes a parameter of type
<literal>LocaleContextInfo</literal>, which represents a compilation of
preferred locales from different sources; user’s profile, portal default, browser language
settings, current session, browser cookie.
@@ -72,7 +72,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Pluggable_Locale_Policy-Default_LocalePolicy">
+ <section
id="sect-Reference_Guide-Pluggable_Locale_Policy-Default_LocalePolicy">
<title>Default <literal>LocalePolicy</literal></title>
<para>
By default,
<literal>org.exoplatform.portal.application.localization.DefaultLocalePolicyService</literal>,
an implementation of <literal>LocalePolicy</literal>, is installed to provide
the default behavior. This, however, can easily be extended and overridden. A completely
new implementation can also be written from scratch.
@@ -83,7 +83,7 @@
<para>
Here is an algorithm used for anonymous users.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Default_LocalePolicy-An_algorithm_for_anonymous_users">
+ <procedure
id="proc-Reference_Guide-Default_LocalePolicy-An_algorithm_for_anonymous_users">
<title>An algorithm for anonymous users</title>
<step>
<para>
@@ -151,7 +151,7 @@
<para>
The algorithm for logged-in users is virtually the same except that the first
<literal>Locale</literal> source checked is user's profile.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Default_LocalePolicy-An_algorithm_for_logged_in_users">
+ <procedure
id="proc-Reference_Guide-Default_LocalePolicy-An_algorithm_for_logged_in_users">
<title>An algorithm for logged-in users</title>
<step>
<para>
@@ -194,7 +194,7 @@
</step>
<step>
<para>
- Perform the rest of the steps in <xref
linkend="proc-Reference_Guide_eXo_JCR_1.14-Default_LocalePolicy-An_algorithm_for_anonymous_users"
/>.
+ Perform the rest of the steps in <xref
linkend="proc-Reference_Guide-Default_LocalePolicy-An_algorithm_for_anonymous_users"
/>.
</para>
</step>
@@ -204,7 +204,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Pluggable_Locale_Policy-Custom_LocalePolicy">
+ <section
id="sect-Reference_Guide-Pluggable_Locale_Policy-Custom_LocalePolicy">
<title>Custom <literal>LocalePolicy</literal></title>
<para>
The easiest way to customize the <literal>LocalePolicy</literal> is to
extend <literal>DefaultLocalePolicyService</literal>. A study of the source
code is required. JavaDocs provide thorough information on this.
@@ -234,7 +234,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Pluggable_Locale_Policy-LocalePolicy_Configuration">
+ <section
id="sect-Reference_Guide-Pluggable_Locale_Policy-LocalePolicy_Configuration">
<title>LocalePolicy Configuration</title>
<para>
The <literal>LocalePolicy</literal> framework is enabled for portlets by
configuring <literal>LocalizationLifecycle</literal> class in portal's
webui configuration file:
<filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/webui-configuration.xml</filename>:
@@ -266,7 +266,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Pluggable_Locale_Policy-Keeping_non_bridged_resources_in_sync_with_current_Locale">
+ <section
id="sect-Reference_Guide-Pluggable_Locale_Policy-Keeping_non_bridged_resources_in_sync_with_current_Locale">
<title>Keeping non-bridged resources in sync with current Locale</title>
<para>
All the resources in portals that are not portlets themselves, but are accessed
through portlets - reading data through <literal>PortletRequest</literal>, and
writing to <literal>PortletResponse</literal> - are referred to as
'bridged'. Any resources that are accessed directly, bypassing portal filters and
servlets, are referred to as 'non-bridged'.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Navigation_Controller_">
+<chapter id="chap-Reference_Guide-Navigation_Controller_">
<title>Navigation Controller </title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Navigation_Controller_-Description">
+ <section id="sect-Reference_Guide-Navigation_Controller_-Description">
<title>Description</title>
<para>
The navigation controller is a major enhancement of JBoss Enterprise Portal Platform
that has several goals:
@@ -34,9 +34,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Navigation_Controller_-Controller_in_Action">
+ <section
id="sect-Reference_Guide-Navigation_Controller_-Controller_in_Action">
<title>Controller in Action</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Controller_in_Action-Controller">
+ <section id="sect-Reference_Guide-Controller_in_Action-Controller">
<title>Controller</title>
<para>
The <application>WebAppController</application> is the component of JBoss
Enterprise Portal Platform that process <literal>http</literal> invocations
and transforms them into a portal request. It has been improved with the addition of a
request mapping engine (<emphasis role="bold">controller</emphasis>)
whose role is to make the decoupling of the <literal>http</literal> request
and create a portal request.
@@ -71,7 +71,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Controller_in_Action-Building_Controller">
+ <section
id="sect-Reference_Guide-Controller_in_Action-Building_Controller">
<title>Building Controller</title>
<para>
The controller configuration that contains the routing rules is loaded from a file
named <filename>controller.xml</filename> that is retrieved in the JBoss
Enterprise Portal Platform configuration directory. Its location is determined by the
<parameter>gatein.controller.config</parameter> property.
@@ -143,7 +143,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Controller_in_Action-Controller_Configuration_controller.xml">
+ <section
id="sect-Reference_Guide-Controller_in_Action-Controller_Configuration_controller.xml">
<title>Controller Configuration (controller.xml)</title>
<para>
Most of the controller configuration cares about defining rules (Routing table -
contains routes object) that will drive the resolution. Routes are processed during the
controller initialization to give a tree of node. Each node
@@ -166,7 +166,7 @@
<para>
A parameter is defined by a qualified name and there are three kind of parameters
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Controller_Configuration_controller.xml-_Route_parameters_">
+ <section
id="sect-Reference_Guide-Controller_Configuration_controller.xml-_Route_parameters_">
<title> <emphasis role="bold">Route parameters</emphasis>
</title>
<para>
Route parameters defines a fixed value associate with a qualified name.
@@ -218,7 +218,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Controller_Configuration_controller.xml-_Path_parameters_Regular_expression_support_">
+ <section
id="sect-Reference_Guide-Controller_Configuration_controller.xml-_Path_parameters_Regular_expression_support_">
<title> <emphasis role="bold">Path parameters - <emphasis
role="italic">Regular expression support</emphasis> </emphasis>
</title>
<para>
Path parameters allow to associate a portion of the request path with a parameter.
Such parameter will match any non empty portion of text except the <emphasis
role="bold">/</emphasis> character (that is the [^/]+ regular
expression) otherwise they can be associated with a regular expression for matching
specific patterns. Path parameters are mandatory for matching since they are part of the
request path, however it is allowed to write regular expression matching an empty value.
@@ -297,7 +297,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Controller_Configuration_controller.xml-Request_parameters">
+ <section
id="sect-Reference_Guide-Controller_Configuration_controller.xml-Request_parameters">
<title>Request parameters</title>
<para>
Request parameters are matched from the request parameters (GET or POST). The match
can be optional as their representation in the request allows it.
@@ -383,7 +383,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Controller_Configuration_controller.xml-Route_precedence">
+ <section
id="sect-Reference_Guide-Controller_Configuration_controller.xml-Route_precedence">
<title>Route precedence</title>
<para>
The order of route declaration is important as it influence how rules are matched.
Sometimes the same request could be matched by several routes and the routing table is
ambiguous.
@@ -407,7 +407,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Controller_Configuration_controller.xml-Route_nesting">
+ <section
id="sect-Reference_Guide-Controller_Configuration_controller.xml-Route_nesting">
<title>Route nesting</title>
<para>
Route nesting is possible and often desirable as it helps to
@@ -475,9 +475,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Navigation_Controller_-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework">
+ <section
id="sect-Reference_Guide-Navigation_Controller_-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework">
<title>Integrate to JBoss Enterprise Portal Platform WebUI
framework</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework-Routing">
+ <section
id="sect-Reference_Guide-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework-Routing">
<title>Routing</title>
<para>
JBoss Enterprise Portal Platform defines a set of parameters in its routing table,
for each client request, the mapping engine processes the request path and return the
defined parameters with their values as a Map<QualifiedName, String>
@@ -542,12 +542,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework-Rendering">
+ <section
id="sect-Reference_Guide-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework-Rendering">
<title>Rendering</title>
<para>
The <emphasis role="bold">controller</emphasis> is designed to
render a Map<QualifiedName, String> as an
<literal>http</literal> URL according to its routing table. But to integrate
it for using easily in WebUI Framework of JBoss Enterprise Portal Platform, we need some
more components
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Rendering-_PortalURL_">
+ <section id="sect-Reference_Guide-Rendering-_PortalURL_">
<title> <emphasis role="bold">PortalURL</emphasis>
</title>
<para>
<code>PortalURL</code> play a similar role at the portal level, its main
role is to abstract the creation of an URL for a resource managed by the portal.
@@ -642,7 +642,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Rendering-_Node_URL_">
+ <section id="sect-Reference_Guide-Rendering-_Node_URL_">
<title> <emphasis role="bold">Node URL</emphasis>
</title>
<para>
The class <code>NodeURL</code> is one of the subclass of
<code>PortalURL</code> that is specialized for navigation node resources:
@@ -679,7 +679,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Rendering-_Component_URL_">
+ <section id="sect-Reference_Guide-Rendering-_Component_URL_">
<title> <emphasis role="bold">Component URL</emphasis>
</title>
<para>
The <code>ComponentURL</code> subclass is another specialization of
<code>PortalURL</code> that allows the creation of WebUI components URLs.
<code>ComponentURL</code> is commonly used to trigger WebUI events from client
side:
@@ -695,7 +695,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Rendering-Portlet_URLs">
+ <section id="sect-Reference_Guide-Rendering-Portlet_URLs">
<title>Portlet URLs</title>
<para>
Portlet URLs API implementation delegates to the portal
<code>ComponentURL</code> (via the portlet container SPI). It is possible to
control the language in the URL from a <code>PortletURL</code> object by
setting a property named <code>gtn:lang</code>:
@@ -730,7 +730,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Rendering-Webui_URLBuilder_">
+ <section id="sect-Reference_Guide-Rendering-Webui_URLBuilder_">
<title>Webui <code>URLBuilder</code> </title>
<para>
This internal API for creating URL works as before and delegates to the
<code>PortletURL</code> API when the framework is executed in a portlet and to
a <code>ComponentURL</code> API when the framework is executed in the portal
context. The API has been modified to take in account the language in URL with two
properties on the builder:
@@ -753,7 +753,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Rendering-Groovy_Templates">
+ <section id="sect-Reference_Guide-Rendering-Groovy_Templates">
<title>Groovy Templates</title>
<para>
Within a Groovy template the mechanism is the same, however a splash of integration
has been done to make creation of NodeURL simpler. A closure is bound under the
<code>nodeurl</code> name and is available for invocation anytime. It will
simply create a NodeURL object and return it:
@@ -789,7 +789,7 @@
</section>
- <!-- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Navigation_Controller_-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x">
+ <!-- <section
id="sect-Reference_Guide-Navigation_Controller_-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x">
<title>Changes and migration from JBoss Enterprise Portal Platform
5</title>
<para>
The navigation controller implies a migration of the client code that is
coupled to several internal APIs of JBoss Enterprise Portal Platform. As far as we know
the major impact is related to anything dealing with URL:
@@ -812,7 +812,7 @@
<para>
There are also changes in the configuration, because there is a change of how
things are internally.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Migration_of_navigation_node_URL">
+ <section
id="sect-Reference_Guide-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Migration_of_navigation_node_URL">
<title>Migration of navigation node URL</title>
<para>
<emphasis role="bold">Using free form
node</emphasis>
@@ -853,7 +853,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Security_changes">
+ <section
id="sect-Reference_Guide-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Security_changes">
<title>Security changes</title>
<para>
Security configuration change in order to keep with the flexibility added
by the navigation controller. In particular the authentication does not depend anymore on
path specified in <code>web.xml</code> but instead rely on the security
mandated by the underlying resource. Here are the noticeable changes for security
@@ -891,7 +891,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Default_handler">
+ <section
id="sect-Reference_Guide-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Default_handler">
<title>Default handler</title>
<para>
Redirection to the default portal used to be done by the
<code>index.jsp</code> JSP page. This is not the case anymore, the index.jsp
has been removed and the welcome file in <code>web.xml</code> was removed too.
Instead a specific handler in the routing table has been configured, the sole role of this
handler is to redirect the request to default portal when no other request has been
matched previously:
@@ -910,7 +910,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Legacy_handler">
+ <section
id="sect-Reference_Guide-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Legacy_handler">
<title>Legacy handler</title>
<para>
Legacy URLs such as <code>/public/...</code> and
<code>/private/...</code> are now emulated to determine the best resource with
the same resolution algorithm than before but instead of displaying the page, will make an
<literal>http</literal> 302 redirection to the correct URL. This handler is
present in the controller configuration. There is a noticeable difference between the two
routes
@@ -933,7 +933,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Static_resource_handler">
+ <section
id="sect-Reference_Guide-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Static_resource_handler">
<title>Static resource handler</title>
<para>
The "/" mapping for "default" servlet is now replaced
by mapping for org.exoplatform.portal.application.PortalController servlet, that mean we
need a handler (<emphasis
role="bold">org.exoplatform.portal.application.StaticResourceRequestHandler</emphasis>)
to serve static resources like image, css or javascript... files in portal.war. And it
should be configured, and extended easily. Thanks to the controller.xml. This file can be
overridden and can be changed and reloaded at runtime (WebAppController is MBean with some
operations such as : reloadConfiguration() ...)
@@ -966,7 +966,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-portal.wars_web.xml_changes">
+ <section
id="sect-Reference_Guide-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-portal.wars_web.xml_changes">
<title>portal.war's web.xml changes</title>
<para>
DoLoginServlet declaration
@@ -1022,7 +1022,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Dashboard_changes">
+ <section
id="sect-Reference_Guide-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Dashboard_changes">
<title>Dashboard changes</title>
<para>
There are several important changes to take in account
@@ -1057,7 +1057,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Remove_unused_files">
+ <section
id="sect-Reference_Guide-Changes_and_migration_from_JBoss_Enterprise_Portal_Platform_3.1.x-Remove_unused_files">
<title>Remove unused files</title>
<para>
1/ portal-unavailable.jsp: this file was presented before if user goes to
a non-available portal. Now the server sends a 404 status code instead.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Portal_Life_cycle">
+<chapter id="chap-Reference_Guide-Portal_Life_cycle">
<title>Portal Life-cycle</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Life_cycle-Overview">
+ <section id="sect-Reference_Guide-Portal_Life_cycle-Overview">
<title>Overview</title>
<para>
This chapter describes the portal life-cycle from the application server start to its
stop including how requests are handled.
@@ -13,7 +13,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Life_cycle-Application_Server_start_and_stop">
+ <section
id="sect-Reference_Guide-Portal_Life_cycle-Application_Server_start_and_stop">
<title>Application Server start and stop</title>
<para>
A portal instance is simply a web application deployed as a
<literal>WAR</literal> in an application server. Portlets are also part of an
enhanced WAR called a portlet application.
@@ -81,7 +81,7 @@
}
}
</programlisting>
- --> <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Life_cycle-The_Command_Servlet">
+ --> <section
id="sect-Reference_Guide-Portal_Life_cycle-The_Command_Servlet">
<title>The Command Servlet</title>
<para>
The CommandServlet is called by the portlet container for requests to particular
portlets, it also includes some <literal>init</literal> code when the portal
is launched. This servlet
(<literal>org.gatein.wci.command.CommandServlet</literal>) is automatically
added during the deployment of each portlet application and mapped to
<literal>/gateinservlet</literal>.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Right_To_Left_RTL_Framework">
+<chapter id="chap-Reference_Guide-Right_To_Left_RTL_Framework">
<title>Right To Left (RTL) Framework</title>
<para>
The text orientation depends on the current locale setting. The orientation is a Java 5
enum that provides a set of functionalities:
@@ -19,7 +19,7 @@
</para>
<para>
In the case of a different context, it delegates to the parent context given the fact
that the root <literal>RequestContext</literal> is always a
<literal>PortalRequestContext</literal>.
- </para> --> <section
id="sect-Reference_Guide_eXo_JCR_1.14-Right_To_Left_RTL_Framework-Groovy_templates">
+ </para> --> <section
id="sect-Reference_Guide-Right_To_Left_RTL_Framework-Groovy_templates">
<title>Groovy templates</title>
<para>
Orientation is defined by implicit variables passed into the groovy binding context:
@@ -70,7 +70,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Right_To_Left_RTL_Framework-Stylesheet">
+ <section
id="sect-Reference_Guide-Right_To_Left_RTL_Framework-Stylesheet">
<title>Stylesheet</title>
<para>
The skin service handles stylesheet rewriting to accommodate the orientation.
@@ -87,7 +87,7 @@
<para>
In the example below we need to use the orientation to modify the float attribute that
will make the horizontal tabs either float on left or on right:
</para>
- <example id="exam-Reference_Guide_eXo_JCR_1.14-Stylesheet-Example_1">
+ <example id="exam-Reference_Guide-Stylesheet-Example_1">
<title>Example 1</title>
<programlisting language="Java" role="Java"><xi:include
href="../../extras/PortalDevelopment_RTLFramework/default173.java"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
@@ -106,7 +106,7 @@
<para>
In this example we need to modify the padding according to the orientation:
</para>
- <example id="exam-Reference_Guide_eXo_JCR_1.14-Stylesheet-Example_2">
+ <example id="exam-Reference_Guide-Stylesheet-Example_2">
<title>Example 2</title>
<programlisting language="Java" role="Java"><xi:include
href="../../extras/PortalDevelopment_RTLFramework/default176.java"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
@@ -125,7 +125,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Right_To_Left_RTL_Framework-Images">
+ <section id="sect-Reference_Guide-Right_To_Left_RTL_Framework-Images">
<title>Images</title>
<para>
Sometimes it is necessary to create an RT version of an image that will be used from a
template or from a stylesheet. However symmetric images can be automatically generated,
avoiding the necessity to create a mirrored version of an image and further maintenance
costs.
@@ -150,7 +150,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Right_To_Left_RTL_Framework-Client_Side_JavaScript">
+ <section
id="sect-Reference_Guide-Right_To_Left_RTL_Framework-Client_Side_JavaScript">
<title>Client Side JavaScript</title>
<para>
The <literal>eXo.core.I18n</literal> object provides the following
parameters for orientation:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal">
+<chapter id="chap-Reference_Guide-Skinning_the_Portal">
<title>Skinning the Portal</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-Overview">
+ <section id="sect-Reference_Guide-Skinning_the_Portal-Overview">
<title>Overview</title>
<para>
JBoss Enterprise Portal Platform provides robust skinning support for the
entire portal User Interface (UI). This includes support for skinning all of the common
portal elements as well as being able to provide custom skins and window decoration for
individual portlets. This has been designed with common graphic resource reuse and ease of
development in mind.
@@ -13,7 +13,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-Skin_Components">
+ <section
id="sect-Reference_Guide-Skinning_the_Portal-Skin_Components">
<title>Skin Components</title>
<para>
The skin of a page is composed of three separate parts:
@@ -87,9 +87,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-Skin_Selection">
+ <section
id="sect-Reference_Guide-Skinning_the_Portal-Skin_Selection">
<title>Skin Selection</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skin_Selection-Skin_Selection_Through_the_User_Interface">
+ <section
id="sect-Reference_Guide-Skin_Selection-Skin_Selection_Through_the_User_Interface">
<title>Skin Selection Through the User Interface</title>
<para>
A skin can be selected to be displayed to the user by multiple means. The
easiest way to change the skin is to select it through the user interface. An
administrator can change the default skin for the portal, or a logged in user can select
which skin they would prefer to be displayed.
@@ -100,7 +100,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skin_Selection-Setting_the_Default_Skin_within_the_Configuration_Files">
+ <section
id="sect-Reference_Guide-Skin_Selection-Setting_the_Default_Skin_within_the_Configuration_Files">
<title>Setting the Default Skin within the Configuration
Files</title>
<para>
The default skin can also be configured using the portal configuration
files. This allows the portal to have the new default skin ready for use when JBoss
Enterprise Portal Platform is first started.
@@ -119,7 +119,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-Skins_in_Page_Markups">
+ <section
id="sect-Reference_Guide-Skinning_the_Portal-Skins_in_Page_Markups">
<title>Skins in Page Markups</title>
<para>
A JBoss Enterprise Portal Platform skin contains CSS styles for the
portal's components but also shares components that may be reused in portlets. When
JBoss Enterprise Portal Platform generates a portal page markup, it inserts stylesheet
links in the page's <literal>head</literal> tag.
@@ -165,12 +165,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Skin_Service">
+ <section
id="sect-Reference_Guide-Skinning_the_Portal-The_Skin_Service">
<title>The Skin Service</title>
<para>
The skin service manages the various types of skins. It is responsible for
discovering and deploying skins into the portal.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_Skin_Service-Skin_configuration">
+ <section
id="sect-Reference_Guide-The_Skin_Service-Skin_configuration">
<title>Skin configuration</title>
<para>
JBoss Enterprise Portal Platform automatically discovers web archives
that contain a file descriptor for skins
(<filename>WEB-INF/gatein-resources.xml</filename>). This file is responsible
for specifying the portal, portlet and window decorators to be deployed into the skin
service.
@@ -186,7 +186,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_Skin_Service-Resource_Request_Filter">
+ <section
id="sect-Reference_Guide-The_Skin_Service-Resource_Request_Filter">
<title>Resource Request Filter</title>
<para>
Because of JBoss Enterprise Portal Platform's Right-To-Left support,
all CSS files need to be retrieved through a Servlet filter and the web application needs
to be configured to activate this filter. This is already done for
<literal>01eXoResources.war</literal> web application which contains the
default skin.
@@ -209,7 +209,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Default_Skin">
+ <section
id="sect-Reference_Guide-Skinning_the_Portal-The_Default_Skin">
<title>The Default Skin</title>
<para>
The default skin for JBoss Enterprise Portal Platform is located as part of
the <literal>01eXoResources.war</literal>. The main files associated with the
skin are:
@@ -243,34 +243,34 @@
</para>
<programlistingco>
<areaspec>
- <area coords="1"
id="area-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Default_Skin-uiportletapplication"
/>
- <area coords="2"
id="area-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Default_Skin-components"
/>
- <area coords="3"
id="area-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Default_Skin-portletthemes"
/>
- <area coords="4"
id="area-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Default_Skin-portlet"
/>
+ <area coords="1"
id="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-uiportletapplication"
/>
+ <area coords="2"
id="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-components" />
+ <area coords="3"
id="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-portletthemes"
/>
+ <area coords="4"
id="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-portlet" />
</areaspec>
<programlisting language="Java" role="Java"><xi:include
href="../../extras/PortalDevelopment_Skinning/default184.java"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Default_Skin-uiportletapplication">
+ <callout
arearefs="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-uiportletapplication">
<para>
The skin for the main portal page.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Default_Skin-components">
+ <callout
arearefs="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-components">
<para>
Skins for various portal components.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Default_Skin-portletthemes">
+ <callout
arearefs="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-portletthemes">
<para>
Window decoration skins.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-The_Default_Skin-portlet">
+ <callout
arearefs="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-portlet">
<para>
The portlet specification CSS classes.
</para>
@@ -305,14 +305,14 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-Creating_New_Skins">
+ <section
id="sect-Reference_Guide-Skinning_the_Portal-Creating_New_Skins">
<title>Creating New Skins</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Creating_New_Skins-Creating_a_New_Portal_Skin">
+ <section
id="sect-Reference_Guide-Creating_New_Skins-Creating_a_New_Portal_Skin">
<title>Creating a New Portal Skin</title>
<para>
New portal skins will need to be added to the portal through the skin
service. Therefore, the web application which contains the skins will need to be properly
configured for the skin service to discover them. This means properly configuring the
<literal>ResourceRequestFilter</literal> and
<filename>gatein-resources.xml</filename>.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Creating_a_New_Portal_Skin-Portal_Skin_Configuration">
+ <section
id="sect-Reference_Guide-Creating_a_New_Portal_Skin-Portal_Skin_Configuration">
<title>Portal Skin Configuration</title>
<para>
The <filename>gatein-resources.xml</filename> will need
to specify the new portal skin. This will include the name of the new skin, where to
locate its CSS stylesheet file and whether to overwrite an existing portal theme with the
same name.
@@ -332,7 +332,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Creating_a_New_Portal_Skin-Portal_Skin_Preview_Icon">
+ <section
id="sect-Reference_Guide-Creating_a_New_Portal_Skin-Portal_Skin_Preview_Icon">
<title>Portal Skin Preview Icon</title>
<para>
It is possible to see a preview of what the portal will look like
when selecting a new skin. This functionality relies on the current skin being updated
with skin icons for all other available skins. Otherwise it will not be able to show the
previews.
@@ -371,7 +371,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Creating_New_Skins-Creating_a_New_Window_Style">
+ <section
id="sect-Reference_Guide-Creating_New_Skins-Creating_a_New_Window_Style">
<title>Creating a New Window Style</title>
<para>
Window styles are the CSS applied to window decorations. An administrator
can decide which style of decoration should go around the window when they add a new
application or gadget to a page.
@@ -385,7 +385,7 @@
</imageobject>
</mediaobject>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Creating_a_New_Window_Style-Window_Style_Configuration">
+ <section
id="sect-Reference_Guide-Creating_a_New_Window_Style-Window_Style_Configuration">
<title>Window Style Configuration</title>
<para>
Window Styles are defined within a
<filename>gatein-resources.xml</filename> file which is used by the skin
service to deploy the window style into the portal. Window styles can belong in a window
style category. This category and the window styles will need to be specified in resources
file.
@@ -411,7 +411,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Creating_a_New_Window_Style-Window_Style_CSS">
+ <section
id="sect-Reference_Guide-Creating_a_New_Window_Style-Window_Style_CSS">
<title>Window Style CSS</title>
<para>
In order for the skin service to display the window decorators, it
must have CSS classes specifically named in relation to the window style name. The service
will try and display CSS based on this naming convention. The CSS class must be included
as part of the current portal skin for the window decorators to be displayed.
@@ -430,7 +430,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Creating_a_New_Window_Style-How_to_Set_the_Default_Window_Style">
+ <section
id="sect-Reference_Guide-Creating_a_New_Window_Style-How_to_Set_the_Default_Window_Style">
<title>How to Set the Default Window Style</title>
<para>
To set the default window style to be used for a portal you will need
to specify the CSS classes for a theme called
<literal>DefaultTheme</literal>.
@@ -448,7 +448,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Creating_New_Skins-How_to_Create_New_Portlet_Skins">
+ <section
id="sect-Reference_Guide-Creating_New_Skins-How_to_Create_New_Portlet_Skins">
<title>How to Create New Portlet Skins</title>
<para>
Portlets often require additional styles that may not be defined by the
portal skin. JBoss Enterprise Portal Platform allows portlets to define additional
stylesheets for each portlet and will append the corresponding
<literal>link</literal> tags to the <literal>head</literal>.
@@ -474,7 +474,7 @@
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_to_Create_New_Portlet_Skins-Change_Portlet_Icons">
+ <section
id="sect-Reference_Guide-How_to_Create_New_Portlet_Skins-Change_Portlet_Icons">
<title>Change Portlet Icons</title>
<para>
Each portlet can be registered by a unique icon in the portlet
registry or page editor. This icon can be changed by adding an image to the directory of
the portlet web application:
@@ -516,7 +516,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Creating_New_Skins-Create_New_Portlet_Specification_CSS_Classes">
+ <section
id="sect-Reference_Guide-Creating_New_Skins-Create_New_Portlet_Specification_CSS_Classes">
<title>Create New Portlet Specification CSS Classes</title>
<para>
The portlet specification defines a set of default CSS classes that
should be available for portlets. These classes are included as part of the portal skin.
Please see the portlet specification for a list of the default classes that should be
available.
@@ -530,9 +530,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Skinning_the_Portal-Tips_and_Tricks">
+ <section
id="sect-Reference_Guide-Skinning_the_Portal-Tips_and_Tricks">
<title>Tips and Tricks</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Tips_and_Tricks-Easier_CSS_Debugging">
+ <section
id="sect-Reference_Guide-Tips_and_Tricks-Easier_CSS_Debugging">
<title>Easier CSS Debugging</title>
<para>
By default, CSS files are cached and their imports are merged into a
single CSS file at the server side. This reduces the number of HTTP requests from the
browser to the server.
@@ -557,7 +557,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Tips_and_Tricks-Some_CSS_Techniques">
+ <section
id="sect-Reference_Guide-Tips_and_Tricks-Some_CSS_Techniques">
<title>Some CSS Techniques</title>
<para>
It is recommended that users have some experience with CSS before
studying JBoss Enterprise Portal Platform CSS.
@@ -565,7 +565,7 @@
<para>
JBoss Enterprise Portal Platform relies heavily on CSS to create the
layout and effects for the UI. Some common techniques for customizing JBoss Enterprise
Portal Platform CSS are explained below.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Some_CSS_Techniques-Border_Pattern">
+ <section
id="sect-Reference_Guide-Some_CSS_Techniques-Border_Pattern">
<title>Border Pattern</title>
<para>
The decorator is a pattern to create a contour or a curve around an
area. In order to achieve this effect you need to create nine cells. The
<literal>BODY</literal> is the central area that you want to decorate. The
other eight cells are distributed around the <literal>BODY</literal> cell. You
can use the width, height and background image properties to achieve any decoration effect
that you want.
@@ -581,7 +581,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Some_CSS_Techniques-Left_Margin_Left_Pattern">
+ <section
id="sect-Reference_Guide-Some_CSS_Techniques-Left_Margin_Left_Pattern">
<title>Left Margin Left Pattern</title>
<para>
Left margin left pattern is a technique to create two blocks side by
side. The left block will have a fixed size and the right block will take the rest of the
available space. When the user resizes the browser the added or removed space will be
taken from the right block.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-XML_Resources_Bundles">
+<chapter id="chap-Reference_Guide-XML_Resources_Bundles">
<title>XML Resources Bundles</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-XML_Resources_Bundles-Overview">
+ <section id="sect-Reference_Guide-XML_Resources_Bundles-Overview">
<title>Overview</title>
<para>
Resource bundles are usually stored in property files. However, as property files are
plain files, issues with the encoding of the file may arise. The XML resource bundle
format has been developed to provide an alternative to property files.
@@ -34,7 +34,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-XML_Resources_Bundles-XML_format">
+ <section id="sect-Reference_Guide-XML_Resources_Bundles-XML_format">
<title>XML format</title>
<para>
The XML format is very simple and has been developed based on the 'Don't
Repeat Yourself' (DRY) principle. Usually resource bundle keys are hierarchically
defined and we can leverage the hierarchic nature of the XML for that purpose. Here is an
example of turning a property file into an XML resource bundle file:
@@ -76,7 +76,7 @@
</bundle>]]></programlisting> -->
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-XML_Resources_Bundles-Portal_Support">
+ <section
id="sect-Reference_Guide-XML_Resources_Bundles-Portal_Support">
<title>Portal Support</title>
<para>
In order to be loaded by the portal at runtime (actually the resource bundle service),
the name of the file must be the same as a property file and it must use the <emphasis
role="bold">.xml</emphasis> suffix.
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<part id="part-Reference_Guide_eXo_JCR_1.14-Portal_Development">
+<part id="part-Reference_Guide-Portal_Development">
<title>Portal Development</title>
<xi:include href="PortalDevelopment/Skinning.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="PortalDevelopment/PortalLifecycle.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Shared_portlet.xml">
+<chapter id="chap-Reference_Guide-Shared_portlet.xml">
<title>Shared <filename>portlet.xml</filename></title>
<para>
The Java Portlet Specification introduces <literal>PortletFilter</literal>
as a standard approach to extend the behaviors of portlet objects. For example, a filter
can transform the content of portlet requests and portlet responses.
@@ -51,7 +51,7 @@
<para>
<emphasis role="bold">For JBoss</emphasis>: The file path is
<filename><replaceable><JBOSS_HOME></replaceable>/server/default/conf/gatein/portlet.xml</filename>.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Shared_portlet.xml-Global_Metadata_Elements">
+ <section
id="sect-Reference_Guide-Shared_portlet.xml-Global_Metadata_Elements">
<title>Global Metadata Elements</title>
<para>
The global <filename>portlet.xml</filename> file conforms, with some
restrictions, to the portlet deployment descriptor schema defined in the Portlet
Specification. In this file, the following elements are supported:
@@ -59,7 +59,7 @@
<orderedlist>
<listitem>
<para>
- <xref
linkend="form-Reference_Guide_eXo_JCR_1.14-Global_Metadata_Elements-Portlet_Filter"
/>
+ <xref
linkend="form-Reference_Guide-Global_Metadata_Elements-Portlet_Filter" />
</para>
</listitem>
@@ -77,7 +77,7 @@
</listitem>
</orderedlist>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Global_Metadata_Elements-Portlet_Filter">
+ <formalpara
id="form-Reference_Guide-Global_Metadata_Elements-Portlet_Filter">
<title>Portlet Filter</title>
<para>
Portlet filter mappings declared in the global
<filename>portlet.xml</filename> file are applied across portlet
applications.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Bridge_Configuration">
+<section id="sect-Reference_Guide-Bridge_Configuration">
<title>Bridge Configuration</title>
<para>
The 329 specification is aimed at making the developer's life as easy as possible
with JSF+Portlet development. You will see below that there are minimal settings to
getting any JSF web application up and running in the Portal environment.
@@ -11,9 +11,9 @@
<!-- Commented as Maven Archetypes section removed from gettingstarted.xml
<para>
If you are new to these concepts, we highly recommend you refer to <xref
linkend="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes"
/>.
- </para> --> <section
id="sect-Reference_Guide_eXo_JCR_1.14-Bridge_Configuration-Core_Setup_and_Configuration">
+ </para> --> <section
id="sect-Reference_Guide-Bridge_Configuration-Core_Setup_and_Configuration">
<title>Core Setup and Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Core_Setup_and_Configuration-portlet.xml">
+ <section
id="sect-Reference_Guide-Core_Setup_and_Configuration-portlet.xml">
<title>portlet.xml</title>
<para>
The basic JSR-329 portlet configuration.
@@ -31,7 +31,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Core_Setup_and_Configuration-faces_config.xml">
+ <section
id="sect-Reference_Guide-Core_Setup_and_Configuration-faces_config.xml">
<title>faces-config.xml</title>
<para>
The <parameter>PortletViewHandler</parameter> ensures that each JSF
portlet instance is properly namespaced.
@@ -41,18 +41,18 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Core_Setup_and_Configuration-Facelets_Configuration">
+ <section
id="sect-Reference_Guide-Core_Setup_and_Configuration-Facelets_Configuration">
<title>Facelets Configuration</title>
<para>
The following <filename>web.xml</filename> setting is only for
<literal>Facelets</literal> based applications
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Facelets_Configuration-web.xml">
+ <section id="sect-Reference_Guide-Facelets_Configuration-web.xml">
<title>web.xml</title>
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/PortletBridge_Configuration/default200.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/PortletBridge_Configuration/default201.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-web.xml-RenderPolicy_Options">
+ <variablelist
id="vari-Reference_Guide-web.xml-RenderPolicy_Options">
<title>RenderPolicy Options</title>
<varlistentry>
<term>ALWAYS_DELEGATE</term>
@@ -92,12 +92,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Core_Setup_and_Configuration-JSP_Only_Configuration">
+ <section
id="sect-Reference_Guide-Core_Setup_and_Configuration-JSP_Only_Configuration">
<title>JSP Only Configuration</title>
<para>
The following <filename>web.xml</filename> setting is only for JSP based
applications. Download the demonstration application <ulink
url="http://anonsvn.jboss.org/repos/portletbridge/trunk/examples/jsf...;.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JSP_Only_Configuration-web.xml">
+ <section id="sect-Reference_Guide-JSP_Only_Configuration-web.xml">
<title>web.xml</title>
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/PortletBridge_Configuration/default202.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
@@ -119,9 +119,9 @@
</section> -->
</section>
- <!-- End 301 core setup --> <section
id="sect-Reference_Guide_eXo_JCR_1.14-Bridge_Configuration-RichFaces_Setup_and_Configuration_Options">
+ <!-- End 301 core setup --> <section
id="sect-Reference_Guide-Bridge_Configuration-RichFaces_Setup_and_Configuration_Options">
<title>RichFaces Setup and Configuration Options</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-RichFaces_Setup_and_Configuration_Options-web.xml">
+ <section
id="sect-Reference_Guide-RichFaces_Setup_and_Configuration_Options-web.xml">
<title>web.xml</title>
<para>
The following configuration is designated for portlets using the
<application>RichFaces</application> library. These settings will vary based
on your individual needs.
@@ -153,7 +153,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-RichFaces_Setup_and_Configuration_Options-Configuration_needed_for_Richfaces_to_work_with_WSRP_and_PortletBridge">
+ <section
id="sect-Reference_Guide-RichFaces_Setup_and_Configuration_Options-Configuration_needed_for_Richfaces_to_work_with_WSRP_and_PortletBridge">
<!-- Content added from JBEPP-708 and JBQA-3999 -->
<title>Configuration needed for Richfaces to work with WSRP and
PortletBridge</title>
<para>
Use the following settings in <filename>web.xml</filename> when running
WSRP portlets:
@@ -187,7 +187,7 @@
<para>
The table below outlines the current status of RichFaces features when used in both
local and remote portlets.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Configuration_needed_for_Richfaces_to_work_with_WSRP_and_PortletBridge-RichFaces_Feature_Status">
+ <table
id="tabl-Reference_Guide-Configuration_needed_for_Richfaces_to_work_with_WSRP_and_PortletBridge-RichFaces_Feature_Status">
<title>RichFaces Feature Status</title>
<tgroup cols="3">
<thead>
@@ -893,9 +893,9 @@
</section> -->
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Bridge_Configuration-Seam_Setup_and_Configuration_Options">
+ <section
id="sect-Reference_Guide-Bridge_Configuration-Seam_Setup_and_Configuration_Options">
<title>Seam Setup and Configuration Options</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Seam_Setup_and_Configuration_Options-Configuration">
+ <section
id="sect-Reference_Guide-Seam_Setup_and_Configuration_Options-Configuration">
<title>Configuration</title>
<para>
The <literal>ExceptionHandler</literal> is used to clean
<application>Seam</application> contexts and transactions after errors.
@@ -913,7 +913,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Bridge_Configuration-Portlet_2.0_Coordination">
+ <section
id="sect-Reference_Guide-Bridge_Configuration-Portlet_2.0_Coordination">
<title>Portlet 2.0 Coordination</title>
<note>
<title>Schema and XSD Definitions</title>
@@ -924,9 +924,9 @@
</note>
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/PortletBridge_Configuration/default209.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portlet_2.0_Coordination-Sending_and_Receiving_Events">
+ <section
id="sect-Reference_Guide-Portlet_2.0_Coordination-Sending_and_Receiving_Events">
<title>Sending and Receiving Events</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Sending_and_Receiving_Events-Configuration">
+ <section
id="sect-Reference_Guide-Sending_and_Receiving_Events-Configuration">
<title>Configuration</title>
<para>
Just like with any portlet 2.0 event consumer and receiver, you must define them in
the <filename>portlet.xml</filename>.
@@ -955,9 +955,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portlet_2.0_Coordination-Public_Render_Parameters">
+ <section
id="sect-Reference_Guide-Portlet_2.0_Coordination-Public_Render_Parameters">
<title>Public Render Parameters</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Public_Render_Parameters-Configuration">
+ <section
id="sect-Reference_Guide-Public_Render_Parameters-Configuration">
<title>Configuration</title>
<para>
Public Render Parameters (or PRPs) are one of the most powerful and simple Portlet
2.0 features. Several portlets (JSF or otherwise) can share the same render parameters.
This feature can be used to present a cohesive UI to the user across all portlets on the
page. An example would be using an employee ID to display relative data.
@@ -994,9 +994,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portlet_2.0_Coordination-Serving_Your_JSF_Resources_in_a_Portlet">
+ <section
id="sect-Reference_Guide-Portlet_2.0_Coordination-Serving_Your_JSF_Resources_in_a_Portlet">
<title>Serving Your JSF Resources in a Portlet</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Serving_Your_JSF_Resources_in_a_Portlet-Configuration">
+ <section
id="sect-Reference_Guide-Serving_Your_JSF_Resources_in_a_Portlet-Configuration">
<title>Configuration</title>
<para>
We have setup a few examples to show you how to use
<literal>EL</literal> and a simple bean that will allow you to use the portlet
resource serving mechanism within a JSF portlet.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,16 +1,16 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Getting_started_with_JBoss_Portlet_Bridge">
+<section
id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge">
<title>Getting started with JBoss Portlet Bridge</title>
<para>
JBoss Portlet Bridge not only gives you the ability to run JSF web applications in a
portlet, but also gives you the benefit of running supported JBoss frameworks like
<application>Seam</application> and
<application>RichFaces</application>.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Getting_started_with_JBoss_Portlet_Bridge-Whats_New_in_2.0">
+ <section
id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Whats_New_in_2.0">
<title>What's New in 2.0?</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Whats_New_in_2.0-Eventing">
+ <section id="sect-Reference_Guide-Whats_New_in_2.0-Eventing">
<title>Eventing</title>
<para>
The bridge considers a portlet event a model event. The event is targeted to the
applications data model, not its view.
@@ -22,12 +22,12 @@
Since event payloads are arbitrarily complex, the manual processing of the data,
though managed by the bridge, is left to the (portlet) application to support.
</para>
<para>
- See <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Portlet_2.0_Coordination-Sending_and_Receiving_Events"
/> for details and examples.
+ See <xref
linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Sending_and_Receiving_Events"
/> for details and examples.
</para>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Whats_New_in_2.0-Portlet_Served_Resources">
+ <section
id="sect-Reference_Guide-Whats_New_in_2.0-Portlet_Served_Resources">
<title>Portlet Served Resources</title>
<para>
The bridge deals with portlet served resources in one of two ways:
@@ -39,12 +39,12 @@
If the request is for a JSF resource, the bridge runs the full JSF life-cycle
ensuring that data is processed and the resource (markup) is rendered.
</para>
<para>
- See <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Portlet_2.0_Coordination-Serving_Your_JSF_Resources_in_a_Portlet"
/> for details and examples.
+ See <xref
linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Serving_Your_JSF_Resources_in_a_Portlet"
/> for details and examples.
</para>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Whats_New_in_2.0-Public_Render_Parameters">
+ <section
id="sect-Reference_Guide-Whats_New_in_2.0-Public_Render_Parameters">
<title>Public Render Parameters</title>
<para>
The bridge automates the processing of public render parameters.
@@ -59,7 +59,7 @@
At the end of a request, if the current value of any mapped public render parameter
doesn't match the current incoming value, the bridge sets the new value in an outgoing
public render parameter (if feasible in the given phase).
</para>
<para>
- See <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Portlet_2.0_Coordination-Public_Render_Parameters"
/> for details and examples.
+ See <xref
linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Public_Render_Parameters"
/> for details and examples.
</para>
</section>
@@ -67,10 +67,10 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Getting_started_with_JBoss_Portlet_Bridge-Bridge_Frameworks_and_Extensions">
+ <section
id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Bridge_Frameworks_and_Extensions">
<title>Bridge Frameworks and Extensions</title>
<para>
- The JBoss Portlet Bridge currently supports JBoss Enterprise Portal Platform,
<application>GateIn</application>, <application>JSF
1.2</application>, <application>JBoss Seam</application>, and
<application>JBoss Richfaces</application>. There are configurations that
apply to supporting each framework. See section <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Bridge_Configuration" /> for
instructions.
+ The JBoss Portlet Bridge currently supports JBoss Enterprise Portal Platform,
<application>GateIn</application>, <application>JSF
1.2</application>, <application>JBoss Seam</application>, and
<application>JBoss Richfaces</application>. There are configurations that
apply to supporting each framework. See section <xref
linkend="sect-Reference_Guide-Bridge_Configuration" /> for instructions.
</para>
<para>
The JBoss Portlet Bridge project is also actively developing extensions called
"<emphasis role="bold">Bridgelets</emphasis>".
@@ -78,7 +78,7 @@
<para>
In this release it was decided to bring all available bridgelets into the impl code
base since they are critical in most JSF portlet applications. A single line of
configuration utilizes these features.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Bridge_Frameworks_and_Extensions-Seam_Bridgelets">
+ <section
id="sect-Reference_Guide-Bridge_Frameworks_and_Extensions-Seam_Bridgelets">
<title>Seam Bridgelets</title>
<para>
For example, the <literal>PortalIdentity</literal>
<application>Seam</application> component allows you to instantly have Single
Sign-On (SSO) between <application>Seam</application> and
<application>GateIn</application> or <application>JBoss Enterprise
Portal Platform</application>.
@@ -91,7 +91,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Bridge_Frameworks_and_Extensions-RichFaces_Bridgelets">
+ <section
id="sect-Reference_Guide-Bridge_Frameworks_and_Extensions-RichFaces_Bridgelets">
<title>RichFaces Bridgelets</title>
<para>
<application>Richfaces</application> does not account for multiple
components on the same portal page by default. This following
<filename>web.xml</filename> renders all
<application>RichFaces</application> component javascript portal-friendly.
@@ -104,7 +104,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Getting_started_with_JBoss_Portlet_Bridge-Before_You_Start">
+ <section
id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Before_You_Start">
<title>Before You Start</title>
<para>
The embedded version in the JBoss Enterprise Portal Platform is made to be compatible
with the JSF implementation, portal and application server that compose the product. You
will find the binaries embedded in
<filename>jboss-epp-<VERSION>/portletbridge</filename>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/overview.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/overview.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/overview.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-JBoss_Portlet_Bridge_Overview">
+<section id="sect-Reference_Guide-JBoss_Portlet_Bridge_Overview">
<title>JBoss Portlet Bridge Overview</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-JBoss_Portlet_Bridge_Overview-What_is_the_JBoss_Portlet_Bridge">
+ <formalpara
id="form-Reference_Guide-JBoss_Portlet_Bridge_Overview-What_is_the_JBoss_Portlet_Bridge">
<title>What is the JBoss Portlet Bridge?</title>
<para>
The JBoss Portlet Bridge (or <literal>JBPB</literal> for short) is a
non-final implementation of the <ulink
url="http://jcp.org/en/jsr/detail?id=329">JSR-329</ulink>
specification.
@@ -21,7 +21,7 @@
<para>
Find more information about the JBoss Portlet Bridge, the developers, the community at
<ulink
url="http://www.jboss.org/portletbridge/">the project
page</ulink>.
</para>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-JBoss_Portlet_Bridge_Overview-Understanding_how_JSF_works_with_Portal">
+ <formalpara
id="form-Reference_Guide-JBoss_Portlet_Bridge_Overview-Understanding_how_JSF_works_with_Portal">
<title>Understanding how JSF works with Portal</title>
<para>
The portlet bridge is not a portlet. It is the mediator between the two environments
and allows JSF and Portal to be completely unaware of each other.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge">
+<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge">
<title>Developing Portlets with the Bridge</title>
<para>
This chapter demonstrates common development tasks described by the 329 specification.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-Excluding_Attributes_from_the_Bridge_Request_Scope">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Excluding_Attributes_from_the_Bridge_Request_Scope">
<title>Excluding Attributes from the Bridge Request Scope</title>
<para>
When your application uses request attributes on a per request basis and you do not
want that particular attribute to be managed in the extended bridge request scope, you
must use the following configuration in your
<filename>faces-config.xml</filename>.
@@ -21,7 +21,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-Supporting_PortletMode_Changes">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Supporting_PortletMode_Changes">
<title>Supporting PortletMode Changes</title>
<para>
A <literal>PortletMode</literal> represents a distinct render path within
an application. There are three standard modes: <emphasis>view</emphasis>,
<emphasis>edit</emphasis>, and <emphasis>help</emphasis>.
@@ -37,7 +37,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-Navigating_to_a_modes_last_viewId">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Navigating_to_a_modes_last_viewId">
<title>Navigating to a mode's last viewId</title>
<para>
By default a mode change will start in the mode's default view without any (prior)
existing state. One common portlet pattern when returning to a mode left after entering
another mode (e.g.. view -> edit -> view) is to return to the last view (and
state) of this origin mode.
@@ -53,7 +53,7 @@
</para>
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/PortletBridge_Portlet_Development/default225.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Navigating_to_a_modes_last_viewId-Note_to_Portlet_Developers">
+ <section
id="sect-Reference_Guide-Navigating_to_a_modes_last_viewId-Note_to_Portlet_Developers">
<title>Note to Portlet Developers</title>
<para>
Depending on the bridge implementation, when using values from these session scoped
attributes or any viewIds which may contain query string parameters it may be necessary to
use the wild-card syntax when identifying the rule target. In the above, for example, the
@@ -89,7 +89,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-Clearing_The_View_History_When_Changing_Portlet_Modes">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Clearing_The_View_History_When_Changing_Portlet_Modes">
<title>Clearing The View History When Changing Portlet Modes</title>
<para>
By default the bridge remembers the view history when you switch to a different
portlet mode (like "Help" or "Edit"). You can use the following
parameter in your <filename>portlet.xml</filename> to use the default viewId
each time you switch modes.
@@ -99,7 +99,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-General_Error_Handling">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-General_Error_Handling">
<title>General Error Handling</title>
<note>
<para>
@@ -122,7 +122,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-Custom_Ajax_Error_Handling">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Custom_Ajax_Error_Handling">
<title>Custom Ajax Error Handling</title>
<para>
By default, error handling is sent to a standard servlet page for Ajax requests. To
handle the error inside the portlet, use the following javascript:
@@ -140,7 +140,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-Communication_Between_Your_Portlets">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Communication_Between_Your_Portlets">
<title>Communication Between Your Portlets</title>
<para>
There are four different ways to send messages, events, and parameters between
portlets which are contained in different <literal>ears/wars</literal> or
contained in the same <literal>war</literal>.
@@ -149,7 +149,7 @@
Having two portlets in the same <literal>war</literal> or having them
separated does not affect the Portlet Container because each portlet has a different
<parameter>HttpSession</parameter>.
</para>
<para>
- The recommended way to share a parameter or event payload between two or more portlets
with the Portlet 2.0 specification are the <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Portlet_2.0_Coordination-Public_Render_Parameters"
/> and <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Portlet_2.0_Coordination-Sending_and_Receiving_Events"
/> mechanisms.
+ The recommended way to share a parameter or event payload between two or more portlets
with the Portlet 2.0 specification are the <xref
linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Public_Render_Parameters"
/> and <xref
linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Sending_and_Receiving_Events"
/> mechanisms.
</para>
<para>
This allows you to decouple your application from surgically managing objects in the
<parameter>PortletSession.APPLICATION_SCOPE.</parameter>
@@ -157,7 +157,7 @@
<para>
However, if these do not meet your use case or you have a different strategy, you can
use one of the following methods.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Communication_Between_Your_Portlets-Storing_Components_in_PortletSession.APPLICATION_SCOPE">
+ <section
id="sect-Reference_Guide-Communication_Between_Your_Portlets-Storing_Components_in_PortletSession.APPLICATION_SCOPE">
<title>Storing Components in
<parameter>PortletSession.APPLICATION_SCOPE</parameter></title>
<para>
Sometimes it is beneficial to store your <application>Seam</application>
components in the portlet <parameter>APPLICATION_SCOPE</parameter>.
@@ -179,7 +179,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Communication_Between_Your_Portlets-Using_the_PortletSession">
+ <section
id="sect-Reference_Guide-Communication_Between_Your_Portlets-Using_the_PortletSession">
<title>Using the PortletSession</title>
<para>
If you need to access the <literal>PortletSession</literal> to simply
share a parameter or value across multiple portlets, you can use the following:
@@ -208,7 +208,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-Linking_to_PortletJSF_Pages_Using_houtputlink">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Linking_to_PortletJSF_Pages_Using_houtputlink">
<title>Linking to Portlet/JSF Pages Using h:outputlink</title>
<para>
For linking to any JSF/Facelets page within your portlet web application, you can use
the following.
@@ -218,7 +218,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-Redirecting_to_an_External_Page_or_Resource">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Redirecting_to_an_External_Page_or_Resource">
<title>Redirecting to an External Page or Resource</title>
<para>
To link to a non JSF view, <emphasis>jboss.org</emphasis> for example, you
can use the following parameter.
@@ -234,7 +234,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Developing_Portlets_with_the_Bridge-Using_Provided_EL_Variables">
+ <section
id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Using_Provided_EL_Variables">
<title>Using Provided EL Variables</title>
<para>
All <literal>EL</literal> variables found in the JSR-329 (Portlet 2.0)
specification are available in the JBoss Portlet Bridge. For example, you can use the
following to edit the portlet preferences on the UI:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Building_JSF_Portlets">
+<chapter id="chap-Reference_Guide-Building_JSF_Portlets">
<title>Building JSF Portlets</title>
<xi:include href="PortletBridge/overview.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="PortletBridge/gettingstarted.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Portlet_Primer">
+<chapter id="chap-Reference_Guide-Portlet_Primer">
<title>Portlet Primer</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portlet_Primer-JSR_168_and_JSR_286_overview">
+ <section
id="sect-Reference_Guide-Portlet_Primer-JSR_168_and_JSR_286_overview">
<title>JSR-168 and JSR-286 overview</title>
<para>
The Java Community Process (<literal>JCP</literal>) uses Java
Specification Requests (<literal>JSR</literal>s) to define proposed
specifications and technologies designed for the Java platform.
@@ -22,7 +22,7 @@
<para>
JBoss Enterprise Portal Platform is fully JSR-286 compliant. Any JSR-168 or
JSR-286 portlet operates as it is mandated by the respective specifications inside the
portal.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JSR_168_and_JSR_286_overview-Portal_Pages">
+ <section
id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Portal_Pages">
<title>Portal Pages</title>
<para>
A portal can be considered as a series of web pages with different
<emphasis>areas</emphasis> within them. Those areas contain different
<emphasis>windows</emphasis> and each <emphasis>window</emphasis>
contains a <emphasis>portlet</emphasis>:
@@ -42,7 +42,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JSR_168_and_JSR_286_overview-Rendering_Modes">
+ <section
id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Rendering_Modes">
<title>Rendering Modes</title>
<para>
A portlet can have different view modes. Three modes are defined by the
JSR-286 specification:
@@ -83,7 +83,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JSR_168_and_JSR_286_overview-Window_States">
+ <section
id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Window_States">
<title>Window States</title>
<para>
Window states are an indicator of how much page space a portlet consumes
on any given page. The three states defined by the JSR-286 specification are:
@@ -127,7 +127,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portlet_Primer-Tutorials">
+ <section id="sect-Reference_Guide-Portlet_Primer-Tutorials">
<title>Tutorials</title>
<para>
The tutorials contained in this chapter are targeted toward portlet
developers. It is also recommend that developers read and understand the <ulink
url="http://www.jcp.org/en/jsr/detail?id=286"> JSR-286 Portlet Specification
</ulink> .
@@ -139,7 +139,7 @@
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Tutorials-Deploying_your_first_Portlet">
+ <section
id="sect-Reference_Guide-Tutorials-Deploying_your_first_Portlet">
<title>Deploying your first Portlet</title>
<para>
This section describes how to deploy a portlet in JBoss Enterprise Portal
Platform.
@@ -147,7 +147,7 @@
<para>
An example portlet called
<filename>SimplestHelloWorld</filename> is available in the
<filename>/jboss-epp-<VERSION>-src/portal/examples/portlets/</filename>
directory of the JBoss Enterprise Portal Platform sources package or the
<filename>jboss-epp-<VERSION>-docs/epp-doc/examples/portlets</filename>
directory of the documentation package.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Compiling">
+ <section
id="sect-Reference_Guide-Deploying_your_first_Portlet-Compiling">
<title>Compiling</title>
<para>
To compile and package the application:
@@ -206,7 +206,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Package_Structure">
+ <section
id="sect-Reference_Guide-Deploying_your_first_Portlet-Package_Structure">
<title>Package Structure</title>
<para>
Like other Java EE applications, JBoss Enterprise Portal Platform
portlets are packaged in <literal>WAR</literal> files. A typical portlet
<literal>WAR</literal> file can include servlets, resource bundles, images,
HTML, JavaServer Pages (JSP), and other static or dynamic files.
@@ -216,27 +216,27 @@
</para>
<programlistingco>
<areaspec>
- <area coords="9"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Package_Structure-javaclass"
/>
- <area coords="10"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Package_Structure-portlet"
/>
- <area coords="11"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Package_Structure-web"
/>
+ <area coords="9"
id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-javaclass"
/>
+ <area coords="10"
id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-portlet"
/>
+ <area coords="11"
id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-web"
/>
</areaspec>
<programlisting language="Java" role="Java"><xi:include
href="../../extras/PortletDevelopment_Standard/default244.java"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Package_Structure-javaclass">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-javaclass">
<para>
The compiled Java class implementing
<emphasis>javax.portlet.Portlet</emphasis> (through
<emphasis>javax.portlet.GenericPortlet </emphasis> )
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Package_Structure-portlet">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-portlet">
<para>
This is the mandatory descriptor file for portlets. It is
used during deployment.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Package_Structure-web">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-web">
<para>
This is the mandatory descriptor for web applications.
</para>
@@ -250,24 +250,24 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class">
+ <section
id="sect-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class">
<title>Portlet Class</title>
<para>
Below is the Java source for an example portlet named
<filename>simplesthelloworld/src/main/java/org/jboss/portal/portlet/samples</filename>:
</para>
<programlistingco>
<areaspec>
- <area coords="10"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-extends"
/>
- <area coords="13"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-doview"
/>
- <area coords="15"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-writer"
/>
- <area coords="16"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-write"
/>
- <area coords="17"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-close"
/>
+ <area coords="10"
id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-extends"
/>
+ <area coords="13"
id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-doview"
/>
+ <area coords="15"
id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-writer"
/>
+ <area coords="16"
id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-write"
/>
+ <area coords="17"
id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-close"
/>
</areaspec>
<programlisting language="Java" role="Java"><xi:include
href="../../extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-extends">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-extends">
<para>
All portlets must implement the
<literal>javax.portlet.Portlet</literal> interface. The portlet API provides a
convenient implementation of this interface.
</para>
@@ -279,25 +279,25 @@
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-doview">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-doview">
<para>
If only the <literal>view</literal> mode is
required, then only the <literal>doView</literal> method needs to be
implemented. The <literal>GenericPortlet</literal> render implementation calls
our implementation when the <literal>view</literal> mode is requested.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-writer">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-writer">
<para>
Use the <emphasis>RenderResponse</emphasis>
to obtain a writer to be used to produce content.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-write">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-write">
<para>
Write the markup to display.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Portlet_Class-close">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-close">
<para>
Closing the writer.
</para>
@@ -321,7 +321,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Application_Descriptors">
+ <section
id="sect-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors">
<title>Application Descriptors</title>
<para>
JBoss Enterprise Portal Platform requires certain descriptors to be
included in a portlet <literal>WAR</literal> file. These descriptors are
defined by the Java EE (<filename>web.xml</filename>) and Portlet
Specification (<filename>portlet.xml</filename>).
@@ -331,28 +331,28 @@
</para>
<programlistingco>
<areaspec>
- <area coords="8 70"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Application_Descriptors-portletname"
/>
- <area coords="9 70"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Application_Descriptors-portletclass"
/>
- <area coords="12 70"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Application_Descriptors-supports"
/>
- <area coords="15 70"
id="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Application_Descriptors-portletinfo"
/>
+ <area coords="8 70"
id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletname"
/>
+ <area coords="9 70"
id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletclass"
/>
+ <area coords="12 70"
id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-supports"
/>
+ <area coords="15 70"
id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletinfo"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/PortletDevelopment_Standard/default245.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Application_Descriptors-portletname">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletname">
<para>
Define the portlet name. It does not have to be the class
name.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Application_Descriptors-portletclass">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletclass">
<para>
The Fully Qualified Name
(<literal>FQN</literal>) of your portlet class must be declared here.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Application_Descriptors-supports">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-supports">
<para>
The
<literal><supports></literal> element declares all of the markup
types that a portlet supports in the <literal>render</literal> method. This is
accomplished via the <literal><mime-type></literal> element,
which is required for every portlet.
</para>
@@ -367,7 +367,7 @@
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Deploying_your_first_Portlet-Application_Descriptors-portletinfo">
+ <callout
arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletinfo">
<para>
When rendered, the portlet's title is displayed as
the header in the portlet window, unless it is overridden programmatically. In the example
above the title would be <literal>Simplest Hello World Portlet</literal> .
</para>
@@ -384,7 +384,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Tutorials-JavaServer_Pages_Portlet_Example">
+ <section
id="sect-Reference_Guide-Tutorials-JavaServer_Pages_Portlet_Example">
<title>JavaServer Pages Portlet Example</title>
<para>
This section discusses:
@@ -416,7 +416,7 @@
</listitem>
</orderedlist>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Compiling_the_example">
+ <formalpara
id="form-Reference_Guide-JavaServer_Pages_Portlet_Example-Compiling_the_example">
<title>Compiling the example</title>
<para>
The example used in this section is available in the
<filename>/jboss-epp-<VERSION>-src/portal/examples/portlets/</filename>
directory of the JBoss Enterprise Portal Platform sources package or the
<filename>/jboss-epp-<VERSION>-docs/epp-doc/examples/portlets</filename>
directory of the documentation package.
@@ -473,7 +473,7 @@
<para>
The <literal>EDIT</literal> button only appears for logged-in users.
</para>
-</note> --> <section
id="sect-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Package_Structure">
+</note> --> <section
id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-Package_Structure">
<title>Package Structure</title>
<para>
The package structure in this tutorial does not differ greatly from
the previous example, with the exception of adding some JSP files which are detailed
later.
@@ -486,41 +486,41 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class">
+ <section
id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class">
<title>Portlet Class</title>
<para>
The code below is from the <filename>
jsphellouser/src/main/java/org/jboss/portal/portlet/samples/JSPHelloUserPortlet.java</filename>
Java source. It is split in different pieces.
</para>
<programlistingco>
<areaspec>
- <area coords="18 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-doView"
/>
- <area coords="21 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-renderParameter"
/>
- <area coords="25 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-requestDispatcher"
/>
- <area coords="26 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-include"
/>
+ <area coords="18 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-doView"
/>
+ <area coords="21 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-renderParameter"
/>
+ <area coords="25 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-requestDispatcher"
/>
+ <area coords="26 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-include"
/>
</areaspec>
<programlisting language="Java" role="Java"><xi:include
href="../../extras/PortletDevelopment_Standard/JSPHelloUserPortlet.java"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-doView">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-doView">
<para>
Override the <emphasis>doView</emphasis>
method (as in the first tutorial).
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-renderParameter">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-renderParameter">
<para>
This entry attempts to obtain the value of the render
parameter named <literal>yourname</literal>. If defined it should redirect to
the <filename>hello.jsp</filename> JSP page, otherwise to the
<filename>welcome.jsp</filename> JSP page.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-requestDispatcher">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-requestDispatcher">
<para>
Get a request dispatcher on a file located within the web
archive.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-include">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-include">
<para>
Perform the inclusion of the markup obtained from the
JSP.
</para>
@@ -553,27 +553,27 @@
</para>
<programlistingco>
<areaspec>
- <area coords="2 100"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-processAction"
/>
- <area coords="5 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-getActionParameter"
/>
- <area coords="6 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-setRenderParameter"
/>
+ <area coords="2 100"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-processAction"
/>
+ <area coords="5 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-getActionParameter"
/>
+ <area coords="6 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-setRenderParameter"
/>
</areaspec>
<programlisting language="Java" role="Java"><xi:include
href="../../extras/PortletDevelopment_Standard/default249.java"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-processAction">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-processAction">
<para>
<literal>processAction</literal> is the
method from <literal>GenericPortlet</literal> to override for the
<emphasis>action</emphasis> phase.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-getActionParameter">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-getActionParameter">
<para>
Here the parameter is retrieved through an
<emphasis>action URL</emphasis>.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-Portlet_Class-setRenderParameter">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-setRenderParameter">
<para>
The value of <literal>yourname</literal> is
kept to make it available in the rendering phase. The previous line simply copies an
action parameter to a render parameter for this example.
</para>
@@ -587,7 +587,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library">
+ <section
id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library">
<title>JSP files and the Portlet Tag Library</title>
<para>
The <filename>help.jsp</filename> and
<filename>edit.jsp</filename> files are very simple. Note that CSS styles are
used as defined in the portlet specification. This ensures that the portlet will render
well within the theme and across portal vendors.
@@ -601,48 +601,48 @@
</para>
<programlistingco>
<areaspec>
- <area coords="1"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib"
/>
- <area coords="13"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method1"
/>
- <area coords="20"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1"
/>
- <area coords="24"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2"
/>
- <area coords="30"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1"
/>
- <area coords="31"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2"
/>
+ <area coords="1"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib"
/>
+ <area coords="13"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method1"
/>
+ <area coords="20"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1"
/>
+ <area coords="24"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2"
/>
+ <area coords="30"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1"
/>
+ <area coords="31"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/PortletDevelopment_Standard/default252.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib">
<para>
The portlet taglib. This needs to be declared.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method1">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method1">
<para>
The first method showed here is the simplest one.
<literal>portlet:renderURL</literal> will create a URL that calls the render
phase of the current portlet and append the result at the place of the markup (within a
tag). A parameter is also added directly to the URL.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1">
<para>
In this method the <literal>var</literal>
attribute is used. This avoids having one XML tag within another. Instead of printing the
url the <literal>portlet:renderURL</literal> tag will store the result in the
referenced variable ( <literal>myRenderURL</literal>).
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2">
<para>
The variable <literal>myRenderURL</literal>
is used like any other JSP variable.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1">
<para>
The third method mixes form submission and action
request. Again, a temporary variable is used to put the created URL into.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2">
<para>
The action URL is used in HTML form.
</para>
@@ -668,7 +668,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge">
+ <section
id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge">
<title>JSF example using the JBoss Portlet Bridge</title>
<para>
In order to write a portlet using JSF a 'bridge' is needed.
This software allows developers to write a portlet application as if it was a JSF
application. The bridge then negotiates the interactions between the two layers.
@@ -689,34 +689,34 @@
</para>
<programlistingco>
<areaspec>
- <area coords="9 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet"
/>
- <area coords="21 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view"
/>
- <area coords="26 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit"
/>
- <area coords="31 80"
id="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help"
/>
+ <area coords="9 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet"
/>
+ <area coords="21 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view"
/>
+ <area coords="26 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit"
/>
+ <area coords="31 80"
id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../extras/PortletDevelopment_Standard/default254.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet">
<para>
All JSF portlets define
<literal>javax.portlet.faces.GenericFacesPortlet </literal> as portlet class.
This class is part of the JBoss Portlet Bridge
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view">
<para>
This is a mandatory parameter to define what's the
default page to display.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit">
<para>
This parameter defines which page to display on the
'edit' mode.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help">
+ <callout
arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help">
<para>
This parameter defines which page to display on the
'help' mode.
</para>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<part id="part-Reference_Guide_eXo_JCR_1.14-Portlet_development">
+<part id="part-Reference_Guide-Portlet_development">
<title>Portlet development</title>
<xi:include href="PortletDevelopment/Standard.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="PortletDevelopment/Global_Portlet.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/RH-WSRP.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/RH-WSRP.xml 2011-11-25 00:48:53
UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/RH-WSRP.xml 2011-11-25 01:13:48
UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP">
+<chapter
id="chap-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP">
<title><remark>Web Services for Remote Portlets
(WSRP)</remark></title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Introduction">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Introduction">
<title>Introduction</title>
<para>
The Web Services for Remote Portlets (WSRP) specification defines a web
service interface for accessing and interacting with interactive presentation-oriented web
services.
@@ -37,7 +37,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Level_of_Support">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Level_of_Support">
<title>Level of Support</title>
<para>
The WSRP Technical Committee defined <ulink
url="http://www.oasis-open.org/committees/download.php/3073">... Use
Profiles</ulink> to help with WSRP interoperability. Terms defined in that document
will be used in this section.
@@ -69,14 +69,14 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Deploying_WSRP">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Deploying_WSRP">
<title>Deploying WSRP</title>
<note>
<title>Notational Devices</title>
<para>
The following list of support files uses the following notational
devices:
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-Notations">
+ <variablelist
id="vari-Reference_Guide-Deploying_WSRP-Notations">
<title>Notations:</title>
<varlistentry>
<term><replaceable>JBOSS_HOME</replaceable></term>
@@ -131,7 +131,7 @@
<para>
The extension itself is composed of the following components:
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-WSRP_support_files">
+ <variablelist
id="vari-Reference_Guide-Deploying_WSRP-WSRP_support_files">
<title>WSRP support files</title>
<varlistentry>
<term><filename>META-INF/</filename></term>
@@ -140,7 +140,7 @@
This directory contains files necessary for EAR packaging. The
only file that is of interest from a user perspective is
<filename>gatein-wsse-consumer.xml</filename> which allows you to configure
WS-Security support for the consumer.
</para>
<para>
- Refer to <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-WSRP_and_WS_Security-WS_Security_Configuration"
/> section for more details.
+ Refer to <xref
linkend="sect-Reference_Guide-WSRP_and_WS_Security-WS_Security_Configuration"
/> section for more details.
</para>
</listitem>
@@ -203,7 +203,7 @@
This file contains the producer-side support for WS-Security. The
only file of interest from a user perspective is
<filename>gatein-wsse-producer.xml</filename> which allows you to configure
WS-Security support for the producer.
</para>
<para>
- Refer to <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-WSRP_and_WS_Security-WS_Security_Configuration"
/> for more details.
+ Refer to <xref
linkend="sect-Reference_Guide-WSRP_and_WS_Security-WS_Security_Configuration"
/> for more details.
</para>
</listitem>
@@ -211,18 +211,18 @@
</varlistentry>
</variablelist>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-Non_default_Ports_or_Hostnames">
+ <section
id="sect-Reference_Guide-Deploying_WSRP-Non_default_Ports_or_Hostnames">
<title>Non-default Ports or Hostnames</title>
<para>
JBoss WS (the web service stack that JBoss Enterprise Portal Platform
uses) should update the port and host name used in WSDL. Refer to the JBoss WS <ulink
url="http://community.jboss.org/wiki/JBossWS-UserGuide#Configuration...
guide</ulink> for more information.
</para>
<para>
- If the host name and port on which the server runs have been modified,
the configuration for the Consumer used to consume JBoss Enterprise Portal Platform's
"self" Producer will need to be updated. Refer to <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets"
/> for directions on how to do this.
+ If the host name and port on which the server runs have been modified,
the configuration for the Consumer used to consume JBoss Enterprise Portal Platform's
"self" Producer will need to be updated. Refer to <xref
linkend="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets"
/> for directions on how to do this.
</para>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Deploying_WSRP-Using_WSRP_with_SSL">
+ <section
id="sect-Reference_Guide-Deploying_WSRP-Using_WSRP_with_SSL">
<title>Using WSRP with SSL</title>
<para>
It is possible to use WSRP over SSL for secure exchange of data. Refer to
these <ulink
url="http://community.jboss.org/wiki/ConfiguringWSRPforuseoverSSL&qu...
for how to do this.
@@ -233,7 +233,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-WSRP_and_WS_Security">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-WSRP_and_WS_Security">
<title>WSRP and WS-Security</title>
<para>
Portlets may present different data or options depending on the currently
authenticated user. For remote portlets, this means having to propagate the user
credentials from the consumer back to the producer in a safe and secure manner.
@@ -280,7 +280,7 @@
<para>
This community Wiki <ulink
url="http://community.jboss.org/wiki/GateInWSRPAndWebServiceSecurity...;,
also provides a step-by-step example on how to configure WSRP with WS-Security.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-WSRP_and_WS_Security-WS_Security_Configuration">
+ <section
id="sect-Reference_Guide-WSRP_and_WS_Security-WS_Security_Configuration">
<title>WS-Security Configuration</title>
<para>
JBoss Enterprise Portal Platform uses <application>JBossWS
Native</application> to handle ws-security.
@@ -321,7 +321,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-WSRP_and_WS_Security-WS_Security_Producer_Configuration">
+ <section
id="sect-Reference_Guide-WSRP_and_WS_Security-WS_Security_Producer_Configuration">
<title>WS-Security Producer Configuration</title>
<para>
Other than the JBossWS configuration file mention above, no other
configuration changes should be necessary for the producer.
@@ -329,7 +329,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-WSRP_and_WS_Security-WS_Security_Consumer_Configuration">
+ <section
id="sect-Reference_Guide-WSRP_and_WS_Security-WS_Security_Consumer_Configuration">
<title>WS-Security Consumer Configuration</title>
<para>
The consumer requires some changes before it will function properly with
WS-Security.
@@ -337,7 +337,7 @@
<para>
The consumer needs access to the current servlet request since this is
used to retrieve the currently authenticated user. In order to access this information,
the consumer needs a special servlet-filter added to the portal.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-WS_Security_Consumer_Configuration-Add_the_servlet_filter">
+ <procedure
id="proc-Reference_Guide-WS_Security_Consumer_Configuration-Add_the_servlet_filter">
<title>Add the servlet-filter</title>
<step>
<para>
@@ -406,7 +406,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Making_a_Portlet_Remotable">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Making_a_Portlet_Remotable">
<title>Making a Portlet Remotable</title>
<note>
<para>
@@ -464,13 +464,13 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_WSRP_portlets_from_a_remote_Consumer">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_WSRP_portlets_from_a_remote_Consumer">
<title>Consuming WSRP portlets from a remote Consumer</title>
<para>
Configuration is extremely variable between different WSRP Consumers. Most,
however, require a specification of the URL for the Producer's WSDL definition. If the
JBoss Enterprise Portal Platform Consumer is not being used, refer to the documentation
for the Consumer that is in use for specific instructions.
</para>
<para>
- For instructions on how to specify this URL in JBoss Enterprise Portal
Platform, refer to <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets"
/>.
+ For instructions on how to specify this URL in JBoss Enterprise Portal
Platform, refer to <xref
linkend="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets"
/>.
</para>
<para>
JBoss Enterprise Portal Platform's Producer is automatically set up when
a portal instance is deployed with the WSRP service.
@@ -478,7 +478,7 @@
<para>
The WSDL file can be accessed at:
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Consuming_WSRP_portlets_from_a_remote_Consumer-File_paths">
+ <variablelist
id="vari-Reference_Guide-Consuming_WSRP_portlets_from_a_remote_Consumer-File_paths">
<title>File paths:</title>
<varlistentry>
<term>WSRP 1.0:</term>
@@ -508,9 +508,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_Remote_WSRP_Portlets">
<title>Consuming Remote WSRP Portlets</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Consuming_Remote_WSRP_Portlets-Overview">
+ <section
id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Overview">
<title>Overview</title>
<para>
To be able to consume WSRP portlets exposed by a remote producer, JBoss
Enterprise Portal Platform's WSRP consumer must be configured to access that remote
producer.
@@ -528,7 +528,7 @@
-->
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Consuming_Remote_WSRP_Portlets-Configuring_a_Remote_Producer">
+ <section
id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Configuring_a_Remote_Producer">
<title>Configuring a Remote Producer</title>
<para>
Access to a remote producer needs to be defined so that portlets can be
consumed within JBoss Enterprise Portal Platform. This section will show how to configure
access to <emphasis role="bold">NetUnity</emphasis>'s public
WSRP producer.
@@ -555,7 +555,7 @@
</para>
</important>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-The_Configuration_Portlet">
+ <section
id="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet">
<title>The Configuration Portlet</title>
<para>
JBoss Enterprise Portal Platform provides a graphical portlet to
assist with configuring access to, and other facets of, remote WSRP Producers.
@@ -569,7 +569,7 @@
<para>
Although the Configuration Portlet is installed by default in JBoss
Enterprise Portal Platform &VY;., installation instructions are included below should
the portlet ever need to be re-installed:
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-The_Configuration_Portlet-Installing_the_configuration_portlet">
+ <procedure
id="proc-Reference_Guide-The_Configuration_Portlet-Installing_the_configuration_portlet">
<title><emphasis role="bold">Installing the
configuration portlet:</emphasis></title>
<step>
<para>
@@ -592,7 +592,7 @@
</procedure>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_Configuration_Portlet-Using_the_Configuration_portlet">
+ <section
id="sect-Reference_Guide-The_Configuration_Portlet-Using_the_Configuration_portlet">
<title><emphasis role="bold">Using the
Configuration portlet</emphasis></title>
<mediaobject>
<imageobject role="html">
@@ -618,7 +618,7 @@
<para>
To create a new Consumer:
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Using_the_Configuration_portlet-Creating_a_Consumer">
+ <procedure
id="proc-Reference_Guide-Using_the_Configuration_portlet-Creating_a_Consumer">
<title><emphasis role="bold">Creating a
Consumer</emphasis></title>
<step>
<para>
@@ -735,7 +735,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-Using_XML">
+ <section
id="sect-Reference_Guide-Configuring_a_Remote_Producer-Using_XML">
<title>Using XML</title>
<para>
Although using the WSRP Configuration portlet to configure Consumers
is recommended, the WSRP component provides an alternative way to configure consumers.
@@ -756,12 +756,12 @@
</note>
<!-- Removed in GateIn revision 8119
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Consuming_Remote_WSRP_Portlets-Configuring_Access_to_Remote_Producers_via_XML">
+ <section
id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Configuring_Access_to_Remote_Producers_via_XML">
<title>Configuring Access to Remote Producers via XML</title>
<para>
Again, configuring consumers via XML is done by editing
<filename><replaceable>WSRP_PATH</replaceable>/lib/wsrp-consumer-<replaceable>WSRP_VERSION</replaceable>.jar/conf/wsrp-consumers-config.xml</filename>.
- </para> --> <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Using_XML-The_Consumer_Configuration_file">
+ </para> --> <formalpara
id="form-Reference_Guide-Using_XML-The_Consumer_Configuration_file">
<title>The Consumer Configuration file</title>
<para>
It is important to understand how the XML Consumers configuration
file is processed. It is read the first time the WSRP service starts and the associated
information is then put under control of the JCR (Java Content Repository).
@@ -775,12 +775,12 @@
The information defined at the XML level is only processed for
producer definition for which no information is already present in the JCR.
</para>
<para>
- Therefore, to delete a Producer configuration, the associated
information in the database must be deleted (this can be accomplished using the
configuration portlet as shown in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-The_Configuration_Portlet"
/> ).
+ Therefore, to delete a Producer configuration, the associated
information in the database must be deleted (this can be accomplished using the
configuration portlet as shown in <xref
linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet"
/> ).
</para>
<para>
The associated information in
<filename>wsrp-consumers-config.xml</filename> (if such information exists)
must also be removed, otherwise the producer will be re-created the next time the WSRP is
launched.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Using_XML-Required_Configuration_Information">
+ <section
id="sect-Reference_Guide-Using_XML-Required_Configuration_Information">
<title>Required Configuration Information</title>
<para>
The following information needs to be provided to configure
access to a remote Producer:
@@ -806,12 +806,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Using_XML-Optional_Configuration">
+ <section
id="sect-Reference_Guide-Using_XML-Optional_Configuration">
<title>Optional Configuration</title>
<para>
It is also possible to provide additional configuration, which,
in some cases, might be important to establish a proper connection to the remote
producer.
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Optional_Configuration-Optional_Configurations">
+ <variablelist
id="vari-Reference_Guide-Optional_Configuration-Optional_Configurations">
<title>Optional Configurations</title>
<varlistentry>
<term>Caching</term>
@@ -881,14 +881,14 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-Examples">
+ <section
id="sect-Reference_Guide-Configuring_a_Remote_Producer-Examples">
<title>Examples</title>
<para>
This is the configuration of the
<literal>selfv1</literal> and <literal>selfv2</literal> consumers
as found in <filename>default-wsrp.xml</filename> with a cache expiring every
500 seconds and with a 50 second timeout for web service operations:
</para>
<note>
<para>
- This file contains the default configuration and should not need
to be edited. If modifications are required, the recommended practice is to follow the
procedure detailed in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-The_Configuration_Portlet-Using_the_Configuration_portlet"
/>.
+ This file contains the default configuration and should not need
to be edited. If modifications are required, the recommended practice is to follow the
procedure detailed in <xref
linkend="sect-Reference_Guide-The_Configuration_Portlet-Using_the_Configuration_portlet"
/>.
</para>
</note>
@@ -905,7 +905,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Consuming_Remote_WSRP_Portlets-Adding_remote_portlets_to_categories">
+ <section
id="sect-Reference_Guide-Consuming_Remote_WSRP_Portlets-Adding_remote_portlets_to_categories">
<title>Adding remote portlets to categories</title>
<para>
Clicking on the Portlet link in the Application Registry will now show
the remote portlets in the <emphasis role="bold">REMOTE</emphasis>
tab in the left column:
@@ -937,11 +937,11 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Consumers_Maintenance">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consumers_Maintenance">
<title>Consumers Maintenance</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Consumers_Maintenance-Modifying_a_Currently_Held_Registration">
+ <section
id="sect-Reference_Guide-Consumers_Maintenance-Modifying_a_Currently_Held_Registration">
<title>Modifying a Currently Held Registration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Modifying_a_Currently_Held_Registration-Registration_Modification_for_Service_Upgrade">
+ <section
id="sect-Reference_Guide-Modifying_a_Currently_Held_Registration-Registration_Modification_for_Service_Upgrade">
<title>Registration Modification for Service Upgrade</title>
<para>
Producers often offer several levels of service depending on
consumers' subscription levels (for example). This is implemented at the WSRP level
with the registration concept: producers can assert which level of service to provide to
consumers based on the values of given registration properties.
@@ -953,7 +953,7 @@
Therefore at times it may be necessary to modify the registration
that sets the service agreement between a consumer and a producer.
</para>
<para>
- For example; the producer requiring an email that was configured in
<xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_a_Remote_Producer-The_Configuration_Portlet"
/> . In that case the producer was requiring registration and required a value to be
provided for the <literal>email</literal> property.
+ For example; the producer requiring an email that was configured in
<xref
linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet"
/> . In that case the producer was requiring registration and required a value to be
provided for the <literal>email</literal> property.
</para>
<para>
To update the email address that was provided, the remote producer
must be informed that some registration data has been modified.
@@ -1013,7 +1013,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error">
+ <section
id="sect-Reference_Guide-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error">
<title>Registration Modification on Producer Error</title>
<para>
If a Producer administrator changes the requirements for registered
consumers, invoking operations on the producer may fail with an
<exceptionname>OperationFailedFault</exceptionname>. JBoss Enterprise Portal
Platform will attempt to assist in these cases.
@@ -1085,7 +1085,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Consumers_Maintenance-Consumer_Operations">
+ <section
id="sect-Reference_Guide-Consumers_Maintenance-Consumer_Operations">
<title>Consumer Operations</title>
<para>
Several operations are available from the consumer list view of the WSRP
configuration portlet:
@@ -1155,14 +1155,14 @@
</varlistentry>
</variablelist>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Consumer_Operations-Additional_Functionalities_in_WSRP_2.0">
+ <formalpara
id="form-Reference_Guide-Consumer_Operations-Additional_Functionalities_in_WSRP_2.0">
<title><emphasis role="bold">Additional
Functionalities in WSRP 2.0</emphasis></title>
<para>
In addition to those listed above, the WSRP 2.0 implementation in
JBoss Enterprise Portal Platform &VY; also includes the following functions:
</para>
</formalpara>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Consumer_Operations-Additional_Functions">
+ <variablelist
id="vari-Reference_Guide-Consumer_Operations-Additional_Functions">
<title>Additional Functions:</title>
<varlistentry>
<term>Export</term>
@@ -1186,7 +1186,7 @@
</varlistentry>
</variablelist>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Consumer_Operations-Importing_and_Exporting_Portlets">
+ <section
id="sect-Reference_Guide-Consumer_Operations-Importing_and_Exporting_Portlets">
<title><emphasis role="bold">Importing and
Exporting Portlets</emphasis></title>
<para>
Import and export are new functionalities added in WSRP 2.
@@ -1251,7 +1251,7 @@
<para>
This screen presents the list of available exports with
available operations for each.
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Importing_and_Exporting_Portlets-Operations">
+ <variablelist
id="vari-Reference_Guide-Importing_and_Exporting_Portlets-Operations">
<title>Operations:</title>
<varlistentry>
<term>View</term>
@@ -1404,7 +1404,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Consumers_Maintenance-Erasing_Local_Registration_Data">
+ <section
id="sect-Reference_Guide-Consumers_Maintenance-Erasing_Local_Registration_Data">
<title>Erasing Local Registration Data</title>
<para>
In rare cases, it may be necessary to erase the local data without being
able to de-register first.
@@ -1448,9 +1448,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Configuring_the_WSRP_Producer">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Configuring_the_WSRP_Producer">
<title>Configuring the WSRP Producer</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-Overview">
+ <section
id="sect-Reference_Guide-Configuring_the_WSRP_Producer-Overview">
<title>Overview</title>
<para>
The behavior of the Portal's WSRP Producer can be configured using
the WSRP administration interface, (this is the recommended method), or by editing the
<filename><replaceable>WSRP_PATH</replaceable>/lib/gatein.portal.component.wsrp-<replaceable><VERSION></replaceable>-epp-GA.jar/conf/wsrp-producer-config.xml</filename>
file.
@@ -1467,7 +1467,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-Default_Configuration">
+ <section
id="sect-Reference_Guide-Configuring_the_WSRP_Producer-Default_Configuration">
<title>Default Configuration</title>
<para>
The default producer configuration requires that consumers register with
it before providing access to its services. However it does not require any specific
registration properties (excepting those mandated by the WSRP standard).
@@ -1479,7 +1479,7 @@
The producer also uses the default
<classname>RegistrationPolicy</classname> paired with the default
<classname>RegistrationPropertyValidator</classname>.
</para>
<para>
- This allows users to customize how Portal's WSRP Producer decides
whether a given registration property is valid or not (however property validators are
discussed in greater detail in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-Registration_Configuration"
/> ).
+ This allows users to customize how Portal's WSRP Producer decides
whether a given registration property is valid or not (however property validators are
discussed in greater detail in <xref
linkend="sect-Reference_Guide-Configuring_the_WSRP_Producer-Registration_Configuration"
/> ).
</para>
<para>
JBoss Enterprise Portal Platform provides a web interface to configure
the producer's behavior. It can be accessed by clicking on the "<emphasis
role="bold">Producer Configuration</emphasis>" tab of the
"<emphasis role="bold">WSRP</emphasis>" page of the
"<emphasis role="bold">admin</emphasis>" portal.
@@ -1505,7 +1505,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-Registration_Configuration">
+ <section
id="sect-Reference_Guide-Configuring_the_WSRP_Producer-Registration_Configuration">
<title>Registration Configuration</title>
<para>
In order to have consumers register with Portal's producer the
Portal's behavior with respect to registration must be configured.
@@ -1552,7 +1552,7 @@
</step>
<step>
<para>
- The fully-qualified name for the
<classname>RegistrationPolicy</classname> and
<classname>RegistrationPropertyValidator</classname> can be specified here.
The default values are acceptable. Refer to <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Registration_Configuration-Customization_of_Registration_Handling_Behavior"
/> for more information.
+ The fully-qualified name for the
<classname>RegistrationPolicy</classname> and
<classname>RegistrationPropertyValidator</classname> can be specified here.
The default values are acceptable. Refer to <xref
linkend="sect-Reference_Guide-Registration_Configuration-Customization_of_Registration_Handling_Behavior"
/> for more information.
</para>
</step>
@@ -1588,11 +1588,11 @@
</note>
<note>
<para>
- If consumers are already registered with the producer, modifying the
configuration of required registration information will trigger the invalidation of held
registrations, requiring consumers to modify their registration before being able to
access the producer again. The consumer side of that process is documented in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error"
/>.
+ If consumers are already registered with the producer, modifying the
configuration of required registration information will trigger the invalidation of held
registrations, requiring consumers to modify their registration before being able to
access the producer again. The consumer side of that process is documented in <xref
linkend="sect-Reference_Guide-Modifying_a_Currently_Held_Registration-Registration_Modification_on_Producer_Error"
/>.
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Registration_Configuration-Customization_of_Registration_Handling_Behavior">
+ <section
id="sect-Reference_Guide-Registration_Configuration-Customization_of_Registration_Handling_Behavior">
<title>Customization of Registration Handling
Behavior</title>
<para>
Registration handling behavior can be customized by users to suit
their Producer needs. This is done with an implementation of the
<classname>RegistrationPolicy</classname> interface.
@@ -1633,7 +1633,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuring_the_WSRP_Producer-WSRP_Validation_Mode">
+ <section
id="sect-Reference_Guide-Configuring_the_WSRP_Producer-WSRP_Validation_Mode">
<title>WSRP Validation Mode</title>
<para>
The lack of conformance kit and the wording of the WSRP specification
leaves room for differing interpretations, resulting in interoperability issues. It is
therefore possible to encounter issues when using consumers from different vendors.
@@ -1653,7 +1653,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Web_Services_for_Remote_Portlets_WSRP-Removing_WSRP">
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Removing_WSRP">
<title>Removing WSRP</title>
<para>
If you are not going to use WSRP in your JBoss Enterprise Portal Platform
instance, the WSRP configuration files may be left in place. They will not adversely
affect your installation.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/conversationstate-when-membership-changed.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/conversationstate-when-membership-changed.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/conversationstate-when-membership-changed.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Update_ConversationState_when_users_Membership_changed">
+<section
id="sect-Reference_Guide-Update_ConversationState_when_users_Membership_changed">
<title>Update ConversationState when user's Membership changed</title>
<para>
When a user logged in portal in ConversationRegistry added ConversationSate for this
user. ConversationState keeps user's Identity that is actual for logged in time. In
this case even user's Membership updated in OrganizationService ConversationState
still keeps old (not actual Identity). User must logged out and login in again to update
Identity. To fix this issue, need add special listener in configuration of
OrganizationServicer. This listener is extended MembershipEventListener.
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/core.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/core.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/core.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-eXo_Core">
+<section id="sect-Reference_Guide-eXo_Core">
<title>eXo Core</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_Core-eXo_Core_introduction">
+ <section id="sect-Reference_Guide-eXo_Core-eXo_Core_introduction">
<title>eXo Core introduction</title>
<para>
The eXo Core is a set of common services that are used by eXo products and modules, it
also can be used in the business logic.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-configuration-hibernate.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-configuration-hibernate.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-configuration-hibernate.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Configuration_for_Hibernate">
+<section id="sect-Reference_Guide-Database_Configuration_for_Hibernate">
<title>Database Configuration for Hibernate</title>
<para>
As usual, it is quite simple to use our configuration XML syntax to configure and
parametrize different Databases for eXo tables but also for your own use.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Configuration_for_Hibernate-Generic_configuration">
+ <section
id="sect-Reference_Guide-Database_Configuration_for_Hibernate-Generic_configuration">
<title>Generic configuration</title>
<para>
The default DB configuration uses HSQLDB, a Java Database quite useful for
demonstrations.
@@ -49,7 +49,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Configuration_for_Hibernate-Example_DB_configuration">
+ <section
id="sect-Reference_Guide-Database_Configuration_for_Hibernate-Example_DB_configuration">
<title>Example DB configuration</title>
<para>
For MySQL
@@ -81,7 +81,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Configuration_for_Hibernate-Registering_custom_Hibernate_XML_files_into_the_service">
+ <section
id="sect-Reference_Guide-Database_Configuration_for_Hibernate-Registering_custom_Hibernate_XML_files_into_the_service">
<title>Registering custom Hibernate XML files into the service</title>
<para>
It is possible to use the eXo hibernate service and register your hibernate hbm.xml
files to leverage some add-on features of the service such as the table automatic creation
as well as the cache of the hibernate session in a ThreadLocal object during all the
request lifecycle. To do so, you just have to add a plugin and indicate the location of
your files.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-creator-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-creator-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-creator-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Database_Creator">
+<section id="sect-Reference_Guide-Database_Creator">
<title>Database Creator</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Creator-About">
+ <section id="sect-Reference_Guide-Database_Creator-About">
<title>About</title>
<para>
Database creator<envar> DBCreator</envar> is responsible for execution DDL
script in runtime. A DDL script may contain templates for database name, user name and
password which will be replaced by real values at execution time.
@@ -37,7 +37,7 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Database_Creator-API">
+ <section id="sect-Reference_Guide-Database_Creator-API">
<title>API</title>
<para>
Service provide method for execute script for new database creation. Database name
which are passed as parameter will be substituted in DDL script instead of
<envar>${database}</envar> template. Returns
<envar>DBConnectionInfo</envar> object (with all necessary information of new
database's connection) or throws <envar>DBCreatorException</envar>
exception if any errors occurs in other case.
@@ -57,7 +57,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Creator-A_configuration_examples">
+ <section
id="sect-Reference_Guide-Database_Creator-A_configuration_examples">
<title>A configuration examples</title>
<para>
Service's configuration.
@@ -174,7 +174,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Database_Creator-An_examples_of_a_DDL_script">
+ <section
id="sect-Reference_Guide-Database_Creator-An_examples_of_a_DDL_script">
<title>An examples of a DDL script</title>
<para>
MySQL:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-schema-creator-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-schema-creator-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/db-schema-creator-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-DB_Schema_creator_service_JDBC_implementation">
+<section
id="sect-Reference_Guide-DB_Schema_creator_service_JDBC_implementation">
<title>DB Schema creator service (JDBC implementation)</title>
<para>
DB Schema Creator is responsible for creating database schema, using a DDL script
inside service configuration or in an external file, calling:
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/digest-auth.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/digest-auth.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/digest-auth.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Digest_Authentication">
+<section id="sect-Reference_Guide-Digest_Authentication">
<title>Digest Authentication</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Digest_Authentication-Overview">
+ <section id="sect-Reference_Guide-Digest_Authentication-Overview">
<title>Overview</title>
<para>
Digest access authentication is one of the agreed methods a web server can use to
negotiate credentials with a web user's browser. It uses encryption to send the
password over the network which is safer than the Basic access authentication that sends
plaintext.
@@ -16,12 +16,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Digest_Authentication-Server_configuration">
+ <section
id="sect-Reference_Guide-Digest_Authentication-Server_configuration">
<title>Server configuration</title>
<para>
To configure you server to use DIGEST authentication we need to edit serverside JAAS
module implementation configuration file.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Server_configuration-Tomcat_Server_configuration">
+ <section
id="sect-Reference_Guide-Server_configuration-Tomcat_Server_configuration">
<title>Tomcat Server configuration</title>
<para>
You need to fulfill a couple of steps. Firstly change login configuration:
@@ -74,7 +74,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Server_configuration-Jetty_server_configuration">
+ <section
id="sect-Reference_Guide-Server_configuration-Jetty_server_configuration">
<title>Jetty server configuration</title>
<para>
You need to fulfill a couple of steps. Firstly change login configuration:
@@ -124,7 +124,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Server_configuration-JBoss_server_configuration">
+ <section
id="sect-Reference_Guide-Server_configuration-JBoss_server_configuration">
<title>JBoss server configuration</title>
<para>
Edit config file located here:
exo-jboss/server/default/deploy/exo.jcr.ear.ear/rest.war/WEB-INF/web.xml
@@ -181,7 +181,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Digest_Authentication-OrganizationService_implementation_requirements">
+ <section
id="sect-Reference_Guide-Digest_Authentication-OrganizationService_implementation_requirements">
<title>OrganizationService implementation requirements</title>
<para>
To make your own
<literal>org.exoplatform.services.organization.OrganizationService</literal>
implementation able to use DIGEST authentication you need to make your UserHandler
implementation also implement
<literal>org.exoplatform.services.organization.DigestAuthenticator</literal>
interface which provide more flexible authenticate method. As it is called from
<literal>org.exoplatform.services.organization.auth.OrganizationAuthenticatorImpl</literal>
it receive a <literal>org.exoplatform.services.security.Credential</literal>
instances, you can get more information from
<literal>org.exoplatform.services.security.PasswordCredential.getPasswordContext()</literal>.
It can be used to calculate md5 digest of original password to compare it with received
from clientside.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/ldap-configuration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/ldap-configuration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/ldap-configuration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Configuration">
+<section id="sect-Reference_Guide-LDAP_Configuration">
<title>LDAP Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Configuration-Overview">
+ <section id="sect-Reference_Guide-LDAP_Configuration-Overview">
<title>Overview</title>
<para>
You may decide that you want eXo users to be mapped to an existing directory. eXo
provides a flexible implementation of its OrganizationService on top of LDAP. It can be
used on any LDAP compliant directory and even Active Directory. This page will guide you
how to configure eXo Platform to work with your directory.
@@ -13,7 +13,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Configuration-Quickstart">
+ <section id="sect-Reference_Guide-LDAP_Configuration-Quickstart">
<title>Quickstart</title>
<para>
If you just want to have a look at how eXo works with ldap. eXo comes with a
predefined ldap configuration. You just need to activate it and eXo will create all it
needs to work at startup.
@@ -74,7 +74,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Configuration-Configuration">
+ <section id="sect-Reference_Guide-LDAP_Configuration-Configuration">
<title>Configuration</title>
<para>
If you have an existing LDAP server, the eXo predefined settings will likely not match
your directory structure. eXo LDAP organization service implementation was written with
flexibility in mind and can certainly be configured to meet your requirements.
@@ -82,7 +82,7 @@
<para>
The configuration is done in <emphasis
role="bold">ldap-configuration.xml</emphasis> file, and this chapter
will explain the numerous parameters it contains.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Connection_Settings">
+ <section id="sect-Reference_Guide-Configuration-Connection_Settings">
<title>Connection Settings</title>
<para>
Firstly, start by connection settings which will tell eXo how to connect to your
directory server. These settings are very close to <ulink
url="http://java.sun.com/products/jndi">JNDI API</ulink> context
parameters. This configuration is activated by the init-param ldap.config of service
LDAPServiceImpl.
@@ -176,7 +176,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Organization_Service_Configuration">
+ <section
id="sect-Reference_Guide-Configuration-Organization_Service_Configuration">
<title>Organization Service Configuration</title>
<para>
Next, you need to configure the eXo <emphasis
role="bold">OrganizationService</emphasis> to tell him how the
directory is structured and how to interact with it. This is managed by a couple of
init-params : <emphasis role="bold">ldap.userDN.key</emphasis> and
<emphasis role="bold">ldap.attribute.mapping</emphasis> in file
<emphasis role="bold">ldap-configuration.xml</emphasis> (by default
located at portal.war/WEB-INF/conf/organization)
@@ -231,9 +231,9 @@
<para>
Other parameters are discussed in the following sections.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service_Configuration-Users">
+ <section
id="sect-Reference_Guide-Organization_Service_Configuration-Users">
<title>Users</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Users-Main_parameters">
+ <section id="sect-Reference_Guide-Users-Main_parameters">
<title>Main parameters</title>
<para>
Here are the main parameters to map eXo users to your directory :
@@ -314,7 +314,7 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Users-User_mapping">
+ <section id="sect-Reference_Guide-Users-User_mapping">
<title>User mapping</title>
<para>
The following parameters maps ldap attributes to eXo User java objects attributes.
@@ -381,7 +381,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service_Configuration-Groups">
+ <section
id="sect-Reference_Guide-Organization_Service_Configuration-Groups">
<title>Groups</title>
<para>
eXo groups can be mapped to organizational or applicative groups defined in your
directory.
@@ -467,7 +467,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service_Configuration-Membership_Types">
+ <section
id="sect-Reference_Guide-Organization_Service_Configuration-Membership_Types">
<title>Membership Types</title>
<para>
Membership types are the possible roles that can be assigned to users in groups.
@@ -542,7 +542,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service_Configuration-Memberships">
+ <section
id="sect-Reference_Guide-Organization_Service_Configuration-Memberships">
<title>Memberships</title>
<para>
Memberships are used to assign a role within a group. They are entries that are
placed under the group entry of their scope group. Users in this role are defined as
attributes of the membership entry.
@@ -649,7 +649,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service_Configuration-User_Profiles">
+ <section
id="sect-Reference_Guide-Organization_Service_Configuration-User_Profiles">
<title>User Profiles</title>
<para>
eXo User profiles also have entries in the ldap but the actual storage is still done
with the hibernate service. You will need the following parameters:
@@ -681,9 +681,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Configuration-Advanced_topics">
+ <section id="sect-Reference_Guide-LDAP_Configuration-Advanced_topics">
<title>Advanced topics</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_topics-Automatic_directory_population">
+ <section
id="sect-Reference_Guide-Advanced_topics-Automatic_directory_population">
<title>Automatic directory population</title>
<para>
At startup, eXo can populate the organization model based on
@@ -751,7 +751,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_topics-Active_Directory_sample_configuration">
+ <section
id="sect-Reference_Guide-Advanced_topics-Active_Directory_sample_configuration">
<title>Active Directory sample configuration</title>
<para>
Here is an alternative configuration for active directory that you can find in
<emphasis role="bold">activedirectory-configuration.xml</emphasis>
@@ -822,7 +822,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_topics-OpenLDAP_dynlist_overlays">
+ <section
id="sect-Reference_Guide-Advanced_topics-OpenLDAP_dynlist_overlays">
<title>OpenLDAP dynlist overlays</title>
<para>
If you use OpenLDAP, you may want to use the <ulink
url="http://www.openldap.org/faq/data/cache/1169.html">overl...;.
Here is how you can use the <ulink
url="http://www.openldap.org/faq/data/cache/1209.html">dynlist
overlay</ulink> to have memberships dynamically populated.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service-initalizer.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service-initalizer.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service-initalizer.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service_Initializer">
+<section id="sect-Reference_Guide-Organization_Service_Initializer">
<title>Organization Service Initializer</title>
<para>
Use the Organization Service Initializer to create users, groups and membership types
by default.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service-listener.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service-listener.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service-listener.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Listener">
+<section id="sect-Reference_Guide-Organization_Listener">
<title>Organization Listener</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Listener-Overview">
+ <section id="sect-Reference_Guide-Organization_Listener-Overview">
<title>Overview</title>
<para>
The Organization Service provides a mechanism to receive notifications when :
@@ -58,12 +58,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Listener-Writing_your_own_listeners">
+ <section
id="sect-Reference_Guide-Organization_Listener-Writing_your_own_listeners">
<title>Writing your own listeners</title>
<para>
To implement your own listener, you just need to write extend some existing listener
classes. These classes define hooks that are invoked before or after operations are
performed on organization model.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Writing_your_own_listeners-UserEventListener">
+ <section
id="sect-Reference_Guide-Writing_your_own_listeners-UserEventListener">
<title>UserEventListener</title>
<para>
To listen to user changes, you need to extend
<>org.exoplatform.services.organization.UserEventListener</>
:
@@ -91,7 +91,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Writing_your_own_listeners-GroupEventListener">
+ <section
id="sect-Reference_Guide-Writing_your_own_listeners-GroupEventListener">
<title>GroupEventListener</title>
<para>
To listen to group changes, you need to extend
<>org.exoplatform.services.organization.GroupEventListener</>
:
@@ -118,7 +118,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Writing_your_own_listeners-MembershipEventListener">
+ <section
id="sect-Reference_Guide-Writing_your_own_listeners-MembershipEventListener">
<title>MembershipEventListener</title>
<para>
To listen to membership changes, you need to extend
<>org.exoplatform.services.organization.MembershipEventListener</>
:
@@ -148,10 +148,10 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Listener-Registering_your_listeners">
+ <section
id="sect-Reference_Guide-Organization_Listener-Registering_your_listeners">
<title>Registering your listeners</title>
<para>
- Registering the listeners is then achieved by using the ExoContainer plugin mechanism.
Learn more about it on the <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Configuring_Services" />.
+ Registering the listeners is then achieved by using the ExoContainer plugin mechanism.
Learn more about it on the <xref
linkend="sect-Reference_Guide-Configuring_Services" />.
</para>
<para>
To effectively register organization service's listeners you simply need to use
the <>addListenerPlugin</> seer injector.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/organization-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service">
+<section id="sect-Reference_Guide-Organization_Service">
<title>Organization Service</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service-Overview">
+ <section id="sect-Reference_Guide-Organization_Service-Overview">
<title>Overview</title>
<para>
OrganizationService is the service that allows to access the Organization model. This
model is composed of :
@@ -58,9 +58,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service-Organizational_Model">
+ <section
id="sect-Reference_Guide-Organization_Service-Organizational_Model">
<title>Organizational Model</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organizational_Model-User">
+ <section id="sect-Reference_Guide-Organizational_Model-User">
<title>User</title>
<itemizedlist>
<listitem>
@@ -80,7 +80,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organizational_Model-Group">
+ <section id="sect-Reference_Guide-Organizational_Model-Group">
<title>Group</title>
<para>
Gather a set of users
@@ -115,7 +115,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organizational_Model-Membership">
+ <section id="sect-Reference_Guide-Organizational_Model-Membership">
<title>Membership</title>
<itemizedlist>
<listitem>
@@ -144,7 +144,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Organization_Service-Related_articles_and_how_tos">
+ <section
id="sect-Reference_Guide-Organization_Service-Related_articles_and_how_tos">
<title>Related articles and how-tos</title>
<itemizedlist>
<listitem>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/security-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/security-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/security-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Security_Service">
+<section id="sect-Reference_Guide-Security_Service">
<title>Security Service</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Security_Service-a1_Overview">
+ <section id="sect-Reference_Guide-Security_Service-a1_Overview">
<title>1 Overview</title>
<para>
The purpose is to make a simple, unified way for the authentication and the
storing/propagation of user sessions through all the eXo components and J2EE containers.
JAAS is supposed to be the primary login mechanism but the Security Service framework
should not prevent other (custom or standard) mechanisms from being used. You can learn
more about JAAS in the <ulink
url="http://java.sun.com/j2se/1.5.0/docs/guide/security/jaas/tutoria...
Tutorial</ulink>
@@ -13,7 +13,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Security_Service-a1_Framework">
+ <section id="sect-Reference_Guide-Security_Service-a1_Framework">
<title>1 Framework</title>
<para>
The central point of this framework is the <emphasis
role="bold">ConversationState</emphasis> object which stores all
information about the state of the current user (very similar to the Session concept). The
same ConversationState also stores acquired attributes of an <emphasis
role="bold">Identity</emphasis> which is a set of principals to
identify a user.
@@ -21,7 +21,7 @@
<para>
The ConversationState has definite lifetime. This object should be created when the
user's identity becomes known by eXo (login procedure) and destroyed when the user
leaves an eXo based application (logout procedure). Using JAAS it should happen in
LoginModule's login() and logout() methods respectively.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-a1_Framework-a1.1_ConversationState_and_ConversationRegistry">
+ <section
id="sect-Reference_Guide-a1_Framework-a1.1_ConversationState_and_ConversationRegistry">
<title>1.1 ConversationState and ConversationRegistry</title>
<para>
The ConversationState can be stored
@@ -71,7 +71,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-a1_Framework-a1.1_Authenticator">
+ <section id="sect-Reference_Guide-a1_Framework-a1.1_Authenticator">
<title>1.1 Authenticator</title>
<para>
An Authenticator is responsible for Identity creating, it contains two methods:
@@ -129,9 +129,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Security_Service-Usage">
+ <section id="sect-Reference_Guide-Security_Service-Usage">
<title>Usage</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Usage-JAAS_login_module">
+ <section id="sect-Reference_Guide-Usage-JAAS_login_module">
<title>JAAS login module</title>
<para>
The framework described is not coupled with any authentication mechanism but the most
logical and implemented by default is the JAAS Login module. The typical sequence looks as
follows (see org.exoplatform.services.security.jaas.DefaultLoginModule):
@@ -217,7 +217,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Usage-a1.1_Predefinded_JAAS_login_modules">
+ <section
id="sect-Reference_Guide-Usage-a1.1_Predefinded_JAAS_login_modules">
<title>1.1 Predefinded JAAS login modules</title>
<para>
There are several JAAS Login modules included in eXo Platform sources:
@@ -236,7 +236,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Usage-a1.1_J2EE_container_authentication">
+ <section
id="sect-Reference_Guide-Usage-a1.1_J2EE_container_authentication">
<title>1.1 J2EE container authentication</title>
<para>
As you know, when a user in JAAS is authenticated, a Subject is created as a result.
This Subject represents the authenticated user. It is important to know and follow the
rules regarding Subject filling which are specific for each J2EE server, where eXo
Platform is deployed.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/spring-security-integration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/spring-security-integration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/spring-security-integration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Spring_Security_Integration">
+<section id="sect-Reference_Guide-Spring_Security_Integration">
<title>Spring Security Integration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Spring_Security_Integration-Introduction">
+ <section
id="sect-Reference_Guide-Spring_Security_Integration-Introduction">
<title>Introduction</title>
<para>
How to Integrate the spring security framework in the eXo portal?
@@ -16,7 +16,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Spring_Security_Integration-Installation">
+ <section
id="sect-Reference_Guide-Spring_Security_Integration-Installation">
<title>Installation</title>
<para>
This tutorial assumes that you have a working eXo WCM installation running under JBoss
4.2.x.
@@ -60,12 +60,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Spring_Security_Integration-Configuration">
+ <section
id="sect-Reference_Guide-Spring_Security_Integration-Configuration">
<title>Configuration</title>
<para>
To enable spring security in exo we need to go through a few configuration steps:
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-JAAS_disabling">
+ <section id="sect-Reference_Guide-Configuration-JAAS_disabling">
<title>JAAS disabling</title>
<para>
First, we need to disable the JAAS security which is the default authentication
mechanism in exo. Edit 02portal.war web.xml file and comment out the JAAS configuration
related lines:
@@ -110,7 +110,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Enabling_spring_security">
+ <section
id="sect-Reference_Guide-Configuration-Enabling_spring_security">
<title>Enabling spring security</title>
<para>
To enable spring and set the spring security filter, add the following lines:
@@ -154,7 +154,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-security_context.xml">
+ <section
id="sect-Reference_Guide-Configuration-security_context.xml">
<title>security-context.xml</title>
<para>
We need to configure the spring security filter chain for our purposes. Create a file
named security-context.xml in 02portal.war WEB-INF directory containing the following
lines:
@@ -192,12 +192,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Spring_Security_Integration-Login_portlet_example">
+ <section
id="sect-Reference_Guide-Spring_Security_Integration-Login_portlet_example">
<title>Login portlet example</title>
<para>
Now that we have successfully installed and configured spring security in exo, we need
a login portlet example to capture user credentials and serve as an entry point in the
authentication process. The login portlet itself is based on JSF 1.2, Jboss portlet bridge
and the spring framework, but you can obviously use whatever web framework you want to
achieve the same.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Login_portlet_example-Building_the_portlet">
+ <section
id="sect-Reference_Guide-Login_portlet_example-Building_the_portlet">
<title>Building the portlet</title>
<para>
So we need a login form to capture user credentials inputs. The portlet login form
consists of the following lines of xml:
@@ -272,7 +272,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Login_portlet_example-Setting_up_the_login_portal_page">
+ <section
id="sect-Reference_Guide-Login_portlet_example-Setting_up_the_login_portal_page">
<title>Setting up the login portal page</title>
<para>
Now that we have a login portlet available we need to set it up into a portal page.
@@ -307,7 +307,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Login_portlet_example-Customization_of_portal_login_and_logout_urls">
+ <section
id="sect-Reference_Guide-Login_portlet_example-Customization_of_portal_login_and_logout_urls">
<title>Customization of portal login and logout urls</title>
<para>
In the portal header, there is a login or logout action displayed depending whether
you are already logged in or not. We need to customize those actions so that when the user
clicks on it she or he will be redirected either to our login page or to the spring
security logout url. Edit the article, go to the default.js tab and apply the following
changes to the code:
@@ -351,7 +351,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Login_portlet_example-A_look_at_the_login_page">
+ <section
id="sect-Reference_Guide-Login_portlet_example-A_look_at_the_login_page">
<title>A look at the login page</title>
<para>
Once you are done with all this, just click on the login action and you should be
redirect to the login page looking something like that:
@@ -368,7 +368,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Spring_Security_Integration-Integration_strategies">
+ <section
id="sect-Reference_Guide-Spring_Security_Integration-Integration_strategies">
<title>Integration strategies</title>
<para>
Until now we haven't discussed about any integration strategies concerning a
potential existing security realm outside of the eXo platform. To address this problem we
have the choice between at least two different strategies:
@@ -376,7 +376,7 @@
<para>
1.1.1 <emphasis role="bold">Direct integration</emphasis> We can
directly integrate eXo with the external realm. Everything related to organisation and
user management in exo is cleanly separated in its own abstraction accessible through the
OrganisationService. The authentication process itself is encapsulated in the
Authenticator abstraction which sits on top of the organization service. eXo provides
several implementations of both. So whether your realm is based on LDAP or JDBC and
because the default implementations are generic enough, you will be able to use them and
fits them to your needs with a matter of a little configuration. You can even develop a
custom implementation to meet your more specific needs.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Integration_strategies-Replication">
+ <section
id="sect-Reference_Guide-Integration_strategies-Replication">
<title>Replication</title>
<para>
Or we can go through a replication process between the external realm and the eXo
platform realm. This is the strategy that we are going to use to build our login portlet
example. Furthermore, the replication will occur dynamically on any user authentication
attempt.
@@ -387,7 +387,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Spring_Security_Integration-Integration_with_eXo_portal">
+ <section
id="sect-Reference_Guide-Spring_Security_Integration-Integration_with_eXo_portal">
<title>Integration with eXo portal</title>
<para>
Being successfully authenticated against an external realm is not sufficient by
itself. We also need to propagate the newly created security context to the portal own
security mechanism. In eXo portal terminology, it means we have to create an Identity
object for the user and register it into the Identity Registry.
@@ -473,12 +473,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Spring_Security_Integration-Security_context_propagation_to_portlets">
+ <section
id="sect-Reference_Guide-Spring_Security_Integration-Security_context_propagation_to_portlets">
<title>Security context propagation to portlets</title>
<para>
Part of the problem is the question of security context propagation between on one
side the portal webapp and at the other side the portlets webapps. This means that the
security context has to be available in the portlet side allowing the application logic to
deal the with current user principal and granted authorities. By default, Spring security
uses a thread local variable to partially achieve this. But a problem may arise due to the
fact that the portal invokes the portlet through a webapp cross context call. This means
that it can lead to a class cast exceptions (two different classloaders involved), or that
the security context is simply not propagated at all. To accommodate this, we will need to
set up two request filters, one at the portal webapp side and the other at the portlet
webapp side and use the http request to propagate the context in between.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Security_context_propagation_to_portlets-Portal_side_filter">
+ <section
id="sect-Reference_Guide-Security_context_propagation_to_portlets-Portal_side_filter">
<title>Portal side filter</title>
<para>
We will use the spring security extensible filter chain to plug in our filter.
@@ -523,7 +523,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Security_context_propagation_to_portlets-Portlet_side_filter">
+ <section
id="sect-Reference_Guide-Security_context_propagation_to_portlets-Portlet_side_filter">
<title>Portlet side filter</title>
<para>
In the portlet webapp we create a regular filter named
PortletSideSecurityContextFilter.
@@ -601,7 +601,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Spring_Security_Integration-Conclusion">
+ <section
id="sect-Reference_Guide-Spring_Security_Integration-Conclusion">
<title>Conclusion</title>
<para>
We are done! Now we know how to integrate the spring security framework in the eXo
portal. Thanks to the the great integration capabilities of both eXo portal and Spring
framework. You can have a look to the attachment section on this page and get the source
code of this tutorial.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/tika-document-reader-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/tika-document-reader-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core/tika-document-reader-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Tika_Document_Reader_Service">
+<section id="sect-Reference_Guide-Tika_Document_Reader_Service">
<title>Tika Document Reader Service</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Tika_Document_Reader_Service-Intro">
+ <section id="sect-Reference_Guide-Tika_Document_Reader_Service-Intro">
<title>Intro</title>
<para>
DocumentReaderService provides API to retrieve DocumentReader by mimetype.
@@ -16,7 +16,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Tika_Document_Reader_Service-Architecture">
+ <section
id="sect-Reference_Guide-Tika_Document_Reader_Service-Architecture">
<title>Architecture</title>
<para>
Basically, DocumentReaderService is a container for all registered DocumentReaders.
So, you can register DocumentReader (method addDocumentReader(ComponentPlugin reader)) and
fetch DocumentReader by mimeType (method getDocumentReader(String mimeType)).
@@ -36,7 +36,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Tika_Document_Reader_Service-Configuration">
+ <section
id="sect-Reference_Guide-Tika_Document_Reader_Service-Configuration">
<title>Configuration</title>
<para>
How TikaDocumentReaderService Impl configuration looks like:
@@ -299,7 +299,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Tika_Document_Reader_Service-Old_style_DocumentReaders_and_Tika_Parsers">
+ <section
id="sect-Reference_Guide-Tika_Document_Reader_Service-Old_style_DocumentReaders_and_Tika_Parsers">
<title>Old-style DocumentReaders and Tika Parsers</title>
<para>
As you see configuration above, there is both old-style DocumentReaders and new Tika
parsers registered.
@@ -310,7 +310,7 @@
<para>
Old-style DocumentReader registered in configuration become registered into
DocumentReaderService. So, mimetypes that is supported by those DocumentReaders will have
a registered pair, and user will always fetch this DocumentReaders with
getDocumentReader(..) method. Tika configuration will be checked for Parsers only if there
is no already registered DocumentReader.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Old_style_DocumentReaders_and_Tika_Parsers-How_to_make_and_register_own_DocumentReader">
+ <section
id="sect-Reference_Guide-Old_style_DocumentReaders_and_Tika_Parsers-How_to_make_and_register_own_DocumentReader">
<title>How to make and register own DocumentReader</title>
<para>
You can make you own DocumentReader in two ways.
@@ -389,7 +389,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Tika_Document_Reader_Service-TikaDocumentReader_features_and_notes">
+ <section
id="sect-Reference_Guide-Tika_Document_Reader_Service-TikaDocumentReader_features_and_notes">
<title>TikaDocumentReader features and notes</title>
<para>
TikaDocumentReader features and notes:
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/core.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-eXoCore">
+<section id="sect-Reference_Guide-eXoCore">
<title>eXoCore</title>
<xi:include href="core/core.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="core/db-creator-service.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/faq/jcr-faq.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/faq/jcr-faq.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/faq/jcr-faq.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_FAQ">
+<section id="sect-Reference_Guide-JCR_FAQ">
<title>JCR FAQ</title>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_FAQ-Kernel">
+ <section id="sect-Reference_Guide-JCR_FAQ-Kernel">
<title>Kernel</title>
<variablelist>
<title></title>
@@ -26,7 +26,7 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-JCR_FAQ-JCR_core">
+ <section id="sect-Reference_Guide-JCR_FAQ-JCR_core">
<title>JCR core</title>
<variablelist>
<title></title>
@@ -683,7 +683,7 @@
</variablelist>
- </section> --> <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_FAQ-WebDAV">
+ </section> --> <section
id="sect-Reference_Guide-JCR_FAQ-WebDAV">
<title>WebDAV</title>
<variablelist>
<title></title>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/faq.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/faq.xml 2011-11-25 00:48:53
UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/faq.xml 2011-11-25 01:13:48
UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Frequently_Asked_Question">
+<section id="sect-Reference_Guide-Frequently_Asked_Question">
<title>Frequently Asked Question</title>
<xi:include href="faq/jcr-faq.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/api-extensions.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/api-extensions.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/api-extensions.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,13 +1,13 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-JCR_API_Extensions">
+<chapter id="chap-Reference_Guide-JCR_API_Extensions">
<title>JCR API Extensions</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_API_Extensions-Lazy_child_nodes_iteration">
+ <section
id="sect-Reference_Guide-JCR_API_Extensions-Lazy_child_nodes_iteration">
<title>"Lazy" child nodes iteration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Lazy_child_nodes_iteration-Concept">
+ <section
id="sect-Reference_Guide-Lazy_child_nodes_iteration-Concept">
<title>Concept</title>
<para>
eXo JCR implementation offers new extended feature beyond JCR specification.
Sometimes it happens that one JCR Node has hundreds or even thousands of child nodes. This
situation is highly not recommended for content repository data storage, but some times it
occurs. JCR Team is pleased to announce new feature that will help to have a deal with
huge child lists. They can be iterated in a "lazy" manner now giving improvement
in term of performance and RAM usage.
@@ -15,7 +15,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Lazy_child_nodes_iteration-API_and_usage">
+ <section
id="sect-Reference_Guide-Lazy_child_nodes_iteration-API_and_usage">
<title>API and usage</title>
<para>
Lazy child nodes iteration feature is accessible via extended interface
org.exoplatform.services.jcr.core.ExtendedNode, the inheritor of javax.jcr.Node. It
provides a new single method shown below:
@@ -39,7 +39,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Lazy_child_nodes_iteration-Configuration">
+ <section
id="sect-Reference_Guide-Lazy_child_nodes_iteration-Configuration">
<title>Configuration</title>
<para>
"Lazy" iterator makes ahead reading into memory, though reading the
"page". "Page" is a set of nodes read at once. Size of the page by
default is 100 nodes and can be configured though workspace container configuration using
"lazy-node-iterator-page-size" parameter. I.e.:
@@ -60,7 +60,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Lazy_child_nodes_iteration-Implementation_notices">
+ <section
id="sect-Reference_Guide-Lazy_child_nodes_iteration-Implementation_notices">
<title>Implementation notices</title>
<para>
Current "lazy" child nodes iterator supports caching, when pages are cached
atomically in safe and optimized way. Cache is always kept in consistent state using
invalidation if child list changed. Take in account the following difference in getNodes
and getNodesLazily. Specification defined getNodes method reads whole list of nodes, so
child items added after invocation will never be in results. GetNodesLazily doesn't
acquire full list of nodes, so child items added after iterator creation can be found in
result. So getNodesLazily can represent some kind of "real-time" results. But it
is highly depend on numerous conditions and should not be used as a feature, it more
likely implementation specific issue typical for "lazy-pattern".
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/backup-client.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/backup-client.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/backup-client.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client">
+<chapter id="chap-Reference_Guide-HTTPBackupAgent_and_Backup_Client">
<title><literal>HTTPBackupAgent</literal> and Backup
Client</title>
<warning>
<title>Configuration Persistance</title>
@@ -22,7 +22,7 @@
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client-Introduction">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_and_Backup_Client-Introduction">
<title>Introduction</title>
<para>
The
<literal>org.exoplatform.services.jcr.ext.backup.server.HTTPBackupAgent</literal>
service is REST-based front-end to
<literal>rg.exoplatform.services.jcr.ext.backup.BackupManager</literal>.
@@ -36,7 +36,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client-HTTPBackupAgent_">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_and_Backup_Client-HTTPBackupAgent_">
<title><literal>HTTPBackupAgent</literal> </title>
<para>
The <literal>HTTPBackupAgent</literal> is based on REST and uses
<literal>POST</literal> and <literal>GET</literal> methods for
request.
@@ -83,9 +83,9 @@
</listitem>
</itemizedlist>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_-Methods">
+ <section id="sect-Reference_Guide-HTTPBackupAgent_-Methods">
<title>Methods</title>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Starting_Backup_Service">
+ <variablelist
id="vari-Reference_Guide-Methods-Starting_Backup_Service">
<title>Starting Backup Service</title>
<varlistentry>
<term>/rest/jcr-backup/start/{repo}/{ws}</term>
@@ -257,7 +257,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Stopping_Backup_Service">
+ <variablelist
id="vari-Reference_Guide-Methods-Stopping_Backup_Service">
<title>Stopping Backup Service</title>
<varlistentry>
<term>/rest/jcr-backup/stop/{id}</term>
@@ -330,7 +330,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Backup_Info_Service">
+ <variablelist id="vari-Reference_Guide-Methods-Backup_Info_Service">
<title>Backup Info Service</title>
<varlistentry>
<term>/rest/jcr-backup/info</term>
@@ -413,7 +413,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Dropping_Workspace_Service">
+ <variablelist
id="vari-Reference_Guide-Methods-Dropping_Workspace_Service">
<title>Dropping Workspace Service</title>
<varlistentry>
<term>/rest/jcr-backup/drop-workspace/{repo}/{ws}/{force-session-close}</term>
@@ -492,7 +492,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Backup_Info">
+ <variablelist id="vari-Reference_Guide-Methods-Backup_Info">
<title>Backup Info</title>
<varlistentry>
<term>/rest/jcr-backup/info/backup</term>
@@ -608,7 +608,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Current_Backups_Information">
+ <variablelist
id="vari-Reference_Guide-Methods-Current_Backups_Information">
<title>Current Backups Information</title>
<varlistentry>
<term>/rest/jcr-backup/info/backup/current</term>
@@ -681,7 +681,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Completed_Backups_Information">
+ <variablelist
id="vari-Reference_Guide-Methods-Completed_Backups_Information">
<title>Completed Backups Information</title>
<varlistentry>
<term>/rest/jcr-backup/info/backup/completed</term>
@@ -754,7 +754,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Workspace_specific_Backup_Information">
+ <variablelist
id="vari-Reference_Guide-Methods-Workspace_specific_Backup_Information">
<title>Workspace-specific Backup Information</title>
<varlistentry>
<term>/rest/jcr-backup/info/backup/{repo}/{ws}</term>
@@ -830,7 +830,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Single_Backup_Information">
+ <variablelist
id="vari-Reference_Guide-Methods-Single_Backup_Information">
<title>Single Backup Information</title>
<varlistentry>
<term>/rest/jcr-backup/info/backup/{id}</term>
@@ -948,7 +948,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Restores_on_a_Workspace_Information">
+ <variablelist
id="vari-Reference_Guide-Methods-Restores_on_a_Workspace_Information">
<title>Restores on a Workspace Information</title>
<varlistentry>
<term>/rest/jcr-backup/info/restore/{repo}/{ws}</term>
@@ -1025,7 +1025,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Restores_Information">
+ <variablelist
id="vari-Reference_Guide-Methods-Restores_Information">
<title>Restores Information</title>
<varlistentry>
<term>/rest/jcr-backup/info/restores</term>
@@ -1098,7 +1098,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Restoring_Service">
+ <variablelist id="vari-Reference_Guide-Methods-Restoring_Service">
<title>Restoring Service</title>
<varlistentry>
<term>/rest/jcr-backup/restore/{repo}/{id}</term>
@@ -1283,7 +1283,7 @@
</varlistentry>
</variablelist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Methods-Default_Workspace_Information">
+ <variablelist
id="vari-Reference_Guide-Methods-Default_Workspace_Information">
<title>Default Workspace Information</title>
<varlistentry>
<term>/rest/jcr-backup/info/default-ws-config</term>
@@ -1452,7 +1452,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_-HTTPBackupAgent_Configuration">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_-HTTPBackupAgent_Configuration">
<title>HTTPBackupAgent Configuration</title>
<para>
Add the components
<literal>org.exoplatform.services.jcr.ext.backup.server.HTTPBackupAgent</literal>
and <literal>org.exoplatform.services.jcr.ext.backup.BackupManager</literal>
to services configuration:
@@ -1504,7 +1504,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client-Backup_Client">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_and_Backup_Client-Backup_Client">
<title>Backup Client</title>
<note>
<para>
@@ -1584,7 +1584,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client-Building_and_Running_Application">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_and_Backup_Client-Building_and_Running_Application">
<title>Building and Running Application</title>
<note>
<title>Document Convention</title>
@@ -1647,7 +1647,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client-Starting_Backups">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_and_Backup_Client-Starting_Backups">
<title>Starting Backups</title>
<para>
To start a full backup only on the workspace called "backup", pass the
parameter <parameter><bakcup_dir></parameter>
(<parameter>../temp/backup</parameter>) to the command:
@@ -1748,7 +1748,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client-Stopping_Backups">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_and_Backup_Client-Stopping_Backups">
<title>Stopping Backups</title>
<para>
Stop an individual backup with the following command:
@@ -1765,7 +1765,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client-Restoring">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_and_Backup_Client-Restoring">
<title>Restoring</title>
<important>
<title>Linebreaks</title>
@@ -2014,7 +2014,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client-Walkthrough_Creating_a_Backup_and_Restoring_a_Workspace">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_and_Backup_Client-Walkthrough_Creating_a_Backup_and_Restoring_a_Workspace">
<title>Walkthrough: Creating a Backup and Restoring a Workspace</title>
<procedure>
<title></title>
@@ -2132,7 +2132,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-HTTPBackupAgent_and_Backup_Client-Walkthrough_Creating_a_Backup_and_Restoring_a_Repository">
+ <section
id="sect-Reference_Guide-HTTPBackupAgent_and_Backup_Client-Walkthrough_Creating_a_Backup_and_Restoring_a_Repository">
<title>Walkthrough: Creating a Backup and Restoring a Repository</title>
<note>
<title>Default Repository</title>
@@ -2152,7 +2152,7 @@
</component></programlisting>
</important>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Walkthrough_Creating_a_Backup_and_Restoring_a_Repository-Backup_and_Restore_a_Repository">
+ <procedure
id="proc-Reference_Guide-Walkthrough_Creating_a_Backup_and_Restoring_a_Repository-Backup_and_Restore_a_Repository">
<title>Backup and Restore a Repository</title>
<step>
<title>Creating a backup</title>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/backup-clonsole-dist.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/backup-clonsole-dist.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/backup-clonsole-dist.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution">
+<chapter id="chap-Reference_Guide-Backup_Console_Binary_Distribution">
<title>Backup Console Binary Distribution</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution-Introduction">
+ <section
id="sect-Reference_Guide-Backup_Console_Binary_Distribution-Introduction">
<title>Introduction</title>
<para>
The backup console binary distribution is a script-based front-end to the backup
client. It assists you to create backups, restore, get the status of current or completed
backup/restore processes.
@@ -16,7 +16,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution-jcrbackup.cmd_and_jcrbackup.sh">
+ <section
id="sect-Reference_Guide-Backup_Console_Binary_Distribution-jcrbackup.cmd_and_jcrbackup.sh">
<title><command>jcrbackup.cmd</command> and
<command>jcrbackup.sh</command></title>
<para>
These scripts are flexible for various authentication methods in shell scripts.
@@ -83,7 +83,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution-exobackup.sh_and_exobackup.cmd">
+ <section
id="sect-Reference_Guide-Backup_Console_Binary_Distribution-exobackup.sh_and_exobackup.cmd">
<title><command>exobackup.sh</command> and
<command>exobackup.cmd</command></title>
<para>
These scripts are suitable for use with JBoss Enterprise Portal Platform.
@@ -143,9 +143,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution-Backup_Console_Binary_Distribution_usage">
+ <section
id="sect-Reference_Guide-Backup_Console_Binary_Distribution-Backup_Console_Binary_Distribution_usage">
<title>Backup Console Binary Distribution usage</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution_usage-Building_Application">
+ <section
id="sect-Reference_Guide-Backup_Console_Binary_Distribution_usage-Building_Application">
<title>Building Application</title>
<procedure>
<title></title>
@@ -169,7 +169,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution_usage-Getting_Information_About_Backup_Service">
+ <section
id="sect-Reference_Guide-Backup_Console_Binary_Distribution_usage-Getting_Information_About_Backup_Service">
<title>Getting Information About Backup Service</title>
<para>
The context is "<emphasis>portal</emphasis>" by default for
<literal>FORM</literal> authentication.
@@ -191,7 +191,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Backup_Console_Binary_Distribution_usage-Getting_Information_About_Backup_Service_Not_Using_Default_Context">
+ <section
id="sect-Reference_Guide-Backup_Console_Binary_Distribution_usage-Getting_Information_About_Backup_Service_Not_Using_Default_Context">
<title>Getting Information About Backup Service Not Using Default
Context</title>
<para>
If the context is "<emphasis>exodms-demo</emphasis>", the
command would be:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service">
+<chapter id="chap-Reference_Guide-eXo_JCR_Backup_Service">
<title>eXo JCR Backup Service</title>
<note>
<para>
@@ -11,7 +11,7 @@
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Concept">
+ <section id="sect-Reference_Guide-eXo_JCR_Backup_Service-Concept">
<title>Concept</title>
<para>
The main purpose of this feature is to restore data in case of system faults
and repository crashes. Also, the backup results may be used as a content history.
@@ -61,9 +61,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-How_it_works">
+ <section
id="sect-Reference_Guide-eXo_JCR_Backup_Service-How_it_works">
<title>How it works</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_it_works-Implementation_details">
+ <section
id="sect-Reference_Guide-How_it_works-Implementation_details">
<title>Implementation details</title>
<para>
<emphasis>Full</emphasis> backup/restore is implemented using
the JCR SysView Export/Import. Workspace data will be exported into Sysview XML data from
root node.
@@ -87,7 +87,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_it_works-Work_basics">
+ <section id="sect-Reference_Guide-How_it_works-Work_basics">
<title>Work basics</title>
<para>
The work of Backup is based on the BackupConfig configuration and the
BackupChain logical unit.
@@ -134,7 +134,7 @@
<para>
<literal>BackupChain</literal> can contain one or more
<literal>BackupJobs</literal>. The initial
<emphasis>Full</emphasis> job is always there. Each
<literal>BackupJobs</literal> has its own unique number which means its Job
order in the chain, the initial <emphasis>Full</emphasis> job always has the
number <literal>0</literal>.
</para>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Work_basics-Backup_process_result_data_and_file_location">
+ <formalpara
id="form-Reference_Guide-Work_basics-Backup_process_result_data_and_file_location">
<title>Backup process, result data and file location</title>
<para>
To start the backup process, it is necessary to create the
<literal>BackupConfig</literal> and call the
<literal>BackupManager.startBackup(BackupConfig)</literal> method. This method
will return <literal>BackupChain</literal> created according to the
configuration. At the same time, the chain creates a
<literal>BackupChainLog</literal> which persists
<literal>BackupConfig</literal> content and
<literal>BackupChain</literal> operation states to the file in the service
working directory (see Configuration).
@@ -159,7 +159,7 @@
</para>
</note>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Work_basics-Restore_requirements">
+ <formalpara
id="form-Reference_Guide-Work_basics-Restore_requirements">
<title>Restore requirements</title>
<para>
As outlined earlier, a Restore operation is a mirror of a Backup. The
process is a <emphasis>Full</emphasis> restore of a root node with restoring
an additional <emphasis>Incremental</emphasis> backup to reach a desired
workspace state. Restoring the workspace <emphasis>Full</emphasis> backup will
create a new workspace in the repository using given
<literal>RepositoryEntry</literal> of existing repository and given
(preconfigured) WorkspaceEntry for a new target workspace. A Restore process will restore
a root node from the SysView XML data.
@@ -182,7 +182,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Configuration">
+ <section
id="sect-Reference_Guide-eXo_JCR_Backup_Service-Configuration">
<title>Configuration</title>
<para>
As an optional extension, the Backup service is not enabled by default.
<emphasis role="bold">You need to enable it via
configuration</emphasis>.
@@ -192,10 +192,10 @@
</para>
<programlistingco>
<areaspec>
- <area coords="9"
id="area-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Configuration-incremental-backup-type"
/>
- <area coords="8"
id="area-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Configuration-full-backup-type"
/>
- <area coords="7"
id="area-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Configuration-default-incremental-job-period"
/>
- <area coords="10"
id="area-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Configuration-backup-dir"
/>
+ <area coords="9"
id="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-incremental-backup-type"
/>
+ <area coords="8"
id="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-full-backup-type"
/>
+ <area coords="7"
id="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-default-incremental-job-period"
/>
+ <area coords="10"
id="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-backup-dir" />
</areaspec>
@@ -209,9 +209,9 @@
</properties-param>
</init-params>
</component></programlisting>
- <calloutlist
id="call-Reference_Guide_eXo_JCR_1.14-Configuration-Mandatory_parameter">
+ <calloutlist
id="call-Reference_Guide-Configuration-Mandatory_parameter">
<title>Mandatory parameter</title>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Configuration-backup-dir">
+ <callout
arearefs="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-backup-dir">
<para>
<parameter>backup-dir</parameter> is the path to a
working directory where the service will store internal files and chain logs.
</para>
@@ -219,21 +219,21 @@
</callout>
</calloutlist>
- <calloutlist
id="call-Reference_Guide_eXo_JCR_1.14-Configuration-Optional_parameters">
+ <calloutlist
id="call-Reference_Guide-Configuration-Optional_parameters">
<title>Optional parameters</title>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Configuration-incremental-backup-type">
+ <callout
arearefs="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-incremental-backup-type">
<para>
<parameter>incremental-backup-type</parameter> The
FQN of incremental job class. Must implement
<literal>org.exoplatform.services.jcr.ext.backup.BackupJob</literal>. By
default,
<literal>org.exoplatform.services.jcr.ext.backup.impl.fs.FullBackupJob</literal>
is used.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Configuration-full-backup-type">
+ <callout
arearefs="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-full-backup-type">
<para>
<parameter>full-backup-type</parameter> is the FQN of
the full backup job class. It must implement
<literal>org.exoplatform.services.jcr.ext.backup.BackupJob</literal>. By
default,
<literal>org.exoplatform.services.jcr.ext.backup.impl.rdbms.FullBackupJob</literal>
is used. Please, notice that file-system based implementation
<literal>org.exoplatform.services.jcr.ext.backup.impl.fs.FullBackupJob</literal>
is deprecated and not recommended for use..
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Configuration-default-incremental-job-period">
+ <callout
arearefs="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-default-incremental-job-period">
<para>
<parameter>default-incremental-job-period</parameter>
is the period between incremental flushes (in seconds). Default is
<literal>3600</literal> seconds.
</para>
@@ -247,7 +247,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-RDBMS_backup">
+ <section
id="sect-Reference_Guide-eXo_JCR_Backup_Service-RDBMS_backup">
<title>RDBMS backup</title>
<para>
RDBMS backup It is the latest, currently supported used by default and
recommended implementation of full backup job for BackupManager service. It is useful in
case when database is used to store data.
@@ -288,9 +288,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Usage">
+ <section id="sect-Reference_Guide-eXo_JCR_Backup_Service-Usage">
<title>Usage</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Usage-Performing_a_Backup">
+ <section id="sect-Reference_Guide-Usage-Performing_a_Backup">
<title>Performing a Backup</title>
<para>
In the following example, we create a
<literal>BackupConfig</literal> bean for the
<emphasis>Full</emphasis> + <emphasis>Incremental</emphasis>s
mode, then we ask the BackupManager to start the backup process.
@@ -324,7 +324,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Usage-Performing_a_Restore">
+ <section id="sect-Reference_Guide-Usage-Performing_a_Restore">
<title>Performing a Restore</title>
<para>
Restoration involves reloading the backup file into a
<literal>BackupChainLog</literal> and applying appropriate workspace
initialization. The following snippet shows the typical sequence for restoring a
workspace:
@@ -348,7 +348,7 @@
// run restoration
backup.restore(bchLog, repositoryEntry, workspaceEntry);</programlisting>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Performing_a_Restore-Restoring_Into_An_Existing_Workspace">
+ <section
id="sect-Reference_Guide-Performing_a_Restore-Restoring_Into_An_Existing_Workspace">
<title>Restoring Into An Existing Workspace</title>
<note>
<para>
@@ -359,7 +359,7 @@
<para>
To restore a backup over an existing workspace, you are required to
clear its data. Your backup process should follow these steps:
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Restoring_Into_An_Existing_Workspace-Restore_Over_a_Workspace">
+ <procedure
id="proc-Reference_Guide-Restoring_Into_An_Existing_Workspace-Restore_Over_a_Workspace">
<title>Restore Over a Workspace</title>
<step>
<para>
@@ -388,7 +388,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Performing_a_Restore-System_workspace">
+ <section
id="sect-Reference_Guide-Performing_a_Restore-System_workspace">
<title>System workspace</title>
<note>
<para>
@@ -454,7 +454,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Usage-Repository_and_Workspace_Initialization_From_Backup">
+ <section
id="sect-Reference_Guide-Usage-Repository_and_Workspace_Initialization_From_Backup">
<title>Repository and Workspace Initialization From
Backup</title>
<para>
Repository and Workspace initialization from backup can use the
<literal>BackupWorkspaceInitializer</literal>.
@@ -516,7 +516,7 @@
</initializer>
...
</workspace></programlisting>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Repository_and_Workspace_Initialization_From_Backup-Restore_the_Workspace_over_BackupWorkspaceInitializer">
+ <section
id="sect-Reference_Guide-Repository_and_Workspace_Initialization_From_Backup-Restore_the_Workspace_over_BackupWorkspaceInitializer">
<title>Restore the Workspace over
BackupWorkspaceInitializer</title>
<para>
Below is an example of configuration initializer to restore the
workspace "<emphasis>backup</emphasis>" over
<literal>BackupWorkspaceInitializer</literal>:
@@ -566,7 +566,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Repository_and_Workspace_Initialization_From_Backup-Restore_the_Repository_over_BackupWorkspaceInitializer">
+ <section
id="sect-Reference_Guide-Repository_and_Workspace_Initialization_From_Backup-Restore_the_Repository_over_BackupWorkspaceInitializer">
<title>Restore the Repository over
BackupWorkspaceInitializer</title>
<para>
Below is an example of configuration initializers to restore the
repository "<emphasis>repository</emphasis>" over
<literal>BackupWorkspaceInitializer</literal>:
@@ -650,7 +650,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Scheduling_experimental">
+ <section
id="sect-Reference_Guide-eXo_JCR_Backup_Service-Scheduling_experimental">
<title>Scheduling (experimental)</title>
<para>
The Backup service has an additional feature that can be useful for a
production level backup implementation. When you need to organize a backup of a
repository, it is necessary to have a tool which will be able to create and manage a cycle
of <emphasis>Full</emphasis> and <emphasis>Incremental</emphasis>
backups in a periodic manner.
@@ -661,7 +661,7 @@
<para>
For that purpose, <literal>BackupScheduler</literal> has the
method: <parameter>BackupScheduler.schedule(backupConfig, startDate, stopDate,
chainPeriod, incrementalPeriod)</parameter>
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Scheduling_experimental-BackupScheduler_Method">
+ <variablelist
id="vari-Reference_Guide-Scheduling_experimental-BackupScheduler_Method">
<title>BackupScheduler Method</title>
<varlistentry>
<term>backupConfig</term>
@@ -752,7 +752,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Restore_existing_workspace_or_repository">
+ <section
id="sect-Reference_Guide-eXo_JCR_Backup_Service-Restore_existing_workspace_or_repository">
<title>Restore existing workspace or repository</title>
<para>
The resore of existing workspace or repository is available.
@@ -873,7 +873,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Restore_a_workspace_or_a_repository_using_original_configuration">
+ <section
id="sect-Reference_Guide-eXo_JCR_Backup_Service-Restore_a_workspace_or_a_repository_using_original_configuration">
<title>Restore a workspace or a repository using original
configuration</title>
<para>
The Backup manager allows you to restore a repository or a workspace using
the original configuration stored into the backup log:
@@ -1015,7 +1015,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Backup_Service-Backup_set_portability">
+ <section
id="sect-Reference_Guide-eXo_JCR_Backup_Service-Backup_set_portability">
<title>Backup set portability</title>
<para>
The Backup log is stored during the Backup operation into two different
locations: <parameter>backup-dir</parameter> directory of
<literal>BackupService</literal> to support interactive operations via Backup
API (e.g. console) and backup set files for portability (e.g. on another server).
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/use-external-backup-tool.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/use-external-backup-tool.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/use-external-backup-tool.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Use_External_Backup_Tool">
+<chapter id="chap-Reference_Guide-Use_External_Backup_Tool">
<title>Use External Backup Tool</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Use_External_Backup_Tool-Repository_Suspending">
+ <section
id="sect-Reference_Guide-Use_External_Backup_Tool-Repository_Suspending">
<title>Repository Suspending</title>
<para>
To have the repository content consistent with the search index and value storage, the
repository should be suspened. This means all working threads are suspended until a resume
operation is performed. The index will be flushed.
@@ -34,7 +34,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Use_External_Backup_Tool-Backup">
+ <section id="sect-Reference_Guide-Use_External_Backup_Tool-Backup">
<title>Backup</title>
<para>
You can backup your content manually or by using third part software. You should back
up:
@@ -63,7 +63,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Use_External_Backup_Tool-Repository_Resuming">
+ <section
id="sect-Reference_Guide-Use_External_Backup_Tool-Repository_Resuming">
<title>Repository Resuming</title>
<para>
Once a backup is done you need to invoke the <literal>resume()</literal>
operation to switch the repository back to online. The returned result will be
"<emphasis>online</emphasis>".
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,13 +1,13 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Cluster_Configuration">
+<chapter id="chap-Reference_Guide-Cluster_Configuration">
<!-- This document was created with Syntext Serna Free. -->
<title>Cluster Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Cluster_Configuration-Launching_Cluster">
+ <section
id="sect-Reference_Guide-Cluster_Configuration-Launching_Cluster">
<title>Launching Cluster</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Deploying_eXo_JCR_to_JBoss_Application_Server">
+ <section
id="sect-Reference_Guide-Launching_Cluster-Deploying_eXo_JCR_to_JBoss_Application_Server">
<title>Deploying eXo JCR to JBoss Application Server</title>
<para>
To deploy eXo JCR to the JBoss AS, do the following:
@@ -94,22 +94,22 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Configuring_JCR_to_use_external_configuration">
+ <section
id="sect-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration">
<title>Configuring JCR to use external configuration</title>
<itemizedlist>
<listitem>
<para>
- To manually configure a repository, create a new configuration
file (<filename>exo-jcr-configuration.xml</filename> for example). For
details, see <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-JCR_configuration" />.
+ To manually configure a repository, create a new configuration
file (<filename>exo-jcr-configuration.xml</filename> for example). For
details, see <xref linkend="chap-Reference_Guide-JCR_configuration" />.
</para>
<para>
The configuration file must be formatted as follows:
</para>
<programlistingco>
<areaspec>
- <area coords="20"
id="area-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Configuring_JCR_to_use_external_configuration-value_storages"
/>
- <area coords="27"
id="area-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_cache"
/>
- <area coords="31"
id="area-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_indexer"
/>
- <area coords="34"
id="area-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_lock_manager"
/>
+ <area coords="20"
id="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-value_storages"
/>
+ <area coords="27"
id="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_cache"
/>
+ <area coords="31"
id="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_indexer"
/>
+ <area coords="34"
id="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_lock_manager"
/>
</areaspec>
@@ -160,27 +160,27 @@
</repositories>
</repository-service></programlisting>
<calloutlist>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Configuring_JCR_to_use_external_configuration-value_storages">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-value_storages">
<para>
- Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-Configuration_requirements-Value_Storage_configuration"
/>.
+ Refer to <xref
linkend="exam-Reference_Guide-Configuration_requirements-Value_Storage_configuration"
/>.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_cache">
+ <callout
arearefs="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_cache">
<para>
- Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-Configuration_requirements-Cache_configuration"
/>.
+ Refer to <xref
linkend="exam-Reference_Guide-Configuration_requirements-Cache_configuration"
/>.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_indexer">
+ <callout
arearefs="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_indexer">
<para>
- Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-Configuration_requirements-Indexer_configuration"
/>.
+ Refer to <xref
linkend="exam-Reference_Guide-Configuration_requirements-Indexer_configuration"
/>.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_lock_manager">
+ <callout
arearefs="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_lock_manager">
<para>
- Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-Configuration_requirements-Lock_Manager_configuration"
/>.
+ Refer to <xref
linkend="exam-Reference_Guide-Configuration_requirements-Lock_Manager_configuration"
/>.
</para>
</callout>
@@ -217,9 +217,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Cluster_Configuration-Requirements">
+ <section
id="sect-Reference_Guide-Cluster_Configuration-Requirements">
<title>Requirements</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Requirements-Environment_requirements">
+ <section
id="sect-Reference_Guide-Requirements-Environment_requirements">
<title>Environment requirements</title>
<itemizedlist>
<listitem>
@@ -238,7 +238,7 @@
<para>
The same Clusters on different nodes <emphasis
role="bold">must</emphasis> have the same names.
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Environment_requirements-Example">
+ <example
id="exam-Reference_Guide-Environment_requirements-Example">
<title>Example</title>
<para>
If the <emphasis>Indexer</emphasis> cluster in
the <emphasis>production</emphasis> workspace on the first node is named
<literal>production_indexer_cluster</literal>, then
<emphasis>indexer</emphasis> clusters in the
<emphasis>production</emphasis> workspace on all other nodes <emphasis
role="bold">must</emphasis> also be named
<literal>production_indexer_cluster</literal>.
@@ -252,12 +252,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Requirements-Configuration_requirements">
+ <section
id="sect-Reference_Guide-Requirements-Configuration_requirements">
<title>Configuration requirements</title>
<para>
The configuration of every workspace in the repository must contain the
following elements:
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Configuration_requirements-Value_Storage_configuration">
+ <example
id="exam-Reference_Guide-Configuration_requirements-Value_Storage_configuration">
<title>Value Storage configuration</title>
<programlisting language="XML"
role="XML"><value-storages>
@@ -272,7 +272,7 @@
</value-storages></programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Configuration_requirements-Cache_configuration">
+ <example
id="exam-Reference_Guide-Configuration_requirements-Cache_configuration">
<title>Cache configuration</title>
<programlisting language="XML" role="XML"><cache
enabled="true"
class="org.exoplatform.services.jcr.impl.dataflow.persistent.jbosscache.JBossCacheWorkspaceStorageCache">
@@ -285,7 +285,7 @@
</cache></programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Configuration_requirements-Indexer_configuration">
+ <example
id="exam-Reference_Guide-Configuration_requirements-Indexer_configuration">
<title>Indexer configuration</title>
<programlisting language="XML" role="XML"><query-handler
class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex">
@@ -300,7 +300,7 @@
</query-handler></programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Configuration_requirements-Lock_Manager_configuration">
+ <example
id="exam-Reference_Guide-Configuration_requirements-Lock_Manager_configuration">
<title>Lock Manager configuration</title>
<programlisting language="XML" role="XML"><lock-manager
class="org.exoplatform.services.jcr.impl.core.lock.jbosscache.CacheableLockManagerImpl">
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-advantages.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-advantages.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-advantages.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Advantages_of_eXo_JCR">
+<chapter id="chap-Reference_Guide-Advantages_of_eXo_JCR">
<title>Advantages of eXo JCR</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advantages_of_eXo_JCR-Application_Developers">
+ <section
id="sect-Reference_Guide-Advantages_of_eXo_JCR-Application_Developers">
<title>Application Developers</title>
<itemizedlist>
<listitem>
@@ -37,7 +37,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advantages_of_eXo_JCR-Managers">
+ <section id="sect-Reference_Guide-Advantages_of_eXo_JCR-Managers">
<title>Managers</title>
<itemizedlist>
<listitem>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-applications.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-applications.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-applications.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-eXo_JCR_Application_Model">
+<chapter id="chap-Reference_Guide-eXo_JCR_Application_Model">
<title>eXo JCR Application Model</title>
<para>
The following image illustrates the interaction between Applications and JCR:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-compatibility-levels.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-compatibility-levels.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-compatibility-levels.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels">
+<chapter id="chap-Reference_Guide-Compatibility_Levels">
<title>Compatibility Levels</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Introduction">
+ <section id="sect-Reference_Guide-Compatibility_Levels-Introduction">
<title>Introduction</title>
<para>
The Java Content Repository specification JSR-170 has been split into two compliance
levels as well as a set of optional features. <literal>Level 1</literal>
defines a read-only repository while <literal>Level 2</literal> defines
methods for writing content and bi-directional interaction with the repository.
@@ -16,7 +16,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Level_1">
+ <section id="sect-Reference_Guide-Compatibility_Levels-Level_1">
<title>Level 1</title>
<para>
Level 1 includes read-only functionality for very simple repositories. It is useful to
migrate an existing data repository and step through converting it to a more advanced
implementation. The JCR uses a well-known Session abstraction to access the repository
data.
@@ -78,7 +78,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Level_2">
+ <section id="sect-Reference_Guide-Compatibility_Levels-Level_2">
<title>Level 2</title>
<para>
JCR Level 2 includes reading and writing of content functionality, importing other
sources and managing content definition and structuring using extensible node types.
@@ -128,7 +128,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Compatibility_Levels-Optional_features">
+ <section
id="sect-Reference_Guide-Compatibility_Levels-Optional_features">
<title>Optional features</title>
<para>
On the top of Level 1 or Level 2, a number of optional features are defined for a more
advanced repository functionality. This includes functions such as Versioning, (JTA)
Transactions, Query using SQL, Explicit Locking and Content Observation. eXo JCR supports
all optional features.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-exo-implementation.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-exo-implementation.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-exo-implementation.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Implementation">
+<chapter id="chap-Reference_Guide-Implementation">
<!-- This document was created with Syntext Serna Free. -->
<title>Implementation</title>
<para>
The relationships between the eXo Repository Service components are illustrated below:
@@ -14,7 +14,7 @@
</imageobject>
</mediaobject>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Implementation-Definitions">
+ <variablelist id="vari-Reference_Guide-Implementation-Definitions">
<title>Definitions</title>
<varlistentry>
<term>eXo Container:</term>
@@ -75,7 +75,7 @@
<procedure>
<step>
<para>
- Obtaining Repository object by getting <emphasis
role="bold">Repository Service</emphasis> via JNDI lookup if eXo
repository is bound to the naming context using (see <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-JCR_configuration" /> for
details).
+ Obtaining Repository object by getting <emphasis
role="bold">Repository Service</emphasis> via JNDI lookup if eXo
repository is bound to the naming context using (see <xref
linkend="chap-Reference_Guide-JCR_configuration" /> for details).
</para>
</step>
@@ -88,7 +88,7 @@
</procedure>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Implementation-Workspace_Data_Model">
+ <section
id="sect-Reference_Guide-Implementation-Workspace_Data_Model">
<title>Workspace Data Model</title>
<para>
The following diagram explains which components of a eXo JCR implementation are used
in a data flow to perform operations specified in the JCR API.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-extensions.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-extensions.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-extensions.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,13 +1,13 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-JCR_Extensions">
+<chapter id="chap-Reference_Guide-JCR_Extensions">
<title>JCR Extensions</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Extensions-JCR_Service_Extensions">
+ <section
id="sect-Reference_Guide-JCR_Extensions-JCR_Service_Extensions">
<title>JCR Service Extensions</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Service_Extensions-Concept">
+ <section id="sect-Reference_Guide-JCR_Service_Extensions-Concept">
<title>Concept</title>
<para>
eXo JCR supports <emphasis role="bold">observation</emphasis>
(JSR-170 8.3), which enables applications to register interest in events that describe
changes to a workspace, and then monitor and respond to those events. The standard
observation feature allows dispatching events when <emphasis
role="bold">persistent change</emphasis> to the workspace is made.
@@ -28,7 +28,7 @@
<para>
However, if your application logic requires the action to add items to a created or
updated item and you save these changes immediately after the JCR API method call is
returned, the suggestion with Thread is not applicable for you in this case.
</para>
- <figure
id="figu-Reference_Guide_eXo_JCR_1.14-Concept-Implementation">
+ <figure id="figu-Reference_Guide-Concept-Implementation">
<title>Implementation</title>
<mediaobject>
<imageobject>
@@ -41,7 +41,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Service_Extensions-Configuration">
+ <section
id="sect-Reference_Guide-JCR_Service_Extensions-Configuration">
<title>Configuration</title>
<para>
Add a <literal>SessionActionCatalog</literal> service and an appropriate
<literal>AddActionsPlugin</literal> (see the example below) configuration to
your eXo Container configuration.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-namespace-altering.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-namespace-altering.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-namespace-altering.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Namespace_Altering">
+<chapter id="chap-Reference_Guide-Namespace_Altering">
<!-- This document was created with Syntext Serna Free. -->
<title>Namespace Altering</title>
<para>
Since version 1.11, the eXo JCR implementation supports namespaces altering.
</para>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Namespace_Altering-Adding_New_Namespace">
+ <formalpara
id="form-Reference_Guide-Namespace_Altering-Adding_New_Namespace">
<title>Adding New Namespace</title>
<para>
Add a new namespace with:
@@ -18,7 +18,7 @@
<programlisting language="Java"
role="Java">ExtendedNamespaceRegistry namespaceRegistry =
(ExtendedNamespaceRegistry) workspace.getNamespaceRegistry();
namespaceRegistry.registerNamespace("newMapping",
"http://dumb.uri/jcr");</programlisting>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Namespace_Altering-Changing_Existing_Namespace">
+ <formalpara
id="form-Reference_Guide-Namespace_Altering-Changing_Existing_Namespace">
<title>Changing Existing Namespace</title>
<para>
Change an existing namespace with:
@@ -29,7 +29,7 @@
<programlisting language="Java"
role="Java">ExtendedNamespaceRegistry namespaceRegistry =
(ExtendedNamespaceRegistry) workspace.getNamespaceRegistry();
namespaceRegistry.registerNamespace("newMapping",
"http://dumb.uri/jcr");
namespaceRegistry.registerNamespace("newMapping2",
"http://dumb.uri/jcr");</programlisting>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Namespace_Altering-Removing_Existing_Namespace">
+ <formalpara
id="form-Reference_Guide-Namespace_Altering-Removing_Existing_Namespace">
<title>Removing Existing Namespace</title>
<para>
Remove an existing namespace with:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-registry-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-registry-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-registry-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Registry_Service">
+<chapter id="chap-Reference_Guide-Registry_Service">
<title>Registry Service</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service-Concept">
+ <section id="sect-Reference_Guide-Registry_Service-Concept">
<title>Concept</title>
<para>
The Registry Service is one of the key parts of the infrastructure built around eXo
JCR. Each JCR that is based on services and applications may have its own configuration,
settings, and other data that have to be stored persistently and used by the appropriate
service or application (referred to as a <emphasis>Consumer</emphasis>).
@@ -47,7 +47,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service-The_API">
+ <section id="sect-Reference_Guide-Registry_Service-The_API">
<title>The API</title>
<para>
The main functionality of the Registry Service is described in the Registry abstract
class as the following:
@@ -107,7 +107,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Registry_Service-Configuration">
+ <section id="sect-Reference_Guide-Registry_Service-Configuration">
<title>Configuration</title>
<para>
<literal>RegistryService</literal> has only one optional properties
parameter; <parameter>locations</parameter>. It is used to mention where
<literal>exo:registry</literal> is placed for each repository. The name of
each property is interpreted as a repository name and its value as a workspace name (a
system workspace by default).
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-usage.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-usage.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/jcr-usage.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Using_The_JCR">
+<chapter id="chap-Reference_Guide-Using_The_JCR">
<title>Using The JCR</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Using_The_JCR-Obtaining_a_Repository_Object">
+ <section
id="sect-Reference_Guide-Using_The_JCR-Obtaining_a_Repository_Object">
<title>Obtaining a Repository Object</title>
<para>
A <literal>javax.jcr.Repository</literal> object can be obtained by:
@@ -50,7 +50,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Using_The_JCR-JCR_Session_common_considerations">
+ <section
id="sect-Reference_Guide-Using_The_JCR-JCR_Session_common_considerations">
<title>JCR Session common considerations</title>
<para>
<itemizedlist>
@@ -85,9 +85,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Using_The_JCR-JCR_Application_Practices">
+ <section
id="sect-Reference_Guide-Using_The_JCR-JCR_Application_Practices">
<title>JCR Application Practices</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Application_Practices-Log_Out_of_All_Open_Sessions">
+ <section
id="sect-Reference_Guide-JCR_Application_Practices-Log_Out_of_All_Open_Sessions">
<title>Log Out of All Open Sessions</title>
<para>
Use
<literal>org.exoplatform.services.jcr.ext.common.SessionProvider</literal>
which is responsible for caching or obtaining your JCR Sessions and closing all opened
sessions at once.
@@ -151,7 +151,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Application_Practices-Reusing_SessionProvider">
+ <section
id="sect-Reference_Guide-JCR_Application_Practices-Reusing_SessionProvider">
<title>Reusing SessionProvider</title>
<para>
Since creating the <literal>SessionProvider</literal> involves multiple
steps which may need to be repeated for each JCR session, the
<literal>SessionProviderService</literal> assists you to get a
<literal>SessionProvider</literal> object.
@@ -168,7 +168,7 @@
<para>
The main contract of an implemented component is obtaining a
<literal>SessionProvider</literal> by key. the eXo JCR provides two
implementations:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Reusing_SessionProvider-SessionProvider_implementations">
+ <table
id="tabl-Reference_Guide-Reusing_SessionProvider-SessionProvider_implementations">
<title>SessionProvider implementations</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/nodetype-registration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/nodetype-registration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/nodetype-registration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-NodeType_Registration">
+<chapter id="chap-Reference_Guide-NodeType_Registration">
<!-- This document was created with Syntext Serna Free. -->
<title>NodeType Registration</title>
<para>
The eXo JCR implementation supports two methods of Nodetypes registration:
@@ -11,21 +11,21 @@
<itemizedlist>
<listitem>
<para>
- From a <literal>NodeTypeValue</literal> POJO. Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-Node_type_registration-Run_time_registration_using_NodeTypeValue"
/>
+ From a <literal>NodeTypeValue</literal> POJO. Refer to <xref
linkend="exam-Reference_Guide-Node_type_registration-Run_time_registration_using_NodeTypeValue"
/>
</para>
</listitem>
<listitem>
<para>
- From an XML document. Refer to <xref
linkend="exam-Reference_Guide_eXo_JCR_1.14-Node_type_registration-Runtime_Registration_From_XML_File"
/>.
+ From an XML document. Refer to <xref
linkend="exam-Reference_Guide-Node_type_registration-Runtime_Registration_From_XML_File"
/>.
</para>
</listitem>
</itemizedlist>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-NodeType_Registration-Interfaces_and_methods">
+ <section
id="sect-Reference_Guide-NodeType_Registration-Interfaces_and_methods">
<title>Interfaces and methods</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-ExtendedNodeTypeManager">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-ExtendedNodeTypeManager">
<title><literal>ExtendedNodeTypeManager</literal></title>
<para>
The <literal>ExtendedNodeTypeManager</literal> (from JCR 1.11) interface
provides the following methods related to registering node types:
@@ -80,7 +80,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-NodeTypeValue">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-NodeTypeValue">
<title><literal>NodeTypeValue</literal></title>
<para>
The NodeTypeValue interface represents a simple container structure used to define
node types which are then registered through the ExtendedNodeTypeManager.registerNodeType
method. The implementation of this interface does not contain any validation logic.
@@ -165,7 +165,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-NodeDefinitionValue">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-NodeDefinitionValue">
<title><literal>NodeDefinitionValue</literal></title>
<para>
The <literal>NodeDefinitionValue</literal> interface extends
<literal>ItemDefinitionValue</literal> with the addition of writing methods,
enabling the characteristics of a child node definition to be set, after that the
<literal>NodeDefinitionValue</literal> is added to a
<literal>NodeTypeValue</literal>.
@@ -252,12 +252,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-PropertyDefinitionValue">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-PropertyDefinitionValue">
<title><literal>PropertyDefinitionValue</literal></title>
<para>
The <literal>PropertyDefinitionValue</literal> interface extends
<literal>ItemDefinitionValue</literal> with the addition of writing methods,
enabling the characteristics of a child property definition to be set, after that the
<literal>PropertyDefinitionValue</literal> is added to a
<literal>NodeTypeValue</literal>.
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-PropertyDefinitionValue-PropertyDefinitionValue">
+ <example
id="exam-Reference_Guide-PropertyDefinitionValue-PropertyDefinitionValue">
<title><literal>PropertyDefinitionValue</literal></title>
<programlisting language="Java" role="Java">/**
@@ -301,7 +301,7 @@
public void setValueConstraints(List<String>
valueConstraints);</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-PropertyDefinitionValue-ItemDefinitionValue">
+ <example
id="exam-Reference_Guide-PropertyDefinitionValue-ItemDefinitionValue">
<title><literal>ItemDefinitionValue</literal></title>
<programlisting language="Java" role="Java"> /**
@@ -358,12 +358,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-Node_type_registration">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-Node_type_registration">
<title>Node type registration</title>
<para>
The eXo JCR implementation supports various methods of the node-type registration.
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Node_type_registration-Runtime_Registration_From_XML_File">
+ <example
id="exam-Reference_Guide-Node_type_registration-Runtime_Registration_From_XML_File">
<title>Runtime Registration From XML File</title>
<programlisting language="Java"
role="Java">ExtendedNodeTypeManager nodeTypeManager =
(ExtendedNodeTypeManager) session.getWorkspace()
@@ -372,7 +372,7 @@
nodeTypeManager.registerNodeTypes(is,ExtendedNodeTypeManager.IGNORE_IF_EXISTS
);</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Node_type_registration-Run_time_registration_using_NodeTypeValue">
+ <example
id="exam-Reference_Guide-Node_type_registration-Run_time_registration_using_NodeTypeValue">
<title>Run time registration using NodeTypeValue</title>
<programlisting language="Java"
role="Java">ExtendedNodeTypeManager nodeTypeManager =
(ExtendedNodeTypeManager) session.getWorkspace()
@@ -402,7 +402,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-Changing_Existing_Node_Type">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-Changing_Existing_Node_Type">
<title>Changing Existing Node Type</title>
<para>
To replace an existing node type definition pass
<literal>ExtendedNodeTypeManager.REPLACE_IF_EXISTS</literal> as a second
parameter for the method
<literal>ExtendedNodeTypeManager.registerNodeType</literal>.
@@ -416,7 +416,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-Removing_node_type">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-Removing_node_type">
<title>Removing node type</title>
<para>
A node type cannot be removed if the repository contains an instance of that node
type.
@@ -426,7 +426,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-Adding_New_PropertyDefinition">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-Adding_New_PropertyDefinition">
<title>Adding New
<literal>PropertyDefinition</literal></title>
<programlisting language="Java" role="Java">
@@ -447,7 +447,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-Adding_New_Child_NodeDefinition">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-Adding_New_Child_NodeDefinition">
<title>Adding New Child
<literal>NodeDefinition</literal></title>
<para>
Use the code below to add a new child <literal>NodeDefinition</literal>.
@@ -470,7 +470,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-Edit_Existing_PropertyDefinition_or_Child_NodeDefinition">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-Edit_Existing_PropertyDefinition_or_Child_NodeDefinition">
<title>Edit Existing <literal>PropertyDefinition</literal> or Child
<literal>NodeDefinition</literal></title>
<para>
Note that the existing data must be consistent before changing or removing a existing
definition.
@@ -528,7 +528,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Interfaces_and_methods-Changing_The_List_of_Super_Types">
+ <section
id="sect-Reference_Guide-Interfaces_and_methods-Changing_The_List_of_Super_Types">
<title>Changing The List of Super Types</title>
<para>
Use the following code to change the list of super types:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Node_Types_and_Namespaces">
+<chapter id="chap-Reference_Guide-Node_Types_and_Namespaces">
<title>Node Types and Namespaces</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Node_Types_and_Namespaces-Introduction">
+ <section
id="sect-Reference_Guide-Node_Types_and_Namespaces-Introduction">
<title>Introduction</title>
<para>
The JSR-170 specification requires support of node types and namespaces. Beyond the
methods required by the specification, the eXo JCR has its own API extension for NodeType
registration as well as the ability to declaratively define node types in the Repository
at the start-up time.
@@ -13,7 +13,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Node_Types_and_Namespaces-Node_Types_Definition">
+ <section
id="sect-Reference_Guide-Node_Types_and_Namespaces-Node_Types_Definition">
<title>Node Types Definition</title>
<para>
Node type registration extension is declared in
<literal>org.exoplatform.services.jcr.core.nodetype.ExtendedNodeTypeManager</literal>
interface
@@ -122,7 +122,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Node_Types_and_Namespaces-Namespaces_Definition">
+ <section
id="sect-Reference_Guide-Node_Types_and_Namespaces-Namespaces_Definition">
<title>Namespaces Definition</title>
<para>
Default namespaces are registered by repository at start up.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/why-jcr.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/why-jcr.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/concepts/why-jcr.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Java_Content_Repository">
+<chapter id="chap-Reference_Guide-Java_Content_Repository">
<title>Java Content Repository</title>
<para>
A Java Content Repository (<abbrev>JCR</abbrev>) is a java interface used
to access contents that are not only web contents, but also other hierarchically stored
data. The content is stored in a repository. The repository can be a file system, a
relational database or an XML document. The internal structure of JCR data looks similar
to an XML document; a document tree with nodes and data, however, in a JCR, the data is
stored in <literal>property items</literal>.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/configuration-persister.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/configuration-persister.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/configuration-persister.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister">
+<chapter id="chap-Reference_Guide-JCR_Configuration_persister">
<title>JCR Configuration persister</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Concept">
+ <section
id="sect-Reference_Guide-JCR_Configuration_persister-Concept">
<title>Concept</title>
<para>
The JCR Repository Service uses the
<literal>org.exoplatform.services.jcr.config.RepositoryServiceConfiguration</literal>
component for its configuration.
</para>
<programlistingco>
<areaspec>
- <area coords="8"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Concept-config"
/>
+ <area coords="8"
id="area-Reference_Guide-JCR_Configuration_persister-Concept-config" />
</areaspec>
@@ -28,7 +28,7 @@
</init-params>
</component></programlisting>
<calloutlist>
- <!-- #1 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Concept-config">
+ <!-- #1 --> <callout
arearefs="area-Reference_Guide-JCR_Configuration_persister-Concept-config">
<para>
In this example, the Repository Service will read the
configuration from the file
<filename>war:/conf/jcr/repository-configuration.xml</filename>.
</para>
@@ -45,7 +45,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Usage">
+ <section
id="sect-Reference_Guide-JCR_Configuration_persister-Usage">
<title>Usage</title>
<para>
On start up the <literal>RepositoryServiceConfiguration</literal>
component checks if a configuration persister was configured. If one has been, it uses the
provided <literal>ConfigurationPersister</literal> implementation class to
instantiate the persister object.
@@ -55,9 +55,9 @@
</para>
<programlistingco>
<areaspec>
- <area coords="13"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Usage-source_name"
/>
- <area coords="14"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Usage-dialect"
/>
- <area coords="15"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Usage-persister_class_name"
/>
+ <area coords="13"
id="area-Reference_Guide-JCR_Configuration_persister-Usage-source_name" />
+ <area coords="14"
id="area-Reference_Guide-JCR_Configuration_persister-Usage-dialect" />
+ <area coords="15"
id="area-Reference_Guide-JCR_Configuration_persister-Usage-persister_class_name"
/>
</areaspec>
@@ -81,19 +81,19 @@
</component>
</programlisting>
<calloutlist>
- <!-- #1 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Usage-source_name">
+ <!-- #1 --> <callout
arearefs="area-Reference_Guide-JCR_Configuration_persister-Usage-source_name">
<para>
-
<parameter><replaceable>source-name</replaceable></parameter>: The
JNDI source name is configured in the
<literal>InitialContextInitializer</literal> component. This was known as
<parameter>sourceName</parameter> in versions prior to 1.9. Refer to <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config" /> for
more information.
+
<parameter><replaceable>source-name</replaceable></parameter>: The
JNDI source name is configured in the
<literal>InitialContextInitializer</literal> component. This was known as
<parameter>sourceName</parameter> in versions prior to 1.9. Refer to <xref
linkend="chap-Reference_Guide-JDBC_Data_Container_Config" /> for more
information.
</para>
</callout>
- <!-- #2 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Usage-dialect">
+ <!-- #2 --> <callout
arearefs="area-Reference_Guide-JCR_Configuration_persister-Usage-dialect">
<para>
-
<parameter><replaceable>dialect</replaceable></parameter>: The SQL
dialect which will be used with the database from
<parameter><replaceable>source-name</replaceable></parameter>.
Refer to <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config" /> for
more information.
+
<parameter><replaceable>dialect</replaceable></parameter>: The SQL
dialect which will be used with the database from
<parameter><replaceable>source-name</replaceable></parameter>.
Refer to <xref linkend="chap-Reference_Guide-JDBC_Data_Container_Config"
/> for more information.
</para>
</callout>
- <!-- #3 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_Configuration_persister-Usage-persister_class_name">
+ <!-- #3 --> <callout
arearefs="area-Reference_Guide-JCR_Configuration_persister-Usage-persister_class_name">
<para>
<parameter><replaceable>persister-class-name</replaceable></parameter>:
The class name of the <literal>ConfigurationPersister</literal> interface
implementation. This was known as <parameter>persisterliteral</parameter> in
versions prior to 1.9.
</para>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-JCR_configuration">
+<chapter id="chap-Reference_Guide-JCR_configuration">
<title>JCR configuration</title>
<para>
The JCR configuration is defined in an XML file which is constructed as per the
DTD below:
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Portal_configuration">
+ <section
id="sect-Reference_Guide-JCR_configuration-Portal_configuration">
<title>Portal configuration</title>
<para>
JCR services are registered in the Portal container.
@@ -18,8 +18,8 @@
</para>
<programlistingco>
<areaspec>
- <area coords="10"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-conf-path" />
- <area coords="15"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-working-conf" />
+ <area coords="10"
id="area-Reference_Guide-JCR_configuration-conf-path" />
+ <area coords="15"
id="area-Reference_Guide-JCR_configuration-working-conf" />
</areaspec>
@@ -46,13 +46,13 @@
</init-params>
</component></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-conf-path">
+ <callout
arearefs="area-Reference_Guide-JCR_configuration-conf-path">
<para>
A path to a RepositoryService JCR Configuration.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-working-conf">
+ <callout
arearefs="area-Reference_Guide-JCR_configuration-working-conf">
<para>
JCR configuration persister configuration. If no
<parameter>working-conf</parameter> is found, the persister will be disabled.
</para>
@@ -63,7 +63,7 @@
</programlistingco>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-JCR_Configuration">
+ <section
id="sect-Reference_Guide-Portal_configuration-JCR_Configuration">
<title>JCR Configuration</title>
<para>
The JCR Service can use multiple
<emphasis>Repositories</emphasis> and each repository can have multiple
<emphasis>Workspaces</emphasis>.
@@ -187,115 +187,115 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-Repository_service_configuration_JCR_repositories_configuration">
+ <section
id="sect-Reference_Guide-Portal_configuration-Repository_service_configuration_JCR_repositories_configuration">
<title>Repository service configuration (JCR repositories
configuration)</title>
<programlistingco>
<areaspec>
- <!-- 1 --> <area coords="1 60"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-default-repository"
/>
- <!-- 2 --> <area coords="2 60"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-repositories"
/>
- <!-- 3 --> <area coords="3 125"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-name"
/>
- <!-- 4 --> <area coords="3 125"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-default-workspace"
/>
- <!-- 5 --> <area coords="3 125"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-system-workspace"
/>
- <!-- 6 --> <area coords="4 60"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-security-domain"
/>
- <!-- 7 --> <area coords="5 60"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-access-control"
/>
- <!-- 8 --> <area coords="6 165"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-authentication-policy"
/>
- <!-- 9 --> <area coords="9 60"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-workspaces"
/>
- <!-- 10 --> <area coords="13 60"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-workspace-name"
/>
- <!-- 11 --> <area coords="14 165"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-container"
/>
- <!-- 12 --> <area coords="34 165"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-service_initializer"
/>
- <!-- 13 --> <area coords="40 165"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-service_cache"
/>
- <!-- 14 --> <area coords="48 165"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-service_query-handler"
/>
- <!-- 15 --> <area coords="61 60"
id="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-service_lock-manager-timeout"
/>
+ <!-- 1 --> <area coords="1 60"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-default-repository"
/>
+ <!-- 2 --> <area coords="2 60"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-repositories"
/>
+ <!-- 3 --> <area coords="3 125"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-name"
/>
+ <!-- 4 --> <area coords="3 125"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-default-workspace"
/>
+ <!-- 5 --> <area coords="3 125"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-system-workspace"
/>
+ <!-- 6 --> <area coords="4 60"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-security-domain"
/>
+ <!-- 7 --> <area coords="5 60"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-access-control"
/>
+ <!-- 8 --> <area coords="6 165"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-authentication-policy"
/>
+ <!-- 9 --> <area coords="9 60"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-workspaces"
/>
+ <!-- 10 --> <area coords="13 60"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-workspace-name"
/>
+ <!-- 11 --> <area coords="14 165"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-container"
/>
+ <!-- 12 --> <area coords="34 165"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_initializer"
/>
+ <!-- 13 --> <area coords="40 165"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_cache"
/>
+ <!-- 14 --> <area coords="48 165"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_query-handler"
/>
+ <!-- 15 --> <area coords="61 60"
id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_lock-manager-timeout"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../../../extras/Advanced_Development_JCR_Configuration/orig.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <!-- 1 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-default-repository">
+ <!-- 1 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-default-repository">
<para>
<emphasis>default-repository</emphasis>: The name
of a default repository (one returned by <parameter>
RepositoryService.getRepository() </parameter> ).
</para>
</callout>
- <!-- 2 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-repositories">
+ <!-- 2 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-repositories">
<para>
<emphasis>repositories</emphasis>: The list of
repositories.
</para>
</callout>
- <!-- 3 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-name">
+ <!-- 3 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-name">
<para>
<emphasis>name</emphasis>: The name of a
repository.
</para>
</callout>
- <!-- 4 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-default-workspace">
+ <!-- 4 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-default-workspace">
<para>
<emphasis>default-workspace</emphasis>: The name
of a workspace obtained using Session's login() or login(Credentials) methods (ones
without an explicit workspace name).
</para>
</callout>
- <!-- 5 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-system-workspace">
+ <!-- 5 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-system-workspace">
<para>
<emphasis>system-workspace</emphasis>: The name
of workspace where <emphasis>/jcr:system</emphasis> node is placed.
</para>
</callout>
- <!-- 6 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-security-domain">
+ <!-- 6 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-security-domain">
<para>
<emphasis>security-domain</emphasis>: The name of
a security domain for JAAS authentication.
</para>
</callout>
- <!-- 7 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-access-control">
+ <!-- 7 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-access-control">
<para>
<emphasis>access-control</emphasis>: The name of
an access control policy. There can 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).
</para>
</callout>
- <!-- 8 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-authentication-policy">
+ <!-- 8 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-authentication-policy">
<para>
<emphasis>authentication-policy</emphasis>: The
name of an authentication policy class.
</para>
</callout>
- <!-- 9 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-workspaces">
+ <!-- 9 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-workspaces">
<para>
<emphasis>workspaces</emphasis>: The list of
workspaces.
</para>
</callout>
- <!-- 10 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-workspace-name">
+ <!-- 10 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-workspace-name">
<para>
The name of the workspace.
</para>
</callout>
- <!-- 11 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-container">
+ <!-- 11 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-container">
<para>
Workspace data container (physical storage) configuration.
</para>
</callout>
- <!-- 12 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-service_initializer">
+ <!-- 12 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_initializer">
<para>
Workspace initializer configuration.
</para>
</callout>
- <!-- 13 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-service_cache">
+ <!-- 13 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_cache">
<para>
Workspace storage cache configuration.
</para>
</callout>
- <!-- 14 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-service_query-handler">
+ <!-- 14 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_query-handler">
<para>
Query handler configuration.
</para>
</callout>
- <!-- 15 --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace-service_lock-manager-timeout">
+ <!-- 15 --> <callout
arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_lock-manager-timeout">
<para>
The amount of time before the unused global lock is removed.
</para>
@@ -319,7 +319,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-Workspace_configuration">
+ <section
id="sect-Reference_Guide-Portal_configuration-Workspace_configuration">
<title>Workspace configuration:</title>
<para>
<emphasis>name</emphasis>: The name of a workspace
@@ -345,7 +345,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-Workspace_data_container_configuration">
+ <section
id="sect-Reference_Guide-Portal_configuration-Workspace_data_container_configuration">
<title>Workspace data container configuration:</title>
<para>
<emphasis>class:</emphasis> A workspace data container class
name.
@@ -353,7 +353,7 @@
<para>
<emphasis>properties</emphasis>: The list of properties
(name-value pairs) for the concrete Workspace data container.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Workspace_data_container_configuration-Parameter_Descriptions">
+ <table
id="tabl-Reference_Guide-Workspace_data_container_configuration-Parameter_Descriptions">
<title>Parameter Descriptions</title>
<tgroup cols="2">
<thead>
@@ -423,7 +423,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-Value_Storage_plugin_configuration_for_data_container">
+ <section
id="sect-Reference_Guide-Portal_configuration-Value_Storage_plugin_configuration_for_data_container">
<title>Value Storage plugin configuration (for data
container):</title>
<note>
<para>
@@ -446,7 +446,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-Initializer_configuration_optional">
+ <section
id="sect-Reference_Guide-Portal_configuration-Initializer_configuration_optional">
<title>Initializer configuration (optional):</title>
<para>
<emphasis>class</emphasis>: Initializer implementation
class.
@@ -466,7 +466,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-Cache_configuration">
+ <section
id="sect-Reference_Guide-Portal_configuration-Cache_configuration">
<title>Cache configuration:</title>
<para>
<emphasis>enabled</emphasis>: If workspace cache is enabled
or not.
@@ -522,7 +522,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-Query_Handler_configuration">
+ <section
id="sect-Reference_Guide-Portal_configuration-Query_Handler_configuration">
<title>Query Handler configuration:</title>
<para>
<emphasis>class</emphasis>: A Query Handler class name.
@@ -536,7 +536,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-Lock_Manager_configuration">
+ <section
id="sect-Reference_Guide-Portal_configuration-Lock_Manager_configuration">
<title>Lock Manager configuration:</title>
<para>
<emphasis>time-out</emphasis>: Time after which the unused
global lock will be removed.
@@ -591,7 +591,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Portal_configuration-Help_application_to_prohibit_the_use_of_closed_sessions">
+ <section
id="sect-Reference_Guide-Portal_configuration-Help_application_to_prohibit_the_use_of_closed_sessions">
<title>Help application to prohibit the use of closed
sessions</title>
<para>
Products that use eXo JCR, sometimes misuse it since they continue to use
a session that has been closed through a method call on a node, a property or even the
session itself. To prevent bad practices we propose three modes which are the following:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,17 +1,17 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-External_Value_Storages">
+<chapter id="chap-Reference_Guide-External_Value_Storages">
<title>External Value Storages</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Introduction">
+ <section
id="sect-Reference_Guide-External_Value_Storages-Introduction">
<title>Introduction</title>
<para>
JCR values are stored in the Workspace Data container by default. The eXo JCR
offers an additional option of storing JCR values separately from the Workspace Data
container which can help keep Binary Large Objects (BLOBs) separate.
</para>
<!-- <para>
- Value storage configuration is a part of the repository configuration. Refer
to <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-JCR_configuration-Example_of_the_portal_system_workspace"
/> for more details.
+ Value storage configuration is a part of the repository configuration. Refer
to <xref
linkend="sect-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace"
/> for more details.
</para> --> <para>
Tree-based storage is recommended in most cases.
</para>
@@ -21,7 +21,7 @@
</para> -->
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Tree_File_Value_Storage">
+ <section
id="sect-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage">
<title>Tree File Value Storage</title>
<para>
Tree File Value Storage holds values in tree-like file system files.
<property>Path</property> property points to the root directory to store the
files.
@@ -34,20 +34,20 @@
</para>
<programlistingco>
<areaspec>
- <area coords="1"
id="area-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Tree_File_Value_Storage-id"
/>
- <area coords="3"
id="area-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Tree_File_Value_Storage-path"
/>
+ <area coords="1"
id="area-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage-id"
/>
+ <area coords="3"
id="area-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage-path"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../../../extras/Advanced_Development_JCR_external-value-storages/default25.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Tree_File_Value_Storage-id">
+ <callout
arearefs="area-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage-id">
<para>
The <emphasis role="bold">id</emphasis> is
the value storage unique identifier, used for linking with properties stored in a
workspace container
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Tree_File_Value_Storage-path">
+ <callout
arearefs="area-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage-path">
<para>
<emphasis role="bold">path</emphasis> is a
location where value files will be stored.
</para>
@@ -103,7 +103,7 @@
<filter property-type="Binary" min-value-size="1M"/>
</filters>
</programlisting>
-</section> --> <section
id="sect-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Content_Addressable_Value_storage_CAS_support">
+</section> --> <section
id="sect-Reference_Guide-External_Value_Storages-Content_Addressable_Value_storage_CAS_support">
<title>Content Addressable Value storage (CAS) support</title>
<para>
eXo JCR supports the <phrase>Content-addressable storage</phrase>
feature for <phrase>values</phrase> storing.
@@ -146,7 +146,7 @@
</para>
<programlisting language="XML" role="XML"><xi:include
href="../../../../extras/Advanced_Development_JCR_external-value-storages/default28.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Content_Addressable_Value_storage_CAS_support-CAS_Properties">
+ <variablelist
id="vari-Reference_Guide-Content_Addressable_Value_storage_CAS_support-CAS_Properties">
<title>CAS Properties</title>
<varlistentry>
<term>digest-algo</term>
@@ -196,7 +196,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-External_Value_Storages-Disabling_value_storage">
+ <section
id="sect-Reference_Guide-External_Value_Storages-Disabling_value_storage">
<title>Disabling value storage</title>
<para>
The JCR allows you to disable value storage by adding the following property
into its configuration.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config">
+<chapter id="chap-Reference_Guide-JDBC_Data_Container_Config">
<title>JDBC Data Container Config</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config-Introduction">
+ <section
id="sect-Reference_Guide-JDBC_Data_Container_Config-Introduction">
<title>Introduction</title>
<para>
eXo JCR persistent data container can work in two configuration modes:
@@ -176,7 +176,7 @@
<para>
The following tables show the correspondence between the scripts and databases:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Introduction-Single_database">
+ <table id="tabl-Reference_Guide-Introduction-Single_database">
<title>Single-database</title>
<tgroup cols="2">
<thead>
@@ -270,7 +270,7 @@
</tgroup>
</table>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Introduction-Multi_database">
+ <table id="tabl-Reference_Guide-Introduction-Multi_database">
<title>Multi-database</title>
<tgroup cols="2">
<thead>
@@ -370,7 +370,7 @@
<para>
There are preconfigured configuration files for HSQLDB. Look for these files in
/conf/portal and /conf/standalone folders of the jar-file
<package>exo.jcr.component.core-XXX.XXX.jar</package> or source-distribution
of eXo JCR implementation.
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Introduction-Example_Parameter">
+ <example id="exam-Reference_Guide-Introduction-Example_Parameter">
<title>Example Parameter</title>
<
programlisting><code>jdbc:mysql://exoua.dnsalias.net/portal?char...
@@ -380,12 +380,12 @@
The configuration files are located in service jars
<filename>/conf/portal/configuration.xml</filename> (eXo services including
JCR Repository Service) and <filename>exo-jcr-config.xml</filename>
(repositories configuration) by default. In JBoss Enterprise Portal Platform, the JCR is
configured in portal web application
<filename>portal/WEB-INF/conf/jcr/jcr-configuration.xml</filename> (JCR
Repository Service and related services) and
<filename>repository-configuration.xml</filename> (repositories
configuration).
</para>
<para>
- Read more about <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-JCR_configuration" />.
+ Read more about <xref linkend="chap-Reference_Guide-JCR_configuration"
/>.
</para>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config-Multi_database_Configuration">
+ <section
id="sect-Reference_Guide-JDBC_Data_Container_Config-Multi_database_Configuration">
<title>Multi-database Configuration</title>
<para>
You need to configure each workspace in a repository as part of multi-database
configuration. Databases may reside on remote servers as required.
@@ -524,12 +524,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config-Single_database_Configuration">
+ <section
id="sect-Reference_Guide-JDBC_Data_Container_Config-Single_database_Configuration">
<title>Single-database Configuration</title>
<para>
Configuring a single-database data container is easier than configuring a
multi-database data container as only one naming resource must be configured.
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Single_database_Configuration-jdbcjcr_Data_Container">
+ <example
id="exam-Reference_Guide-Single_database_Configuration-jdbcjcr_Data_Container">
<title><parameter>jdbcjcr</parameter> Data Container</title>
<programlisting language="XML" role="XML">
@@ -542,7 +542,7 @@
<para>
For example (two workspaces <parameter>ws</parameter> -
<literal>jdbcjcr</literal>, <parameter>ws1</parameter> -
<literal>jdbcjcr</literal>):
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Single_database_Configuration-Example">
+ <example
id="exam-Reference_Guide-Single_database_Configuration-Example">
<title>Example</title>
<programlisting language="XML" role="XML">
@@ -552,7 +552,7 @@
<para>
This configures two persistent workspaces in one database (PostgreSQL).
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Single_database_Configuration-Configuration_without_DataSource">
+ <section
id="sect-Reference_Guide-Single_database_Configuration-Configuration_without_DataSource">
<title>Configuration without DataSource</title>
<para>
It is possible to configure the repository without binding
<literal>javax.sql.DataSource</literal> in the JNDI service if you have a
dedicated JDBC driver implementation with special features like XA transactions,
statements/connections pooling etc:
@@ -594,7 +594,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Single_database_Configuration-Dynamic_Workspace_Creation">
+ <section
id="sect-Reference_Guide-Single_database_Configuration-Dynamic_Workspace_Creation">
<title>Dynamic Workspace Creation</title>
<para>
Workspaces can be added dynamically during runtime.
@@ -625,7 +625,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config-Simple_and_Complex_queries">
+ <section
id="sect-Reference_Guide-JDBC_Data_Container_Config-Simple_and_Complex_queries">
<title>Simple and Complex queries</title>
<para>
eXo JCR provides two ways to interact with the database;
@@ -678,7 +678,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config-Force_Query_Hints">
+ <section
id="sect-Reference_Guide-JDBC_Data_Container_Config-Force_Query_Hints">
<title>Force Query Hints</title>
<para>
Some databases, such as Oracle and MySQL, support hints to increase query performance.
The eXo JCR has separate Complex Query implementations for the Orcale database dialect,
which uses query hints to increase performance for few important queries.
@@ -699,7 +699,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config-Notes_for_Microsoft_Windows_users">
+ <section
id="sect-Reference_Guide-JDBC_Data_Container_Config-Notes_for_Microsoft_Windows_users">
<title>Notes for Microsoft Windows users</title>
<para>
The current configuration of eXo JCR uses <ulink
url="http://commons.apache.org/dbcp/">Apache DBCP</ulink> connection
pool (<literal>org.apache.commons.dbcp.BasicDataSourceFactory</literal>).
@@ -730,7 +730,7 @@
</procedure>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Notes_for_Microsoft_Windows_users-Sample_Registry_File">
+ <example
id="exam-Reference_Guide-Notes_for_Microsoft_Windows_users-Sample_Registry_File">
<title>Sample Registry File</title>
<programlisting>Windows Registry Editor Version 5.00
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB">
+<chapter id="chap-Reference_Guide-Multi_language_Support_the_JCR_RDB">
<title>Multi-language Support the JCR RDB</title>
<para>
Whenever a relational database is used to store multilingual text data in the eXo Java
Content Repository the configuration must be adapted to support UTF-8 encoding. Dialect is
automatically detected for certified database. You can still enforce it in case of
failure, see below.
@@ -14,25 +14,25 @@
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-Oracle"
/>
+ <xref
linkend="sect-Reference_Guide-Multi_language_Support_the_JCR_RDB-Oracle" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-DB2"
/>
+ <xref
linkend="sect-Reference_Guide-Multi_language_Support_the_JCR_RDB-DB2" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-MySQL"
/>
+ <xref
linkend="sect-Reference_Guide-Multi_language_Support_the_JCR_RDB-MySQL" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-PostgreSQL"
/>
+ <xref
linkend="sect-Reference_Guide-Multi_language_Support_the_JCR_RDB-PostgreSQL"
/>
</para>
</listitem>
@@ -56,7 +56,7 @@
</itemizedlist>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-Oracle">
+ <section
id="sect-Reference_Guide-Multi_language_Support_the_JCR_RDB-Oracle">
<title>Oracle</title>
<para>
In order to run multilanguage JCR on an Oracle backend Unicode encoding for characters
set should be applied to the database. Other Oracle globalization parameters do not have
any effect. The property to modify is <literal>NLS_CHARACTERSET</literal>.
@@ -100,7 +100,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-DB2">
+ <section
id="sect-Reference_Guide-Multi_language_Support_the_JCR_RDB-DB2">
<title>DB2</title>
<para>
DB2 Universal Database (DB2 UDB) supports <ulink
url="http://publib.boulder.ibm.com/infocenter/db2luw/v9/index.jsp?to...
and UTF-16/UCS-2</ulink>. When a Unicode database is created,
<parameter>CHAR</parameter>, <parameter>VARCHAR</parameter> and
<parameter>LONG VARCHAR</parameter> data are stored in UTF-8 form.
@@ -125,7 +125,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-MySQL">
+ <section
id="sect-Reference_Guide-Multi_language_Support_the_JCR_RDB-MySQL">
<title>MySQL</title>
<para>
Using JCR with a MySQL-back end requires a special dialect <ulink
url="http://jira.exoplatform.org/browse/JCR-375">MySQL-UTF8&... to
be used for internationalization support.
@@ -147,7 +147,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Multi_language_Support_the_JCR_RDB-PostgreSQL">
+ <section
id="sect-Reference_Guide-Multi_language_Support_the_JCR_RDB-PostgreSQL">
<title>PostgreSQL</title>
<para>
Multilingual support can be enabled with a PostgreSQL-back end in <ulink
url="http://www.postgresql.org/docs/8.3/interactive/charset.html&quo...
ways</ulink>:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/rest-services-on-groovy.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/rest-services-on-groovy.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/rest-services-on-groovy.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-REST_Services_on_Groovy">
+<chapter id="chap-Reference_Guide-REST_Services_on_Groovy">
<title>REST Services on Groovy</title>
<para>
Since version 1.9, the JCR Service supports REST services creation from <ulink
url="http://groovy.codehaus.org">Groovy script</ulink>.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,15 +1,15 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration">
+<chapter id="chap-Reference_Guide-Search_Configuration">
<title>Search Configuration</title>
<para>
The search function in JCR can be configured to perform in specific ways. This
section will discuss configuring the search function to improve search performance and
results.
</para>
<para>
- Below is an example of the configuration file that governs search behaviors.
Refer to <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Global_Search_Index"
/> for how searching operates in JCR and information about customized searches.
+ Below is an example of the configuration file that governs search behaviors.
Refer to <xref
linkend="sect-Reference_Guide-Search_Configuration-Global_Search_Index" />
for how searching operates in JCR and information about customized searches.
</para>
<para>
The JCR index configuration file is located at
<filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
@@ -22,7 +22,7 @@
<para>
The table below outlines the Configuration Parameters available, their default
setting, which version of eXo JCR they were implemented in and other useful information:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Configuration_parameters">
+ <table
id="tabl-Reference_Guide-Search_Configuration-Configuration_parameters">
<!-- align="left" pgwide="1" -->
<title>Configuration parameters</title>
<tgroup cols="4">
<colspec colname="1"
colwidth="90pt"></colspec>
@@ -656,34 +656,34 @@
</tgroup>
</table>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Global_Search_Index">
+ <section
id="sect-Reference_Guide-Search_Configuration-Global_Search_Index">
<title>Global Search Index</title>
<para>
By default eXo JCR uses the Lucene standard Analyzer to index contents. This
analyzer uses some standard filters in the method that analyzes the content:
</para>
<programlistingco>
<areaspec>
- <area coords="4"
id="area-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Global_Search_Index-StandardFilter"
/>
- <area coords="5"
id="area-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Global_Search_Index-LowerCaseFilter"
/>
- <area coords="6"
id="area-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Global_Search_Index-StopFilter"
/>
+ <area coords="4"
id="area-Reference_Guide-Search_Configuration-Global_Search_Index-StandardFilter"
/>
+ <area coords="5"
id="area-Reference_Guide-Search_Configuration-Global_Search_Index-LowerCaseFilter"
/>
+ <area coords="6"
id="area-Reference_Guide-Search_Configuration-Global_Search_Index-StopFilter"
/>
</areaspec>
<programlisting language="Java" role="Java"><xi:include
href="../../../../extras/Advanced_Development_JCR_search-configuration/default62.java"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Global_Search_Index-StandardFilter">
+ <callout
arearefs="area-Reference_Guide-Search_Configuration-Global_Search_Index-StandardFilter">
<para>
The first filter (StandardFilter) removes possessive apostrophes
(<emphasis role="bold">'s</emphasis>) from the end of words and
removes periods (<emphasis role="bold">.</emphasis>) from acronyms.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Global_Search_Index-LowerCaseFilter">
+ <callout
arearefs="area-Reference_Guide-Search_Configuration-Global_Search_Index-LowerCaseFilter">
<para>
The second filter (LowerCaseFilter) normalizes token text to
lower case.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Global_Search_Index-StopFilter">
+ <callout
arearefs="area-Reference_Guide-Search_Configuration-Global_Search_Index-StopFilter">
<para>
The last filter (StopFilter) removes stop words from a token
stream. The stop set is defined in the analyzer.
</para>
@@ -706,7 +706,7 @@
<para>
A customized QueryHandler can also be easily created.
</para>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Global_Search_Index-Customized_Search_Indexes_and_Analyzers">
+ <formalpara
id="form-Reference_Guide-Global_Search_Index-Customized_Search_Indexes_and_Analyzers">
<title>Customized Search Indexes and Analyzers</title>
<para>
By default Exo JCR uses the Lucene standard Analyzer to index contents.
This analyzer uses some standard filters in the method that analyzes the content:
@@ -752,7 +752,7 @@
<para>
In order to use a different filter, a new analyzer must be created, as well
as new search index to use the analyzer. These are packaged into a jar file, which is then
deployed with the application.
</para>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Global_Search_Index-Create_a_new_filter_analyzer_and_search_index">
+ <procedure
id="proc-Reference_Guide-Global_Search_Index-Create_a_new_filter_analyzer_and_search_index">
<title>Create a new filter, analyzer and search index</title>
<step>
<para>
@@ -829,7 +829,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration-IndexingConfiguration">
+ <section
id="sect-Reference_Guide-Search_Configuration-IndexingConfiguration">
<title>IndexingConfiguration</title>
<para>
From version 1.9, the default search index implementation in JCR allows user
control over which properties of a node are indexed. Different analyzers can also be set
for different nodes.
@@ -844,7 +844,7 @@
<programlisting language="XML" role="XML"><param
name="indexing-configuration-path"
value="/indexing_configuration.xml"/>
</programlisting>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Node_Scope_Limit">
+ <formalpara
id="form-Reference_Guide-IndexingConfiguration-Node_Scope_Limit">
<title>Node Scope Limit</title>
<para>
The node scope can be limited so that only certain properties of a node
type are indexed. This can optimize the index size.
@@ -863,7 +863,7 @@
</para>
</note>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Indexing_Boost_Value">
+ <formalpara
id="form-Reference_Guide-IndexingConfiguration-Indexing_Boost_Value">
<title>Indexing Boost Value</title>
<para>
It is also possible to configure a <phrase>boost
value</phrase> for the nodes that match the index rule. The default boost value is
1.0. Higher boost values (a reasonable range is 1.0 - 5.0) will yield a higher score value
and appear as more relevant.
@@ -877,7 +877,7 @@
</para>
<programlisting language="XML" role="XML"><xi:include
href="../../../../extras/Advanced_Development_JCR_search-configuration/default73.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Conditional_Index_Rules">
+ <formalpara
id="form-Reference_Guide-IndexingConfiguration-Conditional_Index_Rules">
<title>Conditional Index Rules</title>
<para>
You may also add a <phrase>condition</phrase> to the index
rule and have multiple rules with the same nodeType. The first index rule that matches
will apply and all remaining ones are ignored:
@@ -899,7 +899,7 @@
</para>
<programlisting language="XML" role="XML"><xi:include
href="../../../../extras/Advanced_Development_JCR_search-configuration/default76.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Exclusion_from_the_Node_Scope_Index">
+ <formalpara
id="form-Reference_Guide-IndexingConfiguration-Exclusion_from_the_Node_Scope_Index">
<title>Exclusion from the Node Scope Index</title>
<para>
All configured properties are full-text indexed by default (if they are
of type STRING and included in the node scope index).
@@ -914,7 +914,7 @@
</para>
<programlisting language="XML" role="XML"><xi:include
href="../../../../extras/Advanced_Development_JCR_search-configuration/default77.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Index_Aggregates">
+ <formalpara
id="form-Reference_Guide-IndexingConfiguration-Index_Aggregates">
<title>Index Aggregates</title>
<para>
Sometimes it is useful to include the contents of descendant nodes into a
single node to more easily search on content that is scattered across multiple nodes.
@@ -944,7 +944,7 @@
</para>
<programlisting language="XML" role="XML"><xi:include
href="../../../../extras/Advanced_Development_JCR_search-configuration/default81.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Property_Level_Analyzers">
+ <formalpara
id="form-Reference_Guide-IndexingConfiguration-Property_Level_Analyzers">
<title>Property-Level Analyzers</title>
<para>
How a property has to be analyzed can be defined in the following
configuration section. If there is an analyzer configuration for a property, this analyzer
is used for indexing and searching of this property. For example:
@@ -962,7 +962,7 @@
<para>
Using different analyzers for different languages can be particularly
useful.
</para>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-IndexingConfiguration-Characteristics_of_Node_Scope_Searches">
+ <formalpara
id="form-Reference_Guide-IndexingConfiguration-Characteristics_of_Node_Scope_Searches">
<title>Characteristics of Node Scope Searches</title>
<para>
Unexpected behavior may be encountered when using analyzers to search
within a <emphasis>property</emphasis> compared to searching within a
<emphasis>node scope</emphasis>. This is because the node scope always uses
the global analyzer.
@@ -1031,7 +1031,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Search_Configuration-Advanced_features">
+ <section
id="sect-Reference_Guide-Search_Configuration-Advanced_features">
<title>Advanced features</title>
<para>
eXo JCR supports some advanced features, which are not specified in JSR 170:
@@ -1039,25 +1039,25 @@
<itemizedlist>
<listitem>
<para>
- Get a text excerpt with <emphasis
role="bold">highlighted words</emphasis> that matches the query:
<xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Highlighting-DefaultXMLExcerpt"
/>>.
+ Get a text excerpt with <emphasis
role="bold">highlighted words</emphasis> that matches the query:
<xref linkend="sect-Reference_Guide-Highlighting-DefaultXMLExcerpt"
/>>.
</para>
</listitem>
<listitem>
<para>
- Search a term and its <emphasis
role="bold">synonyms</emphasis>: <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-SynonymSearch"
/>.
+ Search a term and its <emphasis
role="bold">synonyms</emphasis>: <xref
linkend="sect-Reference_Guide-Searching_Repository_Content-SynonymSearch"
/>.
</para>
</listitem>
<listitem>
<para>
- Search <emphasis role="bold">similar</emphasis>
nodes: <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Similarity"
/>.
+ Search <emphasis role="bold">similar</emphasis>
nodes: <xref
linkend="sect-Reference_Guide-Searching_Repository_Content-Similarity" />.
</para>
</listitem>
<listitem>
<para>
- Check <emphasis role="bold">spelling</emphasis>
of a full text query statement: <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-SpellChecker"
/>.
+ Check <emphasis role="bold">spelling</emphasis>
of a full text query statement: <xref
linkend="sect-Reference_Guide-Searching_Repository_Content-SpellChecker" />.
</para>
</listitem>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container">
+<chapter id="chap-Reference_Guide-Workspace_Data_Container">
<title>Workspace Data Container</title>
<para>
Each Workspace of the JCR has its own persistent storage to hold that
workspace's items data. The eXo JCR can be configured so that it can use one or more
workspaces that are logical units of the repository content.
@@ -13,14 +13,14 @@
</para>
<programlistingco>
<areaspec>
- <area coords="3"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-source_name"
/>
- <area coords="4"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-dialect" />
- <area coords="5"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-multidb" />
- <area coords="6"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-maxbuffer" />
- <area coords="7"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-swap" />
- <area coords="8"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-lazy-node-iterator-page-size"
/>
- <area coords="9"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-acl-bloomfilter-false-positive-probability"
/>
- <area coords="10"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-acl-bloomfilter-elements-number"
/>
+ <area coords="3"
id="area-Reference_Guide-Workspace_Data_Container-source_name" />
+ <area coords="4"
id="area-Reference_Guide-Workspace_Data_Container-dialect" />
+ <area coords="5"
id="area-Reference_Guide-Workspace_Data_Container-multidb" />
+ <area coords="6"
id="area-Reference_Guide-Workspace_Data_Container-maxbuffer" />
+ <area coords="7"
id="area-Reference_Guide-Workspace_Data_Container-swap" />
+ <area coords="8"
id="area-Reference_Guide-Workspace_Data_Container-lazy-node-iterator-page-size"
/>
+ <area coords="9"
id="area-Reference_Guide-Workspace_Data_Container-acl-bloomfilter-false-positive-probability"
/>
+ <area coords="10"
id="area-Reference_Guide-Workspace_Data_Container-acl-bloomfilter-elements-number"
/>
</areaspec>
@@ -36,49 +36,49 @@
<property name="acl-bloomfilter-elements-number"
value="1000000"/>
</properties></programlisting>
<calloutlist>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-source_name">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-source_name">
<para>
<literal>source-name</literal>: The JDBC data source name
which is registered in JDNI by InitialContextInitializer. This was known as
<literal>sourceName</literal> in versions prior to 1.9.
</para>
</callout>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-dialect">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-dialect">
<para>
<literal>dialect</literal>: The database dialect. Must be
one of the following: <literal>hsqldb</literal>,
<literal>mysql</literal>, <literal>mysql-utf8</literal>,
<literal>pgsql</literal>, <literal>oracle</literal>,
<literal>oracle-oci</literal>, <literal>mssql</literal>,
<literal>sybase</literal>, <literal>derby</literal>,
<literal>db2</literal> or <literal>db2v8</literal>).
</para>
</callout>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-multidb">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-multidb">
<para>
<literal>multi-db</literal>: This parameter, if
<literal>true</literal>, enables multi-database container.
</para>
</callout>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-maxbuffer">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-maxbuffer">
<para>
<literal>max-buffer-size</literal>: A threshold in bytes.
If a value size is greater than this setting, then it will be spooled to a temporary
file.
</para>
</callout>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-swap">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-swap">
<para>
<literal>swap-directory</literal>: A location where the
value will be spooled if no value storage is configured but a
<literal>max-buffer-size</literal> is exceeded.
</para>
</callout>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-lazy-node-iterator-page-size">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-lazy-node-iterator-page-size">
<para>
<emphasis
role="bold">lazy-node-iterator-page-size</emphasis>: "Lazy"
child nodes iterator settings. Defines size of page, the number of nodes that are
retrieved from persistent storage at once.
</para>
</callout>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-acl-bloomfilter-false-positive-probability">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-acl-bloomfilter-false-positive-probability">
<para>
<emphasis
role="bold">acl-bloomfilter-false-positive-probability</emphasis>: ACL
Bloom-filter settings. ACL Bloom-filter desired false positive probability. Range [0..1].
Default value 0.1d.
</para>
</callout>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-acl-bloomfilter-elements-number">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-acl-bloomfilter-elements-number">
<para>
<emphasis
role="bold">acl-bloomfilter-elements-number</emphasis>: ACL
Bloom-filter settings. Expected number of ACL-elements in the Bloom-filter. Default value
1000000.
</para>
@@ -112,8 +112,8 @@
</para>
<programlistingco>
<areaspec>
- <area coords="2"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-value_storage"
/>
- <area coords="6"
id="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-filters" />
+ <area coords="2"
id="area-Reference_Guide-Workspace_Data_Container-value_storage" />
+ <area coords="6"
id="area-Reference_Guide-Workspace_Data_Container-filters" />
</areaspec>
@@ -128,13 +128,13 @@
.........
</value-storages></programlisting>
<calloutlist>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-value_storage">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-value_storage">
<para>
<literal>value-storage</literal> is the subclass of
<literal>org.exoplatform.services.jcr.storage.value.ValueStoragePlugin</literal>
and <literal>properties</literal> are optional plugin specific parameters.
</para>
</callout>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Workspace_Data_Container-filters">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-Workspace_Data_Container-filters">
<para>
<literal>filters</literal>: Each file value storage can
have the filter(s) for incoming values. If there are several filter criteria, they all
have to match (AND-Condition).
</para>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/data-container-howto.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/data-container-howto.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/data-container-howto.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,16 +1,16 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-How_to_implement_Workspace_Data_Container">
+<chapter
id="chap-Reference_Guide-How_to_implement_Workspace_Data_Container">
<title>How-to implement Workspace Data Container</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_to_implement_Workspace_Data_Container-Short_intro_about_Workspace_data_container_implementation_practices">
+ <section
id="sect-Reference_Guide-How_to_implement_Workspace_Data_Container-Short_intro_about_Workspace_data_container_implementation_practices">
<title>Short intro about Workspace data container implementation
practices:</title>
<orderedlist>
<listitem>
<para>
- Read a bit about the <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-JCR_Workspace_Data_Container" />.
+ Read a bit about the <xref
linkend="chap-Reference_Guide-JCR_Workspace_Data_Container" />.
</para>
</listitem>
@@ -102,7 +102,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_to_implement_Workspace_Data_Container-Notes_on_Value_storage_usage">
+ <section
id="sect-Reference_Guide-How_to_implement_Workspace_Data_Container-Notes_on_Value_storage_usage">
<title>Notes on Value storage usage:</title>
<para>
Value storages are pluggable to the container but if they are used, the container
implementation should respect set of interfaces and external storage usage principles.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/data-container.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/data-container.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/data-container.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-JCR_Workspace_Data_Container">
+<chapter id="chap-Reference_Guide-JCR_Workspace_Data_Container">
<title>JCR Workspace Data Container</title>
<para>
The JCR Workspace Data Container:
@@ -29,7 +29,7 @@
</listitem>
</itemizedlist>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-JCR_Workspace_Data_Container-Concepts">
+ <variablelist
id="vari-Reference_Guide-JCR_Workspace_Data_Container-Concepts">
<title>Concepts</title>
<varlistentry>
<term>Container and connection</term>
@@ -136,12 +136,12 @@
</varlistentry>
</variablelist>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Workspace_Data_Container-Requirements">
+ <section
id="sect-Reference_Guide-JCR_Workspace_Data_Container-Requirements">
<title>Requirements</title>
<para>
Connection creation and reuse should be a thread safe operation. The connection
provides <abbrev>CRUD</abbrev> operations support on the storage.
</para>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Requirements-Read_Operations">
+ <itemizedlist id="item-Reference_Guide-Requirements-Read_Operations">
<title>Read Operations</title>
<listitem>
<para>
@@ -205,7 +205,7 @@
</listitem>
</itemizedlist>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Requirements-Write_Operations">
+ <itemizedlist
id="item-Reference_Guide-Requirements-Write_Operations">
<title>Write Operations</title>
<listitem>
<para>
@@ -293,7 +293,7 @@
</listitem>
</itemizedlist>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Requirements-State_Operations">
+ <itemizedlist
id="item-Reference_Guide-Requirements-State_Operations">
<title>State Operations</title>
<listitem>
<para>
@@ -306,7 +306,7 @@
</listitem>
</itemizedlist>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Requirements-Validation_of_write_operations">
+ <itemizedlist
id="item-Reference_Guide-Requirements-Validation_of_write_operations">
<title>Validation of write operations</title>
<listitem>
<para>
@@ -315,7 +315,7 @@
</listitem>
<listitem>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Validation_of_write_operations-On_ADD_errors">
+ <itemizedlist
id="item-Reference_Guide-Validation_of_write_operations-On_ADD_errors">
<title>On ADD errors</title>
<listitem>
<itemizedlist>
@@ -346,7 +346,7 @@
</listitem>
<listitem>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Validation_of_write_operations-On_DELETE_errors">
+ <itemizedlist
id="item-Reference_Guide-Validation_of_write_operations-On_DELETE_errors">
<title>On DELETE errors</title>
<listitem>
<itemizedlist>
@@ -371,7 +371,7 @@
</listitem>
<listitem>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Validation_of_write_operations-On_UPDATE_errors">
+ <itemizedlist
id="item-Reference_Guide-Validation_of_write_operations-On_UPDATE_errors">
<title>On UPDATE errors</title>
<listitem>
<itemizedlist>
@@ -397,7 +397,7 @@
</listitem>
</itemizedlist>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Requirements-Consistency_of_save">
+ <itemizedlist
id="item-Reference_Guide-Requirements-Consistency_of_save">
<title>Consistency of save</title>
<listitem>
<para>
@@ -407,10 +407,10 @@
</listitem>
</itemizedlist>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Requirements-Value_storages_API">
+ <itemizedlist
id="item-Reference_Guide-Requirements-Value_storages_API">
<title>Value storages API</title>
<listitem>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Value_storages_API-Storages_provider">
+ <itemizedlist
id="item-Reference_Guide-Value_storages_API-Storages_provider">
<title>Storages provider:</title>
<listitem>
<para>
@@ -450,7 +450,7 @@
</listitem>
<listitem>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Value_storages_API-Value_storage_plugin">
+ <itemizedlist
id="item-Reference_Guide-Value_storages_API-Value_storage_plugin">
<title>Value storage plugin</title>
<listitem>
<para>
@@ -496,7 +496,7 @@
</listitem>
<listitem>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Value_storages_API-Value_IO_channel">
+ <itemizedlist
id="item-Reference_Guide-Value_storages_API-Value_IO_channel">
<title>Value I/O channel</title>
<listitem>
<para>
@@ -542,7 +542,7 @@
</listitem>
<listitem>
- <itemizedlist
id="item-Reference_Guide_eXo_JCR_1.14-Value_storages_API-Transaction_support_via_channel">
+ <itemizedlist
id="item-Reference_Guide-Value_storages_API-Transaction_support_via_channel">
<title>Transaction support via channel</title>
<listitem>
<para>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/db-cleaner-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/db-cleaner-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/db-cleaner-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-DBCleanService">
+<chapter id="chap-Reference_Guide-DBCleanService">
<title>DBCleanService</title>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-DBCleanService-API">
+ <section id="sect-Reference_Guide-DBCleanService-API">
<title>API</title>
<para>
It is special service for removing data from database.
@@ -19,7 +19,7 @@
<para>
There are three methods of DBCleanerService:
</para>
- <table id="tabl-Reference_Guide_eXo_JCR_1.14-API-API">
+ <table id="tabl-Reference_Guide-API-API">
<title>API</title>
<tgroup cols="2">
<tbody>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/intro.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/intro.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/intro.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-eXoJCR-Introduction">
+<chapter id="chap-Reference_Guide-eXoJCR-Introduction">
<title>Introduction</title>
<warning>
<title>eXo JCR usage</title>
@@ -21,7 +21,7 @@
<para>
The eXo JCR included with JBoss Enterprise Portal Platform &VY; is a
(<ulink type="http"
url="http://www.jcp.org/en/jsr/detail?id=170">JSR-170</ulink>)
compliant implementation of the JCR 1.0 specification. The JCR provides versioning,
textual search, access control, content event monitoring, and is used to storing text and
binary data for the portal internal usage. The back-end storage of the JCR is configurable
and can be a file system or a database.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Introduction-Concepts">
+ <section id="sect-Reference_Guide-Introduction-Concepts">
<title>Concepts</title>
<variablelist>
<varlistentry>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jbosscache-configuration-templates.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jbosscache-configuration-templates.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jbosscache-configuration-templates.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-JBoss_Cache_configuration">
+<chapter id="chap-Reference_Guide-JBoss_Cache_configuration">
<title>JBoss Cache configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JBoss_Cache_configuration-Indexer_lock_manager_and_data_container_configuration">
+ <section
id="sect-Reference_Guide-JBoss_Cache_configuration-Indexer_lock_manager_and_data_container_configuration">
<title>Indexer, lock manager and data container
configuration</title>
<para>
Each mentioned component uses instances of the JBoss Cache product for
caching in clustered environment. So every element has its own transport and has to be
configured correctly. As usual, workspaces have similar configuration differing only in
cluster-names (and, possibly, some other parameters). The simplest way to configure them
is to define their own configuration files for each component in each workspace:
@@ -35,7 +35,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JBoss_Cache_configuration-JGroups_configuration">
+ <section
id="sect-Reference_Guide-JBoss_Cache_configuration-JGroups_configuration">
<title>JGroups configuration</title>
<para>
JGroups is used by JBoss Cache for network communications and transport in a
clustered environment. If the property is defined in component configuration, it will be
injected into the JBoss Cache instance on start up.
@@ -57,7 +57,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JBoss_Cache_configuration-Sharing_JBoss_Cache_instances">
+ <section
id="sect-Reference_Guide-JBoss_Cache_configuration-Sharing_JBoss_Cache_instances">
<title>Sharing JBoss Cache instances</title>
<para>
As a single JBoss Cache instance can be demanding on resources, and the
default setup will have an instance each for the indexer, the lock manager and the data
container on each workspace, an environment that uses multiple workspace may benefit from
sharing a JBoss Cache instance between several instances of the same type (the lock
manager instance, for example).
@@ -79,19 +79,19 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JBoss_Cache_configuration-Shipped_JBoss_Cache_configuration_templates">
+ <section
id="sect-Reference_Guide-JBoss_Cache_configuration-Shipped_JBoss_Cache_configuration_templates">
<title>Shipped JBoss Cache configuration templates</title>
<para>
The eXo JCR implementation is shipped with ready-to-use JBoss Cache
configuration templates for JCR's components. They are located in an application
package in the <filename>/conf/portal/</filename> directory.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Data_container_template">
+ <section
id="sect-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Data_container_template">
<title>Data container template</title>
<para>
The data container template is
<filename>jbosscache-data.xml</filename>:
</para>
<programlistingco>
<areaspec>
- <area coords="7"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Data_container_template-jbosscache-cluster-name"
/>
+ <area coords="7"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Data_container_template-jbosscache-cluster-name"
/>
</areaspec>
@@ -117,9 +117,9 @@
</default>
</eviction>
</jbosscache></programlisting>
- <calloutlist
id="call-Reference_Guide_eXo_JCR_1.14-Data_container_template-Template_variables">
+ <calloutlist
id="call-Reference_Guide-Data_container_template-Template_variables">
<title>Template variables</title>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Data_container_template-jbosscache-cluster-name">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Data_container_template-jbosscache-cluster-name">
<para>
<replaceable>jbosscache-cluster-name</replaceable>.
</para>
@@ -133,24 +133,24 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template">
+ <section
id="sect-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template">
<title>Lock manager template</title>
<para>
The lock manager template is
<filename>jbosscache-lock.xml</filename>:
</para>
<programlistingco>
<areaspec>
- <area coords="6"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cluster-name"
/>
- <area coords="18"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.name"
/>
- <area coords="19"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.create"
/>
- <area coords="20"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.drop"
/>
- <area coords="21"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.primarykey"
/>
- <area coords="22"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.fqn.column"
/>
- <area coords="23"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.fqn.type"
/>
- <area coords="24"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.node.column"
/>
- <area coords="25"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.node.type"
/>
- <area coords="26"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.parent.column"
/>
- <area coords="27"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.datasource"
/>
+ <area coords="6"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cluster-name"
/>
+ <area coords="18"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.name"
/>
+ <area coords="19"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.create"
/>
+ <area coords="20"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.drop"
/>
+ <area coords="21"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.primarykey"
/>
+ <area coords="22"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.fqn.column"
/>
+ <area coords="23"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.fqn.type"
/>
+ <area coords="24"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.node.column"
/>
+ <area coords="25"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.node.type"
/>
+ <area coords="26"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.parent.column"
/>
+ <area coords="27"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.datasource"
/>
</areaspec>
@@ -185,69 +185,69 @@
</loader>
</loaders>
</jbosscache></programlisting>
- <calloutlist
id="call-Reference_Guide_eXo_JCR_1.14-Lock_manager_template-Template_variables">
+ <calloutlist
id="call-Reference_Guide-Lock_manager_template-Template_variables">
<title>Template variables</title>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cluster-name">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cluster-name">
<para>
<replaceable>jbosscache-cluster-name</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.name">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.name">
<para>
<replaceable>jbosscache-cl-cache.jdbc.table.name</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.create">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.create">
<para>
<replaceable>jbosscache-cl-cache.jdbc.table.create</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.drop">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.drop">
<para>
<replaceable>jbosscache-cl-cache.jdbc.table.drop</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.primarykey">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.table.primarykey">
<para>
<replaceable>jbosscache-cl-cache.jdbc.table.primarykey</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.fqn.column">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.fqn.column">
<para>
<replaceable>jbosscache-cl-cache.jdbc.fqn.column</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.fqn.type">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.fqn.type">
<para>
<replaceable>jbosscache-cl-cache.jdbc.fqn.type</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.node.column">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.node.column">
<para>
<replaceable>jbosscache-cl-cache.jdbc.node.column</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.node.type">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.node.type">
<para>
<replaceable>jbosscache-cl-cache.jdbc.node.type</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.parent.column">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.parent.column">
<para>
<replaceable>jbosscache-cl-cache.jdbc.parent.column</replaceable>
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.datasource">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Lock_manager_template-jbosscache-cl-cache.jdbc.datasource">
<para>
<replaceable>jbosscache-cl-cache.jdbc.datasource</replaceable>
</para>
@@ -261,14 +261,14 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Query_handler_indexer_template">
+ <section
id="sect-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Query_handler_indexer_template">
<title>Query handler (indexer) template</title>
<para>
The query handler template is called
<filename>jbosscache-indexer.xml</filename>:
</para>
<programlistingco>
<areaspec>
- <area coords="5"
id="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Query_handler_indexer_template-jbosscache-cluster-name"
/>
+ <area coords="5"
id="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Query_handler_indexer_template-jbosscache-cluster-name"
/>
</areaspec>
@@ -290,7 +290,7 @@
</eviction>
</jbosscache></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Shipped_JBoss_Cache_configuration_templates-Query_handler_indexer_template-jbosscache-cluster-name">
+ <callout
arearefs="area-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Query_handler_indexer_template-jbosscache-cluster-name">
<para>
<replaceable>jbosscache-cluster-name</replaceable>
</para>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jbossts-transaction-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jbossts-transaction-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jbossts-transaction-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-JBossTransactionsService">
+<chapter id="chap-Reference_Guide-JBossTransactionsService">
<title>JBossTransactionsService</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JBossTransactionsService-Introduction">
+ <section
id="sect-Reference_Guide-JBossTransactionsService-Introduction">
<title>Introduction</title>
<para>
JBossTransactionsService implements eXo TransactionService and provides access to
<ulink
url="http://www.jboss.org/jbosstm/">JBoss Transaction Service
(JBossTS)</ulink> JTA implementation via eXo container dependency.
@@ -16,7 +16,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JBossTransactionsService-Configuration">
+ <section
id="sect-Reference_Guide-JBossTransactionsService-Configuration">
<title>Configuration</title>
<para>
Example configuration:
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jca.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jca.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jca.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-The_JCA_Resource_Adapter">
+<chapter id="chap-Reference_Guide-The_JCA_Resource_Adapter">
<title>The <emphasis>JCA</emphasis> Resource Adapter</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_JCA_Resource_Adapter-Overview">
+ <section id="sect-Reference_Guide-The_JCA_Resource_Adapter-Overview">
<title>Overview</title>
<para>
eXo JCR supports <emphasis>J2EE Connector Architecture</emphasis> 1.5,
thus If you would like to delegate the JCR Session lifecycle to your application server,
you can use the JCA Resource Adapter for eXo JCR if your application server supports JCA
1.5. This adapter only supports XA Transaction, in other words you cannot use it for local
transactions. Since the JCR Sessions have not been designed to be shareable, the session
pooling is simply not covered by the adapter.
@@ -13,7 +13,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_JCA_Resource_Adapter-The_SessionFactory">
+ <section
id="sect-Reference_Guide-The_JCA_Resource_Adapter-The_SessionFactory">
<title>The <emphasis>SessionFactory</emphasis></title>
<para>
The equivalent of the
<emphasis>javax.resource.cci.ConnectionFactory</emphasis> in JCA terminology
is <emphasis>org.exoplatform.connectors.jcr.adapter.SessionFactory</emphasis>
in the context of eXo JCR, the resource that you will get thanks to a JNDI lookup is of
type <emphasis>SessionFactory</emphasis> and provides the following methods:
@@ -61,9 +61,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_JCA_Resource_Adapter-Configuration">
+ <section
id="sect-Reference_Guide-The_JCA_Resource_Adapter-Configuration">
<title>Configuration</title>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Configuration-Configuration_Properties">
+ <table
id="tabl-Reference_Guide-Configuration-Configuration_Properties">
<title>Configuration Properties</title>
<tgroup cols="2">
<tbody>
@@ -94,7 +94,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-The_JCA_Resource_Adapter-Deployment">
+ <section
id="sect-Reference_Guide-The_JCA_Resource_Adapter-Deployment">
<title>Deployment</title>
<para>
As the JCR and its dependencies are provided when you use it with gateIn you will need
to deploy only the rar file corresponding to the artifactId
<emphasis>exo.jcr.connectors.jca</emphasis> and groupId
<emphasis>org.exoplatform.jcr</emphasis>.
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jta.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jta.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/jta.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Java_Transaction_API">
+<chapter id="chap-Reference_Guide-Java_Transaction_API">
<!-- This document was created with Syntext Serna Free. -->
<title>Java Transaction API</title>
<para>
eXo JCR supports the Java Transaction API (<abbrev>JTA</abbrev>) by
default.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-LockManager">
+<chapter id="chap-Reference_Guide-LockManager">
<title>LockManager</title>
<para>
The LockManager stores lock objects. It can lock or release objects as required.
It is also responsible for removing stale locks.
@@ -19,7 +19,7 @@
</para>
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/Advanced_Development_JCR_lock-manager-config/default47.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-LockManager-CacheableLockManagerImpl">
+ <section
id="sect-Reference_Guide-LockManager-CacheableLockManagerImpl">
<title>CacheableLockManagerImpl</title>
<para>
<classname>CacheableLockManagerImpl</classname> stores lock
objects in JBoss-cache (which implements JDBCCacheLoader to store locks in a database).
This means its locks are replicable and can affect an entire cluster rather than just a
single node.
@@ -67,13 +67,13 @@
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration"
/>
+ <xref
linkend="sect-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration"
/>
+ <xref
linkend="sect-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration"
/>
</para>
</listitem>
@@ -82,7 +82,7 @@
<para>
Refer to <ulink
url="http://community.jboss.org/wiki/JBossCacheJDBCCacheLoader"...
for more information about JBoss Cache and JDBCCacheLoader.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration">
+ <section
id="sect-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration">
<title>Simple JBoss Cache Configuration</title>
<para>
One method to configure the LockManager is to put a JBoss Cache
configuration file path into <classname>CacheableLockManagerImpl</classname>.
@@ -101,13 +101,13 @@
</para>
<programlistingco>
<areaspec>
- <area coords="4 90"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-jbosscache-lock-config.xml"
/>
+ <area coords="4 90"
id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-jbosscache-lock-config.xml"
/>
</areaspec>
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/Advanced_Development_JCR_lock-manager-config/default49.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-jbosscache-lock-config.xml">
+ <callout
arearefs="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-jbosscache-lock-config.xml">
<para>
The
<replaceable>test-jbosscache-lock-config.xml</replaceable> is shown below.
</para>
@@ -123,11 +123,11 @@
</para>
<programlistingco>
<areaspec>
- <area coords="6 90"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-clusterName"
/>
- <area coords="41 50"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.table.name"
/>
- <areaset coords=""
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.types">
- <area coords="48 50"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.node.type"
/>
- <area coords="46 50"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.fqn.type"
/>
+ <area coords="6 90"
id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-clusterName"
/>
+ <area coords="41 50"
id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.table.name"
/>
+ <areaset coords=""
id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.types">
+ <area coords="48 50"
id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.node.type"
/>
+ <area coords="46 50"
id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.fqn.type"
/>
</areaset>
@@ -135,19 +135,19 @@
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/Advanced_Development_JCR_lock-manager-config/default50.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-clusterName">
+ <callout
arearefs="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-clusterName">
<para>
The cluster name at <parameter>clustering
mode="replication"
clusterName="JBoss-Cache-Lock-Cluster_Name"</parameter> must be unique;
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.table.name">
+ <callout
arearefs="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.table.name">
<para>
The <parameter>cache.jdbc.table.name</parameter>
must be unique per datasource.
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.types">
+ <callout
arearefs="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.types">
<para>
The <parameter>cache.jdbc.node.type</parameter>
and <parameter>cache.jdbc.fqn.type</parameter> parameters must be configured
according to the database in use.
</para>
@@ -161,7 +161,7 @@
</programlistingco>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Simple_JBoss_Cache_Configuration-Data_Types_in_Different_Databases">
+ <table
id="tabl-Reference_Guide-Simple_JBoss_Cache_Configuration-Data_Types_in_Different_Databases">
<title>Data Types in Different Databases</title>
<tgroup cols="3">
<thead>
@@ -285,7 +285,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration">
+ <section
id="sect-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration">
<title>Template JBoss Cache Configuration</title>
<para>
Another method to configure LockManager is to use a JBoss Cache
configuration template for all LockManagers.
@@ -295,9 +295,9 @@
</para>
<programlistingco>
<areaspec>
- <areaset coords=""
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.templates">
- <area coords="24 50"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.table.name"
/>
- <area coords="35 50"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.datasource"
/>
+ <areaset coords=""
id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.templates">
+ <area coords="24 50"
id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.table.name"
/>
+ <area coords="35 50"
id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.datasource"
/>
</areaset>
@@ -305,7 +305,7 @@
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/Advanced_Development_JCR_lock-manager-config/you.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.templates">
+ <callout
arearefs="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.templates">
<para>
All the configurable parameters in this file are populated
with templates which will be replaced with LockManager's configuration parameters.
</para>
@@ -321,10 +321,10 @@
</para>
<programlistingco>
<areaspec>
- <area coords="5 90"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-udp-mux.xml"
/>
- <areaset coords=""
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.parameters">
- <area coords="12 90"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.fqn.column"
/>
- <area coords="15 90"
id="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.node.type"
/>
+ <area coords="5 90"
id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-udp-mux.xml"
/>
+ <areaset coords=""
id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.parameters">
+ <area coords="12 90"
id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.fqn.column"
/>
+ <area coords="15 90"
id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.node.type"
/>
</areaset>
@@ -332,7 +332,7 @@
<programlisting language="XML" role="XML"><xi:include
href="../../../extras/Advanced_Development_JCR_lock-manager-config/default51.xml"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-udp-mux.xml">
+ <callout
arearefs="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-udp-mux.xml">
<para>
The <literal>jgroups-configuration</literal> has
been moved to a separate configuration file (<filename>udp-mux.xml</filename>,
shown below).
</para>
@@ -341,12 +341,12 @@
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.parameters">
+ <callout
arearefs="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.parameters">
<para>
The
<parameter>jbosscache-cl-cache.jdbc.fqn.column</parameter> and
<parameter>jbosscache-cl-cache.jdbc.node.type</parameter> parameters are not
explicitly defined as <parameter>cache.jdbc.fqn.type</parameter> and
<parameter>cache.jdbc.node.type</parameter> are defined in the JBoss Cache
configuration.
</para>
<para>
- Refer to <xref
linkend="tabl-Reference_Guide_eXo_JCR_1.14-Simple_JBoss_Cache_Configuration-Data_Types_in_Different_Databases"
/> for information about setting these parameters or set them as
<parameter>AUTO</parameter> and the data type will by detected automatically.
+ Refer to <xref
linkend="tabl-Reference_Guide-Simple_JBoss_Cache_Configuration-Data_Types_in_Different_Databases"
/> for information about setting these parameters or set them as
<parameter>AUTO</parameter> and the data type will by detected automatically.
</para>
</callout>
@@ -363,12 +363,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-CacheableLockManagerImpl-Lock_migration_from_1.12.x">
+ <section
id="sect-Reference_Guide-CacheableLockManagerImpl-Lock_migration_from_1.12.x">
<title>Lock migration from 1.12.x</title>
<para>
There are three options available:
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Lock_migration_from_1.12.x-Lock_Migration_Options">
+ <variablelist
id="vari-Reference_Guide-Lock_migration_from_1.12.x-Lock_Migration_Options">
<title>Lock Migration Options</title>
<varlistentry>
<term>When new Shareable Cache feature is not going to be used
and all locks should be kept after migration.</term>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/acl-ext.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/acl-ext.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/acl-ext.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,19 +1,19 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension">
+<chapter id="chap-Reference_Guide-Access_Control_Extension">
<title>Access Control Extension</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension-Prerequisites">
+ <section
id="sect-Reference_Guide-Access_Control_Extension-Prerequisites">
<title>Prerequisites</title>
<para>
- The Access Control Extension is an extension of eXo JCR Access Control features. Read
<xref linkend="chap-Reference_Guide_eXo_JCR_1.14-Access_Control" /> as a
primer to the information in this section.
+ The Access Control Extension is an extension of eXo JCR Access Control features. Read
<xref linkend="chap-Reference_Guide-Access_Control" /> as a primer to the
information in this section.
</para>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension-Overview">
+ <section id="sect-Reference_Guide-Access_Control_Extension-Overview">
<title>Overview</title>
<para>
An extended Access Control system consists of:
@@ -42,7 +42,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension-Access_Context_Action">
+ <section
id="sect-Reference_Guide-Access_Control_Extension-Access_Context_Action">
<title>Access Context Action</title>
<para>
<literal>SetAccessContextAction</literal> implements Action and may be
called by <literal>SessionActionInterceptor</literal> as a reaction of some
events, usually before writing methods and after reading
(<literal>getNode()</literal>, <literal> getProperty()</literal>
etc). This <literal>SetAccessContextAction</literal> calls the
<literal>AccessManager.setContext(InvocationContext context)</literal> method
which sets the ThreadLocal invocation context for the current call.
@@ -61,7 +61,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension-The_Invocation_Context">
+ <section
id="sect-Reference_Guide-Access_Control_Extension-The_Invocation_Context">
<title>The Invocation Context</title>
<para>
The <literal>InvocationContext</literal> contains the current Item, the
current ExoContainer and the current EventType is like below:
@@ -78,10 +78,10 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension-Custom_Extended_Access_Manager">
+ <section
id="sect-Reference_Guide-Access_Control_Extension-Custom_Extended_Access_Manager">
<title>Custom Extended Access Manager</title>
<para>
- All Workspaces share an <literal>AccessManager</literal> by default. The
<literal>AccessManager</literal> is created by
<literal>RepositoryService</literal> at start up and supports access control
policy as described in <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Access_Control" />.
+ All Workspaces share an <literal>AccessManager</literal> by default. The
<literal>AccessManager</literal> is created by
<literal>RepositoryService</literal> at start up and supports access control
policy as described in <xref linkend="chap-Reference_Guide-Access_Control"
/>.
</para>
<para>
A Custom Access Control policy can be applied to certain Workspaces by configuring the
<parameter>access-manager</parameter> element inside the
<parameter>workspace</parameter> element as follows:
@@ -113,7 +113,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control_Extension-Example_of_a_custom_Access_Manager">
+ <section
id="sect-Reference_Guide-Access_Control_Extension-Example_of_a_custom_Access_Manager">
<title>Example of a custom Access Manager</title>
<para>
The sample <literal>CustomAccessManagerImpl</literal> below extends the
default access manager and uses some <literal>DecisionMakingService</literal>
in the overloaded <literal>hasPermission</literal> method to find out if a
current user has permission to use current <emphasis role="bold">item,
event type, userID</emphasis> and some parameter of AccessManager.
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/acl.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/acl.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/acl.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Access_Control">
+<chapter id="chap-Reference_Guide-Access_Control">
<title>Access Control</title>
<para>
The eXo JCR component is a complete implementation of the standard JSR 170: <ulink
url="http://jcp.org/en/jsr/detail?id=170">Content Repository for Java TM
Technology API</ulink>, including <emphasis role="bold">Level 1,
Level 2 and Additional Features</emphasis> specified in the JCR Specification.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control-Standard_Action_Permissions">
+ <section
id="sect-Reference_Guide-Access_Control-Standard_Action_Permissions">
<title>Standard Action Permissions</title>
<para>
The JCR specification (JSR 170) has few requirements about Access Control. It only
requires the implementation of the <literal>Session.checkPermission(String absPath,
String actions)</literal> method. This method checks if a current session has
permissions to perform some actions on absPath:
@@ -114,12 +114,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Access_Control-eXo_Access_Control">
+ <section id="sect-Reference_Guide-Access_Control-eXo_Access_Control">
<title>eXo Access Control</title>
<para>
The JSR-170 specification does not define how permissions are managed or checked.
Therefore the eXo JCR has a proprietary extension to manage and check permissions on
nodes. In essence, this extension uses an <ulink
url="http://en.wikipedia.org/wiki/Access_control_list">Access Control List
(ACL)</ulink> policy model applied to the eXo Organization model.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_Access_Control-Principal_and_Identity">
+ <section
id="sect-Reference_Guide-eXo_Access_Control-Principal_and_Identity">
<title>Principal and Identity</title>
<para>
The eXo Access Control is built around the notion of the <emphasis
role="bold">identity</emphasis> concept. Access to the JCR is made
through sessions acquired against a repository.
@@ -167,7 +167,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_Access_Control-ACL">
+ <section id="sect-Reference_Guide-eXo_Access_Control-ACL">
<title>ACL</title>
<para>
An access control list (<abbrev>ACL</abbrev>) is a list of permissions
attached to an object. An ACL specifies which users, groups or system processes are
granted access to JCR nodes, as well as what operations are allowed to be performed on
given objects.
@@ -199,7 +199,7 @@
</varlistentry>
</variablelist>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-ACL-Privilegeable">
+ <section id="sect-Reference_Guide-ACL-Privilegeable">
<title>Privilegeable</title>
<para>
A privilegeable node defines the permissions required for actions on this node. For
this purpose, it contains an ACL.
@@ -252,7 +252,7 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-ACL-Ownable">
+ <section id="sect-Reference_Guide-ACL-Ownable">
<title>Ownable</title>
<para>
An ownable node defines an owner identity. The <emphasis
role="bold">owner</emphasis> has always <emphasis
role="bold">full privileges</emphasis>. These privileges are
independent of the permissions set by exo:permissions. At JCR level, the ownership is
implemented by an <emphasis role="bold">exo:owneable</emphasis>
mixin. This mixin holds an owner property.
@@ -272,7 +272,7 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-ACL-ACL_Inheritance">
+ <section id="sect-Reference_Guide-ACL-ACL_Inheritance">
<title>ACL Inheritance</title>
<para>
To grant or deny access to a node, eXo JCR applies a privilege resolving logic at
node access time.
@@ -292,7 +292,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-ACL-Default_ACL_of_the_root_node">
+ <section id="sect-Reference_Guide-ACL-Default_ACL_of_the_root_node">
<title>Default ACL of the root node</title>
<para>
When no matching ACL is found in the ancestor hierarchy, the system may end up
looking at the root node's ACL. As ACL are optional, even for the root node, if the
root node has no ACL, the following rule is ultimately applied to resolve privileges:
@@ -312,13 +312,13 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_Access_Control-Notes">
+ <section id="sect-Reference_Guide-eXo_Access_Control-Notes">
<title>Notes</title>
<para>
<parameter>Access Control nodetypes are not extendible:</parameter> The
access control mechanism works for <parameter>exo:owneable</parameter> and
<parameter>exo:privilegeable</parameter> nodetypes only, not for their
subtypes! So you cannot extend those nodetypes.
</para>
<para>
- <parameter>Autocreation:</parameter> By default, newly created nodes are
neither <parameter>exo:privilegeable</parameter> nor
<parameter>exo:owneable</parameter> but it is possible to configure the
repository to auto-create <parameter>exo:privilegeable</parameter> or/and
<parameter>exo:owneable</parameter> thanks to eXo's JCR interceptors
extension <!-- File not being called: (see <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-JCR_Service_Extensions-Concept"
/>) -->
+ <parameter>Autocreation:</parameter> By default, newly created nodes are
neither <parameter>exo:privilegeable</parameter> nor
<parameter>exo:owneable</parameter> but it is possible to configure the
repository to auto-create <parameter>exo:privilegeable</parameter> or/and
<parameter>exo:owneable</parameter> thanks to eXo's JCR interceptors
extension <!-- File not being called: (see <xref
linkend="sect-Reference_Guide-JCR_Service_Extensions-Concept" />)
-->
</para>
<para>
<parameter>OR-based Privilege Inheritance</parameter>: Note, that
eXo's Access Control implementation supports a privilege inheritance that follows a
strategy of either...or/ and has only an ALLOW privilege mechanism (there is no DENY
feature). This means that a session is allowed to perform some operations on some nodes if
its identity has an appropriate permission assigned to this node. Only if there is no
exo:permission property assigned to the node itself, the permissions of the node's
ancestors are used.
@@ -326,9 +326,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_Access_Control-Example">
+ <section id="sect-Reference_Guide-eXo_Access_Control-Example">
<title>Example</title>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Example-XML_Example">
+ <section id="sect-Reference_Guide-Example-XML_Example">
<title>XML Example</title>
<para>
In the following example, you see a node named
"<emphasis>Politics</emphasis>" which contains two nodes named
"<emphasis>Cats</emphasis>" and
"<emphasis>Dogs</emphasis>".
@@ -370,7 +370,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Example-Inheritance_Examples">
+ <section id="sect-Reference_Guide-Example-Inheritance_Examples">
<title>Inheritance Examples</title>
<para>
Here is an example showing the accessibility of two nodes (to show inheritance) for
two sample users named <emphasis role="bold">manager</emphasis> and
<emphasis role="bold">user</emphasis>:
@@ -387,7 +387,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Example-Permission_validation">
+ <section id="sect-Reference_Guide-Example-Permission_validation">
<title>Permission validation</title>
<para>
This session describes how permission is validated for different JCR actions.
@@ -494,12 +494,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_Access_Control-Java_API">
+ <section id="sect-Reference_Guide-eXo_Access_Control-Java_API">
<title>Java API</title>
<para>
eXo JCR's <literal>ExtendedNode</literal> interface which extends
<literal>javax.jcr.Node</literal> interface provides additional methods for
Access Control management.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Java_API-Additional_methods">
+ <table id="tabl-Reference_Guide-Java_API-Additional_methods">
<title>Additional methods</title>
<tgroup cols="2">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/binary-values-processing.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/binary-values-processing.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/binary-values-processing.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing">
+<chapter id="chap-Reference_Guide-Binary_Values_Processing">
<title>Binary Values Processing</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing-Configuration">
+ <section
id="sect-Reference_Guide-Binary_Values_Processing-Configuration">
<title>Configuration</title>
<para>
Binary large object (<abbrev>BLOB</abbrev>) properties can be stored in
two ways in the eXo JCR; in the database with items information or in an external storage
on host file system. These options can be configured at workspace in the repository
configuration file (<filename>repository-configuration.xml</filename>). The
database storage can not be completely disabled.
@@ -18,20 +18,20 @@
</para>
<note>
<para>
- The eXo JCR Repository service configuration basics is discussed in <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-JCR_configuration" />
+ The eXo JCR Repository service configuration basics is discussed in <xref
linkend="chap-Reference_Guide-JCR_configuration" />
</para>
<para>
- Database and workspace persistence storage configuration is discussed in <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-JDBC_Data_Container_Config" />
+ Database and workspace persistence storage configuration is discussed in <xref
linkend="chap-Reference_Guide-JDBC_Data_Container_Config" />
</para>
<para>
- Configuration details for <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-External_Value_Storages" />.
+ Configuration details for <xref
linkend="chap-Reference_Guide-External_Value_Storages" />.
</para>
</note>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing-Usage">
+ <section id="sect-Reference_Guide-Binary_Values_Processing-Usage">
<title>Usage</title>
<para>
In both of the cases, a developer can set or update the binary Property via
<literal>Node.setProperty(String, InputStream)</literal>,
<literal>Property.setValue(InputStream)</literal> as described in the spec
JSR-170. Also, there is the setter with a ready Value object obtained from
<literal>ValueFactory.createValue(InputStream)</literal>.
@@ -113,7 +113,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Binary_Values_Processing-Value_implementations">
+ <section
id="sect-Reference_Guide-Binary_Values_Processing-Value_implementations">
<title>Value implementations</title>
<mediaobject>
<imageobject>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/jcr-resources.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/jcr-resources.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/jcr-resources.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-JCR_Resources">
+<chapter id="chap-Reference_Guide-JCR_Resources">
<title>JCR Resources:</title>
<para>
* Java Community Process: <ulink
url="http://jcp.org/en/jsr/detail?id=170">JSR 170 </ulink> and
<ulink
url="http://jcp.org/en/jsr/detail?id=283">JSR 283</ulink>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/link-producer.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/link-producer.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/other/link-producer.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Link_Producer_Service">
+<chapter id="chap-Reference_Guide-Link_Producer_Service">
<title>Link Producer Service</title>
<para>
The Link Producer Service is a simple service which generates an file that is
compatible with the Microsoft link file format. It is an extension of the REST Framework
library and is included into the WebDav service. On dispatching a
<literal>GET</literal> request the service generates the content of an
<filename>.lnk</filename> file, which points to a JCR resource via WebDav.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/performance-tuning-guide.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/performance-tuning-guide.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/performance-tuning-guide.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-JCR_Performance_Tuning_Guide">
+<chapter id="chap-Reference_Guide-JCR_Performance_Tuning_Guide">
<title>JCR Performance Tuning Guide</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Performance_Tuning_Guide-Introduction">
+ <section
id="sect-Reference_Guide-JCR_Performance_Tuning_Guide-Introduction">
<title>Introduction</title>
<para>
This section will show you various ways of improving JCR performance.
@@ -16,14 +16,14 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Performance_Tuning_Guide-JCR_Performance_and_Scalability">
+ <section
id="sect-Reference_Guide-JCR_Performance_Tuning_Guide-JCR_Performance_and_Scalability">
<title>JCR Performance and Scalability</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Performance_and_Scalability-Cluster_configuration">
+ <section
id="sect-Reference_Guide-JCR_Performance_and_Scalability-Cluster_configuration">
<title>Cluster configuration</title>
<para>
The table below contains details about the configuration of the cluster used in
benchmark testing:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Cluster_configuration-EC2_network_1Gbit">
+ <table
id="tabl-Reference_Guide-Cluster_configuration-EC2_network_1Gbit">
<title>EC2 network: 1Gbit</title>
<tgroup cols="2">
<colspec colname="1"></colspec>
@@ -128,7 +128,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Performance_and_Scalability-JCR_Clustered_Performance">
+ <section
id="sect-Reference_Guide-JCR_Performance_and_Scalability-JCR_Clustered_Performance">
<title>JCR Clustered Performance</title>
<para>
Benchmark test using WebDAV (Complex read/write load test (benchmark)) with 20K same
file. To obtain per-operation results we have used custom output from the test case
threads to CSV file.
@@ -348,9 +348,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Performance_Tuning_Guide-Performance_Tuning_Guide">
+ <section
id="sect-Reference_Guide-JCR_Performance_Tuning_Guide-Performance_Tuning_Guide">
<title>Performance Tuning Guide</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Performance_Tuning_Guide-JBoss_AS_Tuning">
+ <section
id="sect-Reference_Guide-Performance_Tuning_Guide-JBoss_AS_Tuning">
<title>JBoss AS Tuning</title>
<para>
You can use <parameter>maxThreads</parameter> parameter to increase
maximum amount of threads that can be launched in AS instance. This can improve
performance if you need a high level of concurrency. also you can use
<code>-XX:+UseParallelGC</code> java directory to use parallel garbage
collector.
@@ -375,7 +375,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Performance_Tuning_Guide-JCR_Cache_Tuning">
+ <section
id="sect-Reference_Guide-Performance_Tuning_Guide-JCR_Cache_Tuning">
<title>JCR Cache Tuning</title>
<para>
<citetitle>Cache size</citetitle>
@@ -398,7 +398,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Performance_Tuning_Guide-Clustering">
+ <section
id="sect-Reference_Guide-Performance_Tuning_Guide-Clustering">
<title>Clustering</title>
<para>
For performance it is better to have loadbalacer, DB server and shared NFS on
different computers. If in some reasons you see that one node gets more load than others
you can decrease this load using load value in load balancer.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/protocols/ftp.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/protocols/ftp.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/protocols/ftp.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-FTP">
+<chapter id="chap-Reference_Guide-FTP">
<title>FTP</title>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-FTP-Introduction">
+ <section id="sect-Reference_Guide-FTP-Introduction">
<title>Introduction</title>
<para>
The JCR-FTP Server operates as an FTP server with access to a content stored in JCR
repositories in the form of <literal>nt:file/nt:folder</literal> nodes or
their successors. The client of an executed Server can be any FTP client. The FTP server
is supported by a standard configuration which can be changed as required.
@@ -13,9 +13,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-FTP-Configuration_Parameters">
+ <section id="sect-Reference_Guide-FTP-Configuration_Parameters">
<title>Configuration Parameters</title>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Configuration_Parameters-Parameters">
+ <variablelist
id="vari-Reference_Guide-Configuration_Parameters-Parameters">
<title>Parameters</title>
<varlistentry>
<term>command-port:</term>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/protocols/webdav.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/protocols/webdav.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/protocols/webdav.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-WebDAV">
+<chapter id="chap-Reference_Guide-WebDAV">
<!-- This document was created with Syntext Serna Free. -->
<title>WebDAV</title>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-WebDAV-Introduction">
+ <section id="sect-Reference_Guide-WebDAV-Introduction">
<title>Introduction</title>
<para>
The <application>WebDAV</application> protocol enables you to use third
party tools to communicate with hierarchical content servers via the HTTP protocol. It is
possible to add and remove documents or a set of documents from a path on the server.
@@ -42,7 +42,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-WebDAV-WebDAV_Configuration">
+ <section id="sect-Reference_Guide-WebDAV-WebDAV_Configuration">
<title>WebDAV Configuration</title>
<para>
The WebDAV configuration file: <!-- is defined in the
<remark><filename>DOC NOTE:
where/is/this/file.xml</filename></remark> -->
@@ -133,7 +133,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-WebDAV-Corresponding_WebDav_and_JCR_actions">
+ <section
id="sect-Reference_Guide-WebDAV-Corresponding_WebDav_and_JCR_actions">
<title>Corresponding WebDav and JCR actions</title>
<table>
<title></title>
@@ -331,12 +331,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-WebDAV-WebDAV_Considerations">
+ <section id="sect-Reference_Guide-WebDAV-WebDAV_Considerations">
<title>WebDAV Considerations</title>
<para>
There are some restrictions for WebDAV in different operating systems.
</para>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-WebDAV_Considerations-Windows_7">
+ <formalpara
id="form-Reference_Guide-WebDAV_Considerations-Windows_7">
<title>Windows 7</title>
<para>
When attemping to set up a web folder through <guilabel>Add a Network
Location</guilabel> or <guilabel>Map a Network Drive</guilabel> through
<guilabel>My Computer</guilabel>, an error message stating <guilabel>The
folder you entered does not appear to be valid. Please choose another</guilabel> or
<guilabel>Windows cannot access … Check the spelling of the name. Otherwise, there
might be …</guilabel> may be encountered. These errors may appear when you are using
SSL or non-SSL.
@@ -367,7 +367,7 @@
</listitem>
</orderedlist>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-WebDAV_Considerations-Microsoft_Office_2010">
+ <formalpara
id="form-Reference_Guide-WebDAV_Considerations-Microsoft_Office_2010">
<title>Microsoft Office 2010</title>
<para>
If you have:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/query-handler-config.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/query-handler-config.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/query-handler-config.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-QueryHandler_configuration">
+<chapter id="chap-Reference_Guide-QueryHandler_configuration">
<title>QueryHandler configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-QueryHandler_configuration-Indexing_in_clustered_environment">
+ <section
id="sect-Reference_Guide-QueryHandler_configuration-Indexing_in_clustered_environment">
<title>Indexing in clustered environment</title>
<para>
JCR offers indexing strategies for clustered environments using the advantages of
running in a single JVM or doing the best to use all resources available in cluster. JCR
uses Lucene library as underlying search and indexing engine, but it has several
limitations that greatly reduce possibilities and limits the usage of cluster advantages.
That's why eXo JCR offers two strategies that are suitable for it's own usecases.
They are clustered with shared index and clustered with local indexes. Each one has
it's pros and cons.
@@ -35,14 +35,14 @@
This indexing strategy combines advantages of in-memory index along with shared
persistent index offering "near" real time search capabilities. This means that
newly added content is accessible via search practically immediately. This strategy allows
nodes to index data in their own volatile (in-memory) indexes, but persistent indexes are
managed by single "coordinator" node only. Each cluster instance has a read
access for shared index to perform queries combining search results found in own in-memory
index also. Take in account that shared folder must be configured in your system
environment (i.e. mounted NFS folder). But this strategy in some extremely rare cases can
have a bit different volatile indexes within cluster instances for a while. In a few
seconds they will be up2date.
</para>
<para>
- See more about <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> .
+ See more about <xref linkend="chap-Reference_Guide-Search_Configuration"
/> .
</para>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-QueryHandler_configuration-Configuration">
+ <section
id="sect-Reference_Guide-QueryHandler_configuration-Configuration">
<title>Configuration</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Query_handler_configuration_overview">
+ <section
id="sect-Reference_Guide-Configuration-Query_handler_configuration_overview">
<title>Query-handler configuration overview</title>
<para>
Configuration example:
@@ -67,7 +67,7 @@
</query-handler>
</workspace>
</programlisting>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Query_handler_configuration_overview-Configuration_properties">
+ <table
id="tabl-Reference_Guide-Query_handler_configuration_overview-Configuration_properties">
<title>Configuration properties</title>
<tgroup cols="2">
<thead>
@@ -197,7 +197,7 @@
</tgroup>
</table>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Query_handler_configuration_overview-Improving_Query_Performance_With_postgreSQL_and_rdbms_reindexing">
+ <formalpara
id="form-Reference_Guide-Query_handler_configuration_overview-Improving_Query_Performance_With_postgreSQL_and_rdbms_reindexing">
<title>Improving Query Performance With
<literal>postgreSQL</literal> and
<parameter>rdbms-reindexing</parameter></title>
<para>
If you use <literal>postgreSQL</literal> and
<parameter>rdbms-reindexing</parameter> is set to
<literal>true</literal>, the performance of the queries used while indexing
can be improved by:
@@ -227,7 +227,7 @@
</procedure>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Query_handler_configuration_overview-Improving_Query_Performance_With_DB2_and_rdbms_reindexing">
+ <formalpara
id="form-Reference_Guide-Query_handler_configuration_overview-Improving_Query_Performance_With_DB2_and_rdbms_reindexing">
<title>Improving Query Performance With <literal>DB2</literal> and
<parameter>rdbms-reindexing</parameter></title>
<para>
If you use <literal>DB2</literal> and
<parameter>rdbms-reindexing</parameter> is set to
<literal>true</literal>, the performance of the queries used while indexing
can be improved by:
@@ -250,7 +250,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Cluster_ready_indexing">
+ <section
id="sect-Reference_Guide-Configuration-Cluster_ready_indexing">
<title>Cluster-ready indexing</title>
<para>
For both cluster-ready implementations JBoss Cache, JGroups and Changes Filter values
must be defined. Shared index requires some kind of remote or shared file system to be
attached in a system (i.e. NFS, SMB or etc). Indexing directory ("indexDir"
value) must point to it. Setting "changesfilter-class" to
"org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter"
will enable shared index implementation.
@@ -298,7 +298,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Local_Index_Recovery_Filters">
+ <section
id="sect-Reference_Guide-Configuration-Local_Index_Recovery_Filters">
<title>Local Index Recovery Filters</title>
<para>
A common usecase for all cluster-ready applications is a hot joining and leaving of
processing units. All nodes that are joining a cluster for the first time or nodes joining
after some downtime, must be in a synchronized state.
@@ -330,7 +330,7 @@
<para>
There are multiple filter implementations:
</para>
- <variablelist
id="vari-Reference_Guide_eXo_JCR_1.14-Local_Index_Recovery_Filters-org.exoplatform.services.jcr.impl.core.query.lucene.DummyRecoveryFilter">
+ <variablelist
id="vari-Reference_Guide-Local_Index_Recovery_Filters-org.exoplatform.services.jcr.impl.core.query.lucene.DummyRecoveryFilter">
<title>org.exoplatform.services.jcr.impl.core.query.lucene.DummyRecoveryFilter</title>
<varlistentry>
<term></term>
@@ -390,12 +390,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-JBoss_Cache_template_configuration">
+ <section
id="sect-Reference_Guide-Configuration-JBoss_Cache_template_configuration">
<title>JBoss-Cache template configuration</title>
<para>
JBoss-Cache template configuration for query handler is about the same for both
clustered strategies.
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-JBoss_Cache_template_configuration-jbosscache_indexer.xml">
+ <example
id="exam-Reference_Guide-JBoss_Cache_template_configuration-jbosscache_indexer.xml">
<title>jbosscache-indexer.xml</title>
<programlisting language="XML" role="XML"><?xml
version="1.0" encoding="UTF-8"?>
@@ -421,7 +421,7 @@
</example>
<para>
- Read more about template configurations <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-JBoss_Cache_configuration" />.
+ Read more about template configurations <xref
linkend="chap-Reference_Guide-JBoss_Cache_configuration" />.
</para>
</section>
@@ -429,12 +429,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-QueryHandler_configuration-Asynchronous_Reindexing">
+ <section
id="sect-Reference_Guide-QueryHandler_configuration-Asynchronous_Reindexing">
<title>Asynchronous Reindexing</title>
<para>
Managing a large data set using a JCR in a production environment at times requires
special operations with Indexes, stored on File System. One of those maintenance
operations is a recreation of it. Also called "re-indexing". There are various
usecases when it's important to do. They include hardware faults, hard restarts,
data-corruption, migrations and JCR updates that brings new features related to index.
Usually index re-creation requested on server's startup or in runtime.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Asynchronous_Reindexing-On_startup_indexing">
+ <section
id="sect-Reference_Guide-Asynchronous_Reindexing-On_startup_indexing">
<title>On startup indexing</title>
<para>
Common usecase for updating and re-creating the index is to stop the server and
manually remove indexes for workspaces requiring it. When server will be started, missing
indexes are automatically recovered by re-indexing. JCR Supports direct RDBMS re-indexing,
that usually is faster than ordinary and can be configured via QueryHandler parameter
"rdbms-reindexing" set to "true" (for more information please refer to
"Query-handler configuration overview"). New feature to introduce is
asynchronous indexing on startup. Usually startup is blocked until process is finished.
Block can take any period of time, depending on amount of data persisted in repositories.
But this can be resolved by using an asynchronous approaches of startup indexation. Saying
briefly, it performs all operations with index in background, without blocking the
repository. This is controlled by the value of "async-reindexing" parameter in
QueryHandler configuration. With asynchronous indexation active, J!
CR starts with no active indexes present. Queries on JCR still can be executed without
exceptions, but no results will be returned until index creation completed. Checking index
state is possible via QueryManagerImpl:
@@ -461,7 +461,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Asynchronous_Reindexing-Hot_Asynchronous_Workspace_Reindexing_via_JMX">
+ <section
id="sect-Reference_Guide-Asynchronous_Reindexing-Hot_Asynchronous_Workspace_Reindexing_via_JMX">
<title>Hot Asynchronous Workspace Reindexing via JMX</title>
<para>
Some hard system faults, error during upgrades, migration issues and some other
factors may corrupt the index. Most likely end customers would like the production systems
to fix index issues in run-time, without delays and restarts. Current versions of JCR
supports "Hot Asynchronous Workspace Reindexing" feature. It allows end-user
(Service Administrator) to launch the process in background without stopping or blocking
whole application by using any JMX-compatible console (see screenshot below,
"JConsole in action").
@@ -487,7 +487,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Asynchronous_Reindexing-Notices">
+ <section id="sect-Reference_Guide-Asynchronous_Reindexing-Notices">
<title>Notices</title>
<para>
First of all, can't launch Hot re-indexing via JMX if index is already in offline
mode. It means that index is currently is invoked in some operations, like re-indexing at
startup, copying in cluster to another node or whatever. Another important this is Hot
Asynchronous Reindexing via JMX and "on startup" reindexing are completely
different features. So you can't get the state of startup reindexing using command
getHotReindexingState in JMX interface, but there are some common JMX operations:
@@ -513,9 +513,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-QueryHandler_configuration-Advanced_tuning">
+ <section
id="sect-Reference_Guide-QueryHandler_configuration-Advanced_tuning">
<title>Advanced tuning</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_tuning-Lucene_tuning">
+ <section id="sect-Reference_Guide-Advanced_tuning-Lucene_tuning">
<title>Lucene tuning</title>
<para>
As mentioned above, JCR Indexing is based on Lucene indexing library as underlying
search engine. It uses Directories to store index and manages access to index by Lock
Factories. By default JCR implementation uses optimal combination of Directory
implementation and Lock Factory implementation. When running on OS different from Windows,
NIOFSDirectory implementation used. And SimpleFSDirectory for Windows stations.
NativeFSLockFactory is an optimal solution for wide variety of cases including clustered
environment with NFS shared resources. But those default can be overridden with the help
of system properties. There are two properties:
"org.exoplatform.jcr.lucene.store.FSDirectoryLockFactoryClass" and
"org.exoplatform.jcr.lucene.FSDirectory.class" that are responsible for changing
default behavior. First one defines implementation of abstract Lucene LockFactory class
and the second one sets implementation class for FSDirectory instances. For more
information please ref!
er to Lucene documentation. But be sure You know what You are changing. JCR allows end
users to change implementation classes of Lucene internals, but doesn't guarantee
it's stability and functionality.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-check-controller.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-check-controller.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-check-controller.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Checking_repository_integrity_and_consistency">
+<chapter
id="chap-Reference_Guide-Checking_repository_integrity_and_consistency">
<title>Checking repository integrity and consistency</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Checking_repository_integrity_and_consistency-JMX_based_consistency_tool">
+ <section
id="sect-Reference_Guide-Checking_repository_integrity_and_consistency-JMX_based_consistency_tool">
<title>JMX-based consistency tool</title>
<para>
It is important to check the integrity and consistency of system regularly, especially
if there is no, or stale, backups. The JBoss Enterprise Portal Platform JCR implementation
offers an innovative JMX-based complex checking tool.
@@ -19,7 +19,7 @@
<para>
Access to the check tool is exposed via the JMX interface, with the following
operations available:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-JMX_based_consistency_tool-Available_methods">
+ <table
id="tabl-Reference_Guide-JMX_based_consistency_tool-Available_methods">
<title>Available methods</title>
<tgroup cols="2">
<tbody>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-creation-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-creation-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-creation-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-RepositoryCreationService">
+<chapter id="chap-Reference_Guide-RepositoryCreationService">
<title><literal>RepositoryCreationService</literal></title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-RepositoryCreationService-Introduction">
+ <section
id="sect-Reference_Guide-RepositoryCreationService-Introduction">
<title>Introduction</title>
<para>
The <parameter>RepositoryCreationService</parameter> is the
service for creating repositories during runtime.
@@ -39,14 +39,14 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-RepositoryCreationService-Configuration">
+ <section
id="sect-Reference_Guide-RepositoryCreationService-Configuration">
<title>Configuration</title>
<para>
RepositoryCreationService configuration
</para>
<programlistingco>
<areaspec>
- <area coords="63 50"
id="area-Reference_Guide_eXo_JCR_1.14-RepositoryCreationService-Configuration-factory-class-name"
/>
+ <area coords="63 50"
id="area-Reference_Guide-RepositoryCreationService-Configuration-factory-class-name"
/>
</areaspec>
@@ -115,7 +115,7 @@
</init-params>
</component></programlisting>
<calloutlist>
- <!-- # --> <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-RepositoryCreationService-Configuration-factory-class-name">
+ <!-- # --> <callout
arearefs="area-Reference_Guide-RepositoryCreationService-Configuration-factory-class-name">
<para>
<parameter>factory-class-name</parameter> is not
mandatory parameter, indicates what the factory need to use to create DataSource objects
</para>
@@ -129,7 +129,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-RepositoryCreationService-RepositoryCreationService_Interface">
+ <section
id="sect-Reference_Guide-RepositoryCreationService-RepositoryCreationService_Interface">
<title>RepositoryCreationService Interface</title>
<programlisting language="Java" role="Java">public interface
RepositoryCreationService
@@ -216,7 +216,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-RepositoryCreationService-Conclusions_and_restrictions">
+ <section
id="sect-Reference_Guide-RepositoryCreationService-Conclusions_and_restrictions">
<title>Conclusions and restrictions</title>
<para>
Each datasource in RepositoryEntry of new Repository must have unbinded
datasources. That means, such datasource must have not databases behind them. This
restriction exists to avoid corruption of existing repositories data.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/aggregation-rule.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/aggregation-rule.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/aggregation-rule.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_a_node_by_content_of_child_node">
+<section
id="sect-Reference_Guide-Finding_a_node_by_content_of_child_node">
<title>Finding a node by content of child node</title>
<para>
The node type <literal>nt:file</literal> represents a file. It
requires a single child node, called <literal>jcr:content</literal>. This node
type represents images and other binary content. The node type of
<literal>jcr:content</literal> is <literal>nt:resource</literal>
which represents the actual content of a file.
</para>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Finding_a_node_by_content_of_child_node-Task">
+ <formalpara
id="form-Reference_Guide-Finding_a_node_by_content_of_child_node-Task">
<title>Task:</title>
<para>
Find node with the primary type <literal>nt:file</literal> and
whose <literal>jcr:content</literal> child node contains
<emphasis>cats</emphasis>.
@@ -38,7 +38,7 @@
<para>
Now the content of <literal>nt:file</literal> and
<literal>jcr:content</literal> (<literal>nt:resource</literal>)
nodes are concatenated in a single Lucene document. Then, a fulltext search query can be
based on content of the <literal>nt:file</literal> and this search includes
the content of child <literal>jcr:content</literal> node.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_a_node_by_content_of_child_node-Repository_structure">
+ <section
id="sect-Reference_Guide-Finding_a_node_by_content_of_child_node-Repository_structure">
<title>Repository structure:</title>
<para>
Repository contains different <literal>nt:file</literal> nodes.
@@ -55,9 +55,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_a_node_by_content_of_child_node-Query_execution">
+ <section
id="sect-Reference_Guide-Finding_a_node_by_content_of_child_node-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_a_node_by_content_of_child_node-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Finding_a_node_by_content_of_child_node-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -69,7 +69,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_a_node_by_content_of_child_node-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Finding_a_node_by_content_of_child_node-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -84,7 +84,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_a_node_by_content_of_child_node-Fetching_the_result">
+ <section
id="sect-Reference_Guide-Finding_a_node_by_content_of_child_node-Fetching_the_result">
<title>Fetching the result</title>
<para>
To fetch the matching nodes:
@@ -114,7 +114,7 @@
<para>
Table content is:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Finding_a_node_by_content_of_child_node-Fetching_the_result-Table_content">
+ <table
id="tabl-Reference_Guide-Finding_a_node_by_content_of_child_node-Fetching_the_result-Table_content">
<title>Table content</title>
<tgroup cols="2">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/and-constraint.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/and-constraint.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/and-constraint.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-AND_Constraint">
+<section id="sect-Reference_Guide-AND_Constraint">
<title>AND Constraint</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Task">
+ <formalpara id="form-Reference_Guide-AND_Constraint-Task">
<title>Task:</title>
<para>
To find all <emphasis>fairytales</emphasis> with a page count
more than <literal>90</literal> pages. Or, in JCR terms; find all nodes with
mixin type <literal>mix:title</literal> where the property
<parameter>jcr:description</parameter> equals
<emphasis>fairytale</emphasis> and whose
<parameter>prop_pagecount</parameter> property value is less than
<literal>90</literal>.
@@ -14,11 +14,11 @@
</formalpara>
<note>
<para>
- See also <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison"
/>.
+ See also <xref
linkend="sect-Reference_Guide-Multivalue_Property_Comparison" />.
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Repository_Structure">
+ <section
id="sect-Reference_Guide-AND_Constraint-Repository_Structure">
<title>Repository Structure:</title>
<para>
The repository contains <literal>mix:title</literal> nodes, where
<parameter>prop_pagecount</parameter> has different values.
@@ -32,9 +32,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Query_execution">
+ <section id="sect-Reference_Guide-AND_Constraint-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-AND_Constraint-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -46,7 +46,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-AND_Constraint-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -61,7 +61,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-AND_Constraint-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch the nodes:
@@ -90,7 +90,7 @@
}</programlisting>
<para>
Table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-AND_Constraint-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-AND_Constraint-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="5">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/child-node-constraint.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/child-node-constraint.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/child-node-constraint.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint">
+<section id="sect-Reference_Guide-Child_Node_Constraint">
<title>Child Node Constraint</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint-Task">
+ <formalpara id="form-Reference_Guide-Child_Node_Constraint-Task">
<title>Task:</title>
<para>
To find all nodes with the primary type
'<literal>nt:folder</literal>' that are children of node by path
"<filename>/root1/root2</filename>". Only find children, do not find
further descendants.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint-Repository_Structure">
+ <section
id="sect-Reference_Guide-Child_Node_Constraint-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository is filled by
"<literal>nt:folder</literal>" nodes. The nodes are placed in a
multilayer tree.
@@ -28,9 +28,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint-Query_Execution">
+ <section
id="sect-Reference_Guide-Child_Node_Constraint-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-Child_Node_Constraint-Query_Execution-SQL">
<title>SQL</title>
<para>
The use of "%" in the LIKE statement includes any string,
therefore there is a second LIKE statement that excludes that the string contains
"/". This way child nodes are included but descendant nodes are excluded.
@@ -45,7 +45,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Child_Node_Constraint-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -60,7 +60,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Child_Node_Constraint-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch the nodes:
@@ -89,7 +89,7 @@
}</programlisting>
<para>
The table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Child_Node_Constraint-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="2">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/date-property-comparison.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/date-property-comparison.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/date-property-comparison.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Date_Property_Comparison">
+<section id="sect-Reference_Guide-Date_Property_Comparison">
<title>Date Property Comparison</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Date_Property_Comparison-Task">
+ <formalpara
id="form-Reference_Guide-Date_Property_Comparison-Task">
<title>Task:</title>
<para>
Find all nodes of primary type <literal>nt:resource</literal>
whose <parameter>jcr:lastModified</parameter> property value is greater than
<literal>2006-06-04</literal> and less than
<literal>2008-06-04</literal>.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Date_Property_Comparison-Repository_Structure">
+ <section
id="sect-Reference_Guide-Date_Property_Comparison-Repository_Structure">
<title>Repository Structure</title>
<para>
Repository contains <literal>nt:resource</literal> nodes with
different values of <parameter>jcr:lastModified</parameter> property.
@@ -29,9 +29,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Date_Property_Comparison-Query_Execution">
+ <section
id="sect-Reference_Guide-Date_Property_Comparison-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Date_Property_Comparison-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-Date_Property_Comparison-Query_Execution-SQL">
<title>SQL</title>
<para>
In SQL you have to use the keyword
<emphasis>TIMESTAMP</emphasis> for date comparisons. Otherwise, the date would
be interpreted as a string.
@@ -64,7 +64,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Date_Property_Comparison-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Date_Property_Comparison-Query_Execution-XPath">
<title>XPath</title>
<para>
Compared to the SQL format, you have to use the keyword
<emphasis>xs:dateTime</emphasis> and surround the datetime by extra brackets:
<literal>xs:dateTime('datetime')</literal>. The actual format of the
datetime also conforms with the ISO date standard.
@@ -89,7 +89,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Date_Property_Comparison-Fetching_the_result">
+ <section
id="sect-Reference_Guide-Date_Property_Comparison-Fetching_the_result">
<title>Fetching the result</title>
<para>
To fetch the nodes:
@@ -118,7 +118,7 @@
}</programlisting>
<para>
The table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Date_Property_Comparison-Fetching_the_result-Table_content">
+ <table
id="tabl-Reference_Guide-Date_Property_Comparison-Fetching_the_result-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/escaping-like-statements.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/escaping-like-statements.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/escaping-like-statements.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Escaping_in_LIKE_Statements">
+<section id="sect-Reference_Guide-Escaping_in_LIKE_Statements">
<title>Escaping in LIKE Statements</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Escaping_in_LIKE_Statements-Task">
+ <formalpara
id="form-Reference_Guide-Escaping_in_LIKE_Statements-Task">
<title>Task:</title>
<para>
Find all nodes with a mixin type 'mix:title' and whose property
<literal>jcr:title</literal> starts with
<emphasis>P%ri</emphasis>.
@@ -23,7 +23,7 @@
<para>
XPath does not have any specification for defining escape symbols. The default
XPath escape character is the backslash ('<literal>\</literal>').
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Escaping_in_LIKE_Statements-Repository_structure">
+ <section
id="sect-Reference_Guide-Escaping_in_LIKE_Statements-Repository_structure">
<title>Repository structure</title>
<para>
The repository contains <literal>mix:title</literal> nodes, where
<parameter>jcr:title</parameter> can have different values.
@@ -37,9 +37,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Escaping_in_LIKE_Statements-Query_execution">
+ <section
id="sect-Reference_Guide-Escaping_in_LIKE_Statements-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Escaping_in_LIKE_Statements-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Escaping_in_LIKE_Statements-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -51,7 +51,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Escaping_in_LIKE_Statements-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Escaping_in_LIKE_Statements-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -66,7 +66,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Escaping_in_LIKE_Statements-Fetching_result">
+ <section
id="sect-Reference_Guide-Escaping_in_LIKE_Statements-Fetching_result">
<title>Fetching result</title>
<para>
To get the matching nodes:
@@ -95,7 +95,7 @@
}</programlisting>
<para>
The table content is
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Escaping_in_LIKE_Statements-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-Escaping_in_LIKE_Statements-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="4">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/exact-path-constraint.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/exact-path-constraint.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/exact-path-constraint.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Exact_Path_Constraint">
+<section id="sect-Reference_Guide-Exact_Path_Constraint">
<title>Exact Path Constraint</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Exact_Path_Constraint-Task">
+ <formalpara id="form-Reference_Guide-Exact_Path_Constraint-Task">
<title>Task:</title>
<para>
Find a node with the primary type <literal>nt:file</literal> that
is located on the exact path <filename>/folder1/folder2/document1</filename>.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Exact_Path_Constraint-Repository_Structure">
+ <section
id="sect-Reference_Guide-Exact_Path_Constraint-Repository_Structure">
<title>Repository Structure</title>
<para>
Repository filled by different nodes. There are several folders which contain
other folders and files.
@@ -28,9 +28,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Exact_Path_Constraint-Query_Execution">
+ <section
id="sect-Reference_Guide-Exact_Path_Constraint-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Exact_Path_Constraint-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-Exact_Path_Constraint-Query_Execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -43,7 +43,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Exact_Path_Constraint-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Exact_Path_Constraint-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -66,7 +66,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Exact_Path_Constraint-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Exact_Path_Constraint-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch matching nodes:
@@ -95,7 +95,7 @@
}</programlisting>
<para>
Table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Exact_Path_Constraint-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Exact_Path_Constraint-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="2">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-all-descendant-nodes.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-all-descendant-nodes.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-all-descendant-nodes.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Descendant_Nodes">
+<section id="sect-Reference_Guide-Finding_All_Descendant_Nodes">
<title>Finding All Descendant Nodes</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Finding_All_Descendant_Nodes-Task">
+ <formalpara
id="form-Reference_Guide-Finding_All_Descendant_Nodes-Task">
<title>Task:</title>
<para>
Find all nodes with the primary type <literal>nt:folder</literal>
that are descendants of the node <literal>/folder1/folder2</literal>.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Descendant_Nodes-Repository_Structure">
+ <section
id="sect-Reference_Guide-Finding_All_Descendant_Nodes-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository contains <literal>nt:folder</literal> nodes. The
nodes are placed in a multilayer tree.
@@ -28,9 +28,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Descendant_Nodes-Query_Execution">
+ <section
id="sect-Reference_Guide-Finding_All_Descendant_Nodes-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_All_Descendant_Nodes-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-Finding_All_Descendant_Nodes-Query_Execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -42,7 +42,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_All_Descendant_Nodes-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Finding_All_Descendant_Nodes-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -57,7 +57,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Descendant_Nodes-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Finding_All_Descendant_Nodes-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch the nodes:
@@ -86,7 +86,7 @@
}</programlisting>
<para>
Table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Finding_All_Descendant_Nodes-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Finding_All_Descendant_Nodes-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="2">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-all-nodes.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-all-nodes.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-all-nodes.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes">
+<section id="sect-Reference_Guide-Finding_All_Nodes">
<title>Finding All Nodes</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Task">
+ <formalpara id="form-Reference_Guide-Finding_All_Nodes-Task">
<title>Task:</title>
<para>
Find all nodes in the repository.
@@ -15,11 +15,11 @@
<note>
<title>Note</title>
<para>
- This search will only nodes that the current session has READ access to. See
also <xref linkend="chap-Reference_Guide_eXo_JCR_1.14-Access_Control" />.
+ This search will only nodes that the current session has READ access to. See
also <xref linkend="chap-Reference_Guide-Access_Control" />.
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Repository_structure">
+ <section
id="sect-Reference_Guide-Finding_All_Nodes-Repository_structure">
<title>Repository structure:</title>
<para>
Repository contains many different nodes.
@@ -35,9 +35,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Query_execution">
+ <section
id="sect-Reference_Guide-Finding_All_Nodes-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Finding_All_Nodes-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -49,7 +49,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Finding_All_Nodes-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -64,7 +64,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Fetching_result">
+ <section
id="sect-Reference_Guide-Finding_All_Nodes-Fetching_result">
<title>Fetching result</title>
<para>
To fetch the nodes:
@@ -94,7 +94,7 @@
<para>
Table content is
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-Finding_All_Nodes-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="2">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-by-mixin-type.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-by-mixin-type.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-by-mixin-type.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Mixin_Type">
+<section id="sect-Reference_Guide-Finding_Nodes_by_Mixin_Type">
<title>Finding Nodes by Mixin Type</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Mixin_Type-Task">
+ <formalpara
id="form-Reference_Guide-Finding_Nodes_by_Mixin_Type-Task">
<title>Task:</title>
<para>
Find all nodes in repository, that contain a mixin type
<literal>mix:title</literal>.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Mixin_Type-Repository_structure">
+ <section
id="sect-Reference_Guide-Finding_Nodes_by_Mixin_Type-Repository_structure">
<title>Repository structure:</title>
<para>
The repository contains nodes with different primary types and mixin types.
@@ -26,9 +26,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Mixin_Type-Query_execution">
+ <section
id="sect-Reference_Guide-Finding_Nodes_by_Mixin_Type-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Mixin_Type-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Finding_Nodes_by_Mixin_Type-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -40,7 +40,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Mixin_Type-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Finding_Nodes_by_Mixin_Type-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -55,7 +55,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Mixin_Type-Fetching_result">
+ <section
id="sect-Reference_Guide-Finding_Nodes_by_Mixin_Type-Fetching_result">
<title>Fetching result</title>
<para>
To the fetch the nodes:
@@ -84,7 +84,7 @@
}</programlisting>
<para>
Table content is
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Mixin_Type-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-Finding_Nodes_by_Mixin_Type-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="4">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-by-primary-type.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-by-primary-type.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-by-primary-type.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Primary_Type">
+<section id="sect-Reference_Guide-Finding_Nodes_by_Primary_Type">
<title>Finding Nodes by Primary Type</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Primary_Type-Task">
+ <formalpara
id="form-Reference_Guide-Finding_Nodes_by_Primary_Type-Task">
<title>Task:</title>
<para>
Find all nodes whose primary type is <literal>nt:file</literal>.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Primary_Type-Repository_structure">
+ <section
id="sect-Reference_Guide-Finding_Nodes_by_Primary_Type-Repository_structure">
<title>Repository structure:</title>
<para>
The repository contains nodes with different primary types and mixin types.
@@ -26,9 +26,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Primary_Type-Query_execution">
+ <section
id="sect-Reference_Guide-Finding_Nodes_by_Primary_Type-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Primary_Type-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Finding_Nodes_by_Primary_Type-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -40,7 +40,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Primary_Type-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Finding_Nodes_by_Primary_Type-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -55,7 +55,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Primary_Type-Fetching_result">
+ <section
id="sect-Reference_Guide-Finding_Nodes_by_Primary_Type-Fetching_result">
<title>Fetching result</title>
<para>
To fetch the matching nodes:
@@ -84,7 +84,7 @@
}</programlisting>
<para>
The table content is
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Primary_Type-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-Finding_Nodes_by_Primary_Type-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="2">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-case-insensitive.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-case-insensitive.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-nodes-case-insensitive.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way">
+<section
id="sect-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way">
<title>Finding Nodes in a Case-Insensitive Way</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Task">
+ <formalpara
id="form-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way-Task">
<title>Task:</title>
<para>
Find all nodes with a mixin type <literal>mix:title</literal> and
where the property <parameter>jcr:title</parameter> equals
<literal>casesensitive</literal> in lower or upper case.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Repository_Structure">
+ <section
id="sect-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository contains <literal>mix:title</literal> nodes, whose
<literal>jcr:title</literal> properties have different values.
@@ -26,9 +26,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution">
+ <section
id="sect-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution-SQL_Uppercase">
+ <example
id="exam-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution-SQL_Uppercase">
<title>SQL- Uppercase</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -40,7 +40,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution-XPath_Upper_Case">
+ <example
id="exam-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution-XPath_Upper_Case">
<title>XPath - Upper Case</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -52,7 +52,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution-SQL_Lower_Case">
+ <example
id="exam-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution-SQL_Lower_Case">
<title>SQL - Lower Case</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -64,7 +64,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution-XPath_Lower_Case">
+ <example
id="exam-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way-Query_Execution-XPath_Lower_Case">
<title>XPath - Lower Case</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -79,7 +79,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch the nodes:
@@ -108,7 +108,7 @@
}</programlisting>
<para>
Table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-similar-nodes.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-similar-nodes.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/find-similar-nodes.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes">
+<section id="sect-Reference_Guide-Finding_Similar_Nodes">
<title>Finding Similar Nodes</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Task">
+ <formalpara id="form-Reference_Guide-Finding_Similar_Nodes-Task">
<title>Task:</title>
<para>
To find nodes similar to a nominated node at:
<literal>/baseFile/jcr:content</literal>.
@@ -18,7 +18,7 @@
<note>
<title>Reference</title>
<para>
- Refer to <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content" />
for information about Similarity and configuration.
+ Refer to <xref
linkend="chap-Reference_Guide-Searching_Repository_Content" /> for
information about Similarity and configuration.
</para>
</note>
@@ -33,17 +33,17 @@
...
</properties>
</query-handler></programlisting>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure">
+ <section
id="sect-Reference_Guide-Finding_Similar_Nodes-Repository_structure">
<title>Repository structure:</title>
<para>
Repository contains many nt:file nodes"
</para>
<programlistingco>
<areaspec>
- <area coords="2"
id="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-baseFile"
/>
- <area coords="3"
id="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-target1"
/>
- <area coords="4"
id="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-target2"
/>
- <area coords="5"
id="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-target3"
/>
+ <area coords="2"
id="area-Reference_Guide-Finding_Similar_Nodes-Repository_structure-baseFile"
/>
+ <area coords="3"
id="area-Reference_Guide-Finding_Similar_Nodes-Repository_structure-target1"
/>
+ <area coords="4"
id="area-Reference_Guide-Finding_Similar_Nodes-Repository_structure-target2"
/>
+ <area coords="5"
id="area-Reference_Guide-Finding_Similar_Nodes-Repository_structure-target3"
/>
</areaspec>
@@ -54,25 +54,25 @@
└── target3 (nt:file)
</programlisting>
<calloutlist>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-baseFile">
+ <callout
arearefs="area-Reference_Guide-Finding_Similar_Nodes-Repository_structure-baseFile">
<para>
jcr:content (nt:resource) jcr:data="Similarity is determined
by looking up <emphasis role="bold">terms</emphasis> that are common
to nodes. There are some conditions that must be met for a <emphasis
role="bold">term</emphasis> to be considered. This is required to limit
the number possibly relevant <emphasis role="bold">terms</emphasis>.
Only <emphasis role="bold">terms</emphasis> with at least 4
characters are considered. Only <emphasis
role="bold">terms</emphasis> that occur at least 2 times in the source
node are considered. Only <emphasis role="bold">terms</emphasis>
that occur in at least 5 nodes are considered."
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-target1">
+ <callout
arearefs="area-Reference_Guide-Finding_Similar_Nodes-Repository_structure-target1">
<para>
jcr:content (nt:resource) jcr:data="Similarity is determined
by looking up <emphasis role="bold">terms</emphasis> that are common
to nodes."
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-target2">
+ <callout
arearefs="area-Reference_Guide-Finding_Similar_Nodes-Repository_structure-target2">
<para>
jcr:content (nt:resource) jcr:data="There is no you know
what"
</para>
</callout>
- <callout
arearefs="area-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Repository_structure-target3">
+ <callout
arearefs="area-Reference_Guide-Finding_Similar_Nodes-Repository_structure-target3">
<para>
jcr:content (nt:resource) jcr:data=" <emphasis
role="bold">Terms</emphasis> occurs here"
</para>
@@ -86,9 +86,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Query_execution">
+ <section
id="sect-Reference_Guide-Finding_Similar_Nodes-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Finding_Similar_Nodes-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -100,7 +100,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Finding_Similar_Nodes-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -115,7 +115,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Fetching_results">
+ <section
id="sect-Reference_Guide-Finding_Similar_Nodes-Fetching_results">
<title>Fetching results</title>
<para>
To fetch nodes:
@@ -148,7 +148,7 @@
<para>
The table content is:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes-Fetching_results-Table_content">
+ <table
id="tabl-Reference_Guide-Finding_Similar_Nodes-Fetching_results-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-and-settings.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_And_Affecting_Settings">
+<chapter
id="chap-Reference_Guide-Fulltext_Search_And_Affecting_Settings">
<title>Fulltext Search And Affecting Settings</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_And_Affecting_Settings-Property_content_indexing">
+ <formalpara
id="form-Reference_Guide-Fulltext_Search_And_Affecting_Settings-Property_content_indexing">
<title>Property content indexing</title>
<para>
Each property of a node (if it is indexable) is processed with the Lucene analyzer and
stored in the Lucene index. This is called indexing of a property. It allows fulltext
searching of these indexed properties.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_And_Affecting_Settings-Lucene_Analyzers">
+ <section
id="sect-Reference_Guide-Fulltext_Search_And_Affecting_Settings-Lucene_Analyzers">
<title>Lucene Analyzers</title>
<para>
The purpose of analyzers is to transform all strings stored in the index into a
well-defined condition. The same analyzer(s) is/are used when searching in order to adapt
the query string to the index reality.
@@ -23,7 +23,7 @@
<para>
The example below illustrates how the same string is transformed by different
analyzers.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Lucene_Analyzers-The_quick_brown_fox_jumped_over_the_lazy_dogs">
+ <table
id="tabl-Reference_Guide-Lucene_Analyzers-The_quick_brown_fox_jumped_over_the_lazy_dogs">
<title>"The quick brown fox jumped over the lazy dogs"</title>
<tgroup cols="2">
<thead>
@@ -99,7 +99,7 @@
</tgroup>
</table>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Lucene_Analyzers-XYampZ_Corporation_xyzexample.com">
+ <table
id="tabl-Reference_Guide-Lucene_Analyzers-XYampZ_Corporation_xyzexample.com">
<title>"XY&Z Corporation - xyz(a)example.com"</title>
<tgroup cols="2">
<thead>
@@ -182,12 +182,12 @@
</note>
<para>
- You can assign your analyzer as described in <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration" />.
+ You can assign your analyzer as described in <xref
linkend="chap-Reference_Guide-Search_Configuration" />.
</para>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_And_Affecting_Settings-Property_Indexing">
+ <section
id="sect-Reference_Guide-Fulltext_Search_And_Affecting_Settings-Property_Indexing">
<title>Property Indexing</title>
<para>
Different properties are indexed in different ways and this affects whether it can be
searched via fulltext by property or not.
@@ -195,7 +195,7 @@
<para>
Only two property types are indexed as fulltext searcheable:
<parameter>STRING</parameter> and <parameter>BINARY</parameter>.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Property_Indexing-Fulltext_search_by_different_properties">
+ <table
id="tabl-Reference_Guide-Property_Indexing-Fulltext_search_by_different_properties">
<title>Fulltext search by different properties</title>
<tgroup cols="3">
<thead>
@@ -260,7 +260,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_And_Affecting_Settings-Different_Analyzers">
+ <section
id="sect-Reference_Guide-Fulltext_Search_And_Affecting_Settings-Different_Analyzers">
<title>Different Analyzers</title>
<para>
First of all, we will fill repository by nodes with mixin type 'mix:title' and
different values of 'jcr:description' property.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-by-all-properties.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-by-all-properties.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-by-all-properties.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_All_Properties_in_Node">
+<section
id="sect-Reference_Guide-Fulltext_Search_by_All_Properties_in_Node">
<title>Fulltext Search by All Properties in Node</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_All_Properties_in_Node-Task">
+ <formalpara
id="form-Reference_Guide-Fulltext_Search_by_All_Properties_in_Node-Task">
<title>Task:</title>
<para>
Find nodes with mixin type <literal>mix:title</literal> where any
property contains <literal>break</literal> string.
@@ -15,7 +15,7 @@
<para>
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_All_Properties_in_Node-Repository_structure">
+ <section
id="sect-Reference_Guide-Fulltext_Search_by_All_Properties_in_Node-Repository_structure">
<title>Repository structure:</title>
<para>
The repository filled with different nodes with mixin type
<literal>mix:title</literal> and different values of
<literal>jcr:title</literal> and
<literal>jcr:description</literal> properties.
@@ -29,9 +29,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_All_Properties_in_Node-Query_execution">
+ <section
id="sect-Reference_Guide-Fulltext_Search_by_All_Properties_in_Node-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_All_Properties_in_Node-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Fulltext_Search_by_All_Properties_in_Node-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -43,7 +43,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_All_Properties_in_Node-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Fulltext_Search_by_All_Properties_in_Node-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -59,7 +59,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_All_Properties_in_Node-Fetching_result">
+ <section
id="sect-Reference_Guide-Fulltext_Search_by_All_Properties_in_Node-Fetching_result">
<title>Fetching result</title>
<para>
To fetch matching nodes:
@@ -89,7 +89,7 @@
<para>
Table content is:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_All_Properties_in_Node-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-Fulltext_Search_by_All_Properties_in_Node-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="4">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-by-property.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-by-property.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/fulltext-search-by-property.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_Property">
+<section id="sect-Reference_Guide-Fulltext_Search_by_Property">
<title>Fulltext Search by Property</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_Property-Task">
+ <formalpara
id="form-Reference_Guide-Fulltext_Search_by_Property-Task">
<title>Task:</title>
<para>
Find all nodes containing a mixin type
<literal>mix:title</literal> and whose
<literal>jcr:description</literal> contains the string;
<emphasis>forest</emphasis>.
@@ -15,7 +15,7 @@
<para>
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_Property-Repository_Structure">
+ <section
id="sect-Reference_Guide-Fulltext_Search_by_Property-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository is filled with nodes of the mixin type
<literal>mix:title</literal> and different values of the
<literal>jcr:description</literal> property.
@@ -30,10 +30,10 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_Property-Query_Execution">
+ <section
id="sect-Reference_Guide-Fulltext_Search_by_Property-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_Property-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-Fulltext_Search_by_Property-Query_Execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -46,7 +46,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_Property-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Fulltext_Search_by_Property-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -62,7 +62,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_Property-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Fulltext_Search_by_Property-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch the appropriate nodes:
@@ -92,7 +92,7 @@
<para>
Table content is:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Fulltext_Search_by_Property-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Fulltext_Search_by_Property-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/higlight.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/higlight.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/higlight.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,12 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Highlighting_Results_of_Fulltext_Search">
+<section
id="sect-Reference_Guide-Highlighting_Results_of_Fulltext_Search">
<title>Highlighting Results of Fulltext Search</title>
<para>
- The highlighting functionality is also called excerption (refer to the Excerpt
configuration information in <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration" />).
+ The highlighting functionality is also called excerption (refer to the Excerpt
configuration information in <xref
linkend="chap-Reference_Guide-Search_Configuration" />).
</para>
<para>
This query will find and highlight instances of
<emphasis>eXo</emphasis> and <emphasis>implementation</emphasis>
within fulltext search results.
@@ -34,7 +34,7 @@
<property useInExcerpt="false">title</property>
<property>text</property>
</index-rule></programlisting>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Highlighting_Results_of_Fulltext_Search-Repository_structure">
+ <section
id="sect-Reference_Guide-Highlighting_Results_of_Fulltext_Search-Repository_structure">
<title>Repository structure:</title>
<para>
The repository contains a single node with the primary type
<literal>nt:unstructured</literal>:
@@ -48,9 +48,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Highlighting_Results_of_Fulltext_Search-Query_execution">
+ <section
id="sect-Reference_Guide-Highlighting_Results_of_Fulltext_Search-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Highlighting_Results_of_Fulltext_Search-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Highlighting_Results_of_Fulltext_Search-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -62,7 +62,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Highlighting_Results_of_Fulltext_Search-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Highlighting_Results_of_Fulltext_Search-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -77,7 +77,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Highlighting_Results_of_Fulltext_Search-Fetching_result">
+ <section
id="sect-Reference_Guide-Highlighting_Results_of_Fulltext_Search-Fetching_result">
<title>Fetching result</title>
<para>
Below is the result table:
@@ -94,7 +94,7 @@
<para>
Table content is
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Highlighting_Results_of_Fulltext_Search-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-Highlighting_Results_of_Fulltext_Search-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/ignore-accent-symbols.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/ignore-accent-symbols.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/ignore-accent-symbols.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Ignoring_Accent_Symbols">
+<section id="sect-Reference_Guide-Ignoring_Accent_Symbols">
<title>Ignoring Accent Symbols</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Ignoring_Accent_Symbols-Task">
+ <formalpara id="form-Reference_Guide-Ignoring_Accent_Symbols-Task">
<title>Task:</title>
<para>
Create a new Analyzer to normalize accented characters (such as; é,è,à), set
the new Analyzer in QueryHandler configuration, and create a query to check it.
@@ -18,7 +18,7 @@
<orderedlist>
<listitem>
<para>
- Create a descendant class of SearchIndex with the new Analyzer (refer to
<xref linkend="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration" />
for more infomation).
+ Create a descendant class of SearchIndex with the new Analyzer (refer to
<xref linkend="chap-Reference_Guide-Search_Configuration" /> for more
infomation).
</para>
</listitem>
@@ -30,7 +30,7 @@
</listitem>
</orderedlist>
- <procedure
id="proc-Reference_Guide_eXo_JCR_1.14-Ignoring_Accent_Symbols-Creating_and_Registering_a_New_Analyzer">
+ <procedure
id="proc-Reference_Guide-Ignoring_Accent_Symbols-Creating_and_Registering_a_New_Analyzer">
<title>Creating and Registering a New Analyzer</title>
<step>
<para>
@@ -82,7 +82,7 @@
</procedure>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ignoring_Accent_Symbols-Repository_structure">
+ <section
id="sect-Reference_Guide-Ignoring_Accent_Symbols-Repository_structure">
<title>Repository structure:</title>
<para>
Repository filled by nodes with mixin type
<literal>mix:title</literal> and different values of
<parameter>jcr:title</parameter> property.
@@ -95,9 +95,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ignoring_Accent_Symbols-Query_execution">
+ <section
id="sect-Reference_Guide-Ignoring_Accent_Symbols-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Ignoring_Accent_Symbols-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Ignoring_Accent_Symbols-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -109,7 +109,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Ignoring_Accent_Symbols-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Ignoring_Accent_Symbols-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -124,7 +124,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ignoring_Accent_Symbols-Fetching_result">
+ <section
id="sect-Reference_Guide-Ignoring_Accent_Symbols-Fetching_result">
<title>Fetching result</title>
<para>
To fetch applicable nodes:
@@ -154,7 +154,7 @@
<para>
Table content is
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Ignoring_Accent_Symbols-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-Ignoring_Accent_Symbols-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/index-boost-value.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/index-boost-value.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/index-boost-value.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node">
+<section id="sect-Reference_Guide-Changing_Priority_of_Node">
<title>Changing Priority of Node</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node-Task">
+ <formalpara
id="form-Reference_Guide-Changing_Priority_of_Node-Task">
<title>Task:</title>
<para>
Set different boost values for predefined nodes, and check the effect of this
change by selecting those nodes and order them by
<literal>jcr:score</literal>.
@@ -16,14 +16,14 @@
The default boost value is <literal>1.0</literal>. Higher boost
values (a reasonable range is between <literal>1.0</literal> and
<literal>5.0</literal>) will yield a higher score value and appear as more
relevant.
</para>
<para>
- Refer to <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> for more
information.
+ Refer to <xref linkend="chap-Reference_Guide-Search_Configuration"
/> for more information.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node-Indexing_configuration">
+ <section
id="sect-Reference_Guide-Changing_Priority_of_Node-Indexing_configuration">
<title>Indexing configuration</title>
<para>
In this configuration the boost values for
<literal>nt:unstructured</literal> nodes <emphasis>text</emphasis>
property will be increased.
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Indexing_configuration-indexing_config.xml">
+ <example
id="exam-Reference_Guide-Indexing_configuration-indexing_config.xml">
<title>indexing-config.xml:</title>
<programlisting language="XML" role="XML"><!--
@@ -54,7 +54,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node-Repository_structure">
+ <section
id="sect-Reference_Guide-Changing_Priority_of_Node-Repository_structure">
<title>Repository structure:</title>
<para>
The repository contains many nodes with primary type
<literal>nt:unstructured</literal>. Each node contains
<emphasis>text</emphasis> property and <emphasis>rule</emphasis>
property with different values.
@@ -68,9 +68,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node-Query_execution">
+ <section
id="sect-Reference_Guide-Changing_Priority_of_Node-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Changing_Priority_of_Node-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -82,7 +82,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Changing_Priority_of_Node-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -97,7 +97,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node-Fetching_result">
+ <section
id="sect-Reference_Guide-Changing_Priority_of_Node-Fetching_result">
<title>Fetching result</title>
<para>
To fetch the nodes:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/jcr-query-usecases.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases">
+<chapter id="chap-Reference_Guide-JCR_Query_Usecases">
<title>JCR Query Usecases</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Introduction">
+ <section id="sect-Reference_Guide-JCR_Query_Usecases-Introduction">
<title>Introduction</title>
<para>
The JCR supports two query languages; JCR and XPath. A query, whether XPath
or SQL, specifies a subset of nodes within a workspace, called the result set. The result
set constitutes all the nodes in the workspace that meet the constraints stated in the
query.
@@ -13,11 +13,11 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Query_Lifecycle">
+ <section
id="sect-Reference_Guide-JCR_Query_Usecases-Query_Lifecycle">
<title>Query Lifecycle</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Query_Lifecycle-Query_Creation_and_Execution">
+ <section
id="sect-Reference_Guide-Query_Lifecycle-Query_Creation_and_Execution">
<title>Query Creation and Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Query_Lifecycle-Query_Creation_and_Execution-SQL">
+ <example
id="exam-Reference_Guide-Query_Lifecycle-Query_Creation_and_Execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// get
QueryManager
@@ -28,7 +28,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Query_Lifecycle-Query_Creation_and_Execution-XPath">
+ <example
id="exam-Reference_Guide-Query_Lifecycle-Query_Creation_and_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// get
QueryManager
@@ -42,7 +42,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Query_Lifecycle-Query_Result_Processing">
+ <section
id="sect-Reference_Guide-Query_Lifecycle-Query_Result_Processing">
<title>Query Result Processing</title>
<programlisting language="Java" role="Java">// fetch query
result
@@ -69,7 +69,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Query_Lifecycle-Scoring">
+ <section id="sect-Reference_Guide-Query_Lifecycle-Scoring">
<title>Scoring</title>
<para>
The result returns a score for each row in the result set. The score
contains a value that indicates a rating of how well the result node matches the query. A
high value means a better matching than a low value. This score can be used for ordering
the result.
@@ -81,10 +81,10 @@
The <literal>jcr:score</literal> is calculated as;
<literal>(lucene score)*1000f</literal>.
</para>
<para>
- Score may be increased for specified nodes, see <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node" />
+ Score may be increased for specified nodes, see <xref
linkend="sect-Reference_Guide-Changing_Priority_of_Node" />
</para>
<para>
- Also, see an example in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score" />
+ Also, see an example in <xref
linkend="sect-Reference_Guide-Ordering_by_Score" />
</para>
</section>
@@ -93,12 +93,12 @@
</section>
<!-- DOCS NOTE: The following 'ToC' sections are not required in
Publican builds if the publican.cfg parameter
- "generate_section_toc_level:" is set to "3" --> <!--
<section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Query_result_settings">
+ "generate_section_toc_level:" is set to "3" --> <!--
<section
id="sect-Reference_Guide-JCR_Query_Usecases-Query_result_settings">
<title>Query result settings</title>
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-SetOffset_and_SetLimit" />
+ <xref
linkend="sect-Reference_Guide-SetOffset_and_SetLimit" />
</para>
</listitem>
@@ -107,24 +107,24 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Type_Constraints">
+ <section
id="sect-Reference_Guide-JCR_Query_Usecases-Type_Constraints">
<title>Type Constraints</title>
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Nodes" />
+ <xref linkend="sect-Reference_Guide-Finding_All_Nodes"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Primary_Type" />
+ <xref
linkend="sect-Reference_Guide-Finding_Nodes_by_Primary_Type" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_by_Mixin_Type" />
+ <xref
linkend="sect-Reference_Guide-Finding_Nodes_by_Mixin_Type" />
</para>
</listitem>
@@ -133,72 +133,72 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Property_Constraints">
+ <section
id="sect-Reference_Guide-JCR_Query_Usecases-Property_Constraints">
<title>Property Constraints</title>
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Property_Comparison" />
+ <xref linkend="sect-Reference_Guide-Property_Comparison"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-LIKE_Constraint" />
+ <xref linkend="sect-Reference_Guide-LIKE_Constraint"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Escaping_in_LIKE_Statements" />
+ <xref
linkend="sect-Reference_Guide-Escaping_in_LIKE_Statements" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-NOT_Constraint" />
+ <xref linkend="sect-Reference_Guide-NOT_Constraint"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-AND_Constraint" />
+ <xref linkend="sect-Reference_Guide-AND_Constraint"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-OR_Constraint" />
+ <xref linkend="sect-Reference_Guide-OR_Constraint"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Property_Existence_Constraint" />
+ <xref
linkend="sect-Reference_Guide-Property_Existence_Constraint" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Finding_Nodes_in_a_Case_Insensitive_Way"
/>
+ <xref
linkend="sect-Reference_Guide-Finding_Nodes_in_a_Case_Insensitive_Way" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Date_Property_Comparison" />
+ <xref
linkend="sect-Reference_Guide-Date_Property_Comparison" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Node_Name_Constraint" />
+ <xref
linkend="sect-Reference_Guide-Node_Name_Constraint" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison"
/>
+ <xref
linkend="sect-Reference_Guide-Multivalue_Property_Comparison" />
</para>
</listitem>
@@ -207,24 +207,24 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Path_Constraint">
+ <section
id="sect-Reference_Guide-JCR_Query_Usecases-Path_Constraint">
<title>Path Constraint</title>
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Exact_Path_Constraint" />
+ <xref
linkend="sect-Reference_Guide-Exact_Path_Constraint" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Child_Node_Constraint" />
+ <xref
linkend="sect-Reference_Guide-Child_Node_Constraint" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Finding_All_Descendant_Nodes" />
+ <xref
linkend="sect-Reference_Guide-Finding_All_Descendant_Nodes" />
</para>
</listitem>
@@ -233,30 +233,30 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Ordering_specifying">
+ <section
id="sect-Reference_Guide-JCR_Query_Usecases-Ordering_specifying">
<title>Ordering specifying</title>
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property" />
+ <xref
linkend="sect-Reference_Guide-Sorting_Nodes_by_Property" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Descendant_Nodes_Property_XPath_only"
/>
+ <xref
linkend="sect-Reference_Guide-Ordering_by_Descendant_Nodes_Property_XPath_only"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score" />
+ <xref linkend="sect-Reference_Guide-Ordering_by_Score"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Path_or_Name" />
+ <xref
linkend="sect-Reference_Guide-Ordering_by_Path_or_Name" />
</para>
</listitem>
@@ -265,61 +265,61 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Indexing_rules_and_additional_features">
+ <section
id="sect-Reference_Guide-JCR_Query_Usecases-Indexing_rules_and_additional_features">
<title>Indexing rules and additional features</title>
<itemizedlist>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Finding_a_node_by_content_of_child_node"
/>
+ <xref
linkend="sect-Reference_Guide-Finding_a_node_by_content_of_child_node" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Highlighting_Results_of_Fulltext_Search"
/>
+ <xref
linkend="sect-Reference_Guide-Highlighting_Results_of_Fulltext_Search" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Changing_Priority_of_Node" />
+ <xref
linkend="sect-Reference_Guide-Changing_Priority_of_Node" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope"
/>
+ <xref
linkend="sect-Reference_Guide-Removing_Nodes_Property_From_Indexing_Scope"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules"
/>
+ <xref
linkend="sect-Reference_Guide-Regular_Expression_as_Property_Name_in_Indexing_Rules"
/>
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym" />
+ <xref
linkend="sect-Reference_Guide-Searching_By_Synonym" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Checking_the_spelling_of_Phrase"
/>
+ <xref
linkend="sect-Reference_Guide-Checking_the_spelling_of_Phrase" />
</para>
</listitem>
<listitem>
<para>
- <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-Finding_Similar_Nodes" />
+ <xref
linkend="sect-Reference_Guide-Finding_Similar_Nodes" />
</para>
</listitem>
</itemizedlist>
- </section> --> <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Query_Examples">
+ </section> --> <section
id="sect-Reference_Guide-JCR_Query_Usecases-Query_Examples">
<title>Query Examples</title>
<xi:include href="offset-and-limit.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="find-all-nodes.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
@@ -357,7 +357,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JCR_Query_Usecases-Tips_and_tricks">
+ <section
id="sect-Reference_Guide-JCR_Query_Usecases-Tips_and_tricks">
<title>Tips and tricks</title>
<xi:include href="tip-nodename-with-number.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/like-constraint.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/like-constraint.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/like-constraint.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-LIKE_Constraint">
+<section id="sect-Reference_Guide-LIKE_Constraint">
<title>LIKE Constraint</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-LIKE_Constraint-Task">
+ <formalpara id="form-Reference_Guide-LIKE_Constraint-Task">
<title>Task:</title>
<para>
Find all nodes with mixin type <literal>mix:title</literal> and
where the property <parameter>jcr:title</parameter> starts with
<literal>P</literal>.
@@ -14,11 +14,11 @@
</formalpara>
<note>
<para>
- Further useful information can be found in <xref
linkend="sect-Reference_Guide_eXo_JCR_1.14-NOT_Constraint" />.
+ Further useful information can be found in <xref
linkend="sect-Reference_Guide-NOT_Constraint" />.
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-LIKE_Constraint-Repository_structure">
+ <section
id="sect-Reference_Guide-LIKE_Constraint-Repository_structure">
<title>Repository structure:</title>
<para>
The repository contains three mix:title nodes, where each jcr:title has a
different value.
@@ -32,9 +32,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-LIKE_Constraint-Query_execution">
+ <section id="sect-Reference_Guide-LIKE_Constraint-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-LIKE_Constraint-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-LIKE_Constraint-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -46,7 +46,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-LIKE_Constraint-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-LIKE_Constraint-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -61,7 +61,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-LIKE_Constraint-Fetching_result">
+ <section id="sect-Reference_Guide-LIKE_Constraint-Fetching_result">
<title>Fetching result</title>
<para>
To fetch matching nodes:
@@ -90,7 +90,7 @@
}</programlisting>
<para>
The table content is
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-LIKE_Constraint-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-LIKE_Constraint-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="4">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/multivalue-property-comparison.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/multivalue-property-comparison.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/multivalue-property-comparison.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison">
+<section id="sect-Reference_Guide-Multivalue_Property_Comparison">
<title>Multivalue Property Comparison</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Task">
+ <formalpara
id="form-Reference_Guide-Multivalue_Property_Comparison-Task">
<title>Task:</title>
<para>
To find all nodes with the primary type
<literal>nt:unstructured</literal> whose property
<parameter>multiprop</parameter> contains both values
<emphasis>one</emphasis> and <emphasis>two</emphasis>.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Repository_Structure">
+ <section
id="sect-Reference_Guide-Multivalue_Property_Comparison-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository contains nt:unstructured nodes with different
'multiprop' properties.
@@ -26,9 +26,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Query_Execution">
+ <section
id="sect-Reference_Guide-Multivalue_Property_Comparison-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-Multivalue_Property_Comparison-Query_Execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -40,7 +40,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Multivalue_Property_Comparison-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -55,7 +55,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Multivalue_Property_Comparison-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch nodes:
@@ -84,7 +84,7 @@
}</programlisting>
<para>
The table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Multivalue_Property_Comparison-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Multivalue_Property_Comparison-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/node-name-constraint.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/node-name-constraint.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/node-name-constraint.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Node_Name_Constraint">
+<section id="sect-Reference_Guide-Node_Name_Constraint">
<title>Node Name Constraint</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Node_Name_Constraint-Task">
+ <formalpara id="form-Reference_Guide-Node_Name_Constraint-Task">
<title>Task:</title>
<para>
Find all nodes with primary type <literal>nt:file</literal> whose
node name is <parameter>document</parameter>. The node name is accessible by a
function called <code>fn:name()</code>.
@@ -19,7 +19,7 @@
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Node_Name_Constraint-Repository_Structure">
+ <section
id="sect-Reference_Guide-Node_Name_Constraint-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository contains nt:file nodes with different names.
@@ -33,9 +33,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Node_Name_Constraint-Query_execution">
+ <section
id="sect-Reference_Guide-Node_Name_Constraint-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Node_Name_Constraint-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Node_Name_Constraint-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -47,7 +47,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Node_Name_Constraint-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Node_Name_Constraint-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -62,7 +62,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Node_Name_Constraint-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Node_Name_Constraint-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch appropriate nodes:
@@ -91,7 +91,7 @@
}</programlisting>
<para>
Table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Node_Name_Constraint-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Node_Name_Constraint-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="2">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/node-scope-index.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/node-scope-index.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/node-scope-index.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope">
+<section
id="sect-Reference_Guide-Removing_Nodes_Property_From_Indexing_Scope">
<title>Removing Nodes Property From Indexing Scope</title>
<para>
This example will cover excluding a <emphasis>text</emphasis>
property of <literal>nt:unstructured</literal> nodes from being indexed. This
means the node will not be found by a search for the content of this property, even if it
accepts all constraints.
@@ -22,9 +22,9 @@
<property
nodeScopeIndex="false">text</property>
</index-rule></programlisting>
<para>
- Refer to <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> for more
details.
+ Refer to <xref linkend="chap-Reference_Guide-Search_Configuration"
/> for more details.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope-Repository_structure">
+ <section
id="sect-Reference_Guide-Removing_Nodes_Property_From_Indexing_Scope-Repository_structure">
<title>Repository structure</title>
<para>
The repository contains <literal>nt:unstructured</literal> nodes,
with same <emphasis>text</emphasis> property and different
<emphasis>rule</emphasis> properties.
@@ -38,9 +38,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope-Query_execution">
+ <section
id="sect-Reference_Guide-Removing_Nodes_Property_From_Indexing_Scope-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Removing_Nodes_Property_From_Indexing_Scope-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -52,7 +52,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Removing_Nodes_Property_From_Indexing_Scope-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -67,7 +67,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope-Fetching_result">
+ <section
id="sect-Reference_Guide-Removing_Nodes_Property_From_Indexing_Scope-Fetching_result">
<title>Fetching result</title>
<para>
To fetch nodes:
@@ -97,7 +97,7 @@
<para>
Table content is:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Removing_Nodes_Property_From_Indexing_Scope-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-Removing_Nodes_Property_From_Indexing_Scope-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/not-constraint.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/not-constraint.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/not-constraint.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-NOT_Constraint">
+<section id="sect-Reference_Guide-NOT_Constraint">
<title>NOT Constraint</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-NOT_Constraint-Task">
+ <formalpara id="form-Reference_Guide-NOT_Constraint-Task">
<title>Task:</title>
<para>
Find all nodes with a mixin type <literal>mix:title</literal> and
where the property <parameter>jcr:title</parameter> does <emphasis
role="bold">not</emphasis> start with a
<literal>P</literal> symbol.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-NOT_Constraint-Repository_Structure">
+ <section
id="sect-Reference_Guide-NOT_Constraint-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository contains a mix:title nodes, where the jcr:title has different
values.
@@ -26,9 +26,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-NOT_Constraint-Query_execution">
+ <section id="sect-Reference_Guide-NOT_Constraint-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-NOT_Constraint-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-NOT_Constraint-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -40,7 +40,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-NOT_Constraint-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-NOT_Constraint-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -55,7 +55,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-NOT_Constraint-Fetching_the_result">
+ <section
id="sect-Reference_Guide-NOT_Constraint-Fetching_the_result">
<title>Fetching the result</title>
<para>
To fetch the matching nodes:
@@ -84,7 +84,7 @@
}</programlisting>
<para>
Table content is
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-NOT_Constraint-Fetching_the_result-Table_content">
+ <table
id="tabl-Reference_Guide-NOT_Constraint-Fetching_the_result-Table_content">
<title>Table content</title>
<tgroup cols="4">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/offset-and-limit.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/offset-and-limit.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/offset-and-limit.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-SetOffset_and_SetLimit">
+<section id="sect-Reference_Guide-SetOffset_and_SetLimit">
<title><literal>SetOffset</literal> and
<literal>SetLimit</literal></title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-SetOffset_and_SetLimit-Task">
+ <formalpara id="form-Reference_Guide-SetOffset_and_SetLimit-Task">
<title>Task:</title>
<para>
Select all nodes with primary type
<literal>nt:unstructured</literal> and return only three nodes starting with
the second node in the list.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SetOffset_and_SetLimit-Common_information">
+ <section
id="sect-Reference_Guide-SetOffset_and_SetLimit-Common_information">
<title>Common information</title>
<para>
<literal>QueryImpl</literal> class has two methods; one to
indicate how many results shall be returned at most, and another to fix the starting
position.
@@ -44,7 +44,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SetOffset_and_SetLimit-Repository_structure">
+ <section
id="sect-Reference_Guide-SetOffset_and_SetLimit-Repository_structure">
<title>Repository structure</title>
<para>
The repository contains <literal>mix:title</literal> nodes, where
<literal>jcr:title</literal> has different values.
@@ -61,9 +61,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SetOffset_and_SetLimit-Query_execution">
+ <section
id="sect-Reference_Guide-SetOffset_and_SetLimit-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-SetOffset_and_SetLimit-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-SetOffset_and_SetLimit-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -82,7 +82,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-SetOffset_and_SetLimit-Fetching_result">
+ <section
id="sect-Reference_Guide-SetOffset_and_SetLimit-Fetching_result">
<title>Fetching result</title>
<para>
To fetch the matching nodes:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/or-constraint.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/or-constraint.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/or-constraint.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-OR_Constraint">
+<section id="sect-Reference_Guide-OR_Constraint">
<title>OR Constraint</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-OR_Constraint-Task">
+ <formalpara id="form-Reference_Guide-OR_Constraint-Task">
<title>Task:</title>
<para>
Find all documents whose title is <emphasis>Cinderella</emphasis>
OR whose description is <emphasis>novel</emphasis>. In JCR terms this would
be; find all nodes with a mixin type <literal>mix:title</literal> whose
property <parameter>jcr:title</parameter> equals
<emphasis>Cinderella</emphasis> or whose
<parameter>jcr:description</parameter> property value is
<emphasis>novel</emphasis>.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-OR_Constraint-Repository_Structure">
+ <section
id="sect-Reference_Guide-OR_Constraint-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository contains mix:title nodes, where jcr:title and jcr:description
have different values.
@@ -26,9 +26,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-OR_Constraint-Query_Execution">
+ <section id="sect-Reference_Guide-OR_Constraint-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-OR_Constraint-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-OR_Constraint-Query_Execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -40,7 +40,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-OR_Constraint-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-OR_Constraint-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -55,7 +55,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-OR_Constraint-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-OR_Constraint-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch matching nodes:
@@ -84,7 +84,7 @@
}</programlisting>
<para>
Table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-OR_Constraint-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-OR_Constraint-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="4">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-descendant.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-descendant.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-descendant.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Descendant_Nodes_Property_XPath_only">
+<section
id="sect-Reference_Guide-Ordering_by_Descendant_Nodes_Property_XPath_only">
<title>Ordering by Descendant Nodes Property (XPath only)</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Ordering_by_Descendant_Nodes_Property_XPath_only-Task">
+ <formalpara
id="form-Reference_Guide-Ordering_by_Descendant_Nodes_Property_XPath_only-Task">
<title>Task:</title>
<para>
Find all nodes with the primary type
<literal>nt:unstructured</literal> and sort them by the property value of
descendant nodes with the relative path <literal>/a/b</literal>.
@@ -19,7 +19,7 @@
</para>
</note>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Descendant_Nodes_Property_XPath_only-Repository_structure">
+ <section
id="sect-Reference_Guide-Ordering_by_Descendant_Nodes_Property_XPath_only-Repository_structure">
<title>Repository structure</title>
<programlisting>root
@@ -38,9 +38,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Descendant_Nodes_Property_XPath_only-Query_Execution">
+ <section
id="sect-Reference_Guide-Ordering_by_Descendant_Nodes_Property_XPath_only-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Ordering_by_Descendant_Nodes_Property_XPath_only-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Ordering_by_Descendant_Nodes_Property_XPath_only-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -55,7 +55,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Descendant_Nodes_Property_XPath_only-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Ordering_by_Descendant_Nodes_Property_XPath_only-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch the nodes:
@@ -85,7 +85,7 @@
<para>
Table content is:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Ordering_by_Descendant_Nodes_Property_XPath_only-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Ordering_by_Descendant_Nodes_Property_XPath_only-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-path-or-name.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-path-or-name.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-path-or-name.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Path_or_Name">
+<section id="sect-Reference_Guide-Ordering_by_Path_or_Name">
<title>Ordering by Path or Name</title>
<warning>
<para>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-property.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-property.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-property.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property">
+<section id="sect-Reference_Guide-Sorting_Nodes_by_Property">
<title>Sorting Nodes by Property</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Task">
+ <formalpara
id="form-Reference_Guide-Sorting_Nodes_by_Property-Task">
<title>Task:</title>
<para>
Select all nodes with the mixin type <literal>mix:title</literal>
and order them by the <parameter>prop_pagecount</parameter> property.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Repository_Structure">
+ <section
id="sect-Reference_Guide-Sorting_Nodes_by_Property-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository contains several <literal>mix:title</literal>
nodes, where <parameter>prop_pagecount</parameter> has different values.
@@ -26,9 +26,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Query_Execution">
+ <section
id="sect-Reference_Guide-Sorting_Nodes_by_Property-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-Sorting_Nodes_by_Property-Query_Execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -40,7 +40,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Sorting_Nodes_by_Property-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -55,7 +55,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Sorting_Nodes_by_Property-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch nodes:
@@ -85,7 +85,7 @@
<para>
Table content is:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Sorting_Nodes_by_Property-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Sorting_Nodes_by_Property-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="5">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-score.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-score.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/order-by-score.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score">
+<section id="sect-Reference_Guide-Ordering_by_Score">
<title>Ordering by Score</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score-Task">
+ <formalpara id="form-Reference_Guide-Ordering_by_Score-Task">
<title>Task:</title>
<para>
Select all nodes with the mixin type <literal>mix:title</literal>
containing any word from the set {<emphasis>brown</emphasis>,
<emphasis>fox</emphasis>, <emphasis>jumps</emphasis>}. Then, sort
the results by their score in ascending node. This way nodes that are a closer match to
the query statement are in the last positions in the result list.
@@ -15,7 +15,7 @@
<para>
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score-Info">
+ <section id="sect-Reference_Guide-Ordering_by_Score-Info">
<title>Info</title>
<para>
SQL and XPath queries both support score constructions
<literal>jcr:score</literal> and <literal>jcr:score()</literal>.
@@ -39,7 +39,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score-Repository_Structure">
+ <section
id="sect-Reference_Guide-Ordering_by_Score-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository contains mix:title nodes, where the jcr:description has
different values.
@@ -53,9 +53,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score-Query_Execution">
+ <section
id="sect-Reference_Guide-Ordering_by_Score-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-Ordering_by_Score-Query_Execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -67,7 +67,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Ordering_by_Score-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -82,7 +82,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Ordering_by_Score-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch the nodes:
@@ -112,7 +112,7 @@
<para>
Table content is:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Ordering_by_Score-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Ordering_by_Score-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="4">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/property-comparison.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/property-comparison.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/property-comparison.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,18 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Property_Comparison">
+<section id="sect-Reference_Guide-Property_Comparison">
<title>Property Comparison</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Task">
+ <formalpara id="form-Reference_Guide-Property_Comparison-Task">
<title>Task:</title>
<para>
To find all nodes with mixin type <literal>mix:title</literal>
where the <parameter>prop_pagecount</parameter> property contains a value less
than <literal>90</literal>. Only select the title of each node.
</para>
</formalpara>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Repository_structure">
+ <section
id="sect-Reference_Guide-Property_Comparison-Repository_structure">
<title>Repository structure:</title>
<para>
Repository contains several <literal>mix:title</literal> nodes,
where each <parameter>prop_pagecount</parameter> contains a different value.
@@ -26,9 +26,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Query_execution">
+ <section
id="sect-Reference_Guide-Property_Comparison-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Property_Comparison-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -40,7 +40,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Property_Comparison-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -55,7 +55,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Fetching_result">
+ <section
id="sect-Reference_Guide-Property_Comparison-Fetching_result">
<title>Fetching result</title>
<para>
To fetch nodes:
@@ -84,7 +84,7 @@
}</programlisting>
<para>
The table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Property_Comparison-Fetching_result-Table_Content">
+ <table
id="tabl-Reference_Guide-Property_Comparison-Fetching_result-Table_Content">
<title>Table Content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/property-existance-constraint.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/property-existance-constraint.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/property-existance-constraint.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Property_Existence_Constraint">
+<section id="sect-Reference_Guide-Property_Existence_Constraint">
<title>Property Existence Constraint</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Property_Existence_Constraint-Task">
+ <formalpara
id="form-Reference_Guide-Property_Existence_Constraint-Task">
<title>Task:</title>
<para>
Find all nodes with a mixin type
'<literal>mix:title</literal>' where the property
<parameter>jcr:description</parameter> does not exist (is null).
@@ -15,7 +15,7 @@
<para>
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Property_Existence_Constraint-Repository_Structure">
+ <section
id="sect-Reference_Guide-Property_Existence_Constraint-Repository_Structure">
<title>Repository Structure</title>
<para>
The repository contains <literal>mix:title</literal> nodes, in
one of these nodes the <literal>jcr:description</literal> property is null.
@@ -29,9 +29,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Property_Existence_Constraint-Query_Execution">
+ <section
id="sect-Reference_Guide-Property_Existence_Constraint-Query_Execution">
<title>Query Execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Property_Existence_Constraint-Query_Execution-SQL">
+ <example
id="exam-Reference_Guide-Property_Existence_Constraint-Query_Execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -42,7 +42,7 @@
// execute query and fetch result
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Property_Existence_Constraint-Query_Execution-XPath">
+ <example
id="exam-Reference_Guide-Property_Existence_Constraint-Query_Execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -56,7 +56,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Property_Existence_Constraint-Fetching_the_Result">
+ <section
id="sect-Reference_Guide-Property_Existence_Constraint-Fetching_the_Result">
<title>Fetching the Result</title>
<para>
To fetch the nodes:
@@ -85,7 +85,7 @@
}</programlisting>
<para>
Table content is:
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Property_Existence_Constraint-Fetching_the_Result-Table_content">
+ <table
id="tabl-Reference_Guide-Property_Existence_Constraint-Fetching_the_Result-Table_content">
<title>Table content</title>
<tgroup cols="4">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/regexp-indexing-rule.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/regexp-indexing-rule.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/regexp-indexing-rule.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules">
+<section
id="sect-Reference_Guide-Regular_Expression_as_Property_Name_in_Indexing_Rules">
<title>Regular Expression as Property Name in Indexing Rules</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Task">
+ <formalpara
id="form-Reference_Guide-Regular_Expression_as_Property_Name_in_Indexing_Rules-Task">
<title>Task:</title>
<para>
To configure indexing so that all properties of
<literal>nt:unstructured</literal> nodes must be excluded from searches,
except properties with names ending with a particular
<emphasis>Text</emphasis> string.
@@ -20,9 +20,9 @@
<property isRegexp="true">.*Text</property>
</index-rule></programlisting>
<para>
- See <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> for more
information.
+ See <xref linkend="chap-Reference_Guide-Search_Configuration" />
for more information.
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Repository_structure">
+ <section
id="sect-Reference_Guide-Regular_Expression_as_Property_Name_in_Indexing_Rules-Repository_structure">
<title>Repository structure:</title>
<para>
The repository contains <literal>nt:unstructured</literal> nodes,
with different <parameter>text</parameter>-based properties:
@@ -36,9 +36,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Query_execution">
+ <section
id="sect-Reference_Guide-Regular_Expression_as_Property_Name_in_Indexing_Rules-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Regular_Expression_as_Property_Name_in_Indexing_Rules-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -50,7 +50,7 @@
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Regular_Expression_as_Property_Name_in_Indexing_Rules-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -65,7 +65,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Fetching_result">
+ <section
id="sect-Reference_Guide-Regular_Expression_as_Property_Name_in_Indexing_Rules-Fetching_result">
<title>Fetching result</title>
<para>
To fetch the nodes:
@@ -95,7 +95,7 @@
<para>
Table content is:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Regular_Expression_as_Property_Name_in_Indexing_Rules-Fetching_result-Table_content">
+ <table
id="tabl-Reference_Guide-Regular_Expression_as_Property_Name_in_Indexing_Rules-Fetching_result-Table_content">
<title>Table content</title>
<tgroup cols="3">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,22 +1,22 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content">
+<chapter id="chap-Reference_Guide-Searching_Repository_Content">
<title>Searching Repository Content</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Introduction">
+ <section
id="sect-Reference_Guide-Searching_Repository_Content-Introduction">
<title>Introduction</title>
<para>
You can find the JCR configuration file here:
<filename><replaceable><JBOSS_HOME></replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/portal/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
</para>
<para>
- Please refer to <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration" /> for more
information about index configuration.
+ Please refer to <xref linkend="chap-Reference_Guide-Search_Configuration"
/> for more information about index configuration.
</para>
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Bi_directional_RangeIterator">
+ <section
id="sect-Reference_Guide-Searching_Repository_Content-Bi_directional_RangeIterator">
<title>Bi-directional RangeIterator</title>
<para>
<literal>QueryResult.getNodes()</literal> will return bi-directional
<literal>NodeIterator</literal> implementation.
@@ -71,7 +71,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Fuzzy_Searches">
+ <section
id="sect-Reference_Guide-Searching_Repository_Content-Fuzzy_Searches">
<title>Fuzzy Searches</title>
<para>
The JBoss Enterprise Portal Platform JCR supports features such as Lucene Fuzzy
Searches. To perform a fuzzy search, form your query like the one below:
@@ -83,7 +83,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-SynonymSearch">
+ <section
id="sect-Reference_Guide-Searching_Repository_Content-SynonymSearch">
<title>SynonymSearch</title>
<para>
Searching with synonyms is integrated in the
<literal>jcr:contains()</literal> function and uses the same syntax as synonym
searches in web search engines (Google, for example). If a search term is prefixed by a
tilde symbol ( ~ ), synonyms of the search term are taken into consideration. For
example:
@@ -131,7 +131,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Highlighting">
+ <section
id="sect-Reference_Guide-Searching_Repository_Content-Highlighting">
<title>Highlighting</title>
<para>
An <literal>ExcerptProvider</literal> retrieves text excerpts for a node
in the query result and marks up the words in the text that match the query terms.
@@ -149,7 +149,7 @@
</para>
<programlisting language="XML" role="XML"><param
name="excerptprovider-class"
value="org.exoplatform.services.jcr.impl.core.query.lucene.DefaultXMLExcerpt"/></programlisting>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Highlighting-DefaultXMLExcerpt">
+ <section id="sect-Reference_Guide-Highlighting-DefaultXMLExcerpt">
<title>DefaultXMLExcerpt</title>
<para>
This excerpt provider creates an XML fragment of the following form:
@@ -168,7 +168,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Highlighting-DefaultHTMLExcerpt">
+ <section id="sect-Reference_Guide-Highlighting-DefaultHTMLExcerpt">
<title>DefaultHTMLExcerpt</title>
<para>
This excerpt provider creates an HTML fragment of the following form:
@@ -187,7 +187,7 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Highlighting-Usage">
+ <section id="sect-Reference_Guide-Highlighting-Usage">
<title>Usage</title>
<para>
If you are using XPath, you must use the <code>rep:excerpt()</code>
function in the last location step, just like you would select properties:
@@ -227,13 +227,13 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-SpellChecker">
+ <section
id="sect-Reference_Guide-Searching_Repository_Content-SpellChecker">
<title>SpellChecker</title>
<para>
The lucene based query handler implementation supports a pluggable spell-checker
mechanism. By default, spell checking is not available, it must be configured first.
</para>
<para>
- Information about the <parameter>spellCheckerClass</parameter> parameter
is available in <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Search_Configuration" />.
+ Information about the <parameter>spellCheckerClass</parameter> parameter
is available in <xref linkend="chap-Reference_Guide-Search_Configuration"
/>.
</para>
<para>
The JCR currently provides an implementation class which uses the <ulink
url="http://wiki.apache.org/jakarta-lucene/SpellChecker">luc...;.
@@ -295,7 +295,7 @@
<para>
The spell checker dictionary is stored as a lucene index under
<filename><index-dir>/spellchecker</filename>. If this index
does not exist, a background thread will create it on start up. Similarly, the dictionary
refresh is also done in a background thread so as not to block regular queries.
</para>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-SpellChecker-Usage">
+ <section id="sect-Reference_Guide-SpellChecker-Usage">
<title>Usage</title>
<para>
You can spell check a fulltext statement either with an XPath or a SQL query:
@@ -337,7 +337,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content-Similarity">
+ <section
id="sect-Reference_Guide-Searching_Repository_Content-Similarity">
<title>Similarity</title>
<para>
Starting with version, 1.12 JCR allows you to search for nodes that are similar to an
existing node.
@@ -412,7 +412,7 @@
</para>
</warning>
- <example id="exam-Reference_Guide_eXo_JCR_1.14-Similarity-Example">
+ <example id="exam-Reference_Guide-Similarity-Example">
<title>Example</title>
<programlisting>//element(*, nt:resource)[rep:similar(.,
'/parentnode/node.txt/jcr:content')]</programlisting>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/spell-checker.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/spell-checker.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/spell-checker.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-Checking_the_spelling_of_Phrase">
+<section id="sect-Reference_Guide-Checking_the_spelling_of_Phrase">
<title>Checking the spelling of Phrase</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Checking_the_spelling_of_Phrase-Task">
+ <formalpara
id="form-Reference_Guide-Checking_the_spelling_of_Phrase-Task">
<title>Task:</title>
<para>
Check the correct spelling of phrase '<emphasis>quik OR (-foo
bar)</emphasis>' according to data already stored in index.
@@ -14,14 +14,14 @@
</formalpara>
<note>
<para>
- Refer to <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content" />
for information about SpellChecker configuration.
+ Refer to <xref
linkend="chap-Reference_Guide-Searching_Repository_Content" /> for
information about SpellChecker configuration.
</para>
</note>
<para>
The SpellChecker must be set in query-handler configuration.
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Checking_the_spelling_of_Phrase-test_jcr_config.xml">
+ <example
id="exam-Reference_Guide-Checking_the_spelling_of_Phrase-test_jcr_config.xml">
<title>test-jcr-config.xml:</title>
<programlisting language="XML" role="XML"><query-handler
class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex">
@@ -32,7 +32,7 @@
</properties>
</query-handler></programlisting>
</example>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Checking_the_spelling_of_Phrase-Repository_structure">
+ <section
id="sect-Reference_Guide-Checking_the_spelling_of_Phrase-Repository_structure">
<title>Repository structure:</title>
<para>
Repository contains node, with string property "The quick brown fox
jumps over the lazy dog."
@@ -44,12 +44,12 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Checking_the_spelling_of_Phrase-Query_execution">
+ <section
id="sect-Reference_Guide-Checking_the_spelling_of_Phrase-Query_execution">
<title>Query execution</title>
<para>
The query looks only for the <literal>root</literal> node,
because the spell checker looks for suggestions by full index. Therefore a complicated
query is unecessary.
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Checking_the_spelling_of_Phrase-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Checking_the_spelling_of_Phrase-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -60,7 +60,7 @@
// execute query and fetch result
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Checking_the_spelling_of_Phrase-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Checking_the_spelling_of_Phrase-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -74,7 +74,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Checking_the_spelling_of_Phrase-Fetching_result">
+ <section
id="sect-Reference_Guide-Checking_the_spelling_of_Phrase-Fetching_result">
<title>Fetching result</title>
<para>
To get suggestions of the correct spelling of the nominated phrase:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/synonim-provider.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/synonim-provider.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/synonim-provider.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym">
+<section id="sect-Reference_Guide-Searching_By_Synonym">
<title>Searching By Synonym</title>
- <formalpara
id="form-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Task">
+ <formalpara id="form-Reference_Guide-Searching_By_Synonym-Task">
<title>Task:</title>
<para>
Find all <literal>mix:title</literal> nodes whose title contains
a synonym for the term <emphasis>fast</emphasis>.
@@ -14,7 +14,7 @@
</formalpara>
<note>
<para>
- Refer to <xref
linkend="chap-Reference_Guide_eXo_JCR_1.14-Searching_Repository_Content" />
for information about synonym provider configuration
+ Refer to <xref
linkend="chap-Reference_Guide-Searching_Repository_Content" /> for
information about synonym provider configuration
</para>
</note>
@@ -33,14 +33,14 @@
<para>
The <filename>synonym.properties</filename> file contains the
synonyms list:
</para>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Example_Synonym_List">
+ <example
id="exam-Reference_Guide-Searching_By_Synonym-Example_Synonym_List">
<title>Example Synonym List</title>
<programlisting>ASF=Apache Software Foundation
quick=fast
sluggish=lazy</programlisting>
</example>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Repository_structure">
+ <section
id="sect-Reference_Guide-Searching_By_Synonym-Repository_structure">
<title>Repository structure:</title>
<para>
the repository contains <literal>mix:title</literal> nodes, where
<literal>jcr:title</literal> has different values.
@@ -52,9 +52,9 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Query_execution">
+ <section
id="sect-Reference_Guide-Searching_By_Synonym-Query_execution">
<title>Query execution</title>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Query_execution-SQL">
+ <example
id="exam-Reference_Guide-Searching_By_Synonym-Query_execution-SQL">
<title>SQL</title>
<programlisting language="Java" role="Java">// make SQL query
@@ -65,7 +65,7 @@
// execute query and fetch result
QueryResult result = query.execute();</programlisting>
</example>
- <example
id="exam-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Query_execution-XPath">
+ <example
id="exam-Reference_Guide-Searching_By_Synonym-Query_execution-XPath">
<title>XPath</title>
<programlisting language="Java" role="Java">// make XPath
query
@@ -79,7 +79,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Searching_By_Synonym-Fetching_result">
+ <section
id="sect-Reference_Guide-Searching_By_Synonym-Fetching_result">
<title>Fetching result</title>
<para>
To fetch nodes:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/tip-nodename-with-number.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/tip-nodename-with-number.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/tip-nodename-with-number.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-XPath_queries_containing_node_names_starting_with_a_number">
+<section
id="sect-Reference_Guide-XPath_queries_containing_node_names_starting_with_a_number">
<title>XPath queries containing node names starting with a number</title>
<para>
If you execute an XPath request like this...
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/statistics.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/statistics.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/statistics.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-eXo_JCR_statistics">
+<chapter id="chap-Reference_Guide-eXo_JCR_statistics">
<title>eXo JCR statistics</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_statistics-Statistics_on_the_Database_Access_Layer">
+ <section
id="sect-Reference_Guide-eXo_JCR_statistics-Statistics_on_the_Database_Access_Layer">
<title>Statistics on the Database Access Layer</title>
<para>
In order to have a better idea of the time spent into the database access layer, it
can be interesting to get some statistics on that part of the code, knowing that most of
the time spent into eXo JCR is mainly the database access.
@@ -64,7 +64,7 @@
<para>
The name of the category of statistics corresponding to these statistics is
<literal>JDBCStorageConnection</literal>, this name is mostly needed to access
to the statistics through JMX.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Statistics_on_the_Database_Access_Layer-Method_Alias">
+ <table
id="tabl-Reference_Guide-Statistics_on_the_Database_Access_Layer-Method_Alias">
<title>Method Alias</title>
<tgroup cols="2">
<tbody>
@@ -248,7 +248,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_statistics-Statistics_on_the_JCR_API_accesses">
+ <section
id="sect-Reference_Guide-eXo_JCR_statistics-Statistics_on_the_JCR_API_accesses">
<title>Statistics on the JCR API accesses</title>
<para>
In order to know exactly how your application uses eXo JCR, it can be interesting to
register all the JCR API accesses in order to easily create real life test scenario based
on pure JCR calls and also to tune your eXo JCR to better fit your requirements.
@@ -345,7 +345,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_JCR_statistics-Statistics_Manager">
+ <section
id="sect-Reference_Guide-eXo_JCR_statistics-Statistics_Manager">
<title>Statistics Manager</title>
<para>
The statistics manager manages all the statistics provided by eXo JCR, it is
responsible of printing the data into the CSV files and also exposing the statistics
through JMX and/or Rest.
@@ -354,7 +354,7 @@
The statistics manager will create all the CSV files for each category of statistics
that it manages, the format of those files is
<emphasis>Statistics${category-name}-${creation-timestamp}.csv</emphasis>.
Those files will be created into the user directory if it is possible otherwise it will
create them into the temporary directory. The format of those files is
<envar>CSV</envar> (i.e. Comma-Separated Values), one new line will be added
regularly (every 5 seconds by default) and one last line will be added at JVM exit. Each
line, will be composed of the 5 figures described below for each method and globally for
all the methods.
</para>
<para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Statistics_Manager-Metric_Alias">
+ <table id="tabl-Reference_Guide-Statistics_Manager-Metric_Alias">
<title>Metric Alias</title>
<tgroup cols="2">
<tbody>
@@ -418,7 +418,7 @@
You can also access to the statistics via JMX. The available methods are:
</para>
<para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Statistics_Manager-JMX_Methods">
+ <table id="tabl-Reference_Guide-Statistics_Manager-JMX_Methods">
<title>JMX Methods</title>
<tgroup cols="2">
<tbody>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/transaction-manager-lookup.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/transaction-manager-lookup.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/transaction-manager-lookup.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-TransactionManagerLookup">
+<chapter id="chap-Reference_Guide-TransactionManagerLookup">
<title>TransactionManagerLookup</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-TransactionManagerLookup-Configuration">
+ <section
id="sect-Reference_Guide-TransactionManagerLookup-Configuration">
<title>Configuration</title>
<para>
<literal>TransactionManagerLookup</literal> is a JBossCache class
registered as an eXo container component in the
<filename>configuration.xml</filename> file.
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gatein.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gatein.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gatein.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-eXo_JCR_with_GateIn">
+<chapter id="chap-Reference_Guide-eXo_JCR_with_GateIn">
<title>eXo JCR with GateIn</title>
<!-- <xi:include
href="jcr-with-gtn/how-to-extend-my-gatein-instance.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include
href="jcr-with-gtn/managed-datasources-under-jboss-as.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,13 +1,13 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section
id="sect-Reference_Guide_eXo_JCR_1.14-How_to_use_AS_Managed_DataSource_under_JBoss_AS">
+<section
id="sect-Reference_Guide-How_to_use_AS_Managed_DataSource_under_JBoss_AS">
<title>How to use AS Managed DataSource under JBoss AS</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_to_use_AS_Managed_DataSource_under_JBoss_AS-Configurations_Steps">
+ <section
id="sect-Reference_Guide-How_to_use_AS_Managed_DataSource_under_JBoss_AS-Configurations_Steps">
<title>Configurations Steps</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configurations_Steps-Declaring_the_datasources_in_the_AS">
+ <section
id="sect-Reference_Guide-Configurations_Steps-Declaring_the_datasources_in_the_AS">
<title>Declaring the datasources in the AS</title>
<para>
To declare the datasources using a JBoss application server, deploy a
<literal>ds</literal> file
(<filename><replaceable>XXX</replaceable>-ds.xml</filename>) into
the <emphasis>deploy</emphasis> directory of the appropriate server profile
(<filename>\server\<replaceable><PROFILE></replaceable>\deploy</filename>,
for example).
@@ -59,7 +59,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Configurations_Steps-Do_not_bind_datasources_explicitly">
+ <section
id="sect-Reference_Guide-Configurations_Steps-Do_not_bind_datasources_explicitly">
<title>Do not bind datasources explicitly</title>
<para>
Do not let the portal explicitly bind datasources. Edit the
<filename><replaceable><JBOSS_HOME></replaceable>/server/<replaceable><PROFILE></replaceable>/conf/gatein/configuration.properties</filename>
and comment out the following rows in the JCR section:
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/framework-for-cross-domain-ajax.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/framework-for-cross-domain-ajax.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/framework-for-cross-domain-ajax.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,14 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Framework_for_cross_domain_AJAX">
+<chapter id="chap-Reference_Guide-Framework_for_cross_domain_AJAX">
<title>Framework for cross-domain AJAX</title>
<para>
(<ulink
url="https://anonsvn.jboss.org/repos/exo-jcr/ws/trunk/exo.ws.framewo...>)
</para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Framework_for_cross_domain_AJAX-Motivation">
+ <section
id="sect-Reference_Guide-Framework_for_cross_domain_AJAX-Motivation">
<title>Motivation</title>
<para>
XmlHttpRequest objects are bound by the same origin security policy of browsers, which
prevents a page from accessing data from another server. This has put a serious limitation
on Ajax developers: you can use XmlHttpRequests to make background calls to a server, but
it has to be the same server that served up the current page. For more details, you can
visit <ulink
url="http://www.mozilla.org/projects/security/components/same-origin...;.
@@ -25,7 +25,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Framework_for_cross_domain_AJAX-Scheme_how_it_works">
+ <section
id="sect-Reference_Guide-Framework_for_cross_domain_AJAX-Scheme_how_it_works">
<title>Scheme (how it works)</title>
<para>
To describe our method for cross-domain AJAX solution, let's consider the
following scheme contains of 3 components:
@@ -48,7 +48,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Framework_for_cross_domain_AJAX-A_Working_Sequence">
+ <section
id="sect-Reference_Guide-Framework_for_cross_domain_AJAX-A_Working_Sequence">
<title>A Working Sequence:</title>
<para>
1) A Browser requests the Start page from the ServerA
@@ -74,7 +74,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Framework_for_cross_domain_AJAX-How_to_use_it">
+ <section
id="sect-Reference_Guide-Framework_for_cross_domain_AJAX-How_to_use_it">
<title>How to use it</title>
<para>
1). Place the file client.html and xda.js on the serverA.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/groovy-scripts-as-rest-services.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/groovy-scripts-as-rest-services.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/groovy-scripts-as-rest-services.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Groovy_Scripts_as_REST_Services">
+<chapter id="chap-Reference_Guide-Groovy_Scripts_as_REST_Services">
<title>Groovy Scripts as REST Services</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Groovy_Scripts_as_REST_Services-Overview">
+ <section
id="sect-Reference_Guide-Groovy_Scripts_as_REST_Services-Overview">
<title>Overview</title>
<para>
This article describes how to use Groovy scripts as REST services. We are going to
consider these operations:
@@ -49,7 +49,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Groovy_Scripts_as_REST_Services-Loading_script_and_save_it_in_JCR">
+ <section
id="sect-Reference_Guide-Groovy_Scripts_as_REST_Services-Loading_script_and_save_it_in_JCR">
<title>Loading script and save it in JCR</title>
<para>
There are two ways to save a script in JCR. The first way is to save it at server
startup time by using configuration.xml and the second way is to upload the script via
HTTP.
@@ -115,7 +115,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Groovy_Scripts_as_REST_Services-Instantiation">
+ <section
id="sect-Reference_Guide-Groovy_Scripts_as_REST_Services-Instantiation">
<title>Instantiation</title>
<para>
org.exoplatform.services.script.groovy.GroovyScriptInstantiator is part of project
exo.core.component.script.groovy. GroovyScriptInstantiator can load script from specified
URL and parse stream that contains Groovy source code. It has possibility inject component
from Container in Groovy Class constructor. Configuration example:
@@ -127,7 +127,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Groovy_Scripts_as_REST_Services-Deploying_newly_created_Class_as_RESTful_service">
+ <section
id="sect-Reference_Guide-Groovy_Scripts_as_REST_Services-Deploying_newly_created_Class_as_RESTful_service">
<title>Deploying newly created Class as RESTful service</title>
<para>
To deploy script automatically at server startup time, its property exo:autoload must
be set as true. org.exoplatform.services.jcr.ext.script.groovy.GroovyScript2RestLoader
check JCR workspaces which were specified in configuration and deploy all auto-loadable
scripts.
@@ -162,7 +162,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Groovy_Scripts_as_REST_Services-Script_Lifecycle_Management">
+ <section
id="sect-Reference_Guide-Groovy_Scripts_as_REST_Services-Script_Lifecycle_Management">
<title>Script Lifecycle Management</title>
<para>
If GroovyScript2RestLoader configured as was decribed in the previous section, then
all "autoload" scripts deployed. In the first section, we added script from file
/home/andrew/JcrGroovyTest.groovy to JCR node /script/groovy/JcrGroovyTest.groovy,
repository repository, workspace production. In section "Load script via HTTP",
it was referred about load scripts via HTTP, there is an opportunity to manage the life
cycle of script.
@@ -236,7 +236,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Groovy_Scripts_as_REST_Services-Getting_node_UUID_example">
+ <section
id="sect-Reference_Guide-Groovy_Scripts_as_REST_Services-Getting_node_UUID_example">
<title>Getting node UUID example</title>
<para>
Now we are going to try simple example of Groovy RESTfull service. There is one
limitation, even if we use groovy, we should use Java style code and decline to use
dynamic types, but of course we can use it in private methods and fields. Create file
JcrGroovyTest.groovy, in this example I save it in my home directory
/home/andrew/JcrGroovyTest.groovy. Then, configure GroovyScript2RestLoaderPlugin as
described in section Load script at startup time.
@@ -365,7 +365,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Groovy_Scripts_as_REST_Services-Groovy_script_restrictions">
+ <section
id="sect-Reference_Guide-Groovy_Scripts_as_REST_Services-Groovy_script_restrictions">
<title>Groovy script restrictions</title>
<para>
You should keep one class per one groovy file. The same actually for interface and it
implementation. It's limitation of groovy parser that does not have type Class[]
parseClass(InputStream) or Collection parseClass(InputStream) but only Class
parseClass(InputStream) instead.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/introduction-to-rest.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/introduction-to-rest.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/introduction-to-rest.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-Introduction_to_the_Representational_State_Transfer_REST">
+<chapter
id="chap-Reference_Guide-Introduction_to_the_Representational_State_Transfer_REST">
<title>Introduction to the Representational State Transfer (REST)</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Introduction_to_the_Representational_State_Transfer_REST-Introduction">
+ <section
id="sect-Reference_Guide-Introduction_to_the_Representational_State_Transfer_REST-Introduction">
<title>Introduction</title>
<para>
<command>Representational State Transfer (REST)</command> is a style of
software architecture for distributed hypermedia systems such as the World Wide Web. The
term was introduced in the doctoral dissertation in 2000 by Roy Fielding, one of the
principal authors of the Hypertext Transfer Protocol (HTTP) specification, and has come
into widespread use in the networking community.
@@ -22,7 +22,7 @@
<para>
REST components perform actions with a resource by using a
<command>representation</command> to capture the current or intended state of
that resource and transferring that representation between components. A representation is
a sequence of bytes, plus <command>representation metadata </command>to
describe those bytes. Other commonly used but less precise names for a representation
include: <command>document, file, and HTTP message entity, instance, or
variant</command>. A representation consists of data, metadata describing the data,
and, on occasion, metadata to describe the metadata (usually for the purpose of verifying
message integrity). Metadata are in the form of name-value pairs, where the name
corresponds to a standard that defines the value's structure and semantics. The data
format of a representation is known as a media type.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Introduction-REST_Data_Elements">
+ <table id="tabl-Reference_Guide-Introduction-REST_Data_Elements">
<title>REST Data Elements</title>
<tgroup cols="2">
<thead>
@@ -101,7 +101,7 @@
<para>
REST uses various <command>connector</command> types to encapsulate the
activities of accessing resources and transferring resource representations. The
connectors present an abstract interface for component communication, enhancing simplicity
by providing a complete separation of concepts and hiding the underlying implementation of
resources and communication mechanisms.
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Introduction-REST_Connectors">
+ <table id="tabl-Reference_Guide-Introduction-REST_Connectors">
<title>REST Connectors</title>
<tgroup cols="2">
<thead>
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/overwrite-default-providers.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/overwrite-default-providers.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/overwrite-default-providers.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-OverwriteDefaultProviders">
+<chapter id="chap-Reference_Guide-OverwriteDefaultProviders">
<title>OverwriteDefaultProviders</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-OverwriteDefaultProviders-Motivation">
+ <section
id="sect-Reference_Guide-OverwriteDefaultProviders-Motivation">
<title>Motivation</title>
<para>
There is set of providers embedded in eXo JAX-RS implementation.
@@ -16,7 +16,7 @@
<para>
The next set of media and Java types processed automatically, thanks to embedded
Readers (Writers).
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-Motivation-Embedded_Reader_and_Writers_of_message_body">
+ <table
id="tabl-Reference_Guide-Motivation-Embedded_Reader_and_Writers_of_message_body">
<title>Embedded Reader and Writers of message body</title>
<tgroup cols="2">
<colspec align="center"></colspec>
@@ -180,7 +180,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-OverwriteDefaultProviders-Usage">
+ <section id="sect-Reference_Guide-OverwriteDefaultProviders-Usage">
<title>Usage</title>
<para>
To be able overwrite default JAX-RS provider(s) developer need:
@@ -209,7 +209,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-OverwriteDefaultProviders-Example">
+ <section id="sect-Reference_Guide-OverwriteDefaultProviders-Example">
<title>Example</title>
<para>
In example below see how to use Jackson JSON provider instead of embedded in eXo
RESTful framework.
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/restservicelist-service.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/restservicelist-service.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/restservicelist-service.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter
id="chap-Reference_Guide_eXo_JCR_1.14-RestServicesList_Service">
+<chapter id="chap-Reference_Guide-RestServicesList_Service">
<title>RestServicesList Service</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-RestServicesList_Service-Overview.">
+ <section id="sect-Reference_Guide-RestServicesList_Service-Overview.">
<title>Overview.</title>
<para>
RestServicesList service is intended to provide information about rest services
deployed to the application server.
@@ -37,7 +37,7 @@
</section>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-RestServicesList_Service-Usage">
+ <section id="sect-Reference_Guide-RestServicesList_Service-Usage">
<title>Usage</title>
<note>
<para>
@@ -45,7 +45,7 @@
</para>
</note>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Usage-HTML_format">
+ <section id="sect-Reference_Guide-Usage-HTML_format">
<title>HTML format</title>
<para>
To get the list of services in HTML format use listHTML() method:
@@ -108,7 +108,7 @@
<para>
If you perform the same request with your browser, you'll see the table with the
list of deployed services like this:
</para>
- <table
id="tabl-Reference_Guide_eXo_JCR_1.14-HTML_format-Root_resources">
+ <table id="tabl-Reference_Guide-HTML_format-Root_resources">
<title>Root resources</title>
<tgroup cols="3">
<thead>
@@ -196,7 +196,7 @@
</section>
- <section id="sect-Reference_Guide_eXo_JCR_1.14-Usage-JSON_format">
+ <section id="sect-Reference_Guide-Usage-JSON_format">
<title>JSON format</title>
<para>
To get the list of services in HTML format use listJSON() method:
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/ws.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/ws.xml 2011-11-25
00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws/ws.xml 2011-11-25
01:13:48 UTC (rev 8142)
@@ -1,11 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-eXo_Web_Services">
+<chapter id="chap-Reference_Guide-eXo_Web_Services">
<title>eXo Web Services</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-eXo_Web_Services-eXo_Web_Services_introduction">
+ <section
id="sect-Reference_Guide-eXo_Web_Services-eXo_Web_Services_introduction">
<title>eXo Web Services introduction</title>
<para>
The Web Services module allows eXo technology to integrate with external products and
services.
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws.xml 2011-11-25 00:48:53
UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/ws.xml 2011-11-25 01:13:48
UTC (rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-eXoWS">
+<section id="sect-Reference_Guide-eXoWS">
<title>eXoWS</title>
<xi:include href="ws/ws.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ws/introduction-to-rest.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml 2011-11-25 00:48:53 UTC
(rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml 2011-11-25 01:13:48 UTC
(rev 8142)
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
-<part
id="part-Reference_Guide_eXo_JCR_1.14-The_Java_Content_Repository_">
+<part id="part-Reference_Guide-The_Java_Content_Repository_">
<title><remark>The Java Content Repository</remark>
</title>
<!-- <xi:include href="eXoJCR/eXoJCR/jcr.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include
href="eXoJCR/jcr/intro.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"
/>
Modified: epp/docs/branches/5.2/Reference_Guide/publican.cfg
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/publican.cfg 2011-11-25 00:48:53 UTC (rev 8141)
+++ epp/docs/branches/5.2/Reference_Guide/publican.cfg 2011-11-25 01:13:48 UTC (rev 8142)
@@ -4,7 +4,7 @@
cvs_root: ":ext:cvs.devel.redhat.com:/cvs/dist"
cvs_branch: "DOCS-RHEL-6"
show_remarks: 1
-cvs_pkg:
"JBoss_Enterprise_Portal_Platform-Reference_Guide_eXo_JCR_1.14-5.2-web-__LANG__"
+cvs_pkg: "JBoss_Enterprise_Portal_Platform-Reference_Guide-5.2-web-__LANG__"
xml_lang: "en-US"
brand: JBoss
debug: 1