Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-app-servers.xml
URL:
http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-app-servers.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-app-servers.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-app-servers.xml Sat Mar 3
18:13:22 2007
@@ -1,245 +1,245 @@
-<?xml version="1.0"?>
-<!--
- Copyright 2004 The Apache Software Foundation
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-<document>
- <properties>
- <title>Application Servers Configuration</title>
- <subtitle>Application Servers Configuration for Jetspeed
2</subtitle>
- <authors>
- <person name="David Sean Taylor" email="[EMAIL
PROTECTED]" />
- <person name="David Le Strat" email="[EMAIL PROTECTED]"
/>
- <person name="Ron Wheeler"
- email="[EMAIL PROTECTED]" />
-
- </authors>
- </properties>
- <body>
- <section name="Application Server Properties">
- <p>
- <i>
- Note: The maven-plugin currently only
supports the
- Tomcat Server 5.0.x or 5.5.x
- </i>
- </p>
- <table>
- <tr>
- <th>Property</th>
- <th>Description</th>
- <th nowrap="nowrap">Default value</th>
- </tr>
- <tr>
- <td>
-
<code>org.apache.jetspeed.server.home</code>
- </td>
- <td>
- The root folder of your Tomcat
server
- installation.
- <br />
- Example:
- <code>${CATALINA_HOME}/</code>
- .
- </td>
- <td>
- <i>no default</i>
- </td>
- </tr>
- <tr>
- <td>
-
<code>org.apache.jetspeed.server.shared</code>
- </td>
- <td>
- The location of the shared jars
in your Tomcat
- installation.
- <br />
- Example:
- <code>
-
${org.apache.jetspeed.server.home}/shared/lib/
- </code>
- </td>
- <td>
- <i>no default</i>
- </td>
- </tr>
- <tr>
- <td>
-
<code>org.apache.jetspeed.deploy.war.dir</code>
- </td>
- <td>
- The location of web
applications in your Tomcat
- installation.
- <br />
- Example:
- <code>
-
${org.apache.jetspeed.server.home}/webapps/
- </code>
- </td>
- <td>
- <i>no default</i>
- </td>
- </tr>
- <tr>
- <td>
- <code>
-
org.apache.jetspeed.services.autodeployment.user
- </code>
- </td>
- <td>
- A Tomcat user with the manager
role.
- <br />
- Used to access the Tomcat
Manager application
- from within the portal,
explained below.
- </td>
- <td>
- <i>no default</i>
- </td>
- </tr>
- <tr>
- <td>
- <code>
-
org.apache.jetspeed.services.autodeployment.password
- </code>
- </td>
- <td>
- The password of the Tomcat user
above.
- <br />
- Used to access the Tomcat
Manager application
- from within the portal,
explained below.
- </td>
- <td>
- <i>no default</i>
- </td>
- </tr>
- <tr>
- <td>
- <code>
-
org.apache.jetspeed.catalina.version.major
- </code>
- </td>
- <td>
- The major version of the Tomcat
server you are
- using: 5 or 5.5
- <br />
- Example:
- <code>5.5</code>
- </td>
- <td>
- <i>no default</i>
- </td>
- </tr>
- </table>
- </section>
- <section name="Optional Database Server Properties">
- <p>
- Jetspeed-2 and its maven-plugin uses, as well as
- provides, by default a HSQLDB database.
- </p>
- <p>
- If you want to use a different database you
will need to
- override the following properties:
- </p>
- <table>
- <tr>
- <th>Property</th>
- <th>Description</th>
- <th nowrap="nowrap">Default value</th>
- </tr>
- <tr>
- <td>
- <code>
-
org.apache.jetspeed.production.database.default.name
- </code>
- </td>
- <td>
- The type of database you are
using. Used for sql
- script generation with Torque.
- <br />
- Currently supported databases
(with
- corresponding Torque target
database name):
- <ul>
- <li>hsql
(hypersonic)</li>
- <li>oracle (oracle)</li>
- <li>mysql (mysql)</li>
- <li>postgres
(postresql)</li>
- <li>mssql (mssql)</li>
- </ul>
- </td>
- <td>hsql</td>
- </tr>
- <tr>
- <td>
- <code>
-
org.apache.jetspeed.production.database.url
- </code>
- </td>
- <td>The jdbc connection url</td>
-
<td>jdbc:hsqldb:hsql://127.0.0.1:9001</td>
- </tr>
- <tr>
- <td>
- <code>
-
org.apache.jetspeed.production.database.user
- </code>
- </td>
- <td>The database user name to connect
with.</td>
- <td>sa</td>
- </tr>
- <tr>
- <td>
- <code>
-
org.apache.jetspeed.production.database.password
- </code>
- </td>
- <td>
- The database user its password
to connect with.
- </td>
- <td>
- <i>empty</i>
- </td>
- </tr>
- <tr>
- <td>
- <code>
-
org.apache.jetspeed.production.database.driver
- </code>
- </td>
- <td>The jdbc driver class name</td>
- <td>org.hsqldb.jdbcDriver</td>
- </tr>
- <tr>
- <td>
- <code>
-
org.apache.jetspeed.production.jdbc.drivers.path
- </code>
- </td>
- <td>
- A Java classpath style path to
the jdbc driver
- classes or jar(s) needed for
connecting to the
- database.
- <br />
- Example:
- <code>
-
/lib/ojdbc14.jar;/lib/nls_charset12.jar
- </code>
- </td>
- <td>
- <i>empty</i>
- </td>
- </tr>
- </table>
- </section>
-
- </body>
-</document>
+<?xml version="1.0"?>
+<!--
+ Copyright 2004 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Application Servers Configuration</title>
+ <subtitle>Application Servers Configuration for Jetspeed
2</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="[EMAIL
PROTECTED]" />
+ <person name="David Le Strat" email="[EMAIL PROTECTED]"
/>
+ <person name="Ron Wheeler"
+ email="[EMAIL PROTECTED]" />
+
+ </authors>
+ </properties>
+ <body>
+ <section name="Application Server Properties">
+ <p>
+ <i>
+ Note: The maven-plugin currently only
supports the
+ Tomcat Server 5.0.x or 5.5.x
+ </i>
+ </p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+
<code>org.apache.jetspeed.server.home</code>
+ </td>
+ <td>
+ The root folder of your Tomcat
server
+ installation.
+ <br />
+ Example:
+ <code>${CATALINA_HOME}/</code>
+ .
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+
<code>org.apache.jetspeed.server.shared</code>
+ </td>
+ <td>
+ The location of the shared jars
in your Tomcat
+ installation.
+ <br />
+ Example:
+ <code>
+
${org.apache.jetspeed.server.home}/shared/lib/
+ </code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+
<code>org.apache.jetspeed.deploy.war.dir</code>
+ </td>
+ <td>
+ The location of web
applications in your Tomcat
+ installation.
+ <br />
+ Example:
+ <code>
+
${org.apache.jetspeed.server.home}/webapps/
+ </code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+
org.apache.jetspeed.services.autodeployment.user
+ </code>
+ </td>
+ <td>
+ A Tomcat user with the manager
role.
+ <br />
+ Used to access the Tomcat
Manager application
+ from within the portal,
explained below.
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+
org.apache.jetspeed.services.autodeployment.password
+ </code>
+ </td>
+ <td>
+ The password of the Tomcat user
above.
+ <br />
+ Used to access the Tomcat
Manager application
+ from within the portal,
explained below.
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+
org.apache.jetspeed.catalina.version.major
+ </code>
+ </td>
+ <td>
+ The major version of the Tomcat
server you are
+ using: 5 or 5.5
+ <br />
+ Example:
+ <code>5.5</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ </table>
+ </section>
+ <section name="Optional Database Server Properties">
+ <p>
+ Jetspeed-2 and its maven-plugin uses, as well as
+ provides, by default a HSQLDB database.
+ </p>
+ <p>
+ If you want to use a different database you
will need to
+ override the following properties:
+ </p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+ <code>
+
org.apache.jetspeed.production.database.default.name
+ </code>
+ </td>
+ <td>
+ The type of database you are
using. Used for sql
+ script generation with Torque.
+ <br />
+ Currently supported databases
(with
+ corresponding Torque target
database name):
+ <ul>
+ <li>hsql
(hypersonic)</li>
+ <li>oracle (oracle)</li>
+ <li>mysql (mysql)</li>
+ <li>postgres
(postresql)</li>
+ <li>mssql (mssql)</li>
+ </ul>
+ </td>
+ <td>hsql</td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+
org.apache.jetspeed.production.database.url
+ </code>
+ </td>
+ <td>The jdbc connection url</td>
+
<td>jdbc:hsqldb:hsql://127.0.0.1:9001</td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+
org.apache.jetspeed.production.database.user
+ </code>
+ </td>
+ <td>The database user name to connect
with.</td>
+ <td>sa</td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+
org.apache.jetspeed.production.database.password
+ </code>
+ </td>
+ <td>
+ The database user its password
to connect with.
+ </td>
+ <td>
+ <i>empty</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+
org.apache.jetspeed.production.database.driver
+ </code>
+ </td>
+ <td>The jdbc driver class name</td>
+ <td>org.hsqldb.jdbcDriver</td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+
org.apache.jetspeed.production.jdbc.drivers.path
+ </code>
+ </td>
+ <td>
+ A Java classpath style path to
the jdbc driver
+ classes or jar(s) needed for
connecting to the
+ database.
+ <br />
+ Example:
+ <code>
+
/lib/ojdbc14.jar;/lib/nls_charset12.jar
+ </code>
+ </td>
+ <td>
+ <i>empty</i>
+ </td>
+ </tr>
+ </table>
+ </section>
+
+ </body>
+</document>
Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-app-servers.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml
URL:
http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml Sat Mar 3
18:13:22 2007
@@ -1,245 +1,245 @@
-<?xml version="1.0"?>
-<!--
- Copyright 2004 The Apache Software Foundation
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-<document>
- <properties>
- <title>Guide to Jetspeed-2 Component Architecture</title>
- <subtitle>Guide to Jetspeed-2 Component Architecture</subtitle>
- <authors>
- <person name="David Le Strat" email="[EMAIL PROTECTED]"
/>
- </authors>
- </properties>
- <body>
- <section name="Guide to Jetspeed-2 Component Architecture">
- <p>
- The Jetspeed-2 architecture is build on a component
architecture where as defined by
- <a
href="http://www.martinfowler.com/articles/injection.html";>Martin Fowler</a>:
- <pre>
- By the term component, I mean a glob of software that's intended to be
used,
- without change, by application that is out of the control of the writers
of
- the component. By 'without change' I mean that the using application
doesn't
- change the source code of the components, although they may alter the
component's
- behavior by extending it in ways allowed by the component writers.</pre>
- </p>
- <p>
- Jetspeed-2 uses dependency injection as a programming design
pattern and architectural model
- to establish a level of abstraction via a public interface, and
to remove dependency on the components' implementation.
- The architecture unites the components rather than the
components linking themselves or being linked together.
- Dependency injection is a pattern in which responsibility for
object creation and object linking is removed
- from the objects themselves and transferred to a factory.
- Dependency injection therefore is obviously inverting the
control for object creation and linking,
- and can be seen to be a form of Inversion of Controls(IoC).
- </p>
- <subsection name="Jetspeed-2 and Component Frameworks">
- <p>
- Jetspeed-2 leverages the <a
href="http://www.springframework.org";>Spring Framework</a> as its default
component framework.
- However, Jetspeed-2 provides an architecture in which the
component framework can easily be replaced by alternative
- component frameworks such as <a
href="http://www.picocontainer.org/";>Pico</a>.
- </p>
- <p>
- Jetspeed-2 component framework assembly is configured and
implemented in <i>JetspeedServlet</i>:<br/><br/>
- <img src="images/jetspeedservlet-c.gif" border="0"/>
- </p>
- <p>
- The <code>JetspeedServlet</code> is configured in the portal
application <i>web.xml</i> to load at startup. The
<code>initializeComponentManager</code>
- method loads the <a
href="guide-portal-assembly.html">assembly</a> for the given component
framework. The default implementation
- of <code>initializeComponentManager</code> supports the <a
href="http://www.springframework.com";>spring framework</a> as a component
framework
- and assembles the xml files located under
<code>WEB-INF/assembly</code> to initialize the spring engine. The
<i>JetspeedEngine</i> is then
- constructed with the proper component manager.
- <source>
- engine = new JetspeedEngine(properties, applicationRoot, config,
- initializeComponentManager(config, applicationRoot, properties));
- </source>
- </p>
- <p>
- In order to support another component framework, developers
should override the <code>initializeComponentManager</code> implementation.
- </p>
- </subsection>
- <subsection name="Jetspeed-2 Core Components">
- <table>
- <tr>
- <th colspan="2">Jetspeed-2 Capabilities - Artifact Id:
jetspeed-capability</th>
- </tr>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-capability/index.html"><code>Capabilities</code></a></td>
- <td>The <code>Capabilities</code> components maps clients to
supported mime types and media types.
- It creates a <code>CapabilityMap</code> that is used through the
portal engine to render the
- portal content for the targetted client.</td>
- </tr>
- </table><br/>
- <table>
- <tr>
- <th colspan="2">Jetspeed-2 Component Manager - Artifact Id:
jetspeed-cm</th>
- </tr>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-cm/index.html"><code>ComponentManager</code></a></td>
- <td>The <code>ComponentManager</code> provides a generic layer of
abstraction on top of the component framework
- being used. The default <code>ComponentManager</code>
implementation in Jetspeed-2 is the
- <code>SpringComponentManager</code>. More information can be
found in the
- <a
href="../multiproject/jetspeed-cm/index.html"><code>ComponentManager</code>
documentation</a>.</td>
- </tr>
- </table><br/>
- <table>
- <tr>
- <th colspan="2">Jetspeed-2 Deploy Tools - Artifact Id:
jetspeed-deploy-tools</th>
- </tr>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-deploy-tools/deploy-tools.html"><code>JetspeedDeploy</code></a></td>
- <td><code>JetspeedDeploy</code> prepares portlet applications
prior to being deployed in Jetspeed-2. More information can be found in the
- <a
href="../multiproject/jetspeed-deploy-tools/deploy-tools.html"><code>JetspeedDeploy</code>
documentation</a>.</td>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-deploy-tools/index.html"><code>DeploymentManager</code></a></td>
- <td>The <code>DeploymentManager</code> listens for new portal
assets (portlets, decorators) to be deployed. An overview of how deployment
- works in Jetspeed-2 can be found <a
href="../multiproject/jetspeed-deploy-tools/index.html">here</a>.</td>
- </tr>
- </table><br/>
- <table>
- <tr>
- <th colspan="2">Jetspeed-2 Portal - Artifact Id:
jetspeed-portal</th>
- </tr>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-portal/pipeline.html"><code>Pipeline</code></a></td>
- <td>The <code>Pipeline</code> orchestrates the <code>Valve</code>
that are performing atomic operation on a
- Jetspeed-2 request.</td>
- </tr>
- </table><br/>
- <table>
- <tr>
- <th colspan="2">Jetspeed-2 Preferences - Artifact Id:
jetspeed-prefs</th>
- </tr>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-prefs/index.html"><code>PreferencesProvider</code></a></td>
- <td>The <code>PreferencesProvider</code> exposes Jetspeed-2
implementation of the <code>java.util.Preferences</code> API.</td>
- </tr>
- </table><br/>
- <table>
- <tr>
- <th colspan="2">Jetspeed-2 RDBMS - Artifact Id:
jetspeed-rdbms</th>
- </tr>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-rdbms/index.html"><code>ConnectionRepositoryEntry</code></a></td>
- <td>The <code>ConnectionRepositoryEntry</code> exposes Jetspeed-2
implementation of the <code>java.util.Preferences</code> API.</td>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-rdbms/dao.html"><code>InitablePersistenceBrokerDaoSupport</code></a></td>
- <td><code>InitablePersistenceBrokerDaoSupport</code> provides data
access and persistence support for Jetspeed-2.</td>
- </tr>
- </table><br/>
- <table>
- <tr>
- <th colspan="2">Jetspeed-2 Security - Artifact Id:
jetspeed-security</th>
- </tr>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-security/arch.html"><code>DefaultLoginModule</code></a><br/>
- <a
href="../multiproject/jetspeed-security/arch.html"><code>RdbmsPolicy</code></a><br/></td>
- <td>Jetspeed-2 default implementation for <a
href="http://java.sun.com/products/jaas/";>JAAS services</a>. Jetspeed-2
leverages JAAS as
- a generic security standard framework to expose security
functionality to the portal engine. The JAAS services
- leverage Jetspeed-2 coarsed grained services for which specific
implementations are provided through Jetpseed-2 security SPI.</td>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-security/arch.html"><code>UserManager</code></a><br/>
- <a
href="../multiproject/jetspeed-security/arch.html"><code>RoleManager</code></a><br/>
- <a
href="../multiproject/jetspeed-security/arch.html"><code>GroupManager</code></a><br/>
- <a
href="../multiproject/jetspeed-security/arch.html"><code>PermissionManager</code></a></td>
- <td>Coarsed grained security components exposing Jetspeed-2
security management APIs.</td>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-security/arch.html"><code>UserSecurityHandler</code></a><br/>
- <a
href="../multiproject/jetspeed-security/arch.html"><code>CredentialHandler</code></a><br/>
- <a
href="../multiproject/jetspeed-security/arch.html"><code>GroupSecurityHandler</code></a><br/>
- <a
href="../multiproject/jetspeed-security/arch.html"><code>RoleSecurityHandler</code></a><br/>
- <a
href="../multiproject/jetspeed-security/arch.html"><code>SecurityMappingHandler</code></a></td>
- <td>Fined grained Jetspeed-2 security SPI components exposing a
specific implementation to the Jetspeed-2
- security engine. This mechanism provides a flexible framework for
supporting multiple security implementation
- without having to impact the higher level security services.</td>
- </tr>
- </table><br/>
- <table>
- <tr>
- <th colspan="2">Jetspeed-2 Search - Artifact Id:
jetspeed-search</th>
- </tr>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-search/index.html"><code>SearchEngine</code></a></td>
- <td><code>SearchEngine</code> provides the integration with the <a
href="http://lucene.apache.org/";>Apache Lucene</a> search
- engine.</td>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-search/index.html"><code>HandlerFactory</code></a></td>
- <td>The <code>HandlerFactory</code> exposes the documents handlers
to the <code>SearchEngine</code>.</td>
- </tr>
- </table><br/>
- <table>
- <tr>
- <th colspan="2">Jetspeed-2 Statistics - Artifact Id:
jetspeed-statistics</th>
- </tr>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-statistics/index.html"><code>PortalStatistics</code></a></td>
- <td><code>PortalStatistics</code> exposes the Jetspeed-2 data
collection API for data collection and data
- retrieval.</td>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-statistics/index.html"><code>BatchedStatistics</code></a></td>
- <td><code>BatchedStatistics</code> is responsible for the batch
collection of statistics data given
- a time to flush period.</td>
- </tr>
- <tr>
- <td><a
href="../multiproject/jetspeed-statistics/aggregation.html"><code>AggregateStatistics</code></a><br/>
- <a
href="../multiproject/jetspeed-statistics/aggregation.html"><code>StatisticsQueryCriteria</code></a></td>
- <td><code>AggregateStatistics</code> interacts with the
<code>PortalStatistics</code> component to provide
- aggregate portal data for a specific event and search criteria
provided by <code>StatisticsQueryCriteria</code>.</td>
- </tr>
- </table>
- </subsection>
- </section>
- </body>
+<?xml version="1.0"?>
+<!--
+ Copyright 2004 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Guide to Jetspeed-2 Component Architecture</title>
+ <subtitle>Guide to Jetspeed-2 Component Architecture</subtitle>
+ <authors>
+ <person name="David Le Strat" email="[EMAIL PROTECTED]"
/>
+ </authors>
+ </properties>
+ <body>
+ <section name="Guide to Jetspeed-2 Component Architecture">
+ <p>
+ The Jetspeed-2 architecture is build on a component
architecture where as defined by
+ <a
href="http://www.martinfowler.com/articles/injection.html";>Martin Fowler</a>:
+ <pre>
+ By the term component, I mean a glob of software that's intended to be
used,
+ without change, by application that is out of the control of the writers
of
+ the component. By 'without change' I mean that the using application
doesn't
+ change the source code of the components, although they may alter the
component's
+ behavior by extending it in ways allowed by the component writers.</pre>
+ </p>
+ <p>
+ Jetspeed-2 uses dependency injection as a programming design
pattern and architectural model
+ to establish a level of abstraction via a public interface, and
to remove dependency on the components' implementation.
+ The architecture unites the components rather than the
components linking themselves or being linked together.
+ Dependency injection is a pattern in which responsibility for
object creation and object linking is removed
+ from the objects themselves and transferred to a factory.
+ Dependency injection therefore is obviously inverting the
control for object creation and linking,
+ and can be seen to be a form of Inversion of Controls(IoC).
+ </p>
+ <subsection name="Jetspeed-2 and Component Frameworks">
+ <p>
+ Jetspeed-2 leverages the <a
href="http://www.springframework.org";>Spring Framework</a> as its default
component framework.
+ However, Jetspeed-2 provides an architecture in which the
component framework can easily be replaced by alternative
+ component frameworks such as <a
href="http://www.picocontainer.org/";>Pico</a>.
+ </p>
+ <p>
+ Jetspeed-2 component framework assembly is configured and
implemented in <i>JetspeedServlet</i>:<br/><br/>
+ <img src="images/jetspeedservlet-c.gif" border="0"/>
+ </p>
+ <p>
+ The <code>JetspeedServlet</code> is configured in the portal
application <i>web.xml</i> to load at startup. The
<code>initializeComponentManager</code>
+ method loads the <a
href="guide-portal-assembly.html">assembly</a> for the given component
framework. The default implementation
+ of <code>initializeComponentManager</code> supports the <a
href="http://www.springframework.com";>spring framework</a> as a component
framework
+ and assembles the xml files located under
<code>WEB-INF/assembly</code> to initialize the spring engine. The
<i>JetspeedEngine</i> is then
+ constructed with the proper component manager.
+ <source>
+ engine = new JetspeedEngine(properties, applicationRoot, config,
+ initializeComponentManager(config, applicationRoot, properties));
+ </source>
+ </p>
+ <p>
+ In order to support another component framework, developers
should override the <code>initializeComponentManager</code> implementation.
+ </p>
+ </subsection>
+ <subsection name="Jetspeed-2 Core Components">
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 Capabilities - Artifact Id:
jetspeed-capability</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-capability/index.html"><code>Capabilities</code></a></td>
+ <td>The <code>Capabilities</code> components maps clients to
supported mime types and media types.
+ It creates a <code>CapabilityMap</code> that is used through the
portal engine to render the
+ portal content for the targetted client.</td>
+ </tr>
+ </table><br/>
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 Component Manager - Artifact Id:
jetspeed-cm</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-cm/index.html"><code>ComponentManager</code></a></td>
+ <td>The <code>ComponentManager</code> provides a generic layer of
abstraction on top of the component framework
+ being used. The default <code>ComponentManager</code>
implementation in Jetspeed-2 is the
+ <code>SpringComponentManager</code>. More information can be
found in the
+ <a
href="../multiproject/jetspeed-cm/index.html"><code>ComponentManager</code>
documentation</a>.</td>
+ </tr>
+ </table><br/>
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 Deploy Tools - Artifact Id:
jetspeed-deploy-tools</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-deploy-tools/deploy-tools.html"><code>JetspeedDeploy</code></a></td>
+ <td><code>JetspeedDeploy</code> prepares portlet applications
prior to being deployed in Jetspeed-2. More information can be found in the
+ <a
href="../multiproject/jetspeed-deploy-tools/deploy-tools.html"><code>JetspeedDeploy</code>
documentation</a>.</td>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-deploy-tools/index.html"><code>DeploymentManager</code></a></td>
+ <td>The <code>DeploymentManager</code> listens for new portal
assets (portlets, decorators) to be deployed. An overview of how deployment
+ works in Jetspeed-2 can be found <a
href="../multiproject/jetspeed-deploy-tools/index.html">here</a>.</td>
+ </tr>
+ </table><br/>
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 Portal - Artifact Id:
jetspeed-portal</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-portal/pipeline.html"><code>Pipeline</code></a></td>
+ <td>The <code>Pipeline</code> orchestrates the <code>Valve</code>
that are performing atomic operation on a
+ Jetspeed-2 request.</td>
+ </tr>
+ </table><br/>
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 Preferences - Artifact Id:
jetspeed-prefs</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-prefs/index.html"><code>PreferencesProvider</code></a></td>
+ <td>The <code>PreferencesProvider</code> exposes Jetspeed-2
implementation of the <code>java.util.Preferences</code> API.</td>
+ </tr>
+ </table><br/>
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 RDBMS - Artifact Id:
jetspeed-rdbms</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-rdbms/index.html"><code>ConnectionRepositoryEntry</code></a></td>
+ <td>The <code>ConnectionRepositoryEntry</code> exposes Jetspeed-2
implementation of the <code>java.util.Preferences</code> API.</td>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-rdbms/dao.html"><code>InitablePersistenceBrokerDaoSupport</code></a></td>
+ <td><code>InitablePersistenceBrokerDaoSupport</code> provides data
access and persistence support for Jetspeed-2.</td>
+ </tr>
+ </table><br/>
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 Security - Artifact Id:
jetspeed-security</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-security/arch.html"><code>DefaultLoginModule</code></a><br/>
+ <a
href="../multiproject/jetspeed-security/arch.html"><code>RdbmsPolicy</code></a><br/></td>
+ <td>Jetspeed-2 default implementation for <a
href="http://java.sun.com/products/jaas/";>JAAS services</a>. Jetspeed-2
leverages JAAS as
+ a generic security standard framework to expose security
functionality to the portal engine. The JAAS services
+ leverage Jetspeed-2 coarsed grained services for which specific
implementations are provided through Jetpseed-2 security SPI.</td>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-security/arch.html"><code>UserManager</code></a><br/>
+ <a
href="../multiproject/jetspeed-security/arch.html"><code>RoleManager</code></a><br/>
+ <a
href="../multiproject/jetspeed-security/arch.html"><code>GroupManager</code></a><br/>
+ <a
href="../multiproject/jetspeed-security/arch.html"><code>PermissionManager</code></a></td>
+ <td>Coarsed grained security components exposing Jetspeed-2
security management APIs.</td>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-security/arch.html"><code>UserSecurityHandler</code></a><br/>
+ <a
href="../multiproject/jetspeed-security/arch.html"><code>CredentialHandler</code></a><br/>
+ <a
href="../multiproject/jetspeed-security/arch.html"><code>GroupSecurityHandler</code></a><br/>
+ <a
href="../multiproject/jetspeed-security/arch.html"><code>RoleSecurityHandler</code></a><br/>
+ <a
href="../multiproject/jetspeed-security/arch.html"><code>SecurityMappingHandler</code></a></td>
+ <td>Fined grained Jetspeed-2 security SPI components exposing a
specific implementation to the Jetspeed-2
+ security engine. This mechanism provides a flexible framework for
supporting multiple security implementation
+ without having to impact the higher level security services.</td>
+ </tr>
+ </table><br/>
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 Search - Artifact Id:
jetspeed-search</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-search/index.html"><code>SearchEngine</code></a></td>
+ <td><code>SearchEngine</code> provides the integration with the <a
href="http://lucene.apache.org/";>Apache Lucene</a> search
+ engine.</td>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-search/index.html"><code>HandlerFactory</code></a></td>
+ <td>The <code>HandlerFactory</code> exposes the documents handlers
to the <code>SearchEngine</code>.</td>
+ </tr>
+ </table><br/>
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 Statistics - Artifact Id:
jetspeed-statistics</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-statistics/index.html"><code>PortalStatistics</code></a></td>
+ <td><code>PortalStatistics</code> exposes the Jetspeed-2 data
collection API for data collection and data
+ retrieval.</td>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-statistics/index.html"><code>BatchedStatistics</code></a></td>
+ <td><code>BatchedStatistics</code> is responsible for the batch
collection of statistics data given
+ a time to flush period.</td>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-statistics/aggregation.html"><code>AggregateStatistics</code></a><br/>
+ <a
href="../multiproject/jetspeed-statistics/aggregation.html"><code>StatisticsQueryCriteria</code></a></td>
+ <td><code>AggregateStatistics</code> interacts with the
<code>PortalStatistics</code> component to provide
+ aggregate portal data for a specific event and search criteria
provided by <code>StatisticsQueryCriteria</code>.</td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
+ </body>
</document>
Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-database.xml
URL:
http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-database.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-database.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-database.xml Sat Mar 3
18:13:22 2007
@@ -1,272 +1,272 @@
-<?xml version="1.0"?>
-<!--
- Copyright 2004 The Apache Software Foundation
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-<document>
- <properties>
- <title>Jetspeed 2 Database Configuration</title>
- <subtitle>Welcome to Jetspeed 2</subtitle>
- <authors>
- <person name="David Sean Taylor" email="[EMAIL
PROTECTED]" />
- <person name="David Le Strat" email="[EMAIL PROTECTED]"
/>
- <person name="Ron Wheeler"
- email="[EMAIL PROTECTED]" />
- </authors>
- </properties>
- <body>
- <section name="Default Database">
- <p>
- The default database distributed with
Jetspeed-2 is the
- Apache Derby database. To move on to a more
robust
- database, follow the instructions in the next
section.
- </p>
- </section>
- <section name='Supported Databases'>
- <p>List of supported databases:</p>
- <table>
- <tr>
- <th>Database Name</th>
- <th>Build Constant</th>
- <th>Tested Versions</th>
- </tr>
- <tr>
- <td>IBM DB2</td>
- <td>db2</td>
- <td>9.1</td>
- </tr>
- <tr>
- <td>Apache Derby, IBM Cloudscape</td>
- <td>derby</td>
- <td>10.1</td>
- </tr>
- <tr>
- <td>Hypersonic SQL (HSQL)</td>
- <td>hsql</td>
- <td>1.8</td>
- </tr>
- <tr>
- <td>Microsoft SQL Server</td>
- <td>mssql</td>
- <td>2000, 2005</td>
- </tr>
- <tr>
- <td>MySQL</td>
- <td>mysql</td>
- <td>4.*, 5.*</td>
- </tr>
- <tr>
- <td>Oracle</td>
- <td>oracle</td>
- <td>9i, 10g</td>
- </tr>
- <tr>
- <td>PostgreSQL</td>
- <td>postgres</td>
- <td>8.*</td>
- </tr>
- <tr>
- <td>SAP DB, MaxDB</td>
- <td>sapdb</td>
- <td>7.5</td>
- </tr>
- </table>
- </section>
- <section name="MySQL">
- <p>
- To run with My SQL, add the following
properties to your
- $HOME/build.properties:
- </p>
- <source test="">
- <![CDATA[
-
-# -------------------------------------------------------------------------
-# configure MySQL Test DB (only needed when running unit tests)
-# -------------------------------------------------------------------------
-org.apache.jetspeed.test.database.default.name=mysql
-org.apache.jetspeed.test.database.url = jdbc:mysql://j2-server/j2test
-org.apache.jetspeed.test.database.driver = com.mysql.jdbc.Driver
-org.apache.jetspeed.test.database.user = jetspeed2
-org.apache.jetspeed.test.database.password = whatever
-# -------------------------------------------------------------------------
-# configure MySQL Production DB
-# -------------------------------------------------------------------------
-org.apache.jetspeed.production.database.default.name=mysql
-org.apache.jetspeed.production.database.url = jdbc:mysql://j2-server/j2
-org.apache.jetspeed.production.database.driver = com.mysql.jdbc.Driver
-org.apache.jetspeed.production.database.user = jetspeed2
-org.apache.jetspeed.production.database.password = whatever
-# -------------------------------------------------------------------------
-
-]]>
- </source>
- <p>
- In the example above, you will need to have a
MySQL
- server running on a host named 'j2-server' with
a
- database called 'j2' for production.
- <br />
- If you are going to run the unit tests you will
also
- need an additional test database called
'j2test'.
- <br />
- A user named 'jetspeed2' should be granted
access to
- both the 'j2' and 'j2test' databases.
- </p>
-
- <subsection name="MySQL Known Issues">
- <p>None</p>
- </subsection>
-
- </section>
-
- <section name="Oracle">
- <p>
- To run with Oracle, add the following
properties to your
- $HOME/build.properties:
- </p>
-
- <source test="">
- <![CDATA[
-
-# -------------------------------------------------------------------------
-# configure Oracle Test DB (only needed when running unit tests)
-# -------------------------------------------------------------------------
-# org.apache.jetspeed.test.database.default.name=oracle
-# org.apache.jetspeed.test.database.ojb.platform=oracle9i
-# org.apache.jetspeed.test.database.url = jdbc:oracle:thin:@j2-sever:1521:j2db
-# org.apache.jetspeed.test.database.driver = oracle.jdbc.driver.OracleDriver
-# org.apache.jetspeed.test.database.user = j2test
-# org.apache.jetspeed.test.database.password = whatever
-# -------------------------------------------------------------------------
-# configure Oracle Production DB
-# -------------------------------------------------------------------------
-# org.apache.jetspeed.production.database.default.name=oracle
-# org.apache.jetspeed.production.database.ojb.platform=oracle9i
-# org.apache.jetspeed.production.database.url =
jdbc:oracle:thin:@j2-server:1521:j2db
-# org.apache.jetspeed.production.database.driver =
oracle.jdbc.driver.OracleDriver
-# org.apache.jetspeed.production.database.user = j2
-# org.apache.jetspeed.production.database.password = whatever
-# -------------------------------------------------------------------------
-
-]]>
- </source>
- <p>
- In the example above, you will need to have a
Oracle
- server running on a host named 'j2-server' and
have an
- Oracle database SID named 'j2db' installed on
that
- server. Also, you will need a database user
(schema)
- called 'j2' for production usage.
- <br />
- If you are going to run the unit tests you will
need an
- additional user called 'j2test'.
- </p>
-
- <subsection name="Oracle Known Issues">
- <p>
- Only for the first time you create the
database for
- Oracle, there is an issue with the drop
statements.
- To get around this problem, set your
properties as
- above in your $HOME/build.properties,
and then run
- these commands using the
- <a href="j2-maven-plugin.html">
- Jetspeed 2 Maven plugin
- </a>
- :
- </p>
- <source test="">
- <![CDATA[
-
-maven j2:db.scripts.gen
-maven j2:dropdrops
-maven j2:db.create.test (only when running unit tests)
-maven j2:db.create.production
-
-]]>
- </source>
- </subsection>
-
- </section>
-
- <section name="Drivers">
- <p>
- JDBC drivers are configured to work with the
Maven build
- by adding your specified JDBC driver jars to
the Maven
- class path. Specify the jars with the
-
<b>org.apache.jetspeed.test.jdbc.drivers.path</b>
- and
-
<b>org.apache.jetspeed.production.jdbc.drivers.path</b>
- properties in your $HOME/build.properties.
- </p>
- <p>
- NOTE: The Hypersonic JDBC driver is distributed
with
- Jetspeed and require no configuration.
- </p>
- <source test="">
- <![CDATA[
-
-# My SQL Driver Path Example, test and production
-org.apache.jetspeed.test.jdbc.drivers.path=
- /Portal/lib/MySQL/mysql-connector-java-3.0.8-stable-bin.jar
-org.apache.jetspeed.production.jdbc.drivers.path=
- /Portal/lib/MySQL/mysql-connector-java-3.0.8-stable-bin.jar
-
-# Oracle 9i Driver Path Example, test and production
-org.apache.jetspeed.test.jdbc.drivers.path=
- /Portal/lib/oracle/ojdbc14.jar;/Portal/lib/oracle/nls_charset12.jar
-org.apache.jetspeed.production.jdbc.drivers.path=
- /Portal/lib/oracle/ojdbc14.jar;/Portal/lib/oracle/nls_charset12.jar
-
-# Oracle 8i Driver Path Example, test and production
-org.apache.jetspeed.test.jdbc.drivers.path=
- /Portal/lib/oracle/classes12.jar;
-org.apache.jetspeed.production.jdbc.drivers.path=
- /Portal/lib/oracle/classes12.jar;
-
-]]>
- </source>
-
- <subsection name="Distributing Drivers">
- <p>
- When Jetspeed is deployed to an
application server
- using the maven deploy target, only the
Hypersonic
- JDBC driver is copied into the web
application. To
- distribute a specific driver (i.e.
Oracle, MySQL),
- you will need to copy the driver into
the
- application server's common class path
for shared
- code.
- </p>
- <table>
- <tr>
- <th>Application Server</th>
- <th>Procedure</th>
- </tr>
- <tr>
- <td>Tomcat 5 and 5.5</td>
- <td>
- copy driver(s) to
${TOMCAT_HOME}/endorsed/
- </td>
- </tr>
-
- </table>
-
- </subsection>
- <subsection name="Datasource Configuration with
Jetspeed-2">
- <p>
- Jetspeed-2 requires a datasource to be configured in
the application server on which it is being deployed.
- For more information, see the <a
href="../multiproject/jetspeed-rdbms/index.html">RDBMS component
documentation</a>.
- </p>
- </subsection>
-
- </section>
- </body>
-</document>
+<?xml version="1.0"?>
+<!--
+ Copyright 2004 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Jetspeed 2 Database Configuration</title>
+ <subtitle>Welcome to Jetspeed 2</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="[EMAIL
PROTECTED]" />
+ <person name="David Le Strat" email="[EMAIL PROTECTED]"
/>
+ <person name="Ron Wheeler"
+ email="[EMAIL PROTECTED]" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Default Database">
+ <p>
+ The default database distributed with
Jetspeed-2 is the
+ Apache Derby database. To move on to a more
robust
+ database, follow the instructions in the next
section.
+ </p>
+ </section>
+ <section name='Supported Databases'>
+ <p>List of supported databases:</p>
+ <table>
+ <tr>
+ <th>Database Name</th>
+ <th>Build Constant</th>
+ <th>Tested Versions</th>
+ </tr>
+ <tr>
+ <td>IBM DB2</td>
+ <td>db2</td>
+ <td>9.1</td>
+ </tr>
+ <tr>
+ <td>Apache Derby, IBM Cloudscape</td>
+ <td>derby</td>
+ <td>10.1</td>
+ </tr>
+ <tr>
+ <td>Hypersonic SQL (HSQL)</td>
+ <td>hsql</td>
+ <td>1.8</td>
+ </tr>
+ <tr>
+ <td>Microsoft SQL Server</td>
+ <td>mssql</td>
+ <td>2000, 2005</td>
+ </tr>
+ <tr>
+ <td>MySQL</td>
+ <td>mysql</td>
+ <td>4.*, 5.*</td>
+ </tr>
+ <tr>
+ <td>Oracle</td>
+ <td>oracle</td>
+ <td>9i, 10g</td>
+ </tr>
+ <tr>
+ <td>PostgreSQL</td>
+ <td>postgres</td>
+ <td>8.*</td>
+ </tr>
+ <tr>
+ <td>SAP DB, MaxDB</td>
+ <td>sapdb</td>
+ <td>7.5</td>
+ </tr>
+ </table>
+ </section>
+ <section name="MySQL">
+ <p>
+ To run with My SQL, add the following
properties to your
+ $HOME/build.properties:
+ </p>
+ <source test="">
+ <![CDATA[
+
+# -------------------------------------------------------------------------
+# configure MySQL Test DB (only needed when running unit tests)
+# -------------------------------------------------------------------------
+org.apache.jetspeed.test.database.default.name=mysql
+org.apache.jetspeed.test.database.url = jdbc:mysql://j2-server/j2test
+org.apache.jetspeed.test.database.driver = com.mysql.jdbc.Driver
+org.apache.jetspeed.test.database.user = jetspeed2
+org.apache.jetspeed.test.database.password = whatever
+# -------------------------------------------------------------------------
+# configure MySQL Production DB
+# -------------------------------------------------------------------------
+org.apache.jetspeed.production.database.default.name=mysql
+org.apache.jetspeed.production.database.url = jdbc:mysql://j2-server/j2
+org.apache.jetspeed.production.database.driver = com.mysql.jdbc.Driver
+org.apache.jetspeed.production.database.user = jetspeed2
+org.apache.jetspeed.production.database.password = whatever
+# -------------------------------------------------------------------------
+
+]]>
+ </source>
+ <p>
+ In the example above, you will need to have a
MySQL
+ server running on a host named 'j2-server' with
a
+ database called 'j2' for production.
+ <br />
+ If you are going to run the unit tests you will
also
+ need an additional test database called
'j2test'.
+ <br />
+ A user named 'jetspeed2' should be granted
access to
+ both the 'j2' and 'j2test' databases.
+ </p>
+
+ <subsection name="MySQL Known Issues">
+ <p>None</p>
+ </subsection>
+
+ </section>
+
+ <section name="Oracle">
+ <p>
+ To run with Oracle, add the following
properties to your
+ $HOME/build.properties:
+ </p>
+
+ <source test="">
+ <![CDATA[
+
+# -------------------------------------------------------------------------
+# configure Oracle Test DB (only needed when running unit tests)
+# -------------------------------------------------------------------------
+# org.apache.jetspeed.test.database.default.name=oracle
+# org.apache.jetspeed.test.database.ojb.platform=oracle9i
+# org.apache.jetspeed.test.database.url = jdbc:oracle:thin:@j2-sever:1521:j2db
+# org.apache.jetspeed.test.database.driver = oracle.jdbc.driver.OracleDriver
+# org.apache.jetspeed.test.database.user = j2test
+# org.apache.jetspeed.test.database.password = whatever
+# -------------------------------------------------------------------------
+# configure Oracle Production DB
+# -------------------------------------------------------------------------
+# org.apache.jetspeed.production.database.default.name=oracle
+# org.apache.jetspeed.production.database.ojb.platform=oracle9i
+# org.apache.jetspeed.production.database.url =
jdbc:oracle:thin:@j2-server:1521:j2db
+# org.apache.jetspeed.production.database.driver =
oracle.jdbc.driver.OracleDriver
+# org.apache.jetspeed.production.database.user = j2
+# org.apache.jetspeed.production.database.password = whatever
+# -------------------------------------------------------------------------
+
+]]>
+ </source>
+ <p>
+ In the example above, you will need to have a
Oracle
+ server running on a host named 'j2-server' and
have an
+ Oracle database SID named 'j2db' installed on
that
+ server. Also, you will need a database user
(schema)
+ called 'j2' for production usage.
+ <br />
+ If you are going to run the unit tests you will
need an
+ additional user called 'j2test'.
+ </p>
+
+ <subsection name="Oracle Known Issues">
+ <p>
+ Only for the first time you create the
database for
+ Oracle, there is an issue with the drop
statements.
+ To get around this problem, set your
properties as
+ above in your $HOME/build.properties,
and then run
+ these commands using the
+ <a href="j2-maven-plugin.html">
+ Jetspeed 2 Maven plugin
+ </a>
+ :
+ </p>
+ <source test="">
+ <![CDATA[
+
+maven j2:db.scripts.gen
+maven j2:dropdrops
+maven j2:db.create.test (only when running unit tests)
+maven j2:db.create.production
+
+]]>
+ </source>
+ </subsection>
+
+ </section>
+
+ <section name="Drivers">
+ <p>
+ JDBC drivers are configured to work with the
Maven build
+ by adding your specified JDBC driver jars to
the Maven
+ class path. Specify the jars with the
+
<b>org.apache.jetspeed.test.jdbc.drivers.path</b>
+ and
+
<b>org.apache.jetspeed.production.jdbc.drivers.path</b>
+ properties in your $HOME/build.properties.
+ </p>
+ <p>
+ NOTE: The Hypersonic JDBC driver is distributed
with
+ Jetspeed and require no configuration.
+ </p>
+ <source test="">
+ <![CDATA[
+
+# My SQL Driver Path Example, test and production
+org.apache.jetspeed.test.jdbc.drivers.path=
+ /Portal/lib/MySQL/mysql-connector-java-3.0.8-stable-bin.jar
+org.apache.jetspeed.production.jdbc.drivers.path=
+ /Portal/lib/MySQL/mysql-connector-java-3.0.8-stable-bin.jar
+
+# Oracle 9i Driver Path Example, test and production
+org.apache.jetspeed.test.jdbc.drivers.path=
+ /Portal/lib/oracle/ojdbc14.jar;/Portal/lib/oracle/nls_charset12.jar
+org.apache.jetspeed.production.jdbc.drivers.path=
+ /Portal/lib/oracle/ojdbc14.jar;/Portal/lib/oracle/nls_charset12.jar
+
+# Oracle 8i Driver Path Example, test and production
+org.apache.jetspeed.test.jdbc.drivers.path=
+ /Portal/lib/oracle/classes12.jar;
+org.apache.jetspeed.production.jdbc.drivers.path=
+ /Portal/lib/oracle/classes12.jar;
+
+]]>
+ </source>
+
+ <subsection name="Distributing Drivers">
+ <p>
+ When Jetspeed is deployed to an
application server
+ using the maven deploy target, only the
Hypersonic
+ JDBC driver is copied into the web
application. To
+ distribute a specific driver (i.e.
Oracle, MySQL),
+ you will need to copy the driver into
the
+ application server's common class path
for shared
+ code.
+ </p>
+ <table>
+ <tr>
+ <th>Application Server</th>
+ <th>Procedure</th>
+ </tr>
+ <tr>
+ <td>Tomcat 5 and 5.5</td>
+ <td>
+ copy driver(s) to
${TOMCAT_HOME}/endorsed/
+ </td>
+ </tr>
+
+ </table>
+
+ </subsection>
+ <subsection name="Datasource Configuration with
Jetspeed-2">
+ <p>
+ Jetspeed-2 requires a datasource to be configured in
the application server on which it is being deployed.
+ For more information, see the <a
href="../multiproject/jetspeed-rdbms/index.html">RDBMS component
documentation</a>.
+ </p>
+ </subsection>
+
+ </section>
+ </body>
+</document>
Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-database.xml
------------------------------------------------------------------------------
svn:eol-style = native
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
