You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by dl...@apache.org on 2005/12/05 21:54:09 UTC
svn commit: r354182 - in /portals/jetspeed-2/trunk:
components/deploy-tool/xdocs/ components/prefs/xdocs/
components/rdbms/xdocs/ components/search/xdocs/ components/security/xdocs/
components/statistics/xdocs/ xdocs/ xdocs/guides/ xdocs/images/ xdocs/...
Author: dlestrat
Date: Mon Dec 5 12:54:00 2005
New Revision: 354182
URL: http://svn.apache.org/viewcvs?rev=354182&view=rev
Log:
Some clean up + portlet community start.
Added:
portals/jetspeed-2/trunk/xdocs/images/create-patch.gif (with props)
portals/jetspeed-2/trunk/xdocs/images/portlets/gems.gif (with props)
Modified:
portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml
portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml
portals/jetspeed-2/trunk/components/rdbms/xdocs/index.xml
portals/jetspeed-2/trunk/components/search/xdocs/index.xml
portals/jetspeed-2/trunk/components/security/xdocs/ldap.xml
portals/jetspeed-2/trunk/components/statistics/xdocs/aggregation.xml
portals/jetspeed-2/trunk/components/statistics/xdocs/index.xml
portals/jetspeed-2/trunk/components/statistics/xdocs/stats.xml
portals/jetspeed-2/trunk/xdocs/getting-started-binary.xml
portals/jetspeed-2/trunk/xdocs/getting-started-source.xml
portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml
portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml
portals/jetspeed-2/trunk/xdocs/portlets-community.xml
Modified: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml (original)
+++ portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml Mon Dec 5 12:54:00 2005
@@ -28,8 +28,9 @@
<code>JetspeedDeploy</code> prepares portlet applications for deployment within Jetspeed-2. When a new
portlet deployment event is registered, the <code>DeployPortletAppEventListener</code> invokes <code>JetspeedDeploy</code>
to prepare the portlet application for deployment.
- <pre>
- new JetspeedDeploy(event.getPath(), toFile.getAbsolutePath(), stripLoggers);</pre>
+ <source>
+ new JetspeedDeploy(event.getPath(), toFile.getAbsolutePath(), stripLoggers);
+ </source>
</p>
<p>
<code>JetspeedDeploy</code> copies the web application archives (.war) from the input directory to the
@@ -42,7 +43,7 @@
<p>
<code>JetspeedDeploy</code> invokes the <code>JetspeedWebApplicationRewriter</code> to infuse the <code>web.xml</code>
with the <code>JetspeedContainer</code> servlet if it does not already exist:
- <pre>
+ <source>
<servlet>
<servlet-name>JetspeedContainer</servlet-name>
<display-name>Jetspeed Container</display-name>
@@ -58,7 +59,8 @@
<servlet-mapping>
<servlet-name>JetspeedContainer</servlet-name>
<url-pattern>/container/*</url-pattern>
- </servlet-mapping></pre>
+ </servlet-mapping>
+ </source>
</p>
<p>
In the same fashion, the <code>JetspeedDeploy</code> invokes the <code>JetspeedContextRewriter</code> to manipulate
@@ -69,9 +71,9 @@
<subsection name="JetspeedDeploy Standalone Usage">
<p>
<code>JetspeedDeploy</code> can also be invoke through the command line:
- <pre>
+ <source>
java -jar jetspeed-deploy-tools-<version>.jar -s inputWarPath outputWarPath
- </pre>
+ </source>
where:
<ul>
<li><code>-s</code>: flag indicating whether or not to strip to loggers from the application. When the flag is present, the
Modified: portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml (original)
+++ portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml Mon Dec 5 12:54:00 2005
@@ -57,7 +57,7 @@
<subsection name="Preferences Goals">
<p>
The <i>Preferences</i> API provides a generic implementation for organizing properties as illustrated below:
- <pre>
+ <source>
<preferences EXTERNAL_XML_VERSION="1.0">
<root type="user">
<map />
@@ -72,7 +72,7 @@
</map>
</node>
</node>
-</root></pre>
+</root></source>
</p>
<p>
A good reference article can be found at <a href="http://www.onjava.com/pub/a/onjava/synd/2001/10/17/j2se.html">
Modified: portals/jetspeed-2/trunk/components/rdbms/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/rdbms/xdocs/index.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/rdbms/xdocs/index.xml (original)
+++ portals/jetspeed-2/trunk/components/rdbms/xdocs/index.xml Mon Dec 5 12:54:00 2005
@@ -44,22 +44,22 @@
only if no <code>jndiName</code> is set, i.e. if the connection factory uses the driver to create data sources. The platform
settings are derived from the configured data source or database driver using OJB's <code>JdbcMetadataUtils</code> class. The default
Jetspeed-2 <code>ConnectionRepositoryEntry</code> configuration expose a datasource.
- <pre>
+ <source>
<bean id="JetspeedDS" class="org.apache.jetspeed.components.rdbms.ojb.ConnectionRepositoryEntry">
<property name="jndiName">
<value>java:comp/env/jdbc/jetspeed</value>
</property>
- </bean></pre>
+ </bean></source>
</p>
<p>
In order for OJB to be configured properly with Jetspeed-2, the <code>OJB.properties</code> file (located under
<code>/etc/db-ojb/OJB.properties</code> in the source tree and <code>WEB-INF/classes</code> in the deployed application)
must set:
- <pre>
- ConnectionManagerClass=org.apache.jetspeed.components.rdbms.ojb.ConnectionManagerImpl</pre>
+ <source>
+ ConnectionManagerClass=org.apache.jetspeed.components.rdbms.ojb.ConnectionManagerImpl</source>
instead of:
- <pre>
- ConnectionFactoryClass=org.apache.ojb.broker.accesslayer.ConnectionFactoryManagedImpl</pre>
+ <source>
+ ConnectionFactoryClass=org.apache.ojb.broker.accesslayer.ConnectionFactoryManagedImpl</source>
</p>
<p>
A class diagram of <code>ConnectionRepositoryEntry</code> and <code>ConnectionManagerImpl</code> is
@@ -72,11 +72,11 @@
The bean name provided in <code>datasource.xml</code> must match the <code>jdbc-connection-descriptor</code>
<code>jcd-alias</code> property (by default <code>JetspeedDS</code>) located in OJB <code>repository_database.xml</code>
as illustrated below.
- <pre>
+ <source>
<jdbc-connection-descriptor
jcd-alias="JetspeedDS"
default-connection="true"
- batch-mode="false"></pre>
+ batch-mode="false"></source>
</p>
</subsection>
<subsection name="Jetspeed-2 Datasource Configuration in Tomcat">
@@ -85,13 +85,13 @@
is located under <code>/etc/conf/tomcat</code>. When deployed Jetspeed-2 in a Tomcat instance, the Jetspeed-2
datasource configuration are deployed under <code>${tomcat_home}/conf/Catalina/localhost/jetspeed.xml</code>. If a different
portal name is being used for Jetspeed-2, the configuration file will be named accordingly.
- <pre>
+ <source>
<Resource name="jdbc/jetspeed" auth="Container"
factory="org.apache.commons.dbcp.BasicDataSourceFactory"
type="javax.sql.DataSource" username="" password=""
driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
url="jdbc:derby:/tmp/productiondb;create=true"
- maxActive="100" maxIdle="30" maxWait="10000"/></pre>
+ maxActive="100" maxIdle="30" maxWait="10000"/></source>
</p>
</subsection>
</section>
Modified: portals/jetspeed-2/trunk/components/search/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/search/xdocs/index.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/search/xdocs/index.xml (original)
+++ portals/jetspeed-2/trunk/components/search/xdocs/index.xml Mon Dec 5 12:54:00 2005
@@ -34,14 +34,14 @@
component is configured in <code>WEB-INF/assembly/search.xml</code>. The default implementation based on the embedded Lucene
search engine must specify the location of the search index file, the name of the analyzer class (if null the default analyzer
<code>StandardAnalyzer</code> is used), whether to optimize after update and the <code>HandlerFactory</code>:
- <pre>
+ <source>
<bean id="org.apache.jetspeed.search.SearchEngine"
class="org.apache.jetspeed.search.lucene.SearchEngineImpl">
<constructor-arg index="0"><value>${applicationRoot}/WEB-INF/search_index</value></constructor-arg>
<constructor-arg index="1"><null /></constructor-arg>
<constructor-arg type="boolean"><valu>true</value></constructor-arg>
<constructor-arg><ref bean="org.apache.jetspeed.search.HandlerFactory"/></constructor-arg>
- </bean></pre>
+ </bean></source>
</p>
<p>
The <code>HandlerFactory</code> provides the <code>SearchEngine</code> with a list of <code>ObjectHandler</code>
Modified: portals/jetspeed-2/trunk/components/security/xdocs/ldap.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/security/xdocs/ldap.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/security/xdocs/ldap.xml (original)
+++ portals/jetspeed-2/trunk/components/security/xdocs/ldap.xml Mon Dec 5 12:54:00 2005
@@ -47,9 +47,9 @@
In order to configure Jetspeed 2 to use LDAP, add <i>security-spi-ldap.xml</i> and <i>security-spi-ldap-atn.xml</i> to the Jetspeed 2 application
assembly directory and remove the default authentication SPI file <i>security-spi-atn.xml</i>.
In the source, this directory is located at:
- <pre>${jetspeed-source-home}/src/webapp/WEB-INF/assembly/</pre>
+ <source>${jetspeed-source-home}/src/webapp/WEB-INF/assembly/</source>
If your application is deployed in Tomcat, this directory is located at:
- <pre>${tomcat-home}/webapps/jetspeed/WEB-INF/assembly</pre>
+ <source>${tomcat-home}/webapps/jetspeed/WEB-INF/assembly</source>
</p>
<p>
The <i>security-spi-ldap.xml</i> configuration file requires the following values to be set:
Modified: portals/jetspeed-2/trunk/components/statistics/xdocs/aggregation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/statistics/xdocs/aggregation.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/statistics/xdocs/aggregation.xml (original)
+++ portals/jetspeed-2/trunk/components/statistics/xdocs/aggregation.xml Mon Dec 5 12:54:00 2005
@@ -30,8 +30,8 @@
<p>
The <code>PortalStatistics</code> component exposes a <code>queryStatistics</code> method that given
a <code>StatisticsQueryCriteria</code> will return <code>AggregateStatistics</code>.
- <pre>
- AggregateStatistics queryStatistics(StatisticsQueryCriteria criteria)</pre>
+ <source>
+ AggregateStatistics queryStatistics(StatisticsQueryCriteria criteria)</source>
The <code>AggregateStatistics</code> can then be used for reporting purpose.
<br/>
<img src="images/aggregatestatistics-c.gif" border="0" />
@@ -43,7 +43,7 @@
for view statistics. To query statistics, a <code>StatisticsQueryCriteria</code> must be set. According to this
criteria the <code>PortalStatistics</code> <code>queryStatistics()</code> method will return an <code>AggregateStatistics</code>.
</p>
- <pre>
+ <source>
StatisticsQueryCriteria criteria = statistics.createStatisticsQueryCriteria();
...
criteria.setUser(user);
@@ -55,7 +55,7 @@
AggregateStatistics stats = statistics.getDefaultEmptyAggregateStatistics();
...
statistics.forceFlush();
- stats = statistics.queryStatistics(criteria);</pre>
+ stats = statistics.queryStatistics(criteria);</source>
</subsection>
</section>
</body>
Modified: portals/jetspeed-2/trunk/components/statistics/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/statistics/xdocs/index.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/statistics/xdocs/index.xml (original)
+++ portals/jetspeed-2/trunk/components/statistics/xdocs/index.xml Mon Dec 5 12:54:00 2005
@@ -38,8 +38,8 @@
The <code>PortalStatistics</code> implementation logs usage data based on the
<a href="http://httpd.apache.org/docs/logs.html">Apache Common Log Format (CLF)</a>
where each log entry is formatted in the form:
- <pre>
- %h %l %u %t \"%r\" %>s %b</pre>
+ <source>
+ %h %l %u %t \"%r\" %>s %b</source>
where:
<ul>
<li><b>%h </b>- remote host</li>
@@ -85,7 +85,7 @@
</p>
<p>
A sample configuration is provided below:
- <pre>
+ <source>
<bean id="PortalStatistics"
class="org.apache.jetspeed.statistics.impl.PortalStatisticsImpl"
init-method="springInit"
@@ -108,7 +108,7 @@
<constructor-arg index='7><value>60000</value></constructor-arg>
<!-- jetspeedDSEntry -->
<constructor-arg index='8'><ref bean="JetspeedDS"/></constructor-arg>
- </bean></pre>
+ </bean></source>
</p>
</subsection>
</section>
Modified: portals/jetspeed-2/trunk/components/statistics/xdocs/stats.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/statistics/xdocs/stats.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/statistics/xdocs/stats.xml (original)
+++ portals/jetspeed-2/trunk/components/statistics/xdocs/stats.xml Mon Dec 5 12:54:00 2005
@@ -30,14 +30,14 @@
</p>
<p>
For user events, the <code>SecurityValveImpl</code> logs a user login event in <code>getSubject(RequestContext request)</code>.
- <pre>
- statistics.logUserLogin(request, 0);</pre>
+ <source>
+ statistics.logUserLogin(request, 0);</source>
</p>
<p>
For portlet events, the <code>RenderingJobImpl</code> invoked in <code>RenderingJob</code> <code>buildRenderingJob</code> logs
a portlet access event.
- <pre>
- statistics.logPortletAccess(requestContext, fragment.getName(), PortalStatistics.HTTP_OK, end - start);</pre>
+ <source>
+ statistics.logPortletAccess(requestContext, fragment.getName(), PortalStatistics.HTTP_OK, end - start);</source>
</p>
</subsection>
<subsection name="Viewing Statistics">
Modified: portals/jetspeed-2/trunk/xdocs/getting-started-binary.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/getting-started-binary.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/getting-started-binary.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/getting-started-binary.xml Mon Dec 5 12:54:00 2005
@@ -626,11 +626,9 @@
</p>
<p>
Then you can access the portal with your browser at:
- <pre>
- <a href="http://localhost:8080/jetspeed">
- http://localhost:8080/jetspeed
- </a>
- </pre>
+ <source>
+ <a href="http://localhost:8080/jetspeed">http://localhost:8080/jetspeed</a>
+ </source>
or replace "jetspeed" in the above url with the name
of your own portal application (
<code>
Modified: portals/jetspeed-2/trunk/xdocs/getting-started-source.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/getting-started-source.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/getting-started-source.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/getting-started-source.xml Mon Dec 5 12:54:00 2005
@@ -1033,11 +1033,9 @@
</p>
<p>
Then you can access the portal with your browser at:
- <pre>
- <a href="http://localhost:8080/jetspeed">
- http://localhost:8080/jetspeed
- </a>
- </pre>
+ <source>
+ <a href="http://localhost:8080/jetspeed">http://localhost:8080/jetspeed</a>
+ </source>
or replace "jetspeed" in the above url with the name
of you own portal application (
<code>
Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml Mon Dec 5 12:54:00 2005
@@ -59,10 +59,10 @@
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.
- <pre>
- engine = new JetspeedEngine(properties, applicationRoot, config,
- initializeComponentManager(config, applicationRoot, properties));
- </pre>
+ <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.
Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml Mon Dec 5 12:54:00 2005
@@ -24,7 +24,19 @@
</properties>
<body>
<section name="Guide to Jetspeed-2 Development">
+ <subsection name="Working with Jetspeed-2 Source Code">
+ <p>
+ For information on how to get started with Jetspeed-2 source code, check
+ <a href="../getting-started-source.html">getting started with Jetspeed-2 source code</a>.
+ </p>
+ </subsection>
<subsection name="How to Submit Patches?">
+ <p>
+ When working with Eclipse with the <a href="http://subclipse.tigris.org/">Subclipse plugin</a>,
+ it is possible to generate a patch for the code changed as illustrated below:
+ <br/>
+ <img src="images/create-patch.gif" border="0" />
+ </p>
</subsection>
</section>
</body>
Added: portals/jetspeed-2/trunk/xdocs/images/create-patch.gif
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/images/create-patch.gif?rev=354182&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/trunk/xdocs/images/create-patch.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/trunk/xdocs/images/portlets/gems.gif
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/images/portlets/gems.gif?rev=354182&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/trunk/xdocs/images/portlets/gems.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: portals/jetspeed-2/trunk/xdocs/portlets-community.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/portlets-community.xml?rev=354182&r1=354181&r2=354182&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/portlets-community.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/portlets-community.xml Mon Dec 5 12:54:00 2005
@@ -24,6 +24,25 @@
</properties>
<body>
<section name="Portlets Community">
+ <table>
+ <tr>
+ <th>Project</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a href="https://gems.dev.java.net/"><img src="images/portlets/gems.gif" border="0" /></a></td>
+ <td><a href="https://gems.dev.java.net/">Gems</a> provides a collection of JSR-168 portlets. The list of available portlets include:
+ <ul>
+ <li>E-Mail Portlet</li>
+ <li>Calendar Portlet</li>
+ <li>Blog Portlet</li>
+ <li>RSS Feed Portlet</li>
+ <li>Calculator Portlet</li>
+ <li>Image Viewer Portlet</li>
+ <li>Horoscope Portlet</li>
+ </ul></td>
+ </tr>
+ </table>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org