gatein SVN: r2644 - portal/trunk/webui/portal/src/main/java/org/exoplatform/portal/webui/navigation.
by do-not-reply＠jboss.org
Author: ndkhoiits
Date: 2010-04-14 23:02:07 -0400 (Wed, 14 Apr 2010)
New Revision: 2644
Modified:
portal/trunk/webui/portal/src/main/java/org/exoplatform/portal/webui/navigation/UIPageNodeSelector.java
Log:
Revert UIPageNodeSelector.java
Modified: portal/trunk/webui/portal/src/main/java/org/exoplatform/portal/webui/navigation/UIPageNodeSelector.java
===================================================================
--- portal/trunk/webui/portal/src/main/java/org/exoplatform/portal/webui/navigation/UIPageNodeSelector.java 2010-04-14 21:43:42 UTC (rev 2643)
+++ portal/trunk/webui/portal/src/main/java/org/exoplatform/portal/webui/navigation/UIPageNodeSelector.java 2010-04-15 03:02:07 UTC (rev 2644)
@@ -67,11 +67,9 @@
private void loadNavigations() throws Exception
{
- WebuiRequestContext context = WebuiRequestContext.getCurrentInstance();
PageNavigation portalSelectedNav = Util.getUIPortal().getSelectedNavigation();
if (portalSelectedNav != null)
{
- portalSelectedNav = PageNavigationUtils.filterNavigation(portalSelectedNav, context.getRemoteUser(), true, true);
selectNavigation(portalSelectedNav);
PageNode portalSelectedNode = Util.getUIPortal().getSelectedNode();
if (portalSelectedNode != null)
14 years, 5 months
- 1
- 0
gatein SVN: r2643 - components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies.
by do-not-reply＠jboss.org
Author: chris.laprun(a)jboss.com
Date: 2010-04-14 17:43:42 -0400 (Wed, 14 Apr 2010)
New Revision: 2643
Modified:
components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/RegistrationPolicyWrapper.java
Log:
- Updated copyright.
Modified: components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/RegistrationPolicyWrapper.java
===================================================================
--- components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/RegistrationPolicyWrapper.java 2010-04-14 20:16:55 UTC (rev 2642)
+++ components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/RegistrationPolicyWrapper.java 2010-04-14 21:43:42 UTC (rev 2643)
@@ -1,24 +1,25 @@
/*
-* JBoss, a division of Red Hat
-* Copyright 2008, Red Hat Middleware, LLC, and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, a division of Red Hat
+ * Copyright 2010, Red Hat Middleware, LLC, and individual
+ * contributors as indicated by the @authors tag. See the
+ * copyright.txt in the distribution for a full listing of
+ * individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
package org.gatein.registration.policies;
14 years, 5 months
- 1
- 0
gatein SVN: r2642 - in components/wsrp/trunk/producer/src/main/java/org/gatein: registration/policies and 1 other directories.
by do-not-reply＠jboss.org
Author: chris.laprun(a)jboss.com
Date: 2010-04-14 16:16:55 -0400 (Wed, 14 Apr 2010)
New Revision: 2642
Added:
components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/RegistrationPolicyWrapper.java
Modified:
components/wsrp/trunk/producer/src/main/java/org/gatein/registration/impl/RegistrationManagerImpl.java
components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/DefaultRegistrationPolicy.java
components/wsrp/trunk/producer/src/main/java/org/gatein/wsrp/producer/config/impl/ProducerRegistrationRequirementsImpl.java
Log:
- GTNWSRP-26: Perform minimal sanitization of consumer name before it's transformed into an id.
- Added RegistrationPolicyWrapper so that minimal sanitization is performed even on non-controlled RegistrationPolicy implementations.
Modified: components/wsrp/trunk/producer/src/main/java/org/gatein/registration/impl/RegistrationManagerImpl.java
===================================================================
--- components/wsrp/trunk/producer/src/main/java/org/gatein/registration/impl/RegistrationManagerImpl.java 2010-04-14 15:35:52 UTC (rev 2641)
+++ components/wsrp/trunk/producer/src/main/java/org/gatein/registration/impl/RegistrationManagerImpl.java 2010-04-14 20:16:55 UTC (rev 2642)
@@ -107,7 +107,7 @@
// check with policy if we allow the consumer
policy.validateConsumerName(name);
- String identity = policy.getConsumerIdFrom(name, Collections.EMPTY_MAP);
+ String identity = policy.getConsumerIdFrom(name, Collections.<QName, Object>emptyMap());
Consumer consumer = persistenceManager.createConsumer(identity, name);
Modified: components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/DefaultRegistrationPolicy.java
===================================================================
--- components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/DefaultRegistrationPolicy.java 2010-04-14 15:35:52 UTC (rev 2641)
+++ components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/DefaultRegistrationPolicy.java 2010-04-14 20:16:55 UTC (rev 2642)
@@ -162,11 +162,10 @@
return null;
}
- /** Simply returns the given consumer name, trusted (!) to be unique. */
+ /** Compute a simple, safe id based on the provided consumer name trusted (!) to be unique. */
public String getConsumerIdFrom(String consumerName, Map<QName, Object> registrationProperties) throws IllegalArgumentException, InvalidConsumerDataException
{
- ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(consumerName, "Consumer name", null);
- return consumerName;
+ return RegistrationPolicyWrapper.sanitizeConsumerName(consumerName);
}
/** Rejects registration if a Consumer with the specified name already exists. */
Added: components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/RegistrationPolicyWrapper.java
===================================================================
--- components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/RegistrationPolicyWrapper.java (rev 0)
+++ components/wsrp/trunk/producer/src/main/java/org/gatein/registration/policies/RegistrationPolicyWrapper.java 2010-04-14 20:16:55 UTC (rev 2642)
@@ -0,0 +1,110 @@
+/*
+* JBoss, a division of Red Hat
+* Copyright 2008, Red Hat Middleware, LLC, and individual contributors as indicated
+* by the @authors tag. See the copyright.txt in the distribution for a
+* full listing of individual contributors.
+*
+* This is free software; you can redistribute it and/or modify it
+* under the terms of the GNU Lesser General Public License as
+* published by the Free Software Foundation; either version 2.1 of
+* the License, or (at your option) any later version.
+*
+* This software is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+* Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public
+* License along with this software; if not, write to the Free
+* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+*/
+
+package org.gatein.registration.policies;
+
+import org.gatein.common.util.ParameterValidation;
+import org.gatein.registration.InvalidConsumerDataException;
+import org.gatein.registration.RegistrationException;
+import org.gatein.registration.RegistrationManager;
+import org.gatein.registration.RegistrationPolicy;
+import org.gatein.wsrp.registration.PropertyDescription;
+
+import javax.xml.namespace.QName;
+import java.util.Map;
+
+/**
+ * @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a>
+ * @version $Revision$
+ */
+public class RegistrationPolicyWrapper implements RegistrationPolicy
+{
+ private final RegistrationPolicy delegate;
+
+ public RegistrationPolicyWrapper(RegistrationPolicy delegate)
+ {
+ ParameterValidation.throwIllegalArgExceptionIfNull(delegate, "Delegate");
+ this.delegate = delegate;
+ }
+
+ public void validateRegistrationDataFor(Map<QName, Object> registrationProperties, String consumerIdentity)
+ throws IllegalArgumentException, RegistrationException
+ {
+ delegate.validateRegistrationDataFor(registrationProperties, consumerIdentity);
+ }
+
+ public String createRegistrationHandleFor(String registrationId)
+ throws IllegalArgumentException
+ {
+ return delegate.createRegistrationHandleFor(registrationId);
+ }
+
+ public String getAutomaticGroupNameFor(String consumerName)
+ throws IllegalArgumentException
+ {
+ return delegate.getAutomaticGroupNameFor(consumerName);
+ }
+
+ public String getConsumerIdFrom(String consumerName, Map<QName, Object> registrationProperties)
+ throws IllegalArgumentException, InvalidConsumerDataException
+ {
+ return delegate.getConsumerIdFrom(sanitizeConsumerName(consumerName), registrationProperties);
+ }
+
+ public void validateConsumerName(String consumerName)
+ throws IllegalArgumentException, RegistrationException
+ {
+ delegate.validateConsumerName(consumerName);
+ }
+
+ public void validateConsumerGroupName(String groupName)
+ throws IllegalArgumentException, RegistrationException
+ {
+ delegate.validateConsumerGroupName(groupName);
+ }
+
+ public RegistrationManager getManager()
+ {
+ return delegate.getManager();
+ }
+
+ public void setManager(RegistrationManager manager)
+ {
+ delegate.setManager(manager);
+ }
+
+ public void setExpectations(Map<QName, ? extends PropertyDescription> registrationPropertyDescriptions)
+ {
+ delegate.setExpectations(registrationPropertyDescriptions);
+ }
+
+ static String sanitizeConsumerName(String consumerName)
+ {
+ ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(consumerName, "Consumer name", null);
+ consumerName = consumerName.trim();
+ consumerName = consumerName.replaceAll(",", "_");
+ consumerName = consumerName.replaceAll(" ", "_");
+ consumerName = consumerName.replaceAll("/", "_");
+
+ return consumerName;
+ }
+}
Modified: components/wsrp/trunk/producer/src/main/java/org/gatein/wsrp/producer/config/impl/ProducerRegistrationRequirementsImpl.java
===================================================================
--- components/wsrp/trunk/producer/src/main/java/org/gatein/wsrp/producer/config/impl/ProducerRegistrationRequirementsImpl.java 2010-04-14 15:35:52 UTC (rev 2641)
+++ components/wsrp/trunk/producer/src/main/java/org/gatein/wsrp/producer/config/impl/ProducerRegistrationRequirementsImpl.java 2010-04-14 20:16:55 UTC (rev 2642)
@@ -29,6 +29,7 @@
import org.gatein.registration.RegistrationPropertyChangeListener;
import org.gatein.registration.policies.DefaultRegistrationPolicy;
import org.gatein.registration.policies.DefaultRegistrationPropertyValidator;
+import org.gatein.registration.policies.RegistrationPolicyWrapper;
import org.gatein.registration.policies.RegistrationPropertyValidator;
import org.gatein.wsrp.WSRPConstants;
import org.gatein.wsrp.producer.config.ProducerRegistrationRequirements;
@@ -301,7 +302,11 @@
throw new IllegalArgumentException("Policy class does not implement RegistrationPolicy!");
}
RegistrationPolicy policy = (RegistrationPolicy)policyClass.newInstance();
- setPolicy(policy);
+
+ // wrap policy so that we can perform minimal sanitization of values
+ RegistrationPolicyWrapper wrapper = new RegistrationPolicyWrapper(policy);
+
+ setPolicy(wrapper);
}
catch (ClassNotFoundException e)
{
14 years, 5 months
- 1
- 0
gatein SVN: r2641 - portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US.
by do-not-reply＠jboss.org
Author: thomas.heute(a)jboss.com
Date: 2010-04-14 11:35:52 -0400 (Wed, 14 Apr 2010)
New Revision: 2641
Added:
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/EMailServiceConfiguration.xml
Removed:
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Databases.xml
Modified:
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Configuration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation_Guide.xml
Log:
JBEPP-175: Installation guide update
Added: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml (rev 0)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml 2010-04-14 15:35:52 UTC (rev 2641)
@@ -0,0 +1,61 @@
+<?xml version='1.0'?>
+<!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 "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="sect-Reference_Guide-Clustering_Configuration">
+ <title>Clustering Configuration</title>
+
+ <section id="sect-Reference_Guide-Clustering_Configuration-Overview">
+ <title>Overview</title>
+ <para>EPP has been developed to support high availability and high horizontal and vertical scalability.
+ The setup instructions has been kept to the minimal, but a good understanding of clustering services in
+ EAP and JBoss Cache would be reuired for optimal settings.
+ </para>
+ </section>
+
+ <section id="sect-Reference_Guide-Clustering_Configuration-Prerequisite">
+ <title>Prerequisite</title>
+ <para>As EPP requires the clustering services to run, only the <literal>all</literal>
+ and <literal>configuration</literal> can be used.</para>
+ <para>A rapid shared filesystem is also required such as a Storage Area Network (SAN).</para>
+ <para>Databases should be shared among the various nodes of the cluster and configured to point to the same instances.</para>
+ </section>
+
+ <section id="sect-Reference_Guide-Clustering_Properties">
+ <title>configuration.properties</title>
+ <para>Edit $EPP_HOME/jboss-as/server/$CONFIG/conf/gatein/configuration.properties to edit:</para>
+ <itemizedlist>
+ <listitem><para><literal>gatein.jcr.storage.data.dir</literal> to specify the location of the shared filesystem</para></listitem>
+ <listitem><para><literal>gatein.jcr.index.data.dir</literal> to specify the location on a shared filesystem to store data</para></listitem>
+ <listitem><para><literal>gatein.jcr.changefilterclass</literal> must be changed to org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter</para></listitem>
+ <listitem><para><literal>gatein.jcr.config.type</literal> must be changed to cluster</para></listitem>
+ </itemizedlist>
+ <para>
+ The default property file would look like:
+ <programlisting># Data
+gatein.data.dir=/mnt/shared/mylocation
+
+# DB
+gatein.db.data.dir=${gatein.data.dir}/db
+
+# JCR
+gatein.jcr.config.type=cluster
+gatein.jcr.datasource.name=java:gatein-jcr
+gatein.jcr.datasource.dialect=auto
+
+gatein.jcr.data.dir=${gatein.data.dir}/jcr
+gatein.jcr.storage.data.dir=${gatein.jcr.data.dir}/values
+gatein.jcr.index.data.dir=${gatein.jcr.data.dir}/lucene
+gatein.jcr.index.changefilterclass=org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter
+
+[...]</programlisting>
+ </para>
+ </section>
+
+ <section id="sect-Reference_Guide-Clustering_Running">
+ <title>Running with the cluster profile</title>
+ <para>To run the portal ready for clustering, you would need to start all nodes with the extra profile like:
+ <literal>run.sh -c all -Dexo.profiles=cluster</literal> (Or run.bat -c all -Dexo.profiles=cluster on Windows)</para>
+ </section>
+</section>
\ No newline at end of file
Property changes on: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Configuration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Configuration.xml 2010-04-14 15:00:02 UTC (rev 2640)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Configuration.xml 2010-04-14 15:35:52 UTC (rev 2641)
@@ -3,94 +3,13 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter>
- <title>Database Configuration</title>
-
- <section id="sect-Portal_EAP-Configuration-Installing_an_RDBMS_JDBC_connector">
- <title>Installing an RDBMS JDBC connector</title>
- <para>
- A relational database management system (RDBMS) Java Database Connectivity (JDBC) connector is required for &PRODUCT; to communicate with a database.
- &PRODUCT; comes bundled with Hypersonic SQL (HSQL) database so that users can get up and running quickly without having to initially set up
- a database. However, HSQL should not be used in a production environment. Removing HSQL is simply a matter of removing
- <remark><filename>JBOSS_DIST/jboss-as/server/$CONFIG/deploy/hsql-ds.xml</filename>.</remark>
- </para>
- <para>
- Test suites have been run against
- the <trademark class="registered">Oracle</trademark> 9, <trademark class="registered">Oracle</trademark> 10, <trademark class="registered">Microsoft SQL Server</trademark>,
- MySQL 4, MySQL 5, and PostgreSQL 8 databases - these databases are recommended for production use. Please refer to your database documentation for the correct
- RDBMS JDBC connector to use. The MySQL RDBMS JDBC connector can be downloaded from <ulink url="http://www.mysql.com/products/connector/j/"></ulink>, and the
- PostgreSQL RDBMS JDBC connector can be downloaded from <ulink url="http://jdbc.postgresql.org/download.html"></ulink>.
- </para>
- <para>
- Refer to the help files in each download for installation instructions. In most cases, the RDBMS JDBC connector comes as a <computeroutput>.jar</computeroutput> file within the downloaded zip file. Copy this file into the <filename>$JBOSS_HOME/server/<replaceable>$CONFIG</replaceable>/lib/</filename> directory.
- </para>
- </section>
-
- <section id="sect-Portal_EAP-Configuration-Datasource_Descriptors">
- <title>Datasource Descriptors</title>
- <para>
- A Datasource descriptor is required for JBoss Portal to communicate with a database. Sample Datasource descriptor files are provided for the Hypersonic SQL, <trademark class="registered">Microsoft SQL Server</trademark>, MySQL, <trademark class="registered">Oracle</trademark>, and PostgreSQL databases. These can be found in the <remark><filename>$JBOSS_HOME/jboss-as/docs/examples/jca</filename></remark> directory.
- </para>
- <para>
- The sample Datasource descriptors will work with default installations of external databases; however, you may need to configure the correct username and password. As indicated in the mysql-ds.xml file displayed below, the sample MySQL and PostgreSQL Datasource descriptors assume the name of the database to be <remark><computeroutput>jbossdb</computeroutput></remark>.
- </para>
- <para>
- Copy the required Datasource descriptor file to the <filename>$JBOSS_HOME/server/<replaceable>$CONFIG</replaceable>/deploy/</filename> directory. When copying a Datasource descriptor for MySQL, <trademark class="registered">Microsoft SQL Server</trademark>, PostgreSQL, or <trademark class="registered">Oracle</trademark> databases, change the <computeroutput><user-name><replaceable>portal</replaceable></user-name></computeroutput> and <computeroutput><password><replaceable>portalpassword</replaceable></password></computeroutput> sections to reflect the correct username and password of the user who has access to the jbossportal database.
- </para>
- <important>
- <title>Important: Various Datasource Descriptors</title>
- <para>
- Ensure that there is only one Datasource descriptor in the <filename>$JBOSS_HOME/server/<replaceable>$CONFIG</replaceable>/deploy/</filename> directory. For example, if you want to use a MySQL database, remove the <filename>hsqldb-ds.xml</filename> file and any other descriptors. For a default configuration this will require removing the <filename>gatein-ds.xml</filename> and <filename>hsqldb-ds.xml</filename> files to use a MySQL database.
- </para>
- </important>
- <para>
- The following is an example Datasource descriptor file for MySQL 5:
- </para>
- <para><remark>Note to Reviewer</remark></para>
- <para>This is copied directly from th sample provided in jboss-as/docs/examples/jca/</para>
- <para><remark>End Note to Reviewer</remark></para>
- <para>
-<screen><?xml version="1.0" encoding="UTF-8"?>
+<chapter id="chapter-Reference_Guide-Configuration">
+ <title>Configuration</title>
-<!-- See http://www.jboss.org/community/wiki/Multiple1PC for information about local-tx-datasource -->
-<!-- $Id: mysql-ds.xml 88948 2009-05-15 14:09:08Z jesper.pedersen $ -->
-<!-- Datasource config for MySQL using 3.0.9 available from:
- http://www.mysql.com/downloads/api-jdbc-stable.html
--->
+ <xi:include href="DatabaseConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="EMailServiceConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="ClusteringConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-<datasources>
- <local-tx-datasource>
- <jndi-name>MySqlDS</jndi-name>
- <connection-url>jdbc:mysql://mysql-hostname:3306/jbossdb</connection-url>
- <driver-class>com.mysql.jdbc.Driver</driver-class>
- <user-name>x</user-name>
- <password>y</password>
- <exception-sorter-class-name>
- org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter
- </exception-sorter-class-name>
- <!-- should only be used on drivers after 3.22.1 with "ping" support
- <valid-connection-checker-class-name>
- org.jboss.resource.adapter.jdbc.vendor.MySQLValidConnectionChecker
- </valid-connection-checker-class-name>
- -->
- <!-- sql to call when connection is created
- <new-connection-sql>some arbitrary sql</new-connection-sql>
- -->
- <!-- sql to call on an existing pooled connection when it is obtained from pool -
- MySQLValidConnectionChecker is preferred for newer drivers
- <check-valid-connection-sql>
- some arbitrary sql
- </check-valid-connection-sql>
- -->
- <!-- corresponding type-mapping in the standardjbosscmp-jdbc.xml (optional) -->
- <metadata>
- <type-mapping>mySQL</type-mapping>
- </metadata>
- </local-tx-datasource>
-</datasources></screen>
- </para>
- </section>
-
</chapter>
Added: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml (rev 0)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml 2010-04-14 15:35:52 UTC (rev 2641)
@@ -0,0 +1,298 @@
+<?xml version='1.0'?>
+<!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 "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="sect-Reference_Guide-Database_Configuration">
+ <title>Database Configuration</title>
+
+ <section id="sect-Reference_Guide-Database_Configuration-Overview">
+ <title>Overview</title>
+
+ <para>
+ A relational database management system (RDBMS) Java Database Connectivity (JDBC) connector is required for &PRODUCT; to communicate with a database.
+ &PRODUCT; comes bundled with Hypersonic SQL (HSQL) database so that users can get up and running quickly without having to initially set up
+ a database. However, HSQL should not be used in a production environment.
+ </para>
+
+ <para>&PRODUCT; has two different database dependencies. One is the
+ identity service configuration, which depends on the Hibernate. The other
+ database dependency is Java content repository (JCR) service, which
+ depends on the native JDBC API and it can integrate with any existing
+ datasource implementation.</para>
+
+ <para>When you start the portal for the first time,
+ it will automatically create the proper schema (assuming that the
+ database user has the appropriate permissions).</para>
+
+ <note><para>&PRODUCT; assumes the default encoding for your database is
+ <literal>latin1</literal> . You will need to change this parameter for
+ your database in order to work properly.</para></note>
+ </section>
+
+ <section id="sect-Reference_Guide-Database_Configuration-JCR_database_configuration">
+ <title>Configuring the database for JCR</title>
+
+ <para>To configure the database used by JCR you will need to edit the
+ datasource descriptor located at
+ $JBOSS_HOME/server/default/deploy/gatein-ds.xml:<programlisting><no-tx-datasource>
+ <jndi-name>gatein-jcr</jndi-name>
+ <connection-url>jdbc:hsqldb:${jboss.server.data.dir}${/}gatein${/}hypersonic${/}gatein-jcr-localDB</connection-url>
+ <driver-class>org.hsqldb.jdbcDriver</driver-class>
+ <user-name>sa</user-name>
+ <password></password>
+
+ <min-pool-size>5</min-pool-size>
+ <max-pool-size>20</max-pool-size>
+ <idle-timeout-minutes>0</idle-timeout-minutes>
+ <prepared-statement-cache-size>32</prepared-statement-cache-size>
+</no-tx-datasource></programlisting></para>
+
+ <para>And edit the values of driver-class, connection-url, usern-ame and
+ password with the values for your database (Please refer to your database
+ JDBC driver documentation).</para>
+
+ <para>In the case of HSQL the databases are created automatically, for any
+ other database you will need to create a database.</para>
+
+ <para>Make sure the user has rights to create tables on the database and
+ to update them as during the first startup they will be automatically
+ created.</para>
+
+ <para>Also add the JDBC driver into the classpath, for instance in
+ $JBOSS_HOME/server/default/lib</para>
+
+
+ </section>
+
+ <section>
+ <title>Configuring the database for the default identity store</title>
+
+ <para>By default users are stored in database. To change the database to
+ store users, you will need to edit the file:</para>
+
+ <para><programlisting>$JBOSS_HOME/server/default/deploy/gatein-ds.xml</programlisting></para>
+
+ <para>You will find the same kind of configuration as For JCR:</para>
+
+ <para><programlisting> <no-tx-datasource>
+ <jndi-name>gatein-jcr</jndi-name>
+ <connection-url>jdbc:hsqldb:${jboss.server.data.dir}${/}gatein${/}hypersonic${/}gatein-jcr-localDB</connection-url>
+ <driver-class>org.hsqldb.jdbcDriver</driver-class>
+ <user-name>sa</user-name>
+ <password></password>
+
+ <min-pool-size>5</min-pool-size>
+ <max-pool-size>20</max-pool-size>
+ <idle-timeout-minutes>0</idle-timeout-minutes>
+ <prepared-statement-cache-size>32</prepared-statement-cache-size>
+ </no-tx-datasource>
+</programlisting></para>
+
+ <para>More information about setting up datasources can be found in the
+ Enterprise Application Platform documentation.</para>
+ </section>
+
+ <section>
+ <title>Example with MySQL</title>
+ <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Installing_the_MySQL_RDBMS_JDBC_connector">
+ <title>Installing the MySQL RDBMS JDBC connector</title>
+ <para>
+ The RDBMS JDBC MySQL connector is required for EPP to use a MySQL database:
+ </para>
+ </formalpara>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ Navigate to the <ulink url="http://dev.mysql.com/downloads/connector/j/3.1.html">JDBC MySQL connector</ulink> section of dev.mysql.com. Download the <computeroutput>Compressed Tar Archive (.tar.gz)</computeroutput> file or the <computeroutput>Zip Archive (.zip)</computeroutput> file.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Unzip the <filename>mysql-java-connector</filename> into the desired directory. It does not matter which directory is used.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change into the directory to which the <filename>mysql-java-connector</filename> was extracted. Copy the <filename>mysql-connector-java-<replaceable>version-number</replaceable>-bin.jar</filename> file into the <filename>$JBOSS_HOME/server/<replaceable>$CONFIG</replaceable>/lib/</filename> directory.
+ </para>
+ </listitem>
+ </orderedlist>
+
+ <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database">
+ <title>Creating a MySQL Database</title>
+ <para>
+ If you have just installed MySQL, make sure the MySQL server is running, and then run the following command to set the root user password:
+ </para>
+ </formalpara>
+ <para>
+<screen>
+mysqladmin -u root password '<replaceable>new-root-user-password</replaceable>'
+</screen>
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Run the following command to log in to MySQL. Enter the root user password when prompted:
+ </para>
+ <para>
+<screen>
+mysql -u root -p
+</screen>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Use the <command>CREATE DATABASE</command> command to create a new gateinjcr database. Note: the rest of this guide, and configuration examples following here after, assume the database names to be gatein-jcr and gatein-idm. If you change the database names, please change the name in all gatein-dsl.xml:
+ </para>
+ <para>
+<screen>
+mysql> CREATE DATABASE gatein-idm;
+</screen>
+ </para>
+ <para>
+ The output should be similar to the following:
+ </para>
+ <para>
+<screen>
+Query OK, 1 row affected (0.00 sec)
+</screen>
+ </para>
+ <para>
+ Do the same with gateinjcr. At this point, the <command>SHOW DATABASES;</command> command should display the <command>gatein</command> databases:
+ </para>
+ <para>
+<screen>
+mysql> SHOW DATABASES;
++--------------------+
+| Database |
++--------------------+
+| information_schema |
+| gateinjcr |
+| gateinidm |
+| mysql |
++--------------------+
+4 rows in set (0.00 sec)
+</screen>
+ </para>
+ <para>
+ It is safe to ignore the other databases.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add a new user and give that user access to the gatein databases. The following example adds a new user named <computeroutput>gateinuser</computeroutput>, with the password <computeroutput>gateinpassword</computeroutput>. It is recommended that you choose a different password to the one supplied here by changing <replaceable>gateinpassword</replaceable> to some other password:
+ </para>
+ <screen>CREATE USER 'gateinuser'@'localhost' IDENTIFIED BY 'gateinpassword';</screen>
+ </listitem>
+ <listitem>
+ <para>
+ Grant the necessary privileges to the user:
+ </para>
+ <para>
+<screen>
+mysql> GRANT ALL PRIVILEGES ON gateinjcr.* TO '<replaceable>gateinuser</replaceable>'@'localhost'
+IDENTIFIED BY '<replaceable>gateinpassword</replaceable>' WITH GRANT OPTION;
+</screen>
+<screen>
+mysql> GRANT ALL PRIVILEGES ON gateinidm.* TO '<replaceable>gateinuser</replaceable>'@'localhost'
+IDENTIFIED BY '<replaceable>gateinpassword</replaceable>' WITH GRANT OPTION;
+</screen>
+ </para>
+ <note><title>Note: Changed Password?</title>
+ <para>
+ If you changed the portal user's password, remember to also change the password in the MySQL Datasource descriptor.
+ </para>
+ </note>
+ </listitem>
+ </orderedlist>
+
+ <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-MySQL_Datasource_Descriptor">
+ <title>MySQL Datasource Descriptor</title>
+ <para>
+ We now need to change the portal database descriptor
+ </para>
+ </formalpara>
+ <orderedlist>
+ <listitem>
+ <para>
+ Edit the file located at $JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Update the following lines in the Datasource descriptor to reflect the correct database, username and password respectively:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <computeroutput><connection-url>jdbc:mysql://mysql-hostname:3306/<replaceable>DATABASE</replaceable></connection-url></computeroutput>;
+ <itemizedlist>
+ <listitem>
+ <para>
+ In this example the database name is <literal>gateinjcr</literal>. (And <literal>gateinidm</literal> for the other datasource)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <computeroutput><user-name><replaceable>USER-NAME</replaceable></user-name></computeroutput>;
+ <itemizedlist>
+ <listitem>
+ <para>
+ The user-name for this example is <literal>gateinuser</literal>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <computeroutput><password><replaceable>gateinpassword</replaceable></password></computeroutput>;
+ <itemizedlist>
+ <listitem>
+ <para>
+ This example uses the <literal>portalpassword</literal> password. Enter this or the password chosen at <xref linkend="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"></xref>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </orderedlist>
+
+ <para><literal>gatein-ds.xml</literal> will then look like:</para>
+ <programlisting><![CDATA[<datasources>
+ <no-tx-datasource>
+ <jndi-name>gatein-idm</jndi-name>
+ <connection-url>jdbc:mysql://mysql-hostname:3306/gateinidm</connection-url>
+ <driver-class>com.mysql.jdbc.Driver</driver-class>
+ <user-name>gateinuser</user-name>
+ <password>gateinpassword</password>
+
+ <min-pool-size>5</min-pool-size>
+ <max-pool-size>20</max-pool-size>
+ <idle-timeout-minutes>0</idle-timeout-minutes>
+ <prepared-statement-cache-size>32</prepared-statement-cache-size>
+ </no-tx-datasource>
+
+ <no-tx-datasource>
+ <jndi-name>gatein-jcr</jndi-name>
+ <connection-url>jdbc:mysql://mysql-hostname:3306/gateinjcr</connection-url>
+ <driver-class>com.mysql.jdbc.Driver</driver-class>
+ <user-name>gateinuser</user-name>
+ <password>gateinpassword</password>
+
+ <min-pool-size>5</min-pool-size>
+ <max-pool-size>20</max-pool-size>
+ <idle-timeout-minutes>0</idle-timeout-minutes>
+ <prepared-statement-cache-size>32</prepared-statement-cache-size>
+ </no-tx-datasource>
+</datasources>]]> </programlisting>
+
+ </section>
+</section>
\ No newline at end of file
Property changes on: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Deleted: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Databases.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Databases.xml 2010-04-14 15:00:02 UTC (rev 2640)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Databases.xml 2010-04-14 15:35:52 UTC (rev 2641)
@@ -1,226 +0,0 @@
-<?xml version='1.0'?>
-<!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 "Installation_Guide.ent">
-%BOOK_ENTITIES;
-]>
-
-<chapter id="chap-Portal_EAP-Databases">
- <title>Databases</title>
- <para>
- The following chapter describes how to set up the JDBC connector, the MySQL database and the database user.
- </para>
-
- <section id="sect-Portal_EAP-Databases-Using_a_MySQL_Database">
- <title>Using a MySQL Database</title>
- <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Installing_the_MySQL_RDBMS_JDBC_connector">
- <title>Installing the MySQL RDBMS JDBC connector</title>
- <para>
- The RDBMS JDBC MySQL connector is required for JBoss Portal to use a MySQL database:
- </para>
- </formalpara>
-
- <orderedlist>
- <listitem>
- <para>
- Navigate to the <ulink url="http://dev.mysql.com/downloads/connector/j/3.1.html">JDBC MySQL connector</ulink> section of dev.mysql.com. Download the <computeroutput>Compressed Tar Archive (.tar.gz)</computeroutput> file or the <computeroutput>Zip Archive (.zip)</computeroutput> file.
- </para>
- </listitem>
- <listitem>
- <para>
- Unzip the <filename>mysql-java-connector</filename> into the desired directory. It does not matter which directory is used.
- </para>
- </listitem>
- <listitem>
- <para>
- Change into the directory to which the <filename>mysql-java-connector</filename> was extracted. Copy the <filename>mysql-connector-java-<replaceable>version-number</replaceable>-bin.jar</filename> file into the <filename>$JBOSS_HOME/server/<replaceable>$CONFIG</replaceable>/lib/</filename> directory.
- </para>
- </listitem>
- </orderedlist>
-
- <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Data_Truncation_Errors">
- <title>Data Truncation Errors</title>
- <para>
- If you are running MySQL 5, data truncation errors such as the following may occur:
- </para>
- </formalpara>
- <para>
-<screen>
-ERROR JDBCExceptionReporter Data truncation: Data too long for column 'jbp_viewrealemail' at row 1
-</screen>
- </para>
- <para>
- If you are running MySQL in strict mode, remove <computeroutput>STRICT_TRANS_TABLES</computeroutput> from the <quote><computeroutput>sql-mode =</computeroutput></quote> line of the relevant configuration file. For Linux, this is the <filename>my.cnf</filename> file. For <trademark class="registered">Windows</trademark>, edit the <filename>my.cfg</filename> file. For further information, please see <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=AvoidMySQL5DataTruncationErrors"></ulink>.
- </para>
-
-
- <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database">
- <title>Creating a MySQL Database</title>
- <para>
- If you have just installed MySQL, make sure the MySQL server is running, and then run the following command to set the root user password:
- </para>
- </formalpara>
- <para>
-<screen>
-mysqladmin -u root password '<replaceable>new-root-user-password</replaceable>'
-</screen>
- </para>
- <orderedlist>
- <listitem>
- <para>
- Run the following command to log in to MySQL. Enter the root user password when prompted:
- </para>
- <para>
-<screen>
-mysql -u root -p
-</screen>
- </para>
- </listitem>
- <listitem>
- <para>
- Use the <command>CREATE DATABASE</command> command to create a new jbossportal database. Note: the rest of this guide, and configuration examples following here after, assume the database name to be jbossportal. If you change the database name, please change the name in all necessary configuration files:
- </para>
- <para>
-<screen>
-mysql> CREATE DATABASE jbossportal;
-</screen>
- </para>
- <para>
- The output should be similar to the following:
- </para>
- <para>
-<screen>
-Query OK, 1 row affected (0.00 sec)
-</screen>
- </para>
- <para>
- At this point, the <command>SHOW DATABASES;</command> command should display the <command>jbossportal</command> database:
- </para>
- <para>
-<screen>
-mysql> SHOW DATABASES;
-+--------------------+
-| Database |
-+--------------------+
-| information_schema |
-| jbossportal |
-| mysql |
-+--------------------+
-3 rows in set (0.00 sec)
-</screen>
- </para>
- <para>
- It is safe to ignore the other databases.
- </para>
- </listitem>
- <listitem>
- <para>
- Add a new user and give that user access to the jbossportal database. The following example adds a new user named <computeroutput>portal</computeroutput>, with the password <computeroutput>portalpassword</computeroutput>. It is recommended that you choose a different password to the one supplied here by changing <replaceable>portalpassword</replaceable> to some other password:
- </para>
- <screen>CREATE USER 'portal'@'localhost' IDENTIFIED BY 'portalpassword';</screen>
- </listitem>
- <listitem>
- <para>
- Grant the necessary privileges to the user:
- </para>
- <para>
-<screen>
-mysql> GRANT ALL PRIVILEGES ON jbossportal.* TO '<replaceable>portal</replaceable>'@'localhost'
-IDENTIFIED BY '<replaceable>portalpassword</replaceable>' WITH GRANT OPTION;
-</screen>
- </para>
- <para>
- The output should be similar to the following:
- </para>
- <para>
-<screen>
-Query OK, 0 rows affected (0.00 sec)
-</screen>
- </para>
- <note><title>Note: Changed Password?</title>
- <para>
- If you changed the portal user's password, remember to also change the password in the MySQL Datasource descriptor.
- </para>
- </note>
- </listitem>
- </orderedlist>
-
- <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-MySQL_Datasource_Descriptor">
- <title>MySQL Datasource Descriptor</title>
- <para>
- To install the MySQL Datasource descriptor:
- </para>
- </formalpara>
- <orderedlist>
- <listitem>
- <para>
- Copy the MySQL Datasource descriptor - <filename>$JBOSS_HOME/docs/examples/jca/mysql-ds.xml</filename> - into the <filename>$JBOSS_HOME/server/<replaceable>$CONFIG</replaceable>/deploy/</filename> directory.
- </para>
- </listitem>
- <listitem>
- <para>
- Update the following lines in the Datasource descriptor to reflect the correct database, user-name and password respectively:
- <itemizedlist>
- <listitem>
- <para>
- <computeroutput><connection-url>jdbc:mysql://mysql-hostname:3306/<replaceable>DATABASE</replaceable></connection-url></computeroutput>;
- <itemizedlist>
- <listitem>
- <para>
- In this example the database name is <literal>jbossportal</literal>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- <listitem>
- <para>
- <computeroutput><user-name><replaceable>USER-NAME</replaceable></user-name></computeroutput>;
- <itemizedlist>
- <listitem>
- <para>
- The user-name for this example is <literal>portal</literal>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- <listitem>
- <para>
- <computeroutput><password><replaceable>PASSWORD</replaceable></password></computeroutput>;
- <itemizedlist>
- <listitem>
- <para>
- This example uses the <literal>portalpassword</literal> password. Enter this or the password chosen at <xref linkend="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"></xref>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </orderedlist>
-
- <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-MySQL_Table_Errors">
- <title>MySQL Table Errors</title>
- <para>
- Tables are set up automatically when JBoss Portal first starts. Initially, two users will be stored in the jbossportal MySQL database: a standard user with the username user, and the password user, and an administrative user with the username admin, and the password admin. Since the database tables are created during initial startup, errors such as the following may occur, but are safe to ignore:
- </para>
- </formalpara>
- <para>
-<screen>
-WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
-ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_repositoryentry' doesn't exist
-WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
-ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_version_refs' doesn't exist
-WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
-ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_wsp_node' doesn't exist
-WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
-ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_cmsentry' doesn't exist
-WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
-</screen>
- </para>
- </section>
-
-</chapter>
-
Added: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/EMailServiceConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/EMailServiceConfiguration.xml (rev 0)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/EMailServiceConfiguration.xml 2010-04-14 15:35:52 UTC (rev 2641)
@@ -0,0 +1,45 @@
+<?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 "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="sect-Reference_Guide-EMail_Service_Configuration">
+ <title>E-Mail Service Configuration</title>
+
+ <section id="sect-Reference_Guide-EMail_Service_Configuration-Overview">
+ <title>Overview</title>
+
+ <para>&PRODUCT; 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.</para>
+
+ </section>
+
+ <section id="sect-Reference_Guide-EMail_Service_Configuration-Parameters">
+ <title>Configuring the outgoing e-mail account</title>
+
+ <para>The e-mail service can use any SMTP account configured in
+ $JBOSS_HOME/server/default/conf/gatein/configuration.properties</para>
+
+ <para>The relevant section looks like:</para>
+
+ <programlisting># EMail
+gatein.email.smtp.username=
+gatein.email.smtp.password=
+gatein.email.smtp.host=smtp.gmail.com
+gatein.email.smtp.port=465
+gatein.email.smtp.starttls.enable=true
+gatein.email.smtp.auth=true
+gatein.email.smtp.socketFactory.port=465
+gatein.email.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory</programlisting>
+
+ <para>It is preconfigured for GMail, so that any GMail account can easily be used (simply use the full GMail address
+ as username, and fill-in the password.</para>
+
+ <para>In corporate environments you will want to use your corporate SMTP gateway. When using it over SSL,
+ like in default configuration, you may need to configure a certificate truststore, containing your SMTP server's
+ public certificate. Depending on the key sizes, you may then also need to install Java Cryptography Extension (JCE)
+ Unlimited Strength Jurisdiction Policy Files for your Java Runtime Environment.</para>
+ </section>
+</section>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml 2010-04-14 15:00:02 UTC (rev 2640)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml 2010-04-14 15:35:52 UTC (rev 2641)
@@ -11,13 +11,21 @@
<para>
You must have adequate disk space<!--TODO how much --> to install JDK and &PRODUCT; while also allowing enough space for your applications. Before installing &PRODUCT; you must have a working installation of Java. Since JBoss is 100% pure Java you can have it working on any Operating System / Platform that supports Java. However, there are a few Operating System-specific issues that you should be aware of. Refer to <ulink url="http://www.jboss.org/community/docs/DOC-10687"></ulink> for more information.
</para>
+ <section id="Pre_Requisites-EAP">
+ <title>Enterprise Application Platform</title>
+ <para>The Enterprise Portal Platform 5.0 is built upon the Enterprise Application Platform 5.0.
+ For more details about the underlying platform such as difference between the 4.3 and 5.0 versions, please refer to
+ the EAP installation guide available at: <ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/"></ulink>
+
+ </para>
+ </section>
<section id="Pre_Requisites-Hardware_and_Operating_System_Requirements">
- <title>Hardware and Operating System Requirements</title>
+ <title>System Requirements</title>
- <para>For the latest information on supported Operating System / JVM combinations and supported Database platforms, please refer to <ulink url="http://www.jboss.com/products/platforms/application/testedconfigurations">http://www.jboss.com/products/platforms/application/testedconfigurations</ulink>.
+ <para>For the latest information on supported Operating System / JVM combinations and supported Database platforms, please refer to <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigurations/">http://www.jboss.com/products/platforms/portals/testedconfigurations/</ulink>.
</para>
- <!-- <para>
- The following is a list of supported operating systems and JVM version combination:
+ <para>
+ The following is a list of certified operating systems and JVM version combination:
</para>
<table>
@@ -38,18 +46,18 @@
</row>
<row>
<entry>
- RHEL 4.5 x86
+ RHEL 5 x86
</entry>
<entry>
- Sun JVM 1.5 latest
+ Sun JVM 1.6 Update 15
</entry>
</row>
<row>
<entry>
- RHEL 4.5 x86_64
+ RHEL 5 x86
</entry>
<entry>
- Sun JVM 1.5 latest
+ OpenJDK 1.6.0-b09
</entry>
</row>
<row>
@@ -57,7 +65,7 @@
RHEL 5 x86
</entry>
<entry>
- Sun JVM 1.5 latest
+ IBM JDK 1.6.0 SR5
</entry>
</row>
<row>
@@ -65,170 +73,200 @@
RHEL 5 x86_64
</entry>
<entry>
- Sun JVM 1.5 latest
+ Sun JVM 1.6 Update 15
</entry>
</row>
<row>
<entry>
- RHEL 4.5 x86
+ RHEL 5 x86_64
</entry>
<entry>
- BEA JRockit 1.5 latest
+ OpenJDK 1.6.0-b09
</entry>
</row>
<row>
<entry>
- RHEL 4.5 x86_64
+ RHEL 5 x86_64
</entry>
<entry>
- BEA JRockit 1.5 latest
+ IBM JDK 1.6.0 SR5
</entry>
- </row>
+ </row>
<row>
<entry>
- RHEL 5 x86
+ Microsoft Windows 2008 x86
</entry>
<entry>
- BEA JRockit 1.5 latest
+ Sun JVM 1.6 Update 15
</entry>
</row>
<row>
<entry>
- RHEL 5 x86_64
+ Microsoft Windows 2008 x86_64
</entry>
<entry>
- BEA JRockit 1.5 latest
+ Sun JVM 1.6 Update 15
</entry>
</row>
<row>
<entry>
- Solaris SPARC 9
+ Solaris 10
</entry>
<entry>
- Sun JVM 1.5 latest
+ Sun JVM 1.6 Update 15
</entry>
</row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ The following is a list of supported databases and database drivers:
+ </para>
+
+ <table>
+ <title>
+ Supported and Certified Database / Database driver Combinations.
+ </title>
+
+ <tgroup cols="2">
+ <colspec colnum="1" colname="DB" colwidth="1*"></colspec>
+ <colspec colnum="2" colname="DB_driver" colwidth="1*"></colspec>
+ <tbody>
<row>
<entry>
- MS-Windows 2003 x86
+ <emphasis>Database</emphasis>
</entry>
<entry>
- Sun JVM 1.5 latest
+ <emphasis>Database driver</emphasis>
</entry>
</row>
<row>
<entry>
- MS-Windows 2003 x86_64
+ MySQL 5.1
</entry>
<entry>
- Sun JVM 1.5 latest
+ MySQL Connector/J 5.1.8
</entry>
</row>
<row>
<entry>
- MS-Windows 2003 x86
+ Oracle 10g R2 (10.2.0.4)
</entry>
<entry>
- BEA JRockit 1.5 latest
+ 10g R2 (10.2.0.4)
</entry>
</row>
<row>
<entry>
- MS-Windows 2003 x86_64
+ Oracle 11g R1 (11.1.0.7.0) (Supported)
</entry>
<entry>
- BEA JRockit 1.5 latest
+ 11g R1 (11.1.0.7.0)
</entry>
</row>
<row>
<entry>
- Solaris SPARC 10
+ Oracle 11g RAC (11.1.0.7.0) (Supported)
</entry>
<entry>
- Sun JVM 1.5 latest
+ 11g R1 (11.1.0.7.0)
</entry>
</row>
<row>
<entry>
- HP 11i 1,2 RISC
+ Microsoft SQL Server 2005 SP3
</entry>
<entry>
- HP JVM
+ Microsoft JDBC Driver 2.0
</entry>
- </row>
+ </row>
<row>
<entry>
- HP 11i, 1,2 ia64
+ Microsoft SQL Server 2008 SP1
</entry>
<entry>
- HP JVM
+ Microsoft JDBC Driver 2.0
</entry>
</row>
- </tbody>
- </tgroup>
- </table>
-
- <para>
- The following is a list of supported databases and database drivers:
- </para>
-
- <table>
- <title>
- Supported Database / Database driver Combinations.
- </title>
-
- <tgroup cols="2">
- <colspec colnum="1" colname="DB" colwidth="1*"></colspec>
- <colspec colnum="2" colname="DB_driver" colwidth="1*"></colspec>
- <tbody>
<row>
<entry>
- <emphasis>Database</emphasis>
+ Postgres SQL 8.3.7
</entry>
<entry>
- <emphasis>Database driver</emphasis>
+ Postgres Driver JDBC4, 8.3-605
</entry>
</row>
<row>
<entry>
- Oracle 9i
+ Postgres SQL 8.2.4 (Supported)
</entry>
<entry>
- Oracle thin driver
+ Postgres Driver JDBC4, 8.2-510
</entry>
</row>
<row>
<entry>
- Oracle 10g R2
+ DB2 9.7
</entry>
<entry>
- Oracle thin driver
+ IBM Data Server Driver for JDBC and SQLJ (JCC Driver) Version: 9.1 (fixpack 3a)
</entry>
</row>
<row>
<entry>
- Microsoft SQL Server 2005
+ Sybase 15.0.2
</entry>
<entry>
- Microsoft JDBC Driver
+ JConnect v6.0.5 (Build 26564 / 11 Jun 2009)
</entry>
- </row>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ The following is a list of supported directory servers:
+ </para>
+
+ <table>
+ <title>
+ Supported and Certified directory servers
+ </title>
+
+ <tgroup cols="1">
+ <colspec colnum="1" colname="LDAP" colwidth="1*"></colspec>
+ <tbody>
<row>
<entry>
- MySQL 5.0
+ <emphasis>Directory Server</emphasis>
</entry>
+ </row>
+ <row>
<entry>
- MySQL Driver
+ OpenDS 1.2
</entry>
</row>
<row>
<entry>
- Postgres SQL 8.1
+ OpenDS 2.0
</entry>
+ </row>
+ <row>
<entry>
- Postgres Driver
+ OpenLDAP 2.4
</entry>
</row>
+ <row>
+ <entry>
+ Red Hat Directory Server 7.1
+ </entry>
+ </row>
+ <row>
+ <entry>
+ MS Active Directory – Windows Server 2008
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -236,7 +274,7 @@
<para>
JBoss uses an embedded Tomcat and does not require a stand-alone Tomcat.
</para>
- </note> -->
+ </note>
</section>
<section id="Pre_Requisites-Configuring_Your_Java_Environment">
@@ -302,10 +340,6 @@
<para>
java-1.6.0-ibm (IBM)
</para>
-
- <para>
- java-1.6.0-bea (JRockit)
- </para>
</listitem>
</varlistentry>
</variablelist>
@@ -535,176 +569,5 @@
</section>
</section>
- <!--
- <section id="Getting_Started-Components_of_JBoss_Enterprise_Application_Platform">
- <title>Components of &PRODUCT;</title>
-
- <para>For current information on the revision level of included components please refer to <ulink url="http://www.jboss.com/products/platforms/portals/components">http://www.jboss.com/products/platforms/portals/components</ulink>.
- </para>
- -->
- <!--<para>
- Below is a listing of the components of &PRODUCT; and their revision level at the time of writing. For an updated list of component revision levels please refer to <ulink url="http://www.redhat.com/docs/manuals/jboss">http://www.redhat.com/docs/manuals/jboss</ulink>.
- </para>
-
- <para>
- <table id="Components_of_JBoss_Enterprise_Application_Platform_version_4.2-Application_Platform_4.2">
- <title>Application Platform 4.2</title>
- <tgroup cols="2">
- <colspec colname="Project" colnum="1" colwidth="4*"></colspec>
- <colspec colname="Version" colnum="2" colwidth="4*"></colspec>
- <thead>
- <row>
- <entry>
- Project
- </entry>
- <entry>
- Version
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- Hibernate
- </entry>
- <entry>
- 3.2.4.SP1_CP01
- </entry>
- </row>
- <row>
- <entry>
- Hibernate Entity Manager
- </entry>
- <entry>
- 3.2.1
- </entry>
- </row>
- <row>
- <entry>
- Hibernate Annotations
- </entry>
- <entry>
- 3.2.1
- </entry>
- </row>
- <row>
- <entry>
- JBoss AS
- </entry>
- <entry>
- 4.2.0
- </entry>
- </row>
- <row>
- <entry>
- JBoss MQ
- </entry>
- <entry>
- 4.2.0
- </entry>
- </row>
- <row>
- <entry>
- JBoss Web
- </entry>
- <entry>
- 2.0.0
- </entry>
- </row>
- <row>
- <entry>
- JBoss Transactions
- </entry>
- <entry>
- 4.2.3.SP4
- </entry>
- </row>
- <row>
- <entry>
- JTA
- </entry>
- <entry>
- 1.0.1B
- </entry>
- </row>
- <row>
- <entry>
- JBoss EJB3
- </entry>
- <entry>
- RC10
- </entry>
- </row>
- <row>
- <entry>
- JBoss WS
- </entry>
- <entry>
- 1.2.1
- </entry>
- </row>
- <row>
- <entry>
- JBoss AOP
- </entry>
- <entry>
- 1.5.5
- </entry>
- </row>
- <row>
- <entry>
- JBoss Remoting
- </entry>
- <entry>
- 2.0.0.SP4
- </entry>
- </row>
- <row>
- <entry>
- JBoss Serialization
- </entry>
- <entry>
- 1.0.3
- </entry>
- </row>
- <row>
- <entry>
- JBoss Cache
- </entry>
- <entry>
- 1.4.1.SP3
- </entry>
- </row>
- <row>
- <entry>
- JGroups
- </entry>
- <entry>
- 2.4.1.SP3
- </entry>
- </row>
- <row>
- <entry>
- JBoss Seam
- </entry>
- <entry>
- 1.2.0.AP
- </entry>
- </row>
- <row>
- <entry>
- jBPM (JPDL)
- </entry>
- <entry>
- 3.1.4 (Seam dependency)
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para> -->
- <!--
- </section>
- -->
</chapter>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml 2010-04-14 15:00:02 UTC (rev 2640)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml 2010-04-14 15:35:52 UTC (rev 2641)
@@ -11,7 +11,7 @@
<title>Download</title>
<para>
- You can download the zip file from the JBoss Customer Service Portal (CSP), located at <ulink url="https://network.jboss.com">https://network.jboss.com</ulink>.
+ You can download the zip file from the JBoss Customer Support Portal (CSP), located at <ulink url="https://network.jboss.com">https://network.jboss.com</ulink>.
</para>
</section>
@@ -52,28 +52,20 @@
</listitem>
<listitem>
<para>
- the <literal>default</literal> server configuration includes non-clustered Portal components contained within the <literal>httpha-invoker.sar</literal> <remark>OR</remark> <literal>jbossweb.sar</literal> <remark>OR</remark> <literal>jbossws.sar</literal> <remark>OR</remark> <literal>uuid-key-generator.sar</literal> service archive. This archive is located in the <literal>deploy</literal> folder. <remark>This is the server configuration that is started when no other configuration is specified</remark>
+ the <literal>default</literal> server configuration includes non-clustered Portal components. This archive (gatein.ear) is located in the <literal>deploy</literal> folder. <remark>This is the server configuration that is started when no other configuration is specified</remark>
</para>
</listitem>
<listitem>
<para>
- the <literal>all</literal> server configuration includes clustered Portal components contained within <literal>httpha-invoker.sar</literal> <remark>OR</remark> <literal>jbossweb.sar</literal> <remark>OR</remark> <literal>jbossws.sar</literal> <remark>OR</remark> <literal>juddi-service.sar</literal> <remark>OR</remark> <literal>snmp-adaptor.sar</literal> service archive. This archive is located in the <literal>deploy</literal> folder.
+ the <literal>all</literal> server configuration includes the Portal and services used for running on a cluster.
</para>
</listitem>
<listitem>
<para>
- the <literal>production</literal> server configuration includes clustered Portal components contained within <literal>httpha-invoker.sar</literal> <remark>OR</remark> <literal>jbossweb.sar</literal> <remark>OR</remark> <literal>jbossws.sar</literal> <remark>OR</remark> <literal>juddi-service.sar</literal> <remark>OR</remark> <literal>snmp-adaptor.sar</literal> <remark>OR</remark> <literal>uuid-key-generator.sar</literal>. This archive is located in the <literal>deploy</literal> folder.
+ the <literal>production</literal> server configuration includes Portal component and clustering services. It is preconfigured with default settings which would be more accurate for a production environment.
</para>
</listitem>
</itemizedlist>
- <note><title>Note: Production Server</title>
- <para>
- The <literal>production</literal> server configuration has several optimizations including logging and memory size.
- If you do not need the clustered portal version and want to use this optimized server configuration, you simply need to copy the
- <literal>WHICH FILE?</literal> file from <literal>default/deploy</literal> to <literal>production/deploy</literal>. Don't forget to
- remove <literal>WHICH FILE as jboss-portal-ha.sar doesn't exist?</literal> though.
- </para>
- </note>
</para>
</section>
</chapter>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation_Guide.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation_Guide.xml 2010-04-14 15:00:02 UTC (rev 2640)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation_Guide.xml 2010-04-14 15:35:52 UTC (rev 2641)
@@ -14,7 +14,6 @@
<xi:include href="Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Post_Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Databases.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Test_Your_Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Uninstall_JBoss.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<index />
14 years, 5 months
- 1
- 0
gatein SVN: r2640 - portal/trunk/docs/reference-guide/en/modules/PortalDevelopment.
by do-not-reply＠jboss.org
Author: mstruk
Date: 2010-04-14 11:00:02 -0400 (Wed, 14 Apr 2010)
New Revision: 2640
Modified:
portal/trunk/docs/reference-guide/en/modules/PortalDevelopment/Foundations.xml
Log:
Added InitParams docs to Foundations chapter
Modified: portal/trunk/docs/reference-guide/en/modules/PortalDevelopment/Foundations.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/PortalDevelopment/Foundations.xml 2010-04-14 14:08:28 UTC (rev 2639)
+++ portal/trunk/docs/reference-guide/en/modules/PortalDevelopment/Foundations.xml 2010-04-14 15:00:02 UTC (rev 2640)
@@ -165,7 +165,7 @@
(i.e. JNDI names, Database / DataSource names, JCR repository names, etc ...).</para>
<para>This variable is only defined when there is a current PortalContainer available - only for PortalContainer scoped services.</para>
<para>A good example for this is <emphasis role="bold">HibernateService</emphasis>:</para>
- <example>
+ <example id="sect-Reference_Guide-Foundations-Configuration_syntax-Special_vars-Example">
<title>HibernateService using variables</title>
<programlisting role="XML"><![CDATA[
<?xml version="1.0" encoding="ISO-8859-1"?>
@@ -206,6 +206,169 @@
</section>
</section>
+
+ <section id="sect-Reference_Guide-Foundations-Init_params">
+ <title>InitParams configuration object</title>
+
+ <para>
+ <literal>InitParams</literal> is a configuration object that is essentially a map of key-value pairs,
+ where key is always a <literal>String</literal>, and value can be any type that can be described
+ using kernel configuration xml.
+ </para>
+
+ <para>
+ Service components that form the &PRODUCT; insfrastructure use <literal>InitParams</literal> object to configure themselves.
+ A component can have one instance of InitParams injected at most. If the service component's constructor takes InitParams
+ as any of the parameters it will automatically be injected at component instantiation time. The xml configuration
+ for a service component that expects InitParams object must include <init-params> element (even if an empty one).
+ </para>
+
+ <para>
+ Let's use an example to see how the kernel xml configuration syntax looks for creating <literal>InitParams</literal> instances.
+ </para>
+
+ <example>
+ <title>InitParams - properties-param</title>
+ <programlisting role="XML"><![CDATA[
+<component>
+ <key>org.exoplatform.services.naming.InitialContextInitializer</key>
+ <type>org.exoplatform.services.naming.InitialContextInitializer</type>
+ <init-params>
+ <properties-param>
+ <name>default-properties</name>
+ <description>Default initial context properties</description>
+ <property name="java.naming.factory.initial"
+ value="org.exoplatform.services.naming.SimpleContextFactory" />
+ </properties-param>
+ </init-params>
+</component>
+ ]]></programlisting>
+ </example>
+
+ <para>
+ InitParams object description begins with <init-params> element. It can have zero or more children elements
+ each of which is one of <value-param>, <values-param>, <properties-param>, or <object-param>.
+ Each of these child elements takes a <name> that serves as a map entry key, and an optional <description>.
+ It also takes a type-specific value specification.
+ </para>
+
+ <para>
+ For <properties-param> the value specification is in the form of one or more <property> elements,
+ each of which specifies two strings - a property name, and a property value. Each <properties-params>
+ defines one <literal>java.util.Properties</literal> instance. Also see
+ <xref linkend="sect-Reference_Guide-Foundations-Configuration_syntax-Special_vars-Example"/> for an example.
+ </para>
+
+ <example>
+ <title>InitParams - value-param</title>
+ <programlisting role="XML"><![CDATA[
+<component>
+ <key>org.exoplatform.services.transaction.TransactionService</key>
+ <type>org.exoplatform.services.transaction.impl.jotm.TransactionServiceJotmImpl</type>
+ <init-params>
+ <value-param>
+ <name>timeout</name>
+ <value>5</value>
+ </value-param>
+ </init-params>
+</component>
+ ]]></programlisting>
+ </example>
+
+ <para>
+ For <value-param> the value specification is in the form of <value> element, which defines
+ one <literal>String</literal> instance.
+ </para>
+
+ <example>
+ <title>InitParams - values-param</title>
+ <programlisting role="XML"><![CDATA[
+<component>
+ <key>org.exoplatform.services.resources.ResourceBundleService</key>
+ <type>org.exoplatform.services.resources.impl.SimpleResourceBundleService</type>
+ <init-params>
+ <values-param>
+ <name>classpath.resources</name>
+ <description>The resources that start with the following package name should be load from file system</description>
+ <value>locale.portlet</value>
+ </values-param>
+
+ <values-param>
+ <name>init.resources</name>
+ <description>Store the following resources into the db for the first launch </description>
+ <value>locale.test.resources.test</value>
+ </values-param>
+
+ <values-param>
+ <name>portal.resource.names</name>
+ <description>The properties files of the portal , those file will be merged
+ into one ResourceBundle properties </description>
+ <value>local.portal.portal</value>
+ <value>local.portal.custom</value>
+ </values-param>
+ </init-params>
+</component>
+ ]]></programlisting>
+ </example>
+
+ <para>
+ For <values-param> the value specification is in the form of one or more <value> elements,
+ each of which represents one <literal>String</literal> instance, where all the <literal>String</literal> values
+ are then collected into a <literal>java.util.List</literal> instance.
+ </para>
+
+ <example>
+ <title>InitParams - object-param</title>
+ <programlisting role="XML"><![CDATA[
+<component>
+ <key>org.exoplatform.services.cache.CacheService</key>
+ <jmx-name>cache:type=CacheService</jmx-name>
+ <type>org.exoplatform.services.cache.impl.CacheServiceImpl</type>
+ <init-params>
+ <object-param>
+ <name>cache.config.default</name>
+ <description>The default cache configuration</description>
+ <object type="org.exoplatform.services.cache.ExoCacheConfig">
+ <field name="name">
+ <string>default</string>
+ </field>
+ <field name="maxSize">
+ <int>300</int>
+ </field>
+ <field name="liveTime">
+ <long>300</long>
+ </field>
+ <field name="distributed">
+ <boolean>false</boolean>
+ </field>
+ <field name="implementation">
+ <string>org.exoplatform.services.cache.concurrent.ConcurrentFIFOExoCache</string>
+ </field>
+ </object>
+ </object-param>
+ </init-params>
+</component>
+ ]]></programlisting>
+ </example>
+
+ <para>
+ For <object-param> in our case, the value specification comes in a form of <object> element, which is
+ used for POJO style object specification (you specify an implementation class - <type>, and property values - <field>).
+ </para>
+
+ <para>
+ Also see <xref linkend="sect-Reference_Guide-Foundations-Configuring_portal_Container_declaration_example" />
+ for an example of specifying a field of <literal>Collection</literal> type.
+ </para>
+
+ <para>
+ The <literal>InitParams</literal> structure - the names and types of entries is specific for each service,
+ as it is the code inside service components's class that decides what entry names to look up and what types
+ it expects to find.
+ </para>
+ </section>
+
+
<section id="sect-Reference_Guide-Foundations-Configuring_portal">
<title>Configuring a portal container</title>
@@ -232,7 +395,7 @@
portal (via extension mechanism described later), and are searched in the specified order.
</para>
- <example>
+ <example id="sect-Reference_Guide-Foundations-Configuring_portal_Container_declaration_example">
<title>Portal container declaration example</title>
<programlisting role="XML"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
14 years, 5 months
- 1
- 0
gatein SVN: r2639 - in portal/branches/EPP_5_0_Branch/component: web/src/main/java/org/exoplatform/web and 1 other directory.
by do-not-reply＠jboss.org
Author: thomas.heute(a)jboss.com
Date: 2010-04-14 10:08:28 -0400 (Wed, 14 Apr 2010)
New Revision: 2639
Modified:
portal/branches/EPP_5_0_Branch/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java
portal/branches/EPP_5_0_Branch/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java
Log:
JBEPP-303: GateIn+SSO integration: IdentityException thrown in special case when HTTP session expire
Modified: portal/branches/EPP_5_0_Branch/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java
===================================================================
--- portal/branches/EPP_5_0_Branch/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java 2010-04-14 14:04:59 UTC (rev 2638)
+++ portal/branches/EPP_5_0_Branch/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java 2010-04-14 14:08:28 UTC (rev 2639)
@@ -31,6 +31,7 @@
import org.picocontainer.Startable;
import javax.naming.InitialContext;
+import javax.transaction.Status;
import javax.transaction.UserTransaction;
import java.util.LinkedList;
import java.util.concurrent.atomic.AtomicInteger;
@@ -141,11 +142,17 @@
if (configuration.isUseJTA())
{
UserTransaction tx = (UserTransaction)new InitialContext().lookup("java:comp/UserTransaction");
- tx.begin();
+ if (tx.getStatus() == Status.STATUS_NO_TRANSACTION)
+ {
+ tx.begin();
+ }
}
else
{
- idmService_.getIdentitySession().beginTransaction();
+ if (!idmService_.getIdentitySession().getTransaction().isActive())
+ {
+ idmService_.getIdentitySession().beginTransaction();
+ }
}
}
catch (Exception e)
Modified: portal/branches/EPP_5_0_Branch/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java
===================================================================
--- portal/branches/EPP_5_0_Branch/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java 2010-04-14 14:04:59 UTC (rev 2638)
+++ portal/branches/EPP_5_0_Branch/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java 2010-04-14 14:08:28 UTC (rev 2639)
@@ -19,6 +19,8 @@
package org.exoplatform.web;
+import org.exoplatform.container.component.ComponentRequestLifecycle;
+import org.exoplatform.container.component.RequestLifeCycle;
import org.exoplatform.container.web.AbstractFilter;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;
@@ -59,7 +61,9 @@
OrganizationService orgService =
(OrganizationService)getContainer().getComponentInstanceOfType(OrganizationService.class);
+ begin(orgService);
User user = orgService.getUserHandler().findUserByName(state.getIdentity().getUserId());
+ end(orgService);
state.setAttribute(USER_PROFILE, user);
}
@@ -77,4 +81,20 @@
public void destroy()
{
}
+
+ public void begin(OrganizationService orgService) throws Exception
+ {
+ if (orgService instanceof ComponentRequestLifecycle)
+ {
+ RequestLifeCycle.begin((ComponentRequestLifecycle)orgService);
+ }
+ }
+
+ public void end(OrganizationService orgService) throws Exception
+ {
+ if (orgService instanceof ComponentRequestLifecycle)
+ {
+ RequestLifeCycle.end();
+ }
+ }
}
14 years, 5 months
- 1
- 0
gatein SVN: r2638 - in portal/branches/EPP_5_0_0_CR01_Branch/component: web/src/main/java/org/exoplatform/web and 1 other directory.
by do-not-reply＠jboss.org
Author: thomas.heute(a)jboss.com
Date: 2010-04-14 10:04:59 -0400 (Wed, 14 Apr 2010)
New Revision: 2638
Modified:
portal/branches/EPP_5_0_0_CR01_Branch/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java
portal/branches/EPP_5_0_0_CR01_Branch/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java
Log:
JBEPP-303: GateIn+SSO integration: IdentityException thrown in special case when HTTP session expire
Modified: portal/branches/EPP_5_0_0_CR01_Branch/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java
===================================================================
--- portal/branches/EPP_5_0_0_CR01_Branch/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java 2010-04-14 13:06:31 UTC (rev 2637)
+++ portal/branches/EPP_5_0_0_CR01_Branch/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java 2010-04-14 14:04:59 UTC (rev 2638)
@@ -31,6 +31,7 @@
import org.picocontainer.Startable;
import javax.naming.InitialContext;
+import javax.transaction.Status;
import javax.transaction.UserTransaction;
import java.util.LinkedList;
import java.util.concurrent.atomic.AtomicInteger;
@@ -141,11 +142,17 @@
if (configuration.isUseJTA())
{
UserTransaction tx = (UserTransaction)new InitialContext().lookup("java:comp/UserTransaction");
- tx.begin();
+ if (tx.getStatus() == Status.STATUS_NO_TRANSACTION)
+ {
+ tx.begin();
+ }
}
else
{
- idmService_.getIdentitySession().beginTransaction();
+ if (!idmService_.getIdentitySession().getTransaction().isActive())
+ {
+ idmService_.getIdentitySession().beginTransaction();
+ }
}
}
catch (Exception e)
Modified: portal/branches/EPP_5_0_0_CR01_Branch/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java
===================================================================
--- portal/branches/EPP_5_0_0_CR01_Branch/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java 2010-04-14 13:06:31 UTC (rev 2637)
+++ portal/branches/EPP_5_0_0_CR01_Branch/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java 2010-04-14 14:04:59 UTC (rev 2638)
@@ -19,6 +19,8 @@
package org.exoplatform.web;
+import org.exoplatform.container.component.ComponentRequestLifecycle;
+import org.exoplatform.container.component.RequestLifeCycle;
import org.exoplatform.container.web.AbstractFilter;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;
@@ -59,7 +61,9 @@
OrganizationService orgService =
(OrganizationService)getContainer().getComponentInstanceOfType(OrganizationService.class);
+ begin(orgService);
User user = orgService.getUserHandler().findUserByName(state.getIdentity().getUserId());
+ end(orgService);
state.setAttribute(USER_PROFILE, user);
}
@@ -77,4 +81,20 @@
public void destroy()
{
}
+
+ public void begin(OrganizationService orgService) throws Exception
+ {
+ if (orgService instanceof ComponentRequestLifecycle)
+ {
+ RequestLifeCycle.begin((ComponentRequestLifecycle)orgService);
+ }
+ }
+
+ public void end(OrganizationService orgService) throws Exception
+ {
+ if (orgService instanceof ComponentRequestLifecycle)
+ {
+ RequestLifeCycle.end();
+ }
+ }
}
14 years, 5 months
- 1
- 0
gatein SVN: r2637 - portal/branches/EPP_5_0_Branch/portlet/exoadmin/src/main/webapp/skin/navigation/webui/component/background.
by do-not-reply＠jboss.org
Author: thomas.heute(a)jboss.com
Date: 2010-04-14 09:06:31 -0400 (Wed, 14 Apr 2010)
New Revision: 2637
Modified:
portal/branches/EPP_5_0_Branch/portlet/exoadmin/src/main/webapp/skin/navigation/webui/component/background/PlImg.gif
Log:
JBEPP-264: Create new skin for EPP5
--Thitts line, and those below, will be ignored--
M PlImg.gif
Modified: portal/branches/EPP_5_0_Branch/portlet/exoadmin/src/main/webapp/skin/navigation/webui/component/background/PlImg.gif
===================================================================
(Binary files differ)
14 years, 5 months
- 1
- 0
gatein SVN: r2636 - in portal/trunk/component: web/src/main/java/org/exoplatform/web and 1 other directory.
by do-not-reply＠jboss.org
Author: bdaw
Date: 2010-04-14 08:44:20 -0400 (Wed, 14 Apr 2010)
New Revision: 2636
Modified:
portal/trunk/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java
portal/trunk/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java
Log:
- GTNPORTAL-1048 - check if there is active transaction before starting a new one; wrap IDM call in CacheUserProfileFilter with transaction for different flow with SSO integration
Modified: portal/trunk/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java
===================================================================
--- portal/trunk/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java 2010-04-14 12:11:51 UTC (rev 2635)
+++ portal/trunk/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java 2010-04-14 12:44:20 UTC (rev 2636)
@@ -31,6 +31,7 @@
import org.picocontainer.Startable;
import javax.naming.InitialContext;
+import javax.transaction.Status;
import javax.transaction.UserTransaction;
import java.util.LinkedList;
import java.util.concurrent.atomic.AtomicInteger;
@@ -141,11 +142,17 @@
if (configuration.isUseJTA())
{
UserTransaction tx = (UserTransaction)new InitialContext().lookup("java:comp/UserTransaction");
- tx.begin();
+ if (tx.getStatus() == Status.STATUS_NO_TRANSACTION)
+ {
+ tx.begin();
+ }
}
else
{
- idmService_.getIdentitySession().beginTransaction();
+ if (!idmService_.getIdentitySession().getTransaction().isActive())
+ {
+ idmService_.getIdentitySession().beginTransaction();
+ }
}
}
catch (Exception e)
Modified: portal/trunk/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java
===================================================================
--- portal/trunk/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java 2010-04-14 12:11:51 UTC (rev 2635)
+++ portal/trunk/component/web/src/main/java/org/exoplatform/web/CacheUserProfileFilter.java 2010-04-14 12:44:20 UTC (rev 2636)
@@ -19,6 +19,8 @@
package org.exoplatform.web;
+import org.exoplatform.container.component.ComponentRequestLifecycle;
+import org.exoplatform.container.component.RequestLifeCycle;
import org.exoplatform.container.web.AbstractFilter;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;
@@ -59,7 +61,9 @@
OrganizationService orgService =
(OrganizationService)getContainer().getComponentInstanceOfType(OrganizationService.class);
+ begin(orgService);
User user = orgService.getUserHandler().findUserByName(state.getIdentity().getUserId());
+ end(orgService);
state.setAttribute(USER_PROFILE, user);
}
@@ -77,4 +81,20 @@
public void destroy()
{
}
+
+ public void begin(OrganizationService orgService) throws Exception
+ {
+ if (orgService instanceof ComponentRequestLifecycle)
+ {
+ RequestLifeCycle.begin((ComponentRequestLifecycle)orgService);
+ }
+ }
+
+ public void end(OrganizationService orgService) throws Exception
+ {
+ if (orgService instanceof ComponentRequestLifecycle)
+ {
+ RequestLifeCycle.end();
+ }
+ }
}
14 years, 5 months
- 1
- 0
gatein SVN: r2635 - in portal/trunk: web/portal/src/main/webapp/WEB-INF/conf/wsrp and 1 other directory.
by do-not-reply＠jboss.org
Author: chris.laprun(a)jboss.com
Date: 2010-04-14 08:11:51 -0400 (Wed, 14 Apr 2010)
New Revision: 2635
Added:
portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/WSRPServiceIntegration.java
Removed:
portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ExoKernelIntegration.java
Modified:
portal/trunk/web/portal/src/main/webapp/WEB-INF/conf/wsrp/wsrp-configuration.xml
Log:
- Renamed ExoKernelIntegration for WSRP component to WSRPServiceIntegration to avoid confusion.
- Fixed typo.
Deleted: portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ExoKernelIntegration.java
===================================================================
--- portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ExoKernelIntegration.java 2010-04-14 12:11:47 UTC (rev 2634)
+++ portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ExoKernelIntegration.java 2010-04-14 12:11:51 UTC (rev 2635)
@@ -1,324 +0,0 @@
-/*
- * JBoss, a division of Red Hat
- * Copyright 2010, Red Hat Middleware, LLC, and individual
- * contributors as indicated by the @authors tag. See the
- * copyright.txt in the distribution for a full listing of
- * individual contributors.
- *
- * This is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
- *
- * This software is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this software; if not, write to the Free
- * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
- */
-
-package org.gatein.portal.wsrp;
-
-import org.exoplatform.container.ExoContainer;
-import org.exoplatform.container.ExoContainerContext;
-import org.exoplatform.container.configuration.ConfigurationManager;
-import org.exoplatform.container.xml.InitParams;
-import org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator;
-import org.gatein.common.logging.Logger;
-import org.gatein.common.logging.LoggerFactory;
-import org.gatein.pc.api.PortletInvoker;
-import org.gatein.pc.federation.FederatingPortletInvoker;
-import org.gatein.pc.portlet.container.ContainerPortletInvoker;
-import org.gatein.pc.portlet.impl.state.StateConverterV0;
-import org.gatein.pc.portlet.impl.state.StateManagementPolicyService;
-import org.gatein.pc.portlet.state.StateConverter;
-import org.gatein.pc.portlet.state.producer.PortletStatePersistenceManager;
-import org.gatein.pc.portlet.state.producer.ProducerPortletInvoker;
-import org.gatein.portal.wsrp.state.consumer.JCRConsumerRegistry;
-import org.gatein.portal.wsrp.state.producer.configuration.JCRProducerConfigurationService;
-import org.gatein.portal.wsrp.state.producer.registrations.JCRRegistrationPersistenceManager;
-import org.gatein.portal.wsrp.state.producer.state.JCRPortletStatePersistenceManager;
-import org.gatein.registration.RegistrationManager;
-import org.gatein.registration.RegistrationPersistenceManager;
-import org.gatein.registration.impl.RegistrationManagerImpl;
-import org.gatein.wci.ServletContainer;
-import org.gatein.wci.ServletContainerFactory;
-import org.gatein.wci.WebApp;
-import org.gatein.wci.WebAppEvent;
-import org.gatein.wci.WebAppLifeCycleEvent;
-import org.gatein.wci.WebAppListener;
-import org.gatein.wci.impl.DefaultServletContainerFactory;
-import org.gatein.wsrp.WSRPConstants;
-import org.gatein.wsrp.api.SessionEvent;
-import org.gatein.wsrp.api.SessionEventBroadcaster;
-import org.gatein.wsrp.api.SessionEventListener;
-import org.gatein.wsrp.consumer.registry.ActivatingNullInvokerHandler;
-import org.gatein.wsrp.consumer.registry.ConsumerRegistry;
-import org.gatein.wsrp.producer.ProducerHolder;
-import org.gatein.wsrp.producer.WSRPProducer;
-import org.gatein.wsrp.producer.config.ProducerConfigurationService;
-import org.picocontainer.Startable;
-
-import javax.servlet.ServletContext;
-import java.io.InputStream;
-import java.util.Map;
-import java.util.concurrent.ConcurrentHashMap;
-
-/**
- * @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a>
- * @version $Revision$
- */
-public class ExoKernelIntegration implements Startable, WebAppListener
-{
- private static final Logger log = LoggerFactory.getLogger(ExoKernelIntegration.class);
-
- private static final String CLASSPATH = "classpath:/";
- private static final String PRODUCER_CONFIG_LOCATION = "producerConfigLocation";
- private static final String CONSUMERS_CONFIG_LOCATION = "consumersConfigLocation";
-
- private final InputStream configurationIS;
- private final String producerConfigLocation;
- private WSRPProducer producer;
-
- private ConsumerRegistry consumerRegistry;
- private ExoContainer container;
- private final boolean bypass;
- private static final String WSRP_ADMIN_GUI_CONTEXT_PATH = "/wsrp-admin-gui";
-
- public ExoKernelIntegration(ExoContainerContext context, InitParams params, ConfigurationManager configurationManager,
- org.exoplatform.portal.pc.ExoKernelIntegration pc, NodeHierarchyCreator nhc) throws Exception
- {
- // IMPORTANT: even though PC ExoKernelIntegration and NodeHierarchyCreator is not used anywhere in the code, it's still needed for pico
- // to properly make sure that this service is started after the PC one. Yes, Pico is crap. :/
-
- // todo: we currently only allow the service to go through initialization if we are running in the default portal
- // as this service is not meant to work with extensions yet...
- String consumersConfigLocation;
- if ("portal".equals(context.getName()))
- {
- if (params != null)
- {
- producerConfigLocation = params.getValueParam(PRODUCER_CONFIG_LOCATION).getValue();
- consumersConfigLocation = params.getValueParam(CONSUMERS_CONFIG_LOCATION).getValue();
- }
- else
- {
- throw new IllegalArgumentException("Improperly configured service: missing values for "
- + PRODUCER_CONFIG_LOCATION + "and " + CONSUMERS_CONFIG_LOCATION);
- }
-
- configurationIS = configurationManager.getInputStream(CLASSPATH + producerConfigLocation);
-
- container = context.getContainer();
-
- bypass = false;
- }
- else
- {
- log.info("The WSRP service can only be started in the default portal context. WSRP was not started for '"
- + context.getName() + "'");
-
- producerConfigLocation = null;
- consumersConfigLocation = null;
- configurationIS = null;
- bypass = true;
- }
- }
-
- public void start()
- {
- if (!bypass)
- {
- startProducer();
- startConsumers();
-
- // listen for web app events so that we can inject services into WSRP admin UI "cleanly"
- // todo: this service injection should really be done using CDI... :/
- ServletContainerFactory factory = DefaultServletContainerFactory.getInstance();
- ServletContainer servletContainer = factory.getServletContainer();
- servletContainer.addWebAppListener(this);
-
- log.info("WSRP Service version '" + WSRPConstants.WSRP_SERVICE_VERSION + "' started");
- }
- }
-
- private void startProducer()
- {
-
- JCRProducerConfigurationService producerConfigurationService;
- try
- {
- producerConfigurationService = new JCRProducerConfigurationService(container);
- producerConfigurationService.setDefaultConfigurationIS(configurationIS);
- producerConfigurationService.reloadConfiguration();
- }
- catch (Exception e)
- {
- throw new RuntimeException("Couldn't load WSRP producer configuration from " + producerConfigLocation, e);
- }
- container.registerComponentInstance(ProducerConfigurationService.class, producerConfigurationService);
-
- RegistrationPersistenceManager registrationPersistenceManager;
- try
- {
- registrationPersistenceManager = new JCRRegistrationPersistenceManager(container);
- }
- catch (Exception e)
- {
- throw new RuntimeException("Couln't instantiate RegistrationPersistenceManager", e);
- }
- RegistrationManager registrationManager = new RegistrationManagerImpl();
- registrationManager.setPersistenceManager(registrationPersistenceManager);
-
- // retrieve container portlet invoker from eXo kernel
- ContainerPortletInvoker containerPortletInvoker =
- (ContainerPortletInvoker)container.getComponentInstanceOfType(ContainerPortletInvoker.class);
-
- // The producer persistence manager
- PortletStatePersistenceManager producerPersistenceManager;
- try
- {
- producerPersistenceManager = new JCRPortletStatePersistenceManager(container);
- }
- catch (Exception e)
- {
- throw new RuntimeException("Couldn't instantiate PortletStatePersistenceManager", e);
- }
-
- // The producer state management policy
- StateManagementPolicyService producerStateManagementPolicy = new StateManagementPolicyService();
- producerStateManagementPolicy.setPersistLocally(true);
-
- // The producer state converter
- StateConverter producerStateConverter = new StateConverterV0();
-
- // The producer portlet invoker
- ProducerPortletInvoker producerPortletInvoker = new ProducerPortletInvoker();
- producerPortletInvoker.setNext(containerPortletInvoker);
- producerPortletInvoker.setPersistenceManager(producerPersistenceManager);
- producerPortletInvoker.setStateManagementPolicy(producerStateManagementPolicy);
- producerPortletInvoker.setStateConverter(producerStateConverter);
-
- // create and wire WSRP producer
- producer = ProducerHolder.getProducer(true);
- producer.setPortletInvoker(producerPortletInvoker);
- producer.setRegistrationManager(registrationManager);
- producer.setConfigurationService(producerConfigurationService);
-
- producer.start();
- }
-
- private void startConsumers()
- {
- // retrieve federating portlet invoker from container
- FederatingPortletInvoker federatingPortletInvoker =
- (FederatingPortletInvoker)container.getComponentInstanceOfType(PortletInvoker.class);
-
- try
- {
- consumerRegistry = new JCRConsumerRegistry(container);
- consumerRegistry.setFederatingPortletInvoker(federatingPortletInvoker);
- consumerRegistry.setSessionEventBroadcaster(new SimpleSessionEventBroadcaster());
- consumerRegistry.start();
-
- // set up a NullInvokerHandler so that when a remote producer is queried, we can start it if needed
- ActivatingNullInvokerHandler handler = new ActivatingNullInvokerHandler();
- handler.setConsumerRegistry(consumerRegistry);
- federatingPortletInvoker.setNullInvokerHandler(handler);
- }
- catch (Exception e)
- {
- throw new RuntimeException("Couldn't start WSRP consumers registry.", e);
- }
- container.registerComponentInstance(ConsumerRegistry.class, consumerRegistry);
- }
-
- public void stop()
- {
- if (!bypass)
- {
- // stop listening to web app events
- ServletContainerFactory factory = DefaultServletContainerFactory.getInstance();
- ServletContainer servletContainer = factory.getServletContainer();
- servletContainer.removeWebAppListener(this);
-
- stopProducer();
- stopConsumers();
- }
- }
-
- private void stopProducer()
- {
- producer.stop();
-
- producer = null;
- }
-
- private void stopConsumers()
- {
- try
- {
- consumerRegistry.stop();
- }
- catch (Exception e)
- {
- throw new RuntimeException("Couldn't stop WSRP consumers registry.", e);
- }
-
- consumerRegistry = null;
- }
-
- public void onEvent(WebAppEvent event)
- {
- if (event instanceof WebAppLifeCycleEvent)
- {
- WebAppLifeCycleEvent lifeCycleEvent = (WebAppLifeCycleEvent)event;
- WebApp webApp = event.getWebApp();
- ServletContext context = webApp.getServletContext();
-
- // if we see the WSRP admin GUI being deployed or undeployed, inject or remove services
- if (WSRP_ADMIN_GUI_CONTEXT_PATH.equals(webApp.getContextPath()))
- {
- switch (lifeCycleEvent.getType())
- {
- case WebAppLifeCycleEvent.ADDED:
- context.setAttribute("ConsumerRegistry", consumerRegistry);
- context.setAttribute("ProducerConfigurationService", producer.getConfigurationService());
- break;
- case WebAppLifeCycleEvent.REMOVED:
- context.removeAttribute("ConsumerRegistry");
- context.removeAttribute("ProducerConfigurationService");
- break;
- }
- }
- }
- }
-
- private static class SimpleSessionEventBroadcaster implements SessionEventBroadcaster
- {
- private Map<String, SessionEventListener> listeners = new ConcurrentHashMap<String, SessionEventListener>();
-
- public void registerListener(String listenerId, SessionEventListener listener)
- {
- listeners.put(listenerId, listener);
- }
-
- public void unregisterListener(String listenerId)
- {
- listeners.remove(listenerId);
- }
-
- public void notifyListenersOf(SessionEvent event)
- {
- for (SessionEventListener listener : listeners.values())
- {
- listener.onSessionEvent(event);
- }
- }
-
- }
-}
Copied: portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/WSRPServiceIntegration.java (from rev 2614, portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ExoKernelIntegration.java)
===================================================================
--- portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/WSRPServiceIntegration.java (rev 0)
+++ portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/WSRPServiceIntegration.java 2010-04-14 12:11:51 UTC (rev 2635)
@@ -0,0 +1,324 @@
+/*
+ * JBoss, a division of Red Hat
+ * Copyright 2010, Red Hat Middleware, LLC, and individual
+ * contributors as indicated by the @authors tag. See the
+ * copyright.txt in the distribution for a full listing of
+ * individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+package org.gatein.portal.wsrp;
+
+import org.exoplatform.container.ExoContainer;
+import org.exoplatform.container.ExoContainerContext;
+import org.exoplatform.container.configuration.ConfigurationManager;
+import org.exoplatform.container.xml.InitParams;
+import org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator;
+import org.gatein.common.logging.Logger;
+import org.gatein.common.logging.LoggerFactory;
+import org.gatein.pc.api.PortletInvoker;
+import org.gatein.pc.federation.FederatingPortletInvoker;
+import org.gatein.pc.portlet.container.ContainerPortletInvoker;
+import org.gatein.pc.portlet.impl.state.StateConverterV0;
+import org.gatein.pc.portlet.impl.state.StateManagementPolicyService;
+import org.gatein.pc.portlet.state.StateConverter;
+import org.gatein.pc.portlet.state.producer.PortletStatePersistenceManager;
+import org.gatein.pc.portlet.state.producer.ProducerPortletInvoker;
+import org.gatein.portal.wsrp.state.consumer.JCRConsumerRegistry;
+import org.gatein.portal.wsrp.state.producer.configuration.JCRProducerConfigurationService;
+import org.gatein.portal.wsrp.state.producer.registrations.JCRRegistrationPersistenceManager;
+import org.gatein.portal.wsrp.state.producer.state.JCRPortletStatePersistenceManager;
+import org.gatein.registration.RegistrationManager;
+import org.gatein.registration.RegistrationPersistenceManager;
+import org.gatein.registration.impl.RegistrationManagerImpl;
+import org.gatein.wci.ServletContainer;
+import org.gatein.wci.ServletContainerFactory;
+import org.gatein.wci.WebApp;
+import org.gatein.wci.WebAppEvent;
+import org.gatein.wci.WebAppLifeCycleEvent;
+import org.gatein.wci.WebAppListener;
+import org.gatein.wci.impl.DefaultServletContainerFactory;
+import org.gatein.wsrp.WSRPConstants;
+import org.gatein.wsrp.api.SessionEvent;
+import org.gatein.wsrp.api.SessionEventBroadcaster;
+import org.gatein.wsrp.api.SessionEventListener;
+import org.gatein.wsrp.consumer.registry.ActivatingNullInvokerHandler;
+import org.gatein.wsrp.consumer.registry.ConsumerRegistry;
+import org.gatein.wsrp.producer.ProducerHolder;
+import org.gatein.wsrp.producer.WSRPProducer;
+import org.gatein.wsrp.producer.config.ProducerConfigurationService;
+import org.picocontainer.Startable;
+
+import javax.servlet.ServletContext;
+import java.io.InputStream;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a>
+ * @version $Revision$
+ */
+public class WSRPServiceIntegration implements Startable, WebAppListener
+{
+ private static final Logger log = LoggerFactory.getLogger(WSRPServiceIntegration.class);
+
+ private static final String CLASSPATH = "classpath:/";
+ private static final String PRODUCER_CONFIG_LOCATION = "producerConfigLocation";
+ private static final String CONSUMERS_CONFIG_LOCATION = "consumersConfigLocation";
+
+ private final InputStream configurationIS;
+ private final String producerConfigLocation;
+ private WSRPProducer producer;
+
+ private ConsumerRegistry consumerRegistry;
+ private ExoContainer container;
+ private final boolean bypass;
+ private static final String WSRP_ADMIN_GUI_CONTEXT_PATH = "/wsrp-admin-gui";
+
+ public WSRPServiceIntegration(ExoContainerContext context, InitParams params, ConfigurationManager configurationManager,
+ org.exoplatform.portal.pc.ExoKernelIntegration pc, NodeHierarchyCreator nhc) throws Exception
+ {
+ // IMPORTANT: even though PC ExoKernelIntegration and NodeHierarchyCreator is not used anywhere in the code, it's still needed for pico
+ // to properly make sure that this service is started after the PC one. Yes, Pico is crap. :/
+
+ // todo: we currently only allow the service to go through initialization if we are running in the default portal
+ // as this service is not meant to work with extensions yet...
+ String consumersConfigLocation;
+ if ("portal".equals(context.getName()))
+ {
+ if (params != null)
+ {
+ producerConfigLocation = params.getValueParam(PRODUCER_CONFIG_LOCATION).getValue();
+ consumersConfigLocation = params.getValueParam(CONSUMERS_CONFIG_LOCATION).getValue();
+ }
+ else
+ {
+ throw new IllegalArgumentException("Improperly configured service: missing values for "
+ + PRODUCER_CONFIG_LOCATION + "and " + CONSUMERS_CONFIG_LOCATION);
+ }
+
+ configurationIS = configurationManager.getInputStream(CLASSPATH + producerConfigLocation);
+
+ container = context.getContainer();
+
+ bypass = false;
+ }
+ else
+ {
+ log.info("The WSRP service can only be started in the default portal context. WSRP was not started for '"
+ + context.getName() + "'");
+
+ producerConfigLocation = null;
+ consumersConfigLocation = null;
+ configurationIS = null;
+ bypass = true;
+ }
+ }
+
+ public void start()
+ {
+ if (!bypass)
+ {
+ startProducer();
+ startConsumers();
+
+ // listen for web app events so that we can inject services into WSRP admin UI "cleanly"
+ // todo: this service injection should really be done using CDI... :/
+ ServletContainerFactory factory = DefaultServletContainerFactory.getInstance();
+ ServletContainer servletContainer = factory.getServletContainer();
+ servletContainer.addWebAppListener(this);
+
+ log.info("WSRP Service version '" + WSRPConstants.WSRP_SERVICE_VERSION + "' started");
+ }
+ }
+
+ private void startProducer()
+ {
+
+ JCRProducerConfigurationService producerConfigurationService;
+ try
+ {
+ producerConfigurationService = new JCRProducerConfigurationService(container);
+ producerConfigurationService.setDefaultConfigurationIS(configurationIS);
+ producerConfigurationService.reloadConfiguration();
+ }
+ catch (Exception e)
+ {
+ throw new RuntimeException("Couldn't load WSRP producer configuration from " + producerConfigLocation, e);
+ }
+ container.registerComponentInstance(ProducerConfigurationService.class, producerConfigurationService);
+
+ RegistrationPersistenceManager registrationPersistenceManager;
+ try
+ {
+ registrationPersistenceManager = new JCRRegistrationPersistenceManager(container);
+ }
+ catch (Exception e)
+ {
+ throw new RuntimeException("Couldn't instantiate RegistrationPersistenceManager", e);
+ }
+ RegistrationManager registrationManager = new RegistrationManagerImpl();
+ registrationManager.setPersistenceManager(registrationPersistenceManager);
+
+ // retrieve container portlet invoker from eXo kernel
+ ContainerPortletInvoker containerPortletInvoker =
+ (ContainerPortletInvoker)container.getComponentInstanceOfType(ContainerPortletInvoker.class);
+
+ // The producer persistence manager
+ PortletStatePersistenceManager producerPersistenceManager;
+ try
+ {
+ producerPersistenceManager = new JCRPortletStatePersistenceManager(container);
+ }
+ catch (Exception e)
+ {
+ throw new RuntimeException("Couldn't instantiate PortletStatePersistenceManager", e);
+ }
+
+ // The producer state management policy
+ StateManagementPolicyService producerStateManagementPolicy = new StateManagementPolicyService();
+ producerStateManagementPolicy.setPersistLocally(true);
+
+ // The producer state converter
+ StateConverter producerStateConverter = new StateConverterV0();
+
+ // The producer portlet invoker
+ ProducerPortletInvoker producerPortletInvoker = new ProducerPortletInvoker();
+ producerPortletInvoker.setNext(containerPortletInvoker);
+ producerPortletInvoker.setPersistenceManager(producerPersistenceManager);
+ producerPortletInvoker.setStateManagementPolicy(producerStateManagementPolicy);
+ producerPortletInvoker.setStateConverter(producerStateConverter);
+
+ // create and wire WSRP producer
+ producer = ProducerHolder.getProducer(true);
+ producer.setPortletInvoker(producerPortletInvoker);
+ producer.setRegistrationManager(registrationManager);
+ producer.setConfigurationService(producerConfigurationService);
+
+ producer.start();
+ }
+
+ private void startConsumers()
+ {
+ // retrieve federating portlet invoker from container
+ FederatingPortletInvoker federatingPortletInvoker =
+ (FederatingPortletInvoker)container.getComponentInstanceOfType(PortletInvoker.class);
+
+ try
+ {
+ consumerRegistry = new JCRConsumerRegistry(container);
+ consumerRegistry.setFederatingPortletInvoker(federatingPortletInvoker);
+ consumerRegistry.setSessionEventBroadcaster(new SimpleSessionEventBroadcaster());
+ consumerRegistry.start();
+
+ // set up a NullInvokerHandler so that when a remote producer is queried, we can start it if needed
+ ActivatingNullInvokerHandler handler = new ActivatingNullInvokerHandler();
+ handler.setConsumerRegistry(consumerRegistry);
+ federatingPortletInvoker.setNullInvokerHandler(handler);
+ }
+ catch (Exception e)
+ {
+ throw new RuntimeException("Couldn't start WSRP consumers registry.", e);
+ }
+ container.registerComponentInstance(ConsumerRegistry.class, consumerRegistry);
+ }
+
+ public void stop()
+ {
+ if (!bypass)
+ {
+ // stop listening to web app events
+ ServletContainerFactory factory = DefaultServletContainerFactory.getInstance();
+ ServletContainer servletContainer = factory.getServletContainer();
+ servletContainer.removeWebAppListener(this);
+
+ stopProducer();
+ stopConsumers();
+ }
+ }
+
+ private void stopProducer()
+ {
+ producer.stop();
+
+ producer = null;
+ }
+
+ private void stopConsumers()
+ {
+ try
+ {
+ consumerRegistry.stop();
+ }
+ catch (Exception e)
+ {
+ throw new RuntimeException("Couldn't stop WSRP consumers registry.", e);
+ }
+
+ consumerRegistry = null;
+ }
+
+ public void onEvent(WebAppEvent event)
+ {
+ if (event instanceof WebAppLifeCycleEvent)
+ {
+ WebAppLifeCycleEvent lifeCycleEvent = (WebAppLifeCycleEvent)event;
+ WebApp webApp = event.getWebApp();
+ ServletContext context = webApp.getServletContext();
+
+ // if we see the WSRP admin GUI being deployed or undeployed, inject or remove services
+ if (WSRP_ADMIN_GUI_CONTEXT_PATH.equals(webApp.getContextPath()))
+ {
+ switch (lifeCycleEvent.getType())
+ {
+ case WebAppLifeCycleEvent.ADDED:
+ context.setAttribute("ConsumerRegistry", consumerRegistry);
+ context.setAttribute("ProducerConfigurationService", producer.getConfigurationService());
+ break;
+ case WebAppLifeCycleEvent.REMOVED:
+ context.removeAttribute("ConsumerRegistry");
+ context.removeAttribute("ProducerConfigurationService");
+ break;
+ }
+ }
+ }
+ }
+
+ private static class SimpleSessionEventBroadcaster implements SessionEventBroadcaster
+ {
+ private Map<String, SessionEventListener> listeners = new ConcurrentHashMap<String, SessionEventListener>();
+
+ public void registerListener(String listenerId, SessionEventListener listener)
+ {
+ listeners.put(listenerId, listener);
+ }
+
+ public void unregisterListener(String listenerId)
+ {
+ listeners.remove(listenerId);
+ }
+
+ public void notifyListenersOf(SessionEvent event)
+ {
+ for (SessionEventListener listener : listeners.values())
+ {
+ listener.onSessionEvent(event);
+ }
+ }
+
+ }
+}
Modified: portal/trunk/web/portal/src/main/webapp/WEB-INF/conf/wsrp/wsrp-configuration.xml
===================================================================
--- portal/trunk/web/portal/src/main/webapp/WEB-INF/conf/wsrp/wsrp-configuration.xml 2010-04-14 12:11:47 UTC (rev 2634)
+++ portal/trunk/web/portal/src/main/webapp/WEB-INF/conf/wsrp/wsrp-configuration.xml 2010-04-14 12:11:51 UTC (rev 2635)
@@ -1,33 +1,35 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
+ ~ JBoss, a division of Red Hat
+ ~ Copyright 2010, Red Hat Middleware, LLC, and individual
+ ~ contributors as indicated by the @authors tag. See the
+ ~ copyright.txt in the distribution for a full listing of
+ ~ individual contributors.
+ ~
+ ~ This is free software; you can redistribute it and/or modify it
+ ~ under the terms of the GNU Lesser General Public License as
+ ~ published by the Free Software Foundation; either version 2.1 of
+ ~ the License, or (at your option) any later version.
+ ~
+ ~ This software is distributed in the hope that it will be useful,
+ ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ ~ Lesser General Public License for more details.
+ ~
+ ~ You should have received a copy of the GNU Lesser General Public
+ ~ License along with this software; if not, write to the Free
+ ~ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ ~ 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ -->
- Copyright (C) 2009 eXo Platform SAS.
-
- This is free software; you can redistribute it and/or modify it
- under the terms of the GNU Lesser General Public License as
- published by the Free Software Foundation; either version 2.1 of
- the License, or (at your option) any later version.
-
- This software is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public
- License along with this software; if not, write to the Free
- Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-
--->
-
<configuration
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd http://www.exoplaform.org/xml/ns/kernel_1_0.xsd"
xmlns="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd">
<component>
- <key>org.gatein.portal.wsrp.ExoKernelIntegration</key>
- <type>org.gatein.portal.wsrp.ExoKernelIntegration</type>
+ <key>org.gatein.portal.wsrp.WSRPServiceIntegration</key>
+ <type>org.gatein.portal.wsrp.WSRPServiceIntegration</type>
<init-params>
<value-param>
<name>producerConfigLocation</name>
14 years, 5 months
- 1
- 0