Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/aggregation.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/aggregation.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/aggregation.xml (added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/aggregation.xml Tue Dec 2 00:53:22 2008
@@ -0,0 +1,64 @@
+<?xml version="1.0" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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 Statistics</title>
+ <authors>
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Data Aggregation Overview">
+ <p>
+ Jetspeed-2 provides a mechanism for aggregating portal statistics for reporting purpose.
+ </p>
+ <subsection name="Retrieving Aggregate Statistics">
+ <p>
+ The <code>PortalStatistics</code> component exposes a <code>queryStatistics</code> method that given
+ a <code>StatisticsQueryCriteria</code> will return <code>AggregateStatistics</code>.
+ <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" />
+ </p>
+ </subsection>
+ <subsection name="Using Aggregate Statistics">
+ <p>
+ As illustrated in <a href="stats.html">viewing statistics</a>, Jetspeed-2 provides a default reporting portlet
+ 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>
+ <source>
+ StatisticsQueryCriteria criteria = statistics.createStatisticsQueryCriteria();
+ ...
+ criteria.setUser(user);
+ criteria.setListsize("5");
+ criteria.setSorttype("count");
+ criteria.setSortorder("desc");
+ criteria.setTimePeriod(timeperiod);
+ criteria.setQueryType(queryType);
+ AggregateStatistics stats = statistics.getDefaultEmptyAggregateStatistics();
+ ...
+ statistics.forceFlush();
+ stats = statistics.queryStatistics(criteria);</source>
+ </subsection>
+ </section>
+ </body>
+</document>
+
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/aggregation.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/aggregatestatistics-c.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/aggregatestatistics-c.gif?rev=722405&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/aggregatestatistics-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/batchedstatistics-c.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/batchedstatistics-c.gif?rev=722405&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/batchedstatistics-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/logrecord-c.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/logrecord-c.gif?rev=722405&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/logrecord-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/page-statistics.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/page-statistics.gif?rev=722405&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/page-statistics.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/portalstatistics-c.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/portalstatistics-c.gif?rev=722405&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/portalstatistics-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/portlet-statistics.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/portlet-statistics.gif?rev=722405&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/portlet-statistics.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/statistics-db.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/statistics-db.gif?rev=722405&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/images/statistics-db.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/index.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/index.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/index.xml (added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/index.xml Tue Dec 2 00:53:22 2008
@@ -0,0 +1,122 @@
+<?xml version="1.0" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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 Statistics</title>
+ <authors>
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Statistics Overview">
+ <p>
+ Jetspeed-2 provides components for collecting portal data for various application events.
+ </p>
+ <subsection name="Collecting Portal Data">
+ <p>
+ <code>PortalStatistics</code> provides APIs for collecting portal application events. The following event types
+ are supported out of the box:
+ <ul>
+ <li>Portlet rendering statistics.</li>
+ <li>Page rendering statistics.</li>
+ <li>User access statistics.</li>
+ </ul>
+ 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:
+ <source>
+ %h %l %u %t \"%r\" %>s %b</source>
+ where:
+ <ul>
+ <li><b>%h </b>- remote host</li>
+ <li><b>%l </b>- remote log name</li>
+ <li><b>%u </b>- remote user</li>
+ <li><b>%t </b>- time in common log time format</li>
+ <li><b>%r </b>- first line of HTTP request</li>
+ <li><b>%s </b>- HTTP status code</li>
+ <li><b>%b </b>- number of bytes sent ("-" if no bytes sent).</li>
+ </ul>
+ <br/>
+ <img src="images/portalstatistics-c.gif" border="0" />
+ </p>
+ <p>
+ Statistics data is stored in 3 relational tables as illustrated below:
+ <br/><br/>
+ <img src="images/statistics-db.gif" border="0" />
+ </p>
+ <p>
+ Each event type is mapped to a data holder that gets persisted in the statistics tables illustrated above.
+ <img src="images/logrecord-c.gif" border="0" />
+ <br/>
+ Jetspeed-2 persists the collected data in batches through the <code>BatchedStatistics</code> component.
+ <br/><br/>
+ <img src="images/batchedstatistics-c.gif" border="0" />
+ </p>
+ </subsection>
+ <subsection name="PortalStatistics Configuration">
+ <p>
+ The <code>PortalStatistics</code> component is configured in <code>WEB-INF/assembly/statistics.xml</code> and
+ requires the following configuration parameters:
+ <ul>
+ <li><b>logToCLF</b>: Whether to log to a Common Log Format file.</li>
+ <li><b>logToDatabase</b>: Whether to record the statistics in the database.</li>
+ <li><b>maxRecordToFlush_Portlet</b>: The maximum number of portlet events that can be in the portlet statistics FIFO before a flush occurs.</li>
+ <li><b>maxRecordToFlush_User</b>: The maximum number of user events that can be in the user statistics FIFO before a flush occurs.</li>
+ <li><b>maxRecordToFlush_Page</b>: The maximum number of page events that can be in the page statistics FIFO before a flush occurs.</li>
+ <li><b>maxTimeMsToFlush_Portlet</b>: The maximum length of time between FIFO flushes for the portlet statistics FIFO. </li>
+ <li><b>maxTimeMsToFlush_User</b>: The maximum length of time between FIFO flushes for the user statistics FIFO. </li>
+ <li><b>maxTimeMsToFlush_Page</b>: The maximum length of time between FIFO flushes for the page statistics FIFO. </li>
+ <li><b>jetspeedDSEntry</b>: The reference to the Jetspeed data source.</li>
+ </ul>
+ </p>
+ <p>
+ The FIFO parameters may be adjusted depending on site specific needs. For example, tuning the events and times down makes the system less likely to loose events in the
+ case of a failure, and also makes the user experience viewing the statistics more responsive to recent events. On the other hand, tuning them higher will reduce the overhead
+ to the database. Generally newer sites with fewer users should use smaller tuning parameters and larger more mature sites should use larger ones.
+ </p>
+ <p>
+ A sample configuration is provided below:
+ <source>
+ <bean id="PortalStatistics"
+ class="org.apache.jetspeed.statistics.impl.PortalStatisticsImpl"
+ init-method="springInit"
+ destroy-method="springDestroy">
+ <!-- logToCLF -->
+ <constructor-arg index='0' type="boolean"><value>false</value></constructor-arg>
+ <!-- logToDatabase -->
+ <constructor-arg index='1' type="boolean"><value>true</value></constructor-arg>
+ <!-- maxRecordToFlush_Portal -->
+ <constructor-arg index='2'><value>300</value></constructor-arg>
+ <!-- maxRecordToFlush_User -->
+ <constructor-arg index='3'><value>50</value></constructor-arg>
+ <!-- maxRecordToFlush_Page -->
+ <constructor-arg index='4'><value>100</value></constructor-arg>
+ <!-- maxTimeMsToFlush_Portal -->
+ <constructor-arg index='5'><value>300000</value></constructor-arg>
+ <!-- maxTimeMsToFlush_User -->
+ <constructor-arg index='6'><value>5000</value></constructor-arg>
+ <!-- maxTimeMsToFlush_Page -->
+ <constructor-arg index='7><value>60000</value></constructor-arg>
+ <!-- jetspeedDSEntry -->
+ <constructor-arg index='8'><ref bean="JetspeedDS"/></constructor-arg>
+ </bean></source>
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/index.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/stats.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/stats.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/stats.xml (added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/stats.xml Tue Dec 2 00:53:22 2008
@@ -0,0 +1,54 @@
+<?xml version="1.0" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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 Statistics</title>
+ <authors>
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Viewing Statistics">
+ <subsection name="Where are the Event Recorded?">
+ <p>
+ Portal statistics events collection is injected at multiple points in the portal engine. Some examples are
+ provided below.
+ </p>
+ <p>
+ For user events, the <code>SecurityValveImpl</code> logs a user login event in <code>getSubject(RequestContext request)</code>.
+ <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.
+ <source>
+ statistics.logPortletAccess(requestContext, fragment.getName(), PortalStatistics.HTTP_OK, end - start);</source>
+ </p>
+ </subsection>
+ <subsection name="Viewing Statistics">
+ <p>
+ Jetpseed-2 provides administrative portlets that report on portal statistics.
+ <br/><br/>
+ <img src="images/portlet-statistics.gif" border="0"/><br/>
+ <img src="images/page-statistics.gif" border="0"/>
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/components/jetspeed-statistics/stats.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/developers.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/developers.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/developers.xml (added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/developers.xml Tue Dec 2 00:53:22 2008
@@ -0,0 +1,121 @@
+<?xml version="1.0"?>
+ <!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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 for Developers</title>
+ <subtitle>Development</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Jetspeed For Developers">
+ <p> When developing with Jetspeed, you may be creating portlet
+ applications, or building and creating extensions to the Jetspeed
+ portal. If you ar going to be creating portlet applications, check
+ out this fine e-book for an overall guide to writing portlets:</p>
+ <ul>
+ <li>
+ <a href='http://www.manning.com/hepper/' target='_blank'>Portlets
+ and Apache Portals Book</a>
+ </li>
+ </ul>
+ <h2>Custom Building with Maven2 and Eclipse</h2>
+ <p>
+ If you have never used Maven before, the easiest build option for
+ you may be to build with the Ant-Eclipse Build. This build allows
+ you to build a custom portal with Ant. We also provide a custom
+ installer builder. For your portlet applications, we provide Eclipse
+ WTP support. Although the actual programming tutorial is incomplete,
+ the tutorial describing building with Ant and Eclipse is completed.
+ For version 2.1.3, this is the recommended
+ <b>quickest</b>
+ build for getting custom projects up and running in no time.
+ </p>
+ <li>
+ <a href='http://portals.apache.org/tutorials/jetspeed-2-ant/'
+ target='_blank'>Jetspeed Tutorial - Building a Custom Portal with
+ Ant and Eclipse</a>
+ </li>
+ <h2>Custom Building with Maven Plugins</h2>
+ <p>Jetspeed 2.1 can be built with Maven-2.
+ You can actually build your own portal without the Jetspeed source.
+ You will want to customize your Jetspeed build, overriding the skins
+ and themes, adding your own portlet applications and perhaps
+ overriding key components of the portal. To do so, we provide two most popular build frameworks e.g maven2 and Ant with eclipse.
+ With the custom build, you can easily build and create your own Jetspeed powered portal
+ without ever building Jetspeed itself.</p>
+ <h3>Maven-2 Custom build</h3>
+ <ul>
+ <li>
+ <a href='http://portals.apache.org/tutorials/jetspeed-2/' target='_blank'>
+ Jetspeed Tutorial - Building a Custom Portal with the Maven-2
+ Plugin</a>
+ </li>
+ <li>
+ <a href='maven-2-custom.html' target='_blank'>Building a Custom
+ Portal with the Maven-2 Plugin</a>
+ </li>
+ </ul>
+ <h2>Building from Source</h2>
+ <p>If you need to build the source, here are the guides:</p>
+ <ul>
+ <li>
+ <a href='maven-2-build.html' target='_blank'>Building Jetspeed
+ from Source with Maven-2</a>
+ </li>
+ </ul>
+ <p> Jetspeed is built from the command line with Maven. However, you
+ can still develop, compile, debug, remote debug, all from within
+ Eclipse. Eclipse is a good tool for developing portlet applications
+ as well as Jetspeed extensions.</p>
+ <ul>
+ <li>
+ <a href='jetspeed-eclipse.html' target='_blank'>Developing with
+ Eclipse</a>
+ </li>
+ </ul>
+ <p> To get the binary installation of an official Jetspeed release,
+ go here:</p>
+ <ul>
+ <li>
+ <a href='download.html' target='_blank'>Getting the Binary
+ Installer</a>
+ </li>
+ </ul>
+ <p> You can checkout from the SVN HEAD from here:</p>
+ <ul>
+ <li>
+ <a href='http://svn.apache.org/repos/asf/portals/jetspeed-2/portal/trunk/'
+ target='_blank'>Checking out the Source Code from Subversion</a>
+ </li>
+ </ul>
+ <p> Get your Javadocs here:</p>
+ <ul>
+ <li>
+ <a href='http://www.bluesunrise.com/portlet-api/index.html'
+ target='_blank'>Portlet API Docs</a>
+ </li>
+ <li>
+ <a
+ href='http://portals.apache.org/jetspeed-2/multiproject/jetspeed-api/apidocs/index.html'
+ target='_blank'>Jetspeed API Docs</a>
+ </li>
+ </ul>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/developers.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/developers.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/documentation.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/documentation.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/documentation.xml (added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/documentation.xml Tue Dec 2 00:53:22 2008
@@ -0,0 +1,98 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Documentation for Jetspeed 2</title>
+ <subtitle>Documentation Guideline</subtitle>
+ <authors>
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ <person name="Ate Douma" email="ate@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Documentation Process Overview">
+ <p>
+ Documentation is critical to make Jetspeed's adoption as smooth as possible. Jetspeed documentation
+ process can be found
+ <a href="http://wiki.apache.org/portals/Jetspeed2/DocumenationProcessWebsite">on Jetspeed's Wiki</a>.
+ Please submit documentation patches, or contribute to the Wiki.
+ </p>
+ </section>
+ <section name="Generating full Site Documentation">
+ <p>
+ To generate the full site documentation for Jetspeed run the following maven command:
+ </p>
+ <source>
+ <![CDATA[
+maven allSite]]>
+ </source>
+ <p>
+ Note: make sure Jetspeed builds without problems as this goal will take quite some time.
+ </p>
+ <p>
+ To speed up this goal, I recommend running it without an internet connection (link checks can take very long)
+ and with maven.mode.online=false (or use -o on the commandline).
+ </p>
+ </section>
+ <section name="Generating PDF Documentation">
+ <subsection name="Installing Maven PDF Plugin">
+ <p>If you are using Maven 1.0 or above, to automatically install the plugin, type the following on a single line:</p>
+ <source>
+ <![CDATA[
+maven plugin:download -DgroupId=maven -DartifactId=maven-pdf-plugin
+ -Dversion=2.3]]>
+ </source>
+ <p>
+ Once, the plugin is install copy xalan.jar to the ${MAVEN_HOME}/lib/endorsed. When build Jetspeed, Xalan is download as a dependency. You
+ can copy the Jetspeed version of Xalan from
+ <code>${REPO_HOME}/xalan/jars</code>
+ .
+ </p>
+ <p>
+ More information on the PDF plugin can be found
+ <a href="http://maven.apache.org/reference/plugins/pdf/">on the Maven PDF plugin site</a>
+ .
+ </p>
+ </subsection>
+ <subsection name="Generating the PDF documentation">
+ <p>To create the PDF documentation for a specific component, go to the component root directory and run:</p>
+ <source>
+ <![CDATA[
+maven pdf]]>
+ </source>
+ </subsection>
+ </section>
+ <section name="Updating the website">
+ <p>
+ Once you generated a new version of the site documentation, you can bring it online as follows:
+ </p>
+ <ul>
+ <li>(tar.g)zip the contents of ${JETSPEED_2_HOME}/target/docs</li>
+ <li>upload the resulting archive on people.apache.org</li>
+ <li>extract the archive in /www/portals.apache.org/jetspeed-2</li>
+ </ul>
+ <p>
+ More information can be found at: <a href="http://www.apache.org/dev/committers.html#web">Committers' FAQ</a>
+ </p>
+ <p>
+ Note: the above link points at information assuming the site itself is under svn. For Jetspeed-2 this
+ isn't (yet) the case.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/documentation.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/documentation.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/download.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/download.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/download.xml (added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/download.xml Tue Dec 2 00:53:22 2008
@@ -0,0 +1,135 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>How to Download Jetspeed-2</title>
+ <subtitle>Documentation on How to Download Jetspeed-2</subtitle>
+ <authors>
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Download Jetspeed-2 Distribution">
+ <p>
+ Jetspeed-2 is distributed in several formats for your
+ convenience and distributed under the
+ <a href="license.html">
+ Apache License, version 2.0
+ </a>
+ .
+ </p>
+ <subsection name="Jetspeed-2.1.3 Installer Distribution">
+ <table>
+ <tr>
+ <th>Distribution</th>
+ <th>Mirrors</th>
+ <th>Checksum</th>
+ <th>Signature</th>
+ </tr>
+ <tr>
+ <td>Jetspeed-2 Standard with only the required Administrative Portlets</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/binaries/jetspeed-2.1.3-installer.jar">jetspeed-2.1.3-installer.jar</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3-installer.jar.md5">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3-installer.jar.asc">here</a></td>
+ </tr>
+ <tr>
+ <td>Jetspeed-2 Demo With lots of demo Portlets: RSS, JSF, JPetstore and many more</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/binaries/jetspeed-2.1.3-demo-installer.jar">Jetspeed-2.1.3-demo-installer.jar</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3-demo-installer.jar.md5">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3-demo-installer.jar.asc">here</a></td>
+ </tr>
+ </table>
+ <p>
+ Both the installers support the following databases for Jetspeed: Derby (default), DB2, MySQL, MSSQL, Oracle, PostgreSQL, SapDB,
+ as well as manual (do it yourself) configuration of other databases.
+ </p>
+ <p> Furthermore, through a provided Ant script after installation, reinitializing or switching to another database is a simple one step operation.
+ </p>
+ <p>Complete instructions for getting started using the installer is available <a href="getting-started-installer.html">here</a>.</p>
+ </subsection>
+ <subsection name="Jetspeed-2.1.3 Source Distribution">
+ <table>
+ <tr>
+ <th/>
+ <th>Mirrors</th>
+ <th>Checksum</th>
+ <th>Signature</th>
+ </tr>
+ <tr>
+ <td>jetspeed-2.1.3-src.tar.bz2</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/sources/jetspeed-2.1.3-src.tar.bz2">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/jetspeed-2.1.3-src.tar.bz2.md5">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/jetspeed-2.1.3-src.tar.bz2.asc">here</a></td>
+ </tr>
+ <tr>
+ <td>jetspeed-2.1.3-src.tar.gz</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/sources/jetspeed-2.1.3-src.tar.gz">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/jetspeed-2.1.3-src.tar.gz.md5">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/jetspeed-2.1.3-src.tar.gz.asc">here</a></td>
+ </tr>
+ <tr>
+ <td>jetspeed-2.1.3-src.zip</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/sources/jetspeed-2.1.3-src.zip">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/jetspeed-2.1.3-src.zip.md5">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/jetspeed-2.1.3-src.zip.asc">here</a></td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Jetspeed-2.1.3 Full Distribution (binaries, src and generated website)">
+ <table>
+ <tr>
+ <th/>
+ <th>Mirrors</th>
+ <th>Checksum</th>
+ <th>Signature</th>
+ </tr>
+ <tr>
+ <td>jetspeed-2.1.3.tar.bz2</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/binaries/jetspeed-2.1.3.tar.bz2">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3.tar.bz2.md5">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3.tar.bz2.asc">here</a></td>
+ </tr>
+ <tr>
+ <td>jetspeed-2.1.3.tar.gz</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/binaries/jetspeed-2.1.3.tar.gz">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3.tar.gz.md5">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3.tar.gz.asc">here</a></td>
+ </tr>
+ <tr>
+ <td>jetspeed-2.1.3.zip</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/binaries/jetspeed-2.1.3.zip">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3.zip.md5">here</a></td>
+ <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-2.1.3.zip.asc">here</a></td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="System Requirements">
+ <p>
+ The list of systems requirements for Jetspeed-2 is available <a href="getting-started.html#Requirements">here</a>.
+ </p>
+ </subsection>
+ <subsection name="Migrating Guide">
+ <p>
+ Important information for migrating existing Jetspeed-2.0 and Jetspeed-2.1 installations to Jetspeed-2.1.3 is provided in the <a href="guides/guide-migration.html">migration guide</a>.
+ </p>
+ </subsection>
+ </section>
+
+ </body>
+</document>
+
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/download.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/download.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/faq.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/faq.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/faq.xml (added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/faq.xml Tue Dec 2 00:53:22 2008
@@ -0,0 +1,132 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Frequently Asked Questions</title>
+ <subtitle>Jetspeed-2 FAQs</subtitle>
+ <authors>
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="How do I create new users, roles, and groups?">
+ <p>There are several ways to create new users, roles and groups:</p>
+ <ul>
+ <li>With the administrative user/role/group browser/details portlets</li>
+ <li>With the self-registration portlet</li>
+ <li>With Jetspeed Seed Data</li>
+ <li>Programmatically, writing your own portlet</li>
+ </ul>
+ <subsection name='Administrative Portlets'>
+ <p>Creating a new user with the Administrative portlets is easy:
+ </p>
+ <ul>
+ <li>Login as admin (the default password is admin)</li>
+ <li>From the LHS menu, navigate to the <b>Jetspeed Administrative Portlets</b> link</li>
+ <li>The User Management page is the first tab on the administrative menu across the top</li>
+ <li>Here you see the User Browser on the left, and the User Details on the right</li>
+ </ul>
+ <p>From here you can create a new user. Choose a unique username with no spaces. Then enter a secure password.
+ You can require the password to be changed on the first login. You can also select the default role assigned to this user,
+ as well as a default profiling rule. Last, you can assign this user to a subsite</p>
+ <img src="images/add-user.png"/>
+ <p>Going into edit mode, you an further configure the User Details portlet. Note that the following fields can be defaulted:
+ </p>
+ <img src="images/add-user-editmode.png"/>
+ <ul><li>Default Role for New User</li>
+ <li>Required Role for New User (not shown on view mode)</li>
+ <li>Default Profile for new user</li>
+ <li>New User Template Directory - leave blank to not use a template</li>
+ <li>Subsite Root Folder</li>
+ <li>Default Subsite for new user</li>
+ </ul>
+ <p>The User Details configuration is useful for delegated security scenarios. For example, setting up a User Management page for all users
+ with the <i>Developer</i> role. First, setup the User Browser preference to FilterByRole on <i>Developer</i>. Then you can assign a default role,
+ required role, new user template, and subsite area all for new developers, managed by a user with the <i>DeveloperManager</i> role. This user
+ then can create only developer type users complete with the correct roles and user templates. The edit mode of the User Details portlet can be
+ secured so that the global admin can only edit the configuration, limiting the development manager to only creating or deleting developers</p>
+ <p>The Group and Role administration pages work similarly to the User administration page. You can add/edit/delete both groups and roles</p>
+ </subsection>
+ <subsection name='Self-Registration portlet'>
+ <p>Users can also be created in the portal by the end user, requiring no administrative actions. Self-registration is probably one of the most customization
+ areas of the portal, as all portals have different requirements for self-registration. The self-registration portlet also has preferences that
+ can be configured by the administrator:
+ <ul>
+ <li>A list of one or more groups</li>
+ <li>A list of one or more roles comma-separated</li>
+ <li>A subsite root folder</li>
+ <li>A boolean flag to send email notification or not</li>
+ <li>A new user template</li>
+ <li>Profiling rule names and values comma-seperated</li>
+ </ul>
+ </p>
+ </subsection>
+ <!--
+ <subsection name='Populating Users, Groups and Roles with XML Seed Data'>
+ <p>The <i>out of the box</i> default Users, Groups and Roles are originally populated into the Jetspeed Portal during the installation process as well as during the Jetspeed build.
+ There are specific targets in the build which populate the default <i>seed</i> data from XML files. The installer uses the same XML files to populate the seed data.
+ Lets take a look at what the seed data looks like for roles:
+ </p>
+ </subsection>
+ <subsection name='Creating users, groups, roles programmatically'>
+ </subsection>
+ </section>
+ <section name='How do I create security constraints?'>
+ </section>
+ <section name='How do I create profiles?'>
+ <p>What happens if it fails in the Profiler Admin</p>
+ </section>
+ <section name='How do I debug decorators?'>
+ </section>
+ <section name='Where to debug when Jetspeed wonât get started?'>
+ </section>
+ <section name='What to do when Jetspeed does not show portlets that you have deployed?'>
+ </section>
+ <section name='How do I turn the feature to Clear All Window States and Portlet Modes when Navigating (changing) pages?'>
+ <ul>
+ <li>1. In pipelines.xml, edit the <b>pageHistoryValve</b> bean. Set the <b>valveDisabled</b> flag to false.</li>
+ <li>2. In portal-url-generation.xml, edit the <b>NavigationalState</b> bean. Modify the <b>NavigationalState</b>, changing the constructor-arg 3 to the boolean value true.
+ </li>
+ </ul>
+ </section>
+ <section name='How do I turn the feature to Maximize on Edit mode and Edit Defaults mode?'>
+ <ul>
+ <li></li>
+ <li>
+ </li>
+ </ul>
+ </section>
+ <section name='How do I turn the feature to Maximize on Edit mode, Edit Defaults and Configure modes?'>
+ <ul>
+ <li></li>
+ <li>
+ </li>
+ </ul>
+ </section>
+ <section name='How do I turn the feature - Auto-switching for Edit Defaults and Configure modes?'>
+ <ul>
+ <li></li>
+ <li>
+ </li>
+ </ul>
+ </section>
+ -->
+ </section>
+ </body>
+</document>
+
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/faq.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/faq.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/features.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/features.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/features.xml (added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/features.xml Tue Dec 2 00:53:22 2008
@@ -0,0 +1,193 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Features</title>
+ <subtitle>Features</subtitle>
+ <authors>
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ <person name="Marky Goldstein" email="ready@rosa.com" />
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Features">
+ <p>
+ The Apache Portals Jetspeed Team is pleased to present the Jetspeed-2 Open Source Enterprise Portal. This open source project has matured past several releases,
+ and has been fully-compliant with the Portlet Specification 1.0 (JSR-168) since version 2.0.
+ Jetspeed-2 passes the TCK (Test Compatibility Kit) suite and is fully CERTIFIED to the Java Portlet Standard.
+ </p>
+ <subsection name="Standardized">
+ <ul>
+ <li>Fully compliant with Java Portlet API Standard 1.0 (JSR 168)</li>
+ <li>Passed JSR-168 TCK Compatibility Test Suite</li>
+ <li>J2EE Security based on JAAS Standard, JAAS DB Portal Security Policy</li>
+ <li>LDAP Support for User Authentication</li>
+ </ul>
+ </subsection>
+ <subsection name='Portal Engine Features'>
+ <ul>
+ <li>The Jetspeed Portal - Server-Side Parallel JSR-168 Portlet Rendering Engine</li>
+ <li>The Jetspeed Desktop - Web 2.0 Client-Side JSR-168 Portlet Rendering Engine</li>
+ <li>Full Support for JSR-168 Portlet Caching and per portlet cache configuration</li>
+ <li>Portlet Timeout Tracking with mimimal render time limits</li>
+ <li>Portlet Service Manager for automated removal of slow or dead portlets.</li>
+ <li>Parallel rendering on Websphere 6.1</li>
+ </ul>
+ </subsection>
+ <subsection name="Customization Features">
+ <ul>
+ <li>Portal Page Customizer</li>
+ <li>Desktop Page Customizer</li>
+ <li>Nested Fragment Customization</li>
+ <li>Drag and drop moving of portlets</li>
+ <li>Resizing of desktop portlet windows</li>
+ <li>Portlet Selector with Portlet Categorizations, Full-Text Search of Portlets</li>
+ <li>Customizable Themes (Skins)</li>
+ </ul>
+ </subsection>
+ <subsection name='Security'>
+ <ul>
+ <li>Portlet-level Security checks based on Security Constraints or Security Permissions</li>
+ <li>Declarative Security Constraints and JAAS Database Security Policy</li>
+ <li>Fully swappable Security Constraint or Security Permission support</li>
+ <li>Jetspeed SSO (Single Sign-on)</li>
+ <li>Delegation of Security</li>
+ <li>Administrative actions logged to Audit Activity database</li>
+ </ul>
+ </subsection>
+ <subsection name="Distributed Cluster Support">
+ <ul>
+ <li>Jetspeed Distributed Cluster - support for distributed deployments of the portal on multiple application server platforms</li>
+ <li>Distributed Cache for portal components including preferences, registry and portlet entities.</li>
+ <li>Distributed invalidation of portlet cache</li>
+ </ul>
+ </subsection>
+ <subsection name="Foundation Component Architecture">
+ <ul>
+ <li>Spring-based Components and Scalable Architecture</li>
+ <li>Configurable Pipeline Request Processor</li>
+ <li>Auto Deployment of Portlet Applications</li>
+ <li>Jetspeed Component Java API</li>
+ <li>Jetspeed AJAX XML API</li>
+ <li>PSML: Extended Portlet Site Markup Language
+ <ul><li>Database Persistent</li>
+ <li>Content Management Facilities</li>
+ <li>Security Constraints</li></ul>
+ </li>
+ <li>Full security maintenance using LDAP is now supported for many LDAP providers</li>
+ </ul>
+ </subsection>
+ <subsection name="Portal Core Features">
+ <ul>
+ <li>Runtime Portlet API Standard Role-based Security</li>
+ <li>Portal Content Management and Navigations: Pages, Menus, Folders, Links</li>
+ <li>PSML Folder CMS Navigations, Menus, Links</li>
+ <li>Rules-based Profiler for page and resource location</li>
+ <li>Role-based Aggregation of Visible Pages</li>
+ <li>Integrates with most popular databases including Derby, MySQL, MS SQL, Postgres, Oracle, DB2</li>
+ <li>Client independent capability engine (html, xhtml, wml,vml)</li>
+ <li>Support for Pocket PC</li>
+ <li>Internationalization: Localized Portal Resources in 12 Languages</li>
+ <li>Statistics Logging Engine</li>
+ <li>Portlet Registry</li>
+ <li>Full Text Search of Portlet Resources with Lucene</li>
+ <li>User Registration</li>
+ <li>Forgotten Password</li>
+ <li>Rich Login and Password Configuration Management</li>
+ </ul>
+ </subsection>
+ <subsection name="Administrative Portlets">
+ <ul>
+ <li>User, Role, Group, Password, and Profile Management</li>
+ <li>Portal Site Manager</li>
+ <li>Remote Portal Application Deployer (RPAD) - hot deploy portlet applications from remote locations on the Web</li>
+ <li>JSR 168 Generic User Attributes Editor</li>
+ <li>JSR 168 Preferences Editor</li>
+ <li>SSO Manager</li>
+ <li>Permission Management (JAAS Security)</li>
+ <li>Security Constraints Management</li>
+ <li>Portlet Application and Lifecycle Management</li>
+ <li>Profiler Administration</li>
+ <li>Statistics Reports</li>
+ <li>Portlet Out of Service Manager</li>
+ <li>PSML and XML Import / Export Admin Portlet</li>
+ </ul>
+ </subsection>
+ <subsection name="Web Framework Support and Sample Portlets">
+ <ul>
+ <li>Bridges to other Web Frameworks: Wicket, JSF, Groovy, Struts, PHP, Perl, Velocity</li>
+ <li>Sample Portlets:
+ <ul><li>RSS, IFrame, Calendar XSLT, Struts Petstore, Bookmark, Database Browser</li>
+ <li>Integration with Display Tags, Spring MVC</li></ul>
+ </li>
+ </ul>
+ </subsection>
+ <subsection name='Data Migration Features'>
+ <ul>
+ <li>XML Import/Export Utility for all Jetspeed database data to support data migration over versions</li>
+ <li>All initial portal data seeded with XML</li>
+ <li>XML Schemas for all XML content</li>
+ </ul>
+ </subsection>
+ <subsection name="Portal Design Features">
+ <ul>
+ <li>Deployment Jetspeed Portlet and Page Skins (Decorators) CSS Components</li>
+ <li>Configurable CSS Page Layouts</li>
+ <li>Easy to Use Velocity Macro Language for Skin and Layout Components</li>
+ </ul>
+ </subsection>
+ <subsection name="Development Tools">
+ <ul>
+ <li>Ant-based Custom Build with Tutorial and Installer</li>
+ <li>Automated Maven-2 Build</li>
+ <li>Automated Maven-1 Build</li>
+ <li>Jetspeed-2 Maven Plugin for Custom Portal Development</li>
+ <li>Maven-2 Profiles and Archetypes</li>
+ <li>AutoDeployment of Portlet Applications, Portal Resources</li>
+ <li>Deployment Tools</li>
+ <li>Plugin Goals integrated with Auto Deployment Feature</li>
+ <li>XML Schemas for PSML, jetspeed-portlet.xml, and Jetspeed XML (seed data)</li>
+ </ul>
+ </subsection>
+ <subsection name='Extended JSR-168 Features'>
+ <li>Custom Portlet Modes and Window States: <b>Edit Defaults, Configure, Print, About</b></li>
+ <li>Custom Window States: <b>Solo</b></li>
+ <li>Dynamically hide Portlets at request time</li>
+ <li>Maximize on Edit Defaults or Edit modes option</li>
+ <li>Preliminary Portlet API 2.0 ResourceURL support allowing full response control</li>
+ </subsection>
+ <subsection name='Other Features'>
+ <ul>
+ <li>Installation choice of either Demo Portal or Minimal Starter Portal</li>
+ <li>In-depth Jetspeed 2 Tutorial</li>
+ </ul>
+ </subsection>
+ <subsection name="Application Servers Supported">
+ <ul>
+ <li>Tomcat 5.5.x</li>
+ <li>Jetty</li>
+ <li>Websphere 6.0</li>
+ <li>Geronimo</li>
+ <li>JBoss</li>
+ <li>Weblogic</li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/features.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/features.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-binary.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-binary.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-binary.xml (added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-binary.xml Tue Dec 2 00:53:22 2008
@@ -0,0 +1,776 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>
+ Getting Started with Jetspeed 2 using a Binary Release (deprecated)
+ </title>
+ <subtitle>Getting ready to build your own portal</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="Ate Douma" email="ate@apache.org" />
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ <person name="Ron Wheeler"
+ email="rwheeler@artifact-software.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="1. Some Basic Information (deprecated)">
+ <subsection name="Basic Assumptions">
+ <ul>
+ <li>
+ Unless otherwise specified, you should be
+ running all maven build commands from within the
+ Jetspeed directory (if you are just building
+ Jetspeed) or from within your custom portal
+ directory.
+ </li>
+ <li>
+ You must use "/" as a file seperator on both
+ *nix and windows, e.g. c:/windows, and /home.
+ </li>
+ </ul>
+ </subsection>
+ <subsection name="Maven">
+ <p>
+ We will not go into the specifics of Maven as that
+ is beyond the scope of this document. If you have
+ never used Maven, you need to read
+ <a
+ href="http://maven.apache.org/what-is-maven.html">
+ "What is Maven"
+ </a>
+ just to get a sense of the role of Maven in a
+ software development project. If your project
+ involves more than one or two people, you may want
+ to look into
+ <a href="http://maven.apache.org">Maven</a>
+ in more detail since it does simplify and
+ standardize many of the project management issues
+ that are commonly encountered.
+ </p>
+ <p>
+ Here are a few bits of standard maven jargon we feel
+ is important for you to know.
+ </p>
+ <p>
+ You will see mention of a
+ <i>maven repository</i>
+ in this document. When you install Maven the .maven/
+ directory is created in your ${USER_HOME) directory.
+ <br />
+ Under .maven/ you will see a
+ <i>repository</i>
+ directory. This is were Maven stores all of the jars
+ that it downloads when you run your builds. This is
+ also were Maven puts your jars and wars that you
+ build.
+ Jar files will be stored in a directory structure
+ that has the format of
+ ${groupId}/${projectId}/jars/${projectId}-{$version}.jar.
+ The portal war file is stored as
+ ${groupId}/${projectId}/wars/${projectId}.war. The
+ ${groupId}, ${projectId} and ${version} variables
+ are discussed later on in this document. Jar and war
+ files will also be created in your project in the
+ <i>/target</i>
+ directory.
+ </p>
+ </subsection>
+ <subsection name="Variables">
+ <p>
+ Variables are represented as ${
+ <i>some_variable</i>
+ }. Variable names are case sensitive. Variables are
+ defined in several places in a Maven project and
+ according to the
+ <a
+ href="http://maven.apache.org/reference/user-guide.html##Maven_Setup">
+ Maven Setup
+ </a>
+ section of the on-line Maven User's Guide, the
+ properties files in Maven are processed in the
+ following order:
+ <ul>
+ <li>
+ ${project.home}/project.properties -
+ Properties that are common to the entire
+ project
+ </li>
+ <li>
+ ${project.home}/build.properties -
+ Properties that describe the current release
+ </li>
+ <li>
+ ${user.home}/build.properties - Properties
+ that are particular to you
+ </li>
+ </ul>
+ The usage of these files is quite different from the
+ way they are used in a project that develops from
+ the sources since the project in that case is the
+ Jetspeed project rather than your own portal. In
+ that case, the user's build.properties is used much
+ more intensively used to override Jetspeed's
+ parameters.
+ </p>
+ <p>
+ Maven processes this sequence of properties files,
+ overriding any previously defined properties with
+ newer definitions. The last definition wins! In this
+ sequence, your ${user.home}/build.properties has the
+ final say in the list of properties files processed.
+ </p>
+ <p>
+ This list of properties files that Maven processes
+ is called the "standard properties file set".
+ </p>
+ <p>
+ In addition, System properties are processed after
+ the standard properties files. So, a property
+ specified on the command line using the
+ -Dproperty=value convention will override any
+ previous definition of that property.
+ </p>
+ <p>
+ For example, ${org.apache.jetspeed.server.home}
+ references either:
+ <ul>
+ <li>
+ a property defined earlier in the standard
+ properties file set,
+ </li>
+ <li>
+ a property specified on the command line of
+ the Maven invokation,
+ </li>
+ <li>
+ a variable that has been defined somehwere
+ within the build process or
+ </li>
+ <li>
+ a variable defined in another build file
+ within Jetspeed.
+ </li>
+ </ul>
+ </p>
+ </subsection>
+ <subsection name="Installation dependent locations">
+ <p>
+ The documentation refers to some common locations by
+ the following names:
+ </p>
+ <ul>
+ <li>
+ <b>${USER_HOME}</b>
+ : This is the user's home directory. For Windows
+ systems, this generally c:\Documents and
+ Settings\${userName} where ${userName} is the
+ name you use to log into windows.
+ <br />
+ ${user.home} is synonymous with ${USER_HOME}
+ within this document.
+ </li>
+ <li>
+ <b>${CATALINA_HOME}</b>
+ : This refers to the location of your tomcat
+ installation, e.g.
+ <i>c:/tomcat</i>
+ .
+ </li>
+ </ul>
+ <p>
+ These are not used in the Jetspeed configuration but
+ are merely shorthand notations to make the
+ documentation more concise and precise.
+ </p>
+ </subsection>
+ <subsection name="Subversion (SVN)">
+ <p>
+ <a href="http://subversion.tigris.org">
+ Subversion (SVN)
+ </a>
+ is used in the Jetspeed project to manage the source
+ files. SVN is very similar to CVS. For those user's
+ on Windows system who prefer non-command line access
+ we suggest using
+ <a href="http://tortoisesvn.tigris.org">
+ TortoiseSVN
+ </a>
+ which plugs into your Windows Explorer view. For
+ those using the Eclipse IDE, the
+ <a href="http://subclipse.tigris.org">Subclipse</a>
+ plugin is available for SVN access.
+ </p>
+ </subsection>
+
+ </section>
+
+ <section name='2. Overview of the Jetspeed build Process'>
+ <p>
+ Setting up a custom portal development project using the
+ binary distribution is a fairly simple process. At the
+ end, you will you have a directory structure and set of
+ files that will simplify building and deploying your own
+ custom portal.
+ </p>
+ <p>
+ If you want to setup a Jetspeed portal application using
+ Eclipse as your IDE, you should continue reading this
+ page for background material but refer to
+ <a href="jetspeed-eclipse.html">
+ Building a Jetspeed Enterprise Portal with Eclipse
+ </a>
+ for the actual instructions on using Eclipse for
+ Jetspeed 2 portal development.
+ </p>
+ <p>
+ Creating your own custom portal is very easy with the
+ maven plugin provided by Jetspeed 2. The steps are:
+ <ul>
+ <li>Download and install the Jetspeed plugin</li>
+ <li>
+ Use the plugin to download and generate the
+ Jetspeed binary distribution.
+ </li>
+ <li>
+ Customize the properties files to reflect your
+ database installation and local environment.
+ </li>
+ <li>Prepare the Application Server</li>
+ <li>Build the portal</li>
+ <li>Start the Database Server(if required)</li>
+ <li>Initialize the Database</li>
+ <li>
+ Deploy the default portal using your database
+ </li>
+ <li>Test the default portal</li>
+ <li>
+ Customize the default portal to include your
+ logo and Portal name
+ </li>
+ <li>
+ Generate, deploy and test your custom Portal
+ </li>
+ </ul>
+ </p>
+ <p>
+ The Jetspeed 2 maven-plugin defines default values for
+ most of the properties you can set, but not all. As you
+ customize the portal, you will override others.
+ </p>
+ </section>
+ <section name="3. Installation Steps">
+ <subsection name="3.1 Download the Jetspeed Plugin">
+ <subsection
+ name="3.1.1 Set the maven remote repository lookup configuration">
+ Now we're going to configure your
+ ${user.home}build.properties file to give Maven the
+ information that it needs to download the Jetspeed-2
+ maven-plugin. The base directory where you are going
+ to build your portal needs to be specified to Maven
+ as well as the the maven remote repository need to
+ be configured properly in your
+ <code>${USER_HOME}/build.properties</code>
+ :
+ <source><![CDATA[basedir = c:/myportal
+maven.repo.remote = http://www.bluesunrise.com/maven/, http://www.ibiblio.org/maven/, \
+http://dist.codehaus.org/, http://cvs.apache.org/repository]]>
+ </source>
+ <i>
+ Note: the order in which the repositories are
+ specified is significant!
+ </i>
+ </subsection>
+ <subsection
+ name="3.1.2 Install the Jetspeed 2 maven-plugin">
+ <p>
+ The first time, and when you want to upgrade to
+ a newer version of Jetspeed 2, you need to
+ install the maven-plugin as follows:
+ <source>
+ <![CDATA[
+maven -DartifactId=maven-jetspeed2-plugin -DgroupId=org.apache.portals.jetspeed-2 -Dversion=2.1.3 plugin:download]]>
+ </source>
+ <i>
+ Note: you must set the version to the
+ specific version you want to install,
+ "2.1.3" is just an example.
+ </i>
+ </p>
+ </subsection>
+ </subsection>
+
+ <subsection
+ name="3.2 Download the default Jetspeed portal project">
+ <p>
+ Once you have the maven-plugin installed and set
+ properties as needed, generate a default portal
+ configuration using the plugin as follows:
+ <source>
+ <![CDATA[
+maven j2:portal.genapp]]>
+ </source>
+ <i>
+ This maven goal actually executes several
+ subgoals which are further described in the
+ <a href="j2-maven-plugin.html">
+ maven-plugin documentation
+ </a>
+ itself.
+ </i>
+ </p>
+ </subsection>
+
+ <subsection name="3.3 Customize the properties files">
+ <p>
+ You can fill in as much of the project information
+ in the project.xml file as you want. This will
+ depend on how you intend to use Maven as a project
+ management tool and is beyond the scope of this
+ document. The information in the project.xml file
+ distributed with Jetspeed reflects the Jetspeed
+ development project.
+ </p>
+ <p>
+ You can now customize the properties files to
+ reflect your database installation and local
+ environment.
+ </p>
+ <p>
+ The
+ <code>${basedir}project.properties</code>
+ file provided by the Jetspeed developers includes
+ all of the variables that are common to all portals
+ based on Jetspeed. You should not have to change
+ these.
+ </p>
+ <p>
+ The project properties are described in the
+ <a
+ href="http://maven.apache.org/maven-1.x/reference/properties.html">
+ Maven Properties Reference
+ </a>
+ documentation. We have already filled in the value
+ for basedir and maven.repo.remote in previous steps.
+ You can fill in as much of the project information
+ in the
+ <code>${basedir}project.xml</code>
+ file as you want. This will depend on how you intend
+ to use Maven as a project management tool and is
+ beyond the scope of this document. The
+ <a href="http://maven.apache.org/maven-1.x">
+ Maven site
+ </a>
+ has all of the information that you need to use
+ Maven successfully.
+ </p>
+ <p>
+ The configuration of your specific properties needs
+ to be done before we can build the portal. Review
+ the definition of the configuration properties
+ described in
+ <a href="guide/guide-properties.html">
+ Basic Configuration Parameters
+ </a>
+ .
+ </p>
+ <p>
+ In the case of a binary build, the basic
+ configuration properties can be placed in
+ <code>${basedir}build.properties</code>
+ . A minimal custom portal configuration using the
+ default Derby database can be something like:
+ <source>
+ <![CDATA[
+# required portal configuration properties
+org.apache.jetspeed.portal.home = /home/myportal/
+org.apache.jetspeed.portal.groupId = myprojects
+org.apache.jetspeed.portal.artifactId = myportal
+org.apache.jetspeed.portal.name = My Test Portal
+org.apache.jetspeed.portal.currentVersion = 1.0
+
+]]>
+ </source>
+ </p>
+ <p>
+ If you are not using the Derby database that comes
+ pre-configured in the
+ <code>${basedir}project.properties</code>
+ file, you also need to define the database
+ parameters in the
+ <code>${basedir}build.properties</code>
+ file. Refer to the
+ <a href="guides/guide-database.html">Database Configuration</a>
+ section for a description of the variables required.
+ </p>
+ </subsection>
+ <subsection name="3.4 Prepare the Application Server">
+ Before running the portal, we need to prepare the
+ Application server to run a Jetspeed portal. This
+ consists of telling Jetspeed where the application
+ server expects files to be placed and what
+ authentication values are required to request service
+ from the Application Server's management tools. There
+ may also be modifications to the server configuration so
+ be sure to read the
+ <a href="guides/guide-app-servers.html">
+ Application server configuration documentation
+ </a>
+ .
+ <p>
+ Verify that you made the Application Server changes
+ suggested in the overview of the
+ <a href="getting-started.html">Getting Started</a>
+ documentation.
+ </p>
+ <p>
+ A minimal custom portal configuration using the
+ Tomcat 5.5 Application Server could be something
+ like:
+
+ <source>
+ <![CDATA[
+# required portal configuration properties
+org.apache.jetspeed.portal.home = /home/myportal/
+org.apache.jetspeed.portal.groupId = myprojects
+org.apache.jetspeed.portal.artifactId = myportal
+org.apache.jetspeed.portal.name = My Test Portal
+org.apache.jetspeed.portal.currentVersion = 1.0
+
+# required application server properties
+org.apache.jetspeed.server.home = ${CATALINA_HOME}/
+org.apache.jetspeed.server.shared = ${org.apache.jetspeed.server.home}/shared/lib/
+org.apache.jetspeed.deploy.war.dir = ${org.apache.jetspeed.server.home}/webapps/
+org.apache.jetspeed.services.autodeployment.user = j2deployer
+org.apache.jetspeed.services.autodeployment.password = xxxxx
+org.apache.jetspeed.catalina.version.major = 5.5]]>
+
+ </source>
+ </p>
+ </subsection>
+ <subsection name="3.5 Build the portal">
+ <p>
+ Once your portal configuration and setup is ready,
+ you can build and install the portal application in
+ your local maven repository (as needed for
+ deployment) using the following standard maven goal
+ from your custom portal project directory (in
+ ${org.apache.jetspeed.portal.home}):
+ <source>
+ <![CDATA[
+maven war:install]]>
+ </source>
+ </p>
+ <p>
+ You are now ready to deploy the new portal
+ application. For this, skip the following section on
+ building the Jetspeed 2 portal from source and
+ continue with the
+ <a href="#6__Deploy_and_Run">deployment</a>
+ section.
+ </p>
+ </subsection>
+ <subsection name="3.6 Start the Database Server">
+ <p>
+ You need to make sure that your database server is
+ running. If you are not using the default Derby
+ database, you need to make sure that it is running
+ and that the user that will own the Jetspeed tables
+ is setup and ready for use. Refer to the
+ <a href="guides/guide-database.html">Database Configuration</a>
+ section for more information.
+ </p>
+ <p>
+ You need to have this database running during the
+ deployment and while running the application server.
+ </p>
+ <p>
+ Note: this is required when using the
+ <code>j2:quickStart</code>
+ goal as described below. The Jetspeed 2 maven-plugin
+ provides other (sub)goals which you can use without
+ (re)creating a production database and/or inserting
+ default portal configuration data. See the
+ <a href="j2-maven-plugin.html">
+ Plugin documentation
+ </a>
+ for further information about the available goals.
+ </p>
+ </subsection>
+ <subsection name="3.7 Initialize the Database">
+ <p>
+ The database's tables and initial data needs to be
+ loaded prior to Jetspeed being deployed. The
+ <a href="j2-maven-plugin.html">maven-plugin</a>
+ includes a number of goals that can be used to
+ manage the database. The easiest way to load the
+ tables and deploy the application is to run the
+ j2:quickstart goal.
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.portal.home}
+maven j2:quickStart]]>
+ </source>
+ This can only be run once without a bit of a cleanup
+ afterwards since it defines the tables and loads the
+ data as part of starting the application. If you
+ have an error and you want to run it again, you must
+ make sure that the tables and data are cleaned out
+ either by manually dropping the tables in the
+ database or by using the j2:db.drop.production Maven
+ goal.
+ </p>
+ <p>
+ The j2:quickstart currently only covers deploying to
+ Tomcat 5 or Tomcat 5.5 application servers.
+ </p>
+ <p>
+ Information about deployment to other application
+ servers can be found at the The Jetspeed 2
+ <a
+ href="http://wiki.apache.org/portals/Jetspeed2">
+ Wiki
+ </a>
+ .
+ </p>
+ <p>
+ To deploy a default Jetspeed 2 portal, including the
+ demo portlet applications, run the following in a
+ <i>separate</i>
+ console:
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.portal.home}
+maven j2:quickStart]]>
+ </source>
+ <i>
+ Note: the
+ <a href="j2-maven-plugin.html">
+ maven-plugin documentation
+ </a>
+ described other goals you can use to initialize
+ the database.
+ </i>
+ </p>
+ </subsection>
+ <subsection
+ name="3.8 Deploy the default portal using your database">
+ <p>
+ The j2:quickstart task does this for you. If you
+ have used another Maven goal to initialize the
+ database, then you can deploy the portal by using:
+ </p>
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.portal.home}
+maven j2:fullDeploy]]>
+ </source>
+ <p>
+ The j2:fullDeploy goal currently only covers
+ deploying to Tomcat 5 or Tomcat 5.5 application
+ servers.
+ </p>
+ <p>
+ Information about deployment to other application
+ servers can be found at the The Jetspeed 2
+ <a
+ href="http://wiki.apache.org/portals/Jetspeed2">
+ Wiki
+ </a>
+ .
+ </p>
+ </subsection>
+ <subsection name="3.9 Test the default portal">
+ <p>
+ The final step in getting the default portal running
+ is starting up your Tomcat server. The portal will
+ automatically install any deployed portlet
+ applications.
+ </p>
+ <p>
+ Then you can access the portal with your browser at:
+ <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>
+ ${org.apache.jetspeed.portal.artifactId}
+ </code>
+ ).
+ </p>
+ <p>
+ If you see a running Jetspeed portal, we have
+ succeeded in getting the software installed and
+ working.
+ </p>
+ <p>
+ With the default Jetspeed 2 portal deployment,
+ several example user accounts are inserted into the
+ portal database with which you can logon to the
+ portal:
+ <table>
+ <tr>
+ <th>username</th>
+ <th>password</th>
+ <th>roles</th>
+ </tr>
+ <tr>
+ <td>
+ <code>admin</code>
+ </td>
+ <td>
+ <code>admin</code>
+ </td>
+ <td>
+ <code>admin, manager, user</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>manager</code>
+ </td>
+ <td>
+ <code>manager</code>
+ </td>
+ <td>
+ <code>manager, user</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>jetspeed</code>
+ </td>
+ <td>
+ <code>jetspeed</code>
+ </td>
+ <td>
+ <code>manager</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>user</code>
+ </td>
+ <td>
+ <code>user</code>
+ </td>
+ <td>
+ <code>user</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tomcat</code>
+ </td>
+ <td>
+ <code>tomcat</code>
+ </td>
+ <td></td>
+ </tr>
+ </table>
+ </p>
+ </subsection>
+ <subsection
+ name="3.10 Customize the default portal to include your logo and Portal name">
+ <p>
+ Now that the default portal is working we can try a
+ small customization to test out the customization
+ process. We are going to change the logo and portal
+ name.
+ </p>
+ <subsection
+ name="3.10.1 Creating your customization area">
+
+ <p>
+ The first step is to create a directory to hold
+ your customized files. This will help you to
+ preserve your changes when you install new
+ versions of jetspeed. Create a directory in the
+ top level of the portal home.
+ </p>
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.portal.home}
+mkdir customized]]>
+ </source>
+ <p>
+ Make a copy of the build.properties file that
+ you have already modified.
+ </p>
+ <p>
+ You may also want to make a directory to hold
+ the original files before you modify them. This
+ is not strictly requirred since you can always
+ reload the distribution. However it might be
+ handy to keep a copy for reference or to quickly
+ get back to the state before you made changes.
+ </p>
+ </subsection>
+ <subsection
+ name="3.10.2 Making some simple cuistomizations">
+ <p>
+ We are going to change the logo and the portal
+ name to test customization. You can make you own
+ logo to replace the Jetspeed logo. Take a look
+ at the ${basedir}/src/webapp/images/logo.png to
+ get the size and to verify the background
+ colour. Make your own logo or copy the
+ testlogo.png file to your
+ <code>${basedir}/customized</code>
+ directory.
+ </p>
+ </subsection>
+ </subsection>
+
+ <subsection
+ name="3.11 Generate, deploy and test your custom Portal">
+ <p>
+
+ </p>
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.portal.home}
+maven j2:fullDeploy]]>
+ </source>
+
+ <p>
+ You can access the revised portal with your browser
+ at:
+ <pre>
+ <a href="http://localhost:8080/jetspeed">
+ http://localhost:8080/jetspeed
+ </a>
+ </pre>
+ or replace "jetspeed" in the above url with the name
+ of your own portal application (
+ <code>
+ ${org.apache.jetspeed.portal.artifactId}
+ </code>
+ ).
+ </p>
+ <p>
+ You should see the new name and the new logo on the
+ front page.
+ </p>
+
+ </subsection>
+
+
+ </section>
+ </body>
+</document>
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-binary.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-binary.xml
------------------------------------------------------------------------------
svn:keywords = Id
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
|