tiger****@users*****
tiger****@users*****
2005年 12月 28日 (水) 20:04:27 JST
Update of /cvsroot/jetspeed-japan/jetspeed-2-trans/ja/xdocs In directory sf-cvs:/tmp/cvs-serv4374/ja/xdocs Modified Files: getting-started-source.xml Log Message: Added Japanese translation. Contributed by KATOH Yasufumi, thank you very much. jetspeed-2-trans/ja/xdocs/getting-started-source.xml 1.1.1.1 -> 1.2 (modified) http://cvs.sourceforge.jp/cgi-bin/viewcvs.cgi/jetspeed-japan/jetspeed-2-trans/ja/xdocs/getting-started-source.xml.diff?r1=1.1.1.1&r2=1.2 =================================================================== RCS file: jetspeed-2-trans/ja/xdocs/getting-started-source.xml,v retrieving revision 1.1.1.1 retrieving revision 1.2 diff -u -r1.1.1.1 -r1.2 --- getting-started-source.xml 2005/12/16 03:43:36 1.1.1.1 +++ getting-started-source.xml 2005/12/28 11:04:27 1.2 @@ -1,1115 +1,2069 @@ -<?xml version="1.0"?> -<!-- - Copyright 2004 The Apache Software Foundation - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<document> - <properties> - <title> - Getting Started with Jetspeed 2 using a Source Release - </title> - <subtitle>Gettin gready to modify Jetspeed</subtitle> - <authors> - <person name="David Sean Taylor" email="taylo****@apach*****" /> - <person name="Ate Douma" email="ate****@apach*****" /> - <person name="David Le Strat" email="dlest****@apach*****" /> - <person name="Ron Wheeler" - email="rwhee****@artif*****" /> - </authors> - </properties> - <body> - <section name="Naming Conventions and Basic Assumptions"> - <subsection name="Source 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="Naming Conventions"> - <p> - Below is a listing of common conventions used within - this document. - </p> - <p> - Variables are represented as ${ - <i>some_variable</i> - }. This may signify a setting in Jetspeed or may - represent a setting within your environment. - Properties files are also capable of specifying - variables within them. - </p> - <p> - For example, ${org.apache.jetspeed.server.home} - references either a property defined further up in - the properties file, a variable that has been - defined somehwere within the build process or - defined in another build file within Jetspeed. - </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 is the location of your tomcat - installation, e.g. - <i>c:/tomcat</i> - . - </li> - </ul> - </subsection> - <subsection name="Source 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> - <subsection name="Maven Setup"> - <p> - We will not go into the specifics of Maven as that - is beyond the scope of this document. However, 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 the jars - that it downloads when you run your builds. This is - also were Maven puts your jars and wars that you - build. They will be stored in a directory structure - that has the format of - ${groupId}/${projectId}/jars/${projectId}-{$version}.jar - for jar files and - ${groupId}/${projectId}/wars/${projectId}.war for - war files. 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> - </section> - - <section name='2. Jetspeed build and maven-plugin Properties'> - <p>You need to set a few properties.</p> - <p> - Creating your own custom portal is very easy with the - maven plugin provided by Jetspeed 2. And, it is used - when you build jetspeed from source as well. In fact, - the jetspeed-2 build procedure is just one example of a - custom portal configuration and setup. - </p> - <p> - The Jetspeed 2 maven-plugin defines default values for - most of the properties you can set, but not all. When - you download or checkout the jetspeed-2 source tree, - you'll see it contains a project.properties file in the - root folder overriding and setting some of these - properties. - </p> - <p> - As said before: not all properties are provided with a - default value: you - <i>must</i> - specify a few yourself. And you'll most likely want to - override some others. - </p> - <p> - Set or override the build or maven-plugin properties in - your - <code>${USER_HOME}/build.properties</code> - file. - </p> - <subsection - name="Required Portal Configuration Properties"> - <table> - <tr> - <th>Property</th> - <th>Description</th> - <th nowrap="nowrap">Default value</th> - </tr> - <tr> - <td> - <code>org.apache.jetspeed.portal.home</code> - </td> - <td> - The folder where the maven-plugin will - (re)create or update your custom portal - maven project configuration (with goal - <code>j2:portal.conf.project</code> - ). This will be where you will be performing - all of your future custom portal - development. - <br /> - Example: - <code>/home/myportal/</code> - </td> - <td> - <i>no default</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.portal.groupId - </code> - </td> - <td> - The (maven) short name of your portal - project group. - <br /> - This value is used for the maven repository - folder in which the project artifacts (like - the portal war file) is stored. - <br /> - Example: - <code>myprojects</code> - </td> - <td> - <i>no default</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.portal.artifactId - </code> - </td> - <td> - The (maven) short name of your portal - project. - <br /> - This value is used for the portal war file - and the (portal) web application context - name. - <br /> - Example: - <code>myportal</code> - </td> - <td> - <i>no default</i> - </td> - </tr> - <tr> - <td> - <code>org.apache.jetspeed.portal.name</code> - </td> - <td> - The (maven) full name of your portal - project. - <br /> - This value is used by maven for generating - JavaDoc titles. - <br /> - Example: - <code>My Test Portal</code> - </td> - <td> - <i>no default</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.portal.currentVersion - </code> - </td> - <td> - The current version of your portal project. - <br /> - This value is used by maven as name postfix - for the generated artifacts. - <br /> - Example: - <code>1.0</code> - </td> - <td> - <i>no default</i> - </td> - </tr> - </table> - </subsection> - <subsection - name="Optional Portal Configuration Properties"> - <p> - The following properties all specify a subfolder of - the - <code>${org.apache.jetspeed.portal.home}</code> - location as defined above. - </p> - <table> - <tr> - <th>Property</th> - <th>Description</th> - <th nowrap="nowrap">Default value</th> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.portal.conf.dir - </code> - </td> - <td> - The folder where the maven-plugin will - generate and copy application server - specific configuration files as a tomcat - application context descriptor. - <br /> - This folder and its contents is created or - updated by plugin goal - <code>j2:portal.conf.tomcat</code> - . - </td> - <td> - <i>target/portal-conf</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.portal.sql.dir - </code> - </td> - <td> - The folder where the maven-plugin will - generate and copy portal and database server - specific sql DDL and DML scripts. - <br /> - This folder and its contents is always - (re)created by plugin goal - <code>j2:portal.conf.sql</code> - . - </td> - <td> - <i>target/portal-sql</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.portal.db.dir - </code> - </td> - <td> - The folder where the maven-plugin will - create its build-in HSQLDB database(s). - <br /> - This folder and its contents is created or - updated by plugin goal - <code>j2:start.production.server</code> - or - <code>j2:start.test.server</code> - . - </td> - <td> - <i>target/portal-db</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.portal.webapp.dir - </code> - </td> - <td> - The folder where the maven-plugin will copy - the standard jetspeed web application - resources. - <br /> - This folder and its contents is created or - updated by plugin goal - <code>j2:portal.copy.webapp</code> - . - </td> - <td> - <i> - target/${org.apache.jetspeed.portal.artifactId} - </i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.portal.target.dir - </code> - </td> - <td> - The folder where the maven-plugin will - generate and copy runtime portal - configuration files. - <br /> - These configuration files contain values - derived from build/plugin properties for the - portal and OJB. - <br /> - This folder and its contents is created or - updated by plugin goal - <code>j2:portal.conf.jetspeed</code> - and goal - <code>j2:portal.conf.ojb</code> - . - </td> - <td> - <i> - target/${org.apache.jetspeed.portal.artifactId} - </i> - </td> - </tr> - </table> - </subsection> - <subsection name="Required Application Server Properties"> - <p> - <i> - Note: The maven-plugin currently only supports - the Tomcat Server 5.0.x or 5.5.x - </i> - </p> - <table> - <tr> - <th>Property</th> - <th>Description</th> - <th nowrap="nowrap">Default value</th> - </tr> - <tr> - <td> - <code>org.apache.jetspeed.server.home</code> - </td> - <td> - The root folder of your Tomcat server - installation. - <br /> - Example: - <code>${CATALINA_HOME}/</code> - . - </td> - <td> - <i>no default</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.server.shared - </code> - </td> - <td> - The location of the shared jars in your - Tomcat installation. - <br /> - Example: - <code> - ${org.apache.jetspeed.server.home}/shared/lib/ - </code> - </td> - <td> - <i>no default</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.deploy.war.dir - </code> - </td> - <td> - The location of web applications in your - Tomcat installation. - <br /> - Example: - <code> - ${org.apache.jetspeed.server.home}/webapps/ - </code> - </td> - <td> - <i>no default</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.services.autodeployment.user - </code> - </td> - <td> - A Tomcat user with the manager role. - <br /> - Used to access the Tomcat Manager - application from within the portal, - explained below. - </td> - <td> - <i>no default</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.services.autodeployment.password - </code> - </td> - <td> - The password of the Tomcat user above. - <br /> - Used to access the Tomcat Manager - application from within the portal, - explained below. - </td> - <td> - <i>no default</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.catalina.version.major - </code> - </td> - <td> - The major version of the Tomcat server you - are using: 5 or 5.5 - <br /> - Example: - <code>5.5</code> - </td> - <td> - <i>no default</i> - </td> - </tr> - </table> - </subsection> - <subsection name="Optional Database Server Properties"> - <p> - Jetspeed-2 and its maven-plugin uses, as well as - provides, by default a HSQLDB database. - </p> - <p> - If you want to use a different database you will - need to override the following properties: - </p> - <table> - <tr> - <th>Property</th> - <th>Description</th> - <th nowrap="nowrap">Default value</th> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.production.database.default.name - </code> - </td> - <td> - The type of database you are using. Used for - sql script generation with Torque. - <br /> - Currently supported databases (with - corresponding Torque target database name): - <ul> - <li>hsql (hypersonic)</li> - <li>oracle (oracle)</li> - <li>mysql (mysql)</li> - <li>postgres (postresql)</li> - <li>mssql (mssql)</li> - </ul> - </td> - <td>hsql</td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.production.database.url - </code> - </td> - <td>The jdbc connection url</td> - <td>jdbc:hsqldb:hsql://127.0.0.1:9001</td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.production.database.user - </code> - </td> - <td>The database user name to connect with.</td> - <td>sa</td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.production.database.password - </code> - </td> - <td> - The database user its password to connect - with. - </td> - <td> - <i>empty</i> - </td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.production.database.driver - </code> - </td> - <td>The jdbc driver class name</td> - <td>org.hsqldb.jdbcDriver</td> - </tr> - <tr> - <td> - <code> - org.apache.jetspeed.production.jdbc.drivers.path - </code> - </td> - <td> - A Java classpath style path to the jdbc - driver classes or jar(s) needed for - connecting to the database. - <br /> - Example: - <code> - /lib/ojdbc14.jar;/lib/nls_charset12.jar - </code> - </td> - <td> - <i>empty</i> - </td> - </tr> - </table> - </subsection> - <subsection - name="Example: A minimal custom portal configuration"> - <p> - Make sure you have define at least the required - properties as described above in your - <code>${USER_HOME}/build.properties</code> - . A minimal custom portal configuration using the - default HSQLDB 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 - -# 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> - <i> - Note: If you're going to build the default - Jetspeed 2 portal directly from the source only - the - <code>org.apache.jetspeed.portal.home</code> - property is required from the set of required - portal configuration properties. - </i> - </p> - </subsection> - </section> - <section name="4. Creating a new Portal Application"> - <p> - Now we're going to configure, setup and build a new - custom portal application using the Jetspeed-2 - maven-plugin. - </p> - <subsection - name="4.1 Set the maven remote repository lookup configuration"> - <p> - To be able to setup a Jetspeed 2 based portal the - maven remote repository lookup needs to be - configured properly in your - <code>${USER_HOME}/build.properties</code> - : - <source> - <![CDATA[ -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 these repositories must - be specified is significant! - </i> - </p> - </subsection> - <subsection - name="4.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.0-M4-SNAPSHOT plugin:download]]> - </source> - <i> - Note: you can set the version flag to the - specific version you want to install, - 2.0-M4-SNAPSHOT is just an example here. - </i> - </p> - </subsection> - <subsection name="4.3 Generate a new 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="4.4 Further customization of the portal"> - <p> - This section doesn't specify anything to do. After - the portal project is generated you can adapt and - customize it to your taste by overriding and merging - your own configurations and extensions. - </p> - <p> - You can regenerate or update (part of) your portal - project with the - <code>j2:portal.genapp</code> - goal as described in the previous section or use its - subgoals directly. - </p> - </subsection> - <subsection name="4.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> - </section> - <section name='5. Build Jetspeed 2 from source'> - <p> - Build the Jetspeed 2 portal directly from the source is - somewhat easier to do but should only be done if you - don't want to create a new, customizable portal. - </p> - <subsection - name="5.1 Setup the Jetspeed 2 source and build properties"> - <p> - The Jetspeed 2 source contains a - <code>project.properties</code> - file which provides all of the required portal - configuration settings as described - <a - href="#Required_Portal_Configuration_Properties"> - above - </a> - . - </p> - <p> - You should - <i> - <b>not</b> - </i> - define any of those properties in your - <code>${USER_HOME}/build.properties</code> - . - <br /> - Instead, you - <i>must</i> - set a - <code>org.apache.jetspeed.project.home</code> - property, specifying the location where you expanded - the downloaded source or checked out the source from - subversion, like: - <source> - <![CDATA[ -# required Jetspeed 2 portal configuration property for building from the source -org.apache.jetspeed.project.home = /home/apache/jetspeed-2/]]> - </source> - <i> - Note: you still need to specify the required - application server properties as described - <a - href="#Required_Application_Server_Properties"> - above - </a> - . - </i> - </p> - <p> - The Jetspeed 2 project.properties uses this property - to define the required - <code>org.apache.portal.home</code> - : - <source> - <![CDATA[ -org.apache.jetspeed.portal.home = ${org.apache.jetspeed.project.home}]]> - </source> - So, they are the same when you build the Jetspeed 2 - portal from the source. - </p> - <p> - When you are going to deploy the portal as described - further below, you'll see references to the - <code>org.apache.jetspeed.portal.home</code> - which you can translate with the root folder of your - Jetspeed 2 source. - </p> - <p> - If you want to run the testcases when building the - Jetspeed 2 sources - <i>and</i> - don't want to use the default HSQLDB test database, - you need to override the default test database - properties, similar to the production database - properties as described - <a href="#Optional_Database_Server_Properties"> - above - </a> - : - <ul> - <li> - <code> - org.apache.jetspeed.test.database.default.name - </code> - </li> - <li> - <code> - org.apache.jetspeed.test.database.url - </code> - </li> - <li> - <code> - org.apache.jetspeed.test.database.user - </code> - </li> - <li> - <code> - org.apache.jetspeed.test.database.password - </code> - </li> - <li> - <code> - org.apache.jetspeed.test.database.driver - </code> - </li> - <li> - <code> - org.apache.jetspeed.test.database.drivers.path - </code> - </li> - </ul> - <i> - Note: due to outstanding issue - <a - href="http://issues.apache.org/jira/browse/JS2-320"> - JS2-320 - </a> - you currently - <b>must</b> - use hard coded values for the test database - properties. - </i> - </p> - </subsection> - <subsection name="Initialize the maven-plugin"> - <p> - Instead of downloading and installing the Jetspeed 2 - maven-plugin, you are going to build and install it - directly from the source. You will need to repeat - this every time you update to a newer version of - Jetspeed 2 or change its project configuration, the - plugin itself or the resources used by the plugin. - </p> - <p> - Build and install the maven-plugin as follows from - the root directory of the Jetspeed-2 source: - <source> - <![CDATA[ -cd ${org.apache.jetspeed.project.home} -maven initMavenPlugin]]> - </source> - </p> - </subsection> - <subsection - name="Optional: start the HSQLDB test database first"> - <p> - If you are going to run the testcases and are using - the default HSQLDB database configuration, you will - need to start the test database before building - Jetspeed 2 in a - <i>separate</i> - console: - <source> - <![CDATA[ -cd ${org.apache.jetspeed.project.home} -maven j2:start.test.server]]> - </source> - </p> - <p> - After the build is finished you can stop the - database and close this console with a - <code>Ctrl-C</code> - . - </p> - </subsection> - <subsection - name="Build the Jetspeed 2 portal and demo portlet applications"> - <p> - For a full build and installation of the portal and - the demo portlet applications in your local maven - repository run: - <source> - <![CDATA[ -cd ${org.apache.jetspeed.project.home} -maven allClean allBuild]]> - </source> - </p> - <p> - But, if you also want to run the testcases during - the build run the following instead: - <source> - <![CDATA[ -cd ${org.apache.jetspeed.project.home} -maven -Dmaven.test.skip=false allClean allBuild]]> - </source> - </p> - <p> - You are now ready to deploy the Jetspeed 2 Portal. - </p> - </subsection> - </section> - <section name="6. Deploy and Run"> - <subsection - name="Optional: start the HSQLDB production database first"> - <p> - If you are using the default HSQLDB database you - need to start it before deploying the portal. - </p> - <p> - To start the HSQLDB production database run the - following in a - <i>separate</i> - console: - <source> - <![CDATA[ -cd ${org.apache.jetspeed.portal.home} -maven j2:start.production.server]]> - </source> - </p> - <p> - You need to have this database running during the - deployment and while running the application server. - Afterwards you can stop the database and close this - console with a - <code>Ctrl-C</code> - . - </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="Deploy"> - <p> - We currently only cover deploying to Tomcat 5 or - Tomcat 5.5. - </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 customize - the deployment to your taste. - </i> - </p> - </subsection> - <subsection name="Run"> - <p> - The final step is starting up your Tomcat server and - 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 you own portal application ( - <code> - ${org.apache.jetspeed.portal.artifactId} - </code> - ). - </p> - </subsection> - <subsection name="Default installed user accounts"> - <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> - </section> - </body> -</document> +<?xml version="1.0"?> +<!-- + Copyright 2004 The Apache Software Foundation + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title> + [Getting Started with Jetspeed 2 using a Source Release] $B%=!<%9%j%j!<%9$r;H$C$?(B Jetspeed2 $B$N$O$8$a$+$?(B + </title> + <subtitle>[Gettin gready to modify Jetspeed] Jetspeed $B$rJQ99$9$k=`Hw$r$9$k(B</subtitle> + <authors> + <person name="David Sean Taylor" email="taylo****@apach*****" /> + <person name="Ate Douma" email="ate****@apach*****" /> + <person name="David Le Strat" email="dlest****@apach*****" /> + <person name="Ron Wheeler" + email="rwhee****@artif*****" /> + </authors> + </properties> + <body> + <section name="[Naming Conventions and Basic Assumptions] $BL?L>5,B'$H4pK\$H$J$kA0Ds(B"> + <subsection name="[Source Basic Assumptions] $B%=!<%9$K$*$1$k4pK\$H$J$kA0Ds(B"> + + <div class="original"> + <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> + </div> + + <ul> + <li>$BFCJL$KDj$a$N$J$$8B$j!"A4$F$N(B maven $B$N%S%k%I%3%^%s%I$O(B (Jetspeed $B$r%S%k%I$9$k$H$-$O(B) Jetspeed $B%G%#%l%/%H%j$G<B9T$5$l$k$+!":n @ .$7$h$&$H$7$F$$$k%+%9%?%`$N%]!<%?%k:n @ .MQ%G%#%l%/%H%j$G<B9T$5$l$^$9!#(B</li> + <li> * *nix $B4D6-$G$"$C$F$b!"(BWindows $B4D6-$G$"$C$F$b!"Nc$($P(B c:/windows $B$d(B /home $B$N$h$&$K!"%G%#%l%/%H%j$N%;%Q%l!<%?$H$7$F$O(B "/" $B$r;HMQ$7$J$1$l$P$$$1$^$;$s!#(B</li> + </ul> + + </subsection> + <subsection name="[Naming Conventions] $BL?L>5,B'(B"> + + <div class="original"> + <p> + Below is a listing of common conventions used within + this document. + </p> + </div> + <p>$B$3$NJ8=q$G;HMQ$9$k6&DL$N5,B'$r0J2<$K<($7$^$9!#(B</p> + + <div class="original"> + <p> + Variables are represented as ${ + <i>some_variable</i> + }. This may signify a setting in Jetspeed or may + represent a setting within your environment. + Properties files are also capable of specifying + variables within them. + </p> + </div> + <p> + $BJQ?t$O(B <i>${ some_variable }</i> $B$H$7$FI=$7$^$9!#$3$l$O(B Jetspeed $B$N @ _Dj$rI=$9$3$H$b=PMh$^$9$7!"$"$J$?$N4D6-Fb$G$N @ _Dj$rI=$9$3$H$b=PMh$^$9!#%W%m%Q%F%#%U%!%$%k$b$=$NCf$GJQ?t$r5-=R$9$k$3$H$,=PMh$^$9!#(B + </p> + + <div class="original"> + <p> + For example, ${org.apache.jetspeed.server.home} + references either a property defined further up in + the properties file, a variable that has been + defined somehwere within the build process or + defined in another build file within Jetspeed. + </p> + </div> + <p> + $BNc$($P!"(B${org.apache.jetspeed.server.home} $B$O%W%m%Q%F%#%U%!%$%kFb$GDj5A$5$l$k$+$bCN$l$^$;$s$7!"%S%k%I%W%m%;%9Fb$N$I$3$+$GDj5A$5$l$kJQ?t$+$bCN$l$^$;$s$7!"(BJetspeed $BFb$NB>$N%S%k%I%U%!%$%kFb$GDj5A$5$l$k$+$bCN$l$^$;$s!#(B + </p> + + <div class="original"> + <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 is the location of your tomcat + installation, e.g. + <i>c:/tomcat</i> + . + </li> + </ul> + </div> + + <ul> + <li> + <b>${USER_HOME}</b> + : $B%f!<%6$N%[!<%`%G%#%l%/%H%j$G$9!#(BWindows $B$G$O!"0lHLE*$K(B c:\Documents and Settings\${userName}\ $B$K$J$j$^$9!#$3$3$G(B ${userName} $B$O(B Windows $B$K%m%0%$%s$9$k$H$-$N%m%0%$%sL>$G$9!#(B + </li> + <li> + <b>${CATALINA_HOME}</b> + : $B$"$J$?$,(B Tomcat $B$r%$%s%9%H!<%k$7$?>l=j$G$9!#Nc$($P(B <i>c:/tomcat</i> $B$J$I$G$9!#(B + </li> + </ul> + + </subsection> + <subsection name="[Source Subversion (SVN)] Source Subversion (SVN)"> + + <div class="original"> + <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> + </div> + <p> + <a href="http://subversion.tigris.org"> + Subversion (SVN) + </a> + $B$O(B Jetspeed $B$N%=!<%9%U%!%$%k$r4IM}$9$k$?$a$K;H$o$l$^$9!#(BSVN $B$O(B CVS $B$K$H$F$b;w$F$$$^$9!#(BWindows $B%7%9%F%`$G%3%^%s%I%i%$%s$r;HMQ$7$J$$%f!<%6$O!"(B + <a href="http://tortoisesvn.tigris.org"> + TortoiseSVN + </a> + $B$r;H$C$F$_$k$HNI$$$G$7$g$&!#$3$N%D!<%k$O(B Windows Explorer $B$K%W%i%0%$%s$5$l$^$9!#(BEclipse IDE $B$r;H$C$F$$$k%f!<%6$O(B + <a href="http://subclipse.tigris.org">Subclipse</a> + $B%W%i%0%$%s$,(B SVN $B%"%/%;%9$K;HMQ=PMh$^$9!#(B + </p> + + </subsection> + <subsection name="[Maven Setup] Maven Setup"> + + <div class="original"> + <p> + We will not go into the specifics of Maven as that + is beyond the scope of this document. However, here + are a few bits of standard maven jargon we feel is + important for you to know. + </p> + </div> + <p> + $B$3$NJ8=q$G$O!"(BMaven $B$N;EMM$K$D$$$F$O=R$Y$^$;$s!#$7$+$7!"$3$3$G$"$J$?$,CN$C$F$*$/$Y$-=EMW$J(B maven $B$N4pK\E*$J @ lLgMQ8l$r0J2<$K>/$7$@$15s$2$F$*$-$^$9!#(B + </p> + + <div class="original"> + <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 the jars + that it downloads when you run your builds. This is + also were Maven puts your jars and wars that you + build. They will be stored in a directory structure + that has the format of + ${groupId}/${projectId}/jars/${projectId}-{$version}.jar + for jar files and + ${groupId}/${projectId}/wars/${projectId}.war for + war files. 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> + </div> + <p> + $B$"$J$?$OJ8=qFb$G(B maven repository $B$K$D$$$F?($l$k$N$rL\$K$9$k$3$H$,$"$k$G$7$g$&!#(Bmaven $B$r%$%s%9%H!<%k$9$k$H!"(B.maven/ $B%G%#%l%/%H%j$,(B ${USER_HOME} $B%G%#%l%/%H%j$K:n @ .$5$l$^$9!#(B<br /> +.maven/ $B0J2<$K(B repository $B$H$$$&%G%#%l%/%H%j$,$"$k$O$:$G$9!#$3$3$K$O%S%k%I$r<B9T$9$k$H$-$K(B maven $B$,%@%&%s%m!<%I$7$?(B jar $B%U%!%$%k$,J]B8$5$l$^$9!#$3$3$O$"$J$?$N%S%k%I$G=PMh$?(B jar $B%U%!%$%k$d(B war $B%U%!%$%k$bCV$+$l$k$3$H$,$"$j$^$9!#(Bjar $B%U%!%$%k$O(B ${groupId}/${projectId}/jars/${projectId}-{$version}.jar $B$KCV$+$l$^$9!#%]!<%?%k(B war $B%U%!%$%k$O(B ${groupId}/${projectId}/wars/${projectId}.war $B$H$J$j$^$9!#(B${groupId}$B!"(B${projectId}$B!"(B${version} $B$N3FJQ?t$K$D$$$F$O$3$NJ8=q$N8e$NJ}$G?($l$^$9!#(Bjar $B%U%!%$%k$H(B war $B%U%!%$%k$O!"$"$J$?$N%W%m%8%'%/%H$N(B /target $B%G%#%l%/%H%j$K$b:n @ .$5$l$^$9!#(B + </p> + + </subsection> + </section> + + <section name='[2. Jetspeed build and maven-plugin Properties] 2. Jetspeed $B$N%S%k%I$H(B maven $B%W%i%0%$%s$N%W%m%Q%F%#(B'> + + <div class="original"> + <p>You need to set a few properties.</p> + </div> + <p>$B$$$/$D$+%W%m%Q%F%#$r @ _Dj$9$kI,MW$,$"$j$^$9!#(B</p> + + <div class="original"> + <p> + Creating your own custom portal is very easy with the + maven plugin provided by Jetspeed 2. And, it is used + when you build jetspeed from source as well. In fact, + the jetspeed-2 build procedure is just one example of a + custom portal configuration and setup. + </p> + </div> + <p> + $B%+%9%?%`$N%]!<%?%k$r:n$k$N$O(B Jetspeed 2 $B$,Ds6!$9$k(B Maven $B%W%i%0%$%s$r;H$($P$H$F$b4JC1$G$9!#%=!<%9$+$i(B Jetspeed $B$r%S%k%I$9$k;~$bF1MM$K(B Maven $B%W%i%0%$%s$r;H$$$^$9!#;v<B!"(BJetspeed 2 $B$N%S%k%I<j=g$OCzEY%+%9%?%`%]!<%?%k$r @ _Dj$7!"9=C[$9$k0lNc$N$h$&$J$b$N$G$9!#(B + </p> + + <div class="original"> + <p> + The Jetspeed 2 maven-plugin defines default values for + most of the properties you can set, but not all. When + you download or checkout the jetspeed-2 source tree, + you'll see it contains a project.properties file in the + root folder overriding and setting some of these + properties. + </p> + </div> + <p> + Jetspeed 2 $B$N(B Maven $B%W%i%0%$%s$O @ _Dj2DG=$J$[$H$s$I$N%W%m%Q%F%#$K%G%U%)%k%HCM$rDj5A$7$F$$$^$9!#$7$+$7!"A4$F$KDj5A$5$l$F$$$k$o$1$G$O$"$j$^$;$s!#(BJetspeed 2 $B$N%=!<%9%D%j!<$r%@%&%s%m!<%I$7$?$j!"%A%'%C%/%"%&%H$7$?$H$-!"$3$l$i$N%W%m%Q%F%#$N$$$/$D$+$r @ _Dj$7$?$j>e=q$-$7$?$j$9$k(B project.properties $B%U%!%$%k$,%k!<%H%U%)%k%@$K$"$k$N$,$o$+$k$G$7$g$&!#(B + </p> + + <div class="original"> + <p> + As said before: not all properties are provided with a + default value: you + <i>must</i> + specify a few yourself. And you'll most likely want to + override some others. + </p> + </div> + <p> + $BA0=R$N$h$&$K!"A4$F$N%W%m%Q%F%#$K%G%U%)%k%HCM$,Dj5A$5$l$F$$$k$o$1$G$O$"$j$^$;$s!#$$$/$D$+$N%W%m%Q%F%#$r;XDj(B <i>$B$7$J$1$l$P$J$j$^$;$s(B</i>$B!#$=$7$F!"BgBN$N>l9g$O$$$/$D$+$NCM$r>e=q$-$7$?$/$J$k$G$7$g$&!#(B + </p> + + <div class="original"> + <p> + Set or override the build or maven-plugin properties in + your + <code>${USER_HOME}/build.properties</code> + file. + </p> + </div> + <p> + $B%S%k%I%W%m%Q%F%#$b$7$/$O(B Maven $B%W%i%0%$%s$N%W%m%Q%F%#$O(B + <code>${USER_HOME}/build.properties</code> + $B$K @ _Dj$b$7$/$O>e=q$-$7$F$/$@$5$$!#(B + </p> + + <subsection + name="[Required Portal Configuration Properties] $BI,?\$N%]!<%?%k @ _Dj%W%m%Q%F%#(B"> + + <div class="original"> + <table> + <tr> + <th>Property</th> + <th>Description</th> + <th nowrap="nowrap">Default value</th> + </tr> + <tr> + <td> + <code>org.apache.jetspeed.portal.home</code> + </td> + <td> + The folder where the maven-plugin will + (re)create or update your custom portal + maven project configuration (with goal + <code>j2:portal.conf.project</code> + ). This will be where you will be performing + all of your future custom portal + development. + <br /> + Example: + <code>/home/myportal/</code> + </td> + <td> + <i>no default</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.groupId + </code> + </td> + <td> + The (maven) short name of your portal + project group. + <br /> + This value is used for the maven repository + folder in which the project artifacts (like + the portal war file) is stored. + <br /> + Example: + <code>myprojects</code> + </td> + <td> + <i>no default</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.artifactId + </code> + </td> + <td> + The (maven) short name of your portal + project. + <br /> + This value is used for the portal war file + and the (portal) web application context + name. + <br /> + Example: + <code>myportal</code> + </td> + <td> + <i>no default</i> + </td> + </tr> + <tr> + <td> + <code>org.apache.jetspeed.portal.name</code> + </td> + <td> + The (maven) full name of your portal + project. + <br /> + This value is used by maven for generating + JavaDoc titles. + <br /> + Example: + <code>My Test Portal</code> + </td> + <td> + <i>no default</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.currentVersion + </code> + </td> + <td> + The current version of your portal project. + <br /> + This value is used by maven as name postfix + for the generated artifacts. + <br /> + Example: + <code>1.0</code> + </td> + <td> + <i>no default</i> + </td> + </tr> + </table> + </div> + + <table> + <tr> + <th>$B%W%m%Q%F%#(B</th> + <th>$B @ bL@(B</th> + <th nowrap="nowrap">$B%G%U%)%k%HCM(B</th> + </tr> + <tr> + <td> + <code>org.apache.jetspeed.portal.home</code> + </td> + <td> + Maven $B%W%i%0%$%s$,(B ($B:F(B) $B:n @ .$7$?$j!"%+%9%?%`%]!<%?%k$N(B Mave $B%W%m%8%'%/%H @ _Dj$,(B ( + <code>j2:portal.conf.project</code> + $B%4!<%k$G(B) $B99?7$7$?$j$9$k%U%)%k%@!#$3$N%U%)%k%@$O%+%9%?%`$N%]!<%?%k3+H/$NA4$F$r<B9T$9$k>l=j$G$9!#(B<br /> + $BNc(B: + <code>/home/myportal</code> + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.groupId + </code> + </td> + <td> + $B$"$J$?$N%]!<%?%k%W%m%8%'%/%H%0%k!<%W$N(B (Maven $B$G$N(B) $B>JN,L>!#(B + <br /> + $B$3$NCM$O(B ($B%]!<%?%k(B war $B%U%!%$%k$N$h$&$J(B) $B%W%m%8%'%/%H$N @ .2LJ*$rJd4V$7$F$*$/(B Maven $B$N%j%]%8%H%j%U%)%k%@$K;H$$$^$9!#(B + <br /> + $BNc(B: + <code>myprojects</code> + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.artifactId + </code> + </td> + <td> + $B$"$J$?$N%]!<%?%k%W%m%8%'%/%H$N(B (Maven $B$G$N(B) $B>JN,L>!#(B + <br /> + $B$3$NCM$O%]!<%?%k(B war $B%U%!%$%k$d(B ($B%]!<%?%k(B) $B%&%'%V%"%W%j%1!<%7%g%s$N%3%s%F%-%9%HL>$K;H$$$^$9!#(B + <br /> + $BNc(B: + <code>myportal</code> + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + <tr> + <td> + <code>org.apache.jetspeed.portal.name</code> + </td> + <td> + $B$"$J$?$N%]!<%?%k%W%m%8%'%/%H$N(B (Maven $B$G$N(B) $B%U%k%M!<%`!#(B + <br /> + $B$3$NCM$O(B JaveDoc $B$N%?%$%H%k$r @ 8@.$9$k$N$K(B Maven $B$,;H$$$^$9!#(B + <br /> + $BNc(B: + <code>My Test Portal</code> + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.currentVersion + </code> + </td> + <td> + $B$"$J$?$N%]!<%?%k%W%m%8%'%/%H$N8=:_$N%P!<%8%g%s!#(B + <br /> + $B$3$NCM$O%W%m%8%'%/%H$N @ 8@.J*$NL>A0$N:G8e$K(B Maven $B$KIU$12C$($i$l$^$9!#(B + <br /> + Example: + <code>1.0</code> + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + </table> + + </subsection> + <subsection + name="[Optional Portal Configuration Properties] $B%*%W%7%g%J%k$N%]!<%?%k @ _Dj%W%m%Q%F%#(B"> + + <div class="original"> + <p> + The following properties all specify a subfolder of + the + <code>${org.apache.jetspeed.portal.home}</code> + location as defined above. + </p> + </div> + <p> + $B$3$N$"$H$K=R$Y$k%W%m%Q%F%#$OA4$F(B + <code>${org.apache.jetspeed.portal.home}</code> + $B$N%5%V%U%)%k%@$rDj5A$7$^$9!#(B + </p> + + <div class="original"> + <table> + <tr> + <th>Property</th> + <th>Description</th> + <th nowrap="nowrap">Default value</th> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.conf.dir + </code> + </td> + <td> + The folder where the maven-plugin will + generate and copy application server + specific configuration files as a tomcat + application context descriptor. + <br /> + This folder and its contents is created or + updated by plugin goal + <code>j2:portal.conf.tomcat</code> + . + </td> + <td> + <i>target/portal-conf</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.sql.dir + </code> + </td> + <td> + The folder where the maven-plugin will + generate and copy portal and database server + specific sql DDL and DML scripts. + <br /> + This folder and its contents is always + (re)created by plugin goal + <code>j2:portal.conf.sql</code> + . + </td> + <td> + <i>target/portal-sql</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.db.dir + </code> + </td> + <td> + The folder where the maven-plugin will + create its build-in HSQLDB database(s). + <br /> + This folder and its contents is created or + updated by plugin goal + <code>j2:start.production.server</code> + or + <code>j2:start.test.server</code> + . + </td> + <td> + <i>target/portal-db</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.webapp.dir + </code> + </td> + <td> + The folder where the maven-plugin will copy + the standard jetspeed web application + resources. + <br /> + This folder and its contents is created or + updated by plugin goal + <code>j2:portal.copy.webapp</code> + . + </td> + <td> + <i> + target/${org.apache.jetspeed.portal.artifactId} + </i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.target.dir + </code> + </td> + <td> + The folder where the maven-plugin will + generate and copy runtime portal + configuration files. + <br /> + These configuration files contain values + derived from build/plugin properties for the + portal and OJB. + <br /> + This folder and its contents is created or + updated by plugin goal + <code>j2:portal.conf.jetspeed</code> + and goal + <code>j2:portal.conf.ojb</code> + . + </td> + <td> + <i> + target/${org.apache.jetspeed.portal.artifactId} + </i> + </td> + </tr> + </table> + </div> + + <table> + <tr> + <th>$B%W%m%Q%F%#(B</th> + <th>$B @ bL@(B</th> + <th nowrap="nowrap">$B%G%U%)%k%HCM(B</th> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.conf.dir + </code> + </td> + <td> + $B$3$N%U%)%k%@$O(B Maven $B%W%i%0%$%s$,%"%W%j%1!<%7%g%s%5!<%P$N @ _Dj%U%!%$%k$r(B Tomcat $B$N%"%W%j%1!<%7%g%s$N%3%s%F%-%9%H5-=R;R$H$7$F @ 8@.$7%3%T!<$7$^$9!#(B + <br /> + $B$3$N%U%)%k%@$H%U%)%k%@Fb$N%3%s%F%s%D$O(B + <code>j2:portal.conf.tomcat</code> + $B%W%i%0%$%s%4!<%k$K$h$C$F:n @ .$5$l$?$j99?7$5$l$?$j$7$^$9!#(B + </td> + <td> + <i>target/portal-conf</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.sql.dir + </code> + </td> + <td> + $B$3$N%U%)%k%@$O(B Maven $B%W%i%0%$%s$,%]!<%?%k$d%G!<%?%Y!<%9%5!<%P$N(B sql DDL $B$H(B DML $B%9%/%j%W%H$r @ 8@.$7%3%T!<$7$^$9!#(B + <br /> + $B$3$N%U%)%k%@$H%U%)%k%@Fb$N%3%s%F%s%D$O>o$K(B + <code>j2:portal.conf.sql</code> + $B%W%i%0%$%s%4!<%k$K$h$C$F(B ($B:F(B) $B @ 8@.$5$l$^$9!#(B + </td> + <td> + <i>target/portal-sql</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.db.dir + </code> + </td> + <td> + $B$3$N%U%)%k%@$O(B Maven $B%W%i%0%$%s$,%S%k%I%$%s$N(B HSQLDB $B%G!<%?%Y!<%9$r:n @ .$7$^$9!#(B + <br /> + $B$3$N%U%)%k%@$H%U%)%k%@Fb$N%3%s%F%s%D$O(B + <code>j2:start.production.server</code> + ããã㯠+ <code>j2:start.test.server</code> + $B%W%i%0%$%s%4!<%k$K$h$C$F @ 8@.$5$l$?$j99?7$5$l$?$j$7$^$9!#(B + </td> + <td> + <i>target/portal-db</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.webapp.dir + </code> + </td> + <td> + $B$3$N%U%)%k%@$O(B Maven $B%W%i%0%$%s$,I8=`$N(B Jetspeed $B$N%&%'%V%"%W%j%1!<%7%g%s$N%j%=!<%9$r%3%T!<$7$^$9!#(B + <br /> + $B$3$N%U%)%k%@$H%U%)%k%@Fb$N%3%s%F%s%D$O(B + <code>j2:portal.copy.webapp</code> + $B%W%i%0%$%s%4!<%k$K$h$C$F @ 8@.$5$l$?$j99?7$5$l$?$j$7$^$9!#(B + . + </td> + <td> + <i> + target/${org.apache.jetspeed.portal.artifactId} + </i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.portal.target.dir + </code> + </td> + <td> + $B$3$N%U%)%k%@$O(B Maven $B%W%i%0%$%s$,%i%s%?%$%`$N%]!<%?%k$N @ _Dj%U%!%$%k$r @ 8@.$7$?$j%3%T!<$7$?$j$7$^$9!#(B + <br /> + $B$3$l$i$N @ _Dj%U%!%$%k$O%]!<%?%k$d(B OJB $B$N%S%k%I(B/$B%W%i%0%$%s%W%m%Q%F%#$+$i @ 8@.$5$l$?CM$r4^$_$^$9!#(B + <br /> + $B$3$N%U%)%k%@$H%U%)%k%@Fb$N%3%s%F%s%D$O(B + <code>j2:portal.conf.jetspeed</code> + ããã㯠+ <code>j2:portal.conf.ojb</code> + $B%W%i%0%$%s%4!<%k$K$h$C$F @ 8@.$5$l$?$j99?7$5$l$?$j$7$^$9!#(B + </td> + <td> + <i> + target/${org.apache.jetspeed.portal.artifactId} + </i> + </td> + </tr> + </table> + + </subsection> + <subsection name="[Required Application Server Properties] $BI,?\$N%"%W%j%1!<%7%g%s%5!<%P$N%W%m%Q%F%#(B"> + + <div class="original"> + <p> + <i> + Note: The maven-plugin currently only supports + the Tomcat Server 5.0.x or 5.5.x + </i> + </p> + </div> + <p> + <i> + $BCm0U(B: Maven$B%W%i%0%$%s$O8=;~E@$G$O(B Tomcat 5.0.x $B$^$?$O(B 5.5.x $B$N$_$r%5%]!<%H$7$^$9!#(B + </i> + </p> + + <div class="original"> + <table> + <tr> + <th>Property</th> + <th>Description</th> + <th nowrap="nowrap">Default value</th> + </tr> + <tr> + <td> + <code>org.apache.jetspeed.server.home</code> + </td> + <td> + The root folder of your Tomcat server + installation. + <br /> + Example: + <code>${CATALINA_HOME}/</code> + . + </td> + <td> + <i>no default</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.server.shared + </code> + </td> + <td> + The location of the shared jars in your + Tomcat installation. + <br /> + Example: + <code> + ${org.apache.jetspeed.server.home}/shared/lib/ + </code> + </td> + <td> + <i>no default</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.deploy.war.dir + </code> + </td> + <td> + The location of web applications in your + Tomcat installation. + <br /> + Example: + <code> + ${org.apache.jetspeed.server.home}/webapps/ + </code> + </td> + <td> + <i>no default</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.services.autodeployment.user + </code> + </td> + <td> + A Tomcat user with the manager role. + <br /> + Used to access the Tomcat Manager + application from within the portal, + explained below. + </td> + <td> + <i>no default</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.services.autodeployment.password + </code> + </td> + <td> + The password of the Tomcat user above. + <br /> + Used to access the Tomcat Manager + application from within the portal, + explained below. + </td> + <td> + <i>no default</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.catalina.version.major + </code> + </td> + <td> + The major version of the Tomcat server you + are using: 5 or 5.5 + <br /> + Example: + <code>5.5</code> + </td> + <td> + <i>no default</i> + </td> + </tr> + </table> + </div> + + <table> + <tr> + <th>$B%W%m%Q%F%#(B</th> + <th>$B @ bL@(B</th> + <th nowrap="nowrap">$B%G%U%)%k%HCM(B</th> + </tr> + <tr> + <td> + <code>org.apache.jetspeed.server.home</code> + </td> + <td> + Tomcat $B$r%$%s%9%H!<%k$7$?%k!<%H%U%)%k%@!#(B + <br /> + Example: + <code>${CATALINA_HOME}/</code> + . + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.server.shared + </code> + </td> + <td> + Tomcat $B$N6&M-$N(B jar $B$NCV>l!#(B + <br /> + Example: + <code> + ${org.apache.jetspeed.server.home}/shared/lib/ + </code> + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.deploy.war.dir + </code> + </td> + <td> + Tomcat $B$N%&%'%V%"%W%j%1!<%7%g%s$N>l=j!#(B + <br /> + Example: + <code> + ${org.apache.jetspeed.server.home}/webapps/ + </code> + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.services.autodeployment.user + </code> + </td> + <td> + manager $B%m!<%k$KB0$9$k(B Tomcat $B$N%f!<%6!#(B + <br /> + $B8e$G @ bL@$9$k$h$&$K!"%]!<%?%kFb$+$i(B Tomcat Manager $B%"%W%j%1!<%7%g%s$X%"%/%;%9$9$k$N$K;H$$$^$9!#(B + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.services.autodeployment.password + </code> + </td> + <td> + $BA0=R$N(B Tomcat $B%f!<%6$N%Q%9%o!<%I!#(B + <br /> + $B8e$G @ bL@$9$k$h$&$K!"%]!<%?%kFb$+$i(B Tomcat Manager $B%"%W%j%1!<%7%g%s$X%"%/%;%9$9$k$N$K;H$$$^$9!#(B + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.catalina.version.major + </code> + </td> + <td> + $B;HMQ$9$k(B Tomcat $B$N%a%8%c!<%P!<%8%g%s!#(B5 $B$b$7$/$O(B 5.5 $B$,;H$($^$9!#(B + <br /> + $BNc(B: + <code>5.5</code> + </td> + <td> + <i>$B%G%U%)%k%HCM$J$7(B</i> + </td> + </tr> + </table> + + </subsection> + <subsection name="[Optional Database Server Properties] $B%*%W%7%g%J%k$N%G!<%?%Y!<%9%5!<%P$N%W%m%Q%F%#(B"> + + <div class="original"> + <p> + Jetspeed-2 and its maven-plugin uses, as well as + provides, by default a HSQLDB database. + </p> + </div> + <p> + Jetspeed 2 $B$H(B Jetspeed 2 $B$N(B Maven $B%W%i%0%$%s$O%G%U%)%k%H$G$O(B HSQLDB $B$N%G!<%?%Y!<%9$r;HMQ$7$^$9!#(B + </p> + + <div class="original"> + <p> + If you want to use a different database you will + need to override the following properties: + </p> + </div> + <p> + $B$b$70[$J$k%G!<%?%Y!<%9$r;HMQ$9$k$N$G$"$l$P!"0J2<$N%W%m%Q%F%#$r>e=q$-$9$kI,MW$,$"$j$^$9!#(B + </p> + + <div class="original"> + <table> + <tr> + <th>Property</th> + <th>Description</th> + <th nowrap="nowrap">Default value</th> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.default.name + </code> + </td> + <td> + The type of database you are using. Used for + sql script generation with Torque. + <br /> + Currently supported databases (with + corresponding Torque target database name): + <ul> + <li>hsql (hypersonic)</li> + <li>oracle (oracle)</li> + <li>mysql (mysql)</li> + <li>postgres (postresql)</li> + <li>mssql (mssql)</li> + </ul> + </td> + <td>hsql</td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.url + </code> + </td> + <td>The jdbc connection url</td> + <td>jdbc:hsqldb:hsql://127.0.0.1:9001</td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.user + </code> + </td> + <td>The database user name to connect with.</td> + <td>sa</td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.password + </code> + </td> + <td> + The database user its password to connect + with. + </td> + <td> + <i>empty</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.driver + </code> + </td> + <td>The jdbc driver class name</td> + <td>org.hsqldb.jdbcDriver</td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.jdbc.drivers.path + </code> + </td> + <td> + A Java classpath style path to the jdbc + driver classes or jar(s) needed for + connecting to the database. + <br /> + Example: + <code> + /lib/ojdbc14.jar;/lib/nls_charset12.jar + </code> + </td> + <td> + <i>empty</i> + </td> + </tr> + </table> + </div> + + <table> + <tr> + <th>$B%W%m%Q%F%#(B</th> + <th>$B @ bL@(B</th> + <th nowrap="nowrap">$B%G%U%)%k%HCM(B</th> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.default.name + </code> + </td> + <td> + $B$"$J$?$,;HMQ$9$k%G!<%?%Y!<%9$N<oN`$r;XDj$7$^$9!#(BTorque $B$, @ 8@.$9$k(B SQL $B%9%/%j%W%H$N$?$a$K;HMQ$7$^$9!#(B + <br /> + $B8=;~E@$G%5%]!<%H$9$k%G!<%?%Y!<%9$O0J2<$NDL$j$G$9!#(B(Torque $B$N%?!<%2%C%H%G!<%?%Y!<%9L>$H0lCW$7$^$9!#(B) + <ul> + <li>hsql (hypersonic)</li> + <li>oracle (oracle)</li> + <li>mysql (mysql)</li> + <li>postgres (postresql)</li> + <li>mssql (mssql)</li> + </ul> + </td> + <td>hsql</td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.url + </code> + </td> + <td>JDBC $B$N@\B3(B url</td> + <td>jdbc:hsqldb:hsql://127.0.0.1:9001</td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.user + </code> + </td> + <td>$B%G!<%?%Y!<%9$K@\B3$9$k:]$N%f!<%6L>!#(B</td> + <td>sa</td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.password + </code> + </td> + <td> + $B%G!<%?%Y!<%9$K@\B3$9$k%f!<%6$N%Q%9%o!<%I!#(B + </td> + <td> + <i>$B6u(B</i> + </td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.database.driver + </code> + </td> + <td>JDBC $B%I%i%$%P$N%/%i%9L>(B</td> + <td>org.hsqldb.jdbcDriver</td> + </tr> + <tr> + <td> + <code> + org.apache.jetspeed.production.jdbc.drivers.path + </code> + </td> + <td> + $B%G!<%?%Y!<%9@\B3$KI,MW$J(B JDBC $B%I%i%$%P%/%i%9$d(B jar $B$X$N(B Java $B%/%i%9%Q%9%9%?%$%k$N%Q%9!#(B + <br /> + $BNc(B: + <code> + /lib/ojdbc14.jar;/lib/nls_charset12.jar + </code> + </td> + <td> + <i>$B6u(B</i> + </td> + </tr> + </table> + + </subsection> + <subsection + name="[Example: A minimal custom portal configuration] $BNc(B: $B:G>.8B$N%+%9%?%`%]!<%?%k$N @ _Dj(B"> + + <div class="original"> + <p> + Make sure you have define at least the required + properties as described above in your + <code>${USER_HOME}/build.properties</code> + . A minimal custom portal configuration using the + default HSQLDB 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 + +# 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> + <i> + Note: If you're going to build the default + Jetspeed 2 portal directly from the source only + the + <code>org.apache.jetspeed.portal.home</code> + property is required from the set of required + portal configuration properties. + </i> + </p> + </div> + <p> + $B>/$J$/$H$bA0=R$NI,?\$N%W%m%Q%F%#$O(B + <code>${USER_HOME}/build.properties</code> + $B$GDj5A$9$kI,MW$,$"$k$3$H$KCm0U$7$F$/$@$5$$!#(BHSQLDB $B$r;H$C$?:GDc8B$N%+%9%?%`%]!<%?%k$N @ _Dj$O0J2<$N$h$&$JIw$K$J$j$^$9!#(B + <source> + <![CDATA[ +# $BI,?\$N%]!<%?%k$N @ _Dj%W%m%Q%F%#(B +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 + +# $BI,?\$N%"%W%j%1!<%7%g%s%5!<%P$N%W%m%Q%F%#(B +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> + <i> + $BCm0U(B: $B$b$7%G%U%)%k%H$N(B Jetspeed 2 $B%]!<%?%k$r%=!<%9$+$iD>@\%S%k%I$9$k$D$b$j$J$N$G$"$l$P!"I,?\$N%]!<%?%k$N @ _Dj%W%m%Q%F%#$N$&$A!"(B + <code>org.apache.jetspeed.portal.home</code> + $B$@$1$,I,MW$K$J$j$^$9!#(B + </i> + </p> + </subsection> + </section> + <section name="[4. Creating a new Portal Application] 4. $B?7$7$$%]!<%?%k%"%W%j%1!<%7%g%s$N:n @ .(B"> + + <div class="original"> + <p> + Now we're going to configure, setup and build a new + custom portal application using the Jetspeed-2 + maven-plugin. + </p> + </div> + <p> + $B$5$F!"$3$3$G$O(B Jetspeed 2 $B$N(B Maven $B%W%i%0%$%s$r;H$C$F!"?7$7$$%+%9%?%`%]!<%?%k%"%W%j%1!<%7%g%s$r @ _Dj$7!"%;%C%H%"%C%W$7!"%S%k%I$7$^$9!#(B + </p> + <subsection + name="[4.1 Set the maven remote repository lookup configuration] 4.1 Maven $B$N%j%b!<%H%j%]%8%H%j$r8+IU$1$k$?$a$N @ _Dj(B"> + + <div class="original"> + <p> + To be able to setup a Jetspeed 2 based portal the + maven remote repository lookup needs to be + configured properly in your + <code>${USER_HOME}/build.properties</code> + : + <source> + <![CDATA[ +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 these repositories must + be specified is significant! + </i> + </p> + </div> + <p> + Jetspeed 2 $B%Y!<%9$N%]!<%?%k$N @ _Dj$,=PMh$k$?$a$K$O!"(BMaven $B$N%j%b!<%H%j%]%8%H%j$N>l=j$r(B + <code>${USER_HOME}/build.properties</code> + $B$K0J2<$N$h$&$K @ _Dj$9$kI,MW$,$"$j$^$9!#(B + <source> + <![CDATA[ +maven.repo.remote = http://www.bluesunrise.com/maven/, http://www.ibiblio.org/maven/, \ + http://dist.codehaus.org/, http://cvs.apache.org/repository]]> + </source> + <i> + $BCm0U(B: $B$3$l$i$N%j%]%8%H%j$N=gHV$bF1$8$h$&$K;XDj$7$J$1$l$P$$$1$^$;$s!#(B + </i> + </p> + </subsection> + <subsection + name="[4.2 Install the Jetspeed 2 maven-plugin] 4.2 Jetspeed 2 $B$N(B Maven $B%W%i%0%$%s$N%$%s%9%H!<%k(B"> + + <div class="original"> + <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.0-M4-SNAPSHOT plugin:download]]> + </source> + <i> + Note: you can set the version flag to the + specific version you want to install, + 2.0-M4-SNAPSHOT is just an example here. + </i> + </p> + </div> + <p> + $B:G=i$K!"$=$7$F$h$j?7$7$$%P!<%8%g%s$N(B Jetspeed 2 $B$K%"%C%W%0%l!<%I$7$?$/$J$C$?$H$-$O!"(BMaven $B%W%i%0%$%s$r0J2<$N$h$&$K$7$F%$%s%9%H!<%k$9$kI,MW$,$"$j$^$9!#(B + <source> + <![CDATA[ +maven -DartifactId=maven-jetspeed2-plugin -DgroupId=org.apache.portals.jetspeed-2 -Dversion=2.0-M4-SNAPSHOT plugin:download]]> + </source> + <i> + $BCm0U(B: $B%$%s%9%H!<%k$7$?$$%P!<%8%g%s$r;XDj$9$k$?$a$K%P!<%8%g%s%U%i%0$r @ _Dj$9$k$3$H$,=PMh$^$9!#$3$3$G$NNc$G$O(B 2.0-M4-SNAPSHOT $B$r;XDj$7$F$$$^$9!#(B + </i> + </p> + </subsection> + <subsection name="[4.3 Generate a new portal project] 4.3 $B?7$7$$%]!<%?%k%W%m%8%'%/%H$N @ 8@.(B"> + + <div class="original"> + <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> + </div> + <p> + Maven $B%W%i%0%$%s$r%$%s%9%H!<%k$7!"I,MW$J%W%m%Q%F%#$r @ _Dj$7$?$i!"0J2<$N$h$&$K$7$F%W%i%0%$%s$r;H$C$F%G%U%)%k%H$N%]!<%?%k @ _Dj$r @ 8@.$7$F$/$@$5$$!#(B + <source> + <![CDATA[ +maven j2:portal.genapp]]> + </source> + <i> + $B$3$N(B Maven $B$N%4!<%k$O<B:]$O(B + <a href="j2-maven-plugin.html"> + maven-plugin documentation + </a> + $B$K5-=R$5$l$k$h$&$J$$$/$D$+$N%5%V%4!<%k$r<B9T$7$^$9!#(B + </i> + </p> + </subsection> + <subsection + name="[4.4 Further customization of the portal] 4.4 $B%]!<%?%k$NDI2C$N%+%9%?%^%$%:(B"> + <div class="original"> + <p> + This section doesn't specify anything to do. After + the portal project is generated you can adapt and + customize it to your taste by overriding and merging + your own configurations and extensions. + </p> + </div> + <p> + $B$3$N%;%/%7%g%s$G$OFCJL2?$+$r9T$&$H$$$&;X<($O$"$j$^$;$s!#%]!<%?%k%W%m%8%'%/%H$, @ 8@.$5$l$?$i!"<+?H$N @ _Dj$d%(%/%9%F%s%7%g%s$r>e=q$-$7$?$j%^!<%8$7$?$j$7$F!"$"$J$?$,9%$_$K9g$o$;$F%+%9%?%^%$%:$r9T$C$F$/$@$5$$!#(B + </p> + <div class="original"> + <p> + You can regenerate or update (part of) your portal + project with the + <code>j2:portal.genapp</code> + goal as described in the previous section or use its + subgoals directly. + </p> + </div> + <p> + $BA0$N%;%/%7%g%s$G @ bL@$7$?$h$&$K(B + <code>j2:portal.genapp</code> + $B%4!<%k$r;H$&$+!"$3$N%4!<%kFb$G<B9T$5$l$k%5%V%4!<%k$rD>@\;H$&$J$j$7$F!"%]!<%?%k%W%m%8%'%/%H(B ($B$N0lIt(B) $B$r:F @ 8@.$7$?$j99?7$7$?$j$7$F$/$@$5$$!#(B + </p> + </subsection> + <subsection name="[4.5 Build the portal] 4.5 $B%]!<%?%k$N%S%k%I(B"> + <div class="original"> + <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> + </div> + <p> + $B%]!<%?%k$N @ _Dj$H%;%C%H%"%C%W$N=`Hw$,=PMh$?$i!"0J2<$N(BMaven $BI8=`$N%4!<%k$r%+%9%?%`%]!<%?%k%W%m%8%'%/%H$N%G%#%l%/%H%j(B (${org.apache.jetspeed.portal.home} $BFb(B) $B$G<B9T$9$k$3$H$K$h$j!"%m!<%+%k$N(B Maven $B%j%]%8%H%j(B ($BG[Hw$KI,MW$G$9(B) $B$G%]!<%?%k%"%W%j%1!<%7%g%s$r%S%k%I$7!"%$%s%9%H!<%k$9$k;v$,=PMh$^$9!#(B + </p> + <div class="original"> + <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> + </div> + <p> + $B$5$"!"$3$l$G?7$7$$%]!<%?%k%"%W%j%1!<%7%g%s$NG[Hw$N=`Hw$,=PMh$^$7$?!#?7$7$$%]!<%?%k%"%W%j%1!<%7%g%s$NG[Hw$r$9$k$K$O!"B3$/(B Jetspeed 2 $B$N%=!<%9$+$i$N%S%k%I$N%;%/%7%g%s$rHt$P$7!"(B + <a href="#6__Deploy_and_Run">deployment</a> + $B$rB3$$$FFI$s$G$/$@$5$$!#(B + </p> + </subsection> + </section> + <section name='[5. Build Jetspeed 2 from source] 5. $B%=!<%9$+$i$N(B Jetspeed 2 $B$N%S%k%I(B'> + <div class="original"> + <p> + Build the Jetspeed 2 portal directly from the source is + somewhat easier to do but should only be done if you + don't want to create a new, customizable portal. + </p> + </div> + <p> + $B%=!<%9$+$iD>@\(B Jetspeed 2 $B%]!<%?%k$r%S%k%I$9$k$N$O!"4vJ,4JC1$G$9!#$7$+$7!"$3$l$O$"$J$?$,?7$7$$%+%9%?%^%$%:$5$l$?%]!<%?%k$r:n$j$?$/$J$$>l9g$N$_$=$&$9$Y$-$G$9!#(B + </p> + <subsection + name="[5.1 Setup the Jetspeed 2 source and build properties]"> + <div class="original"> + <p> + The Jetspeed 2 source contains a + <code>project.properties</code> + file which provides all of the required portal + configuration settings as described + <a + href="#Required_Portal_Configuration_Properties"> + above + </a> + . + </p> + </div> + <p> + Jetspeed 2 $B$N%=!<%9$K$O(B + <code>project.properties</code> + $B%U%!%$%k$,4^$^$l$F$$$^$9!#$3$l$O!"(B + <a + href="#Required_Portal_Configuration_Properties"> + $BI,?\$N%]!<%?%k @ _Dj%W%m%Q%F%#(B + </a> + $B$K=R$Y$?$h$&$J%]!<%?%k$N @ _Dj$KI,?\$NA4$F$N%W%m%Q%F%#$,Ds6!$5$l$F$$$^$9!#(B + </p> + <div class="original"> + <p> + You should + <i> + <b>not</b> + </i> + define any of those properties in your + <code>${USER_HOME}/build.properties</code> + . + <br /> + Instead, you + <i>must</i> + set a + <code>org.apache.jetspeed.project.home</code> + property, specifying the location where you expanded + the downloaded source or checked out the source from + subversion, like: + <source> + <![CDATA[ +# required Jetspeed 2 portal configuration property for building from the source +org.apache.jetspeed.project.home = /home/apache/jetspeed-2/]]> + </source> + <i> + Note: you still need to specify the required + application server properties as described + <a + href="#Required_Application_Server_Properties"> + above + </a> + . + </i> + </p> + </div> + <p> + ãã$B*c(Bã® + <code>${USER_HOME}/build.properties</code> + $B%U%!%$%kCf$K$O$3$l$i$N%W%m%Q%F%#$r0l @ Z4^$s$G$O$$$1$^$;$s!#(B + <br /> + $BBe$o$j$K!"(B + <code>org.apache.jetspeed.project.home</code> + $B%W%m%Q%F%#$r @ _Dj$7$J$1$l$P$$$1$^$;$s!#$3$N%W%m%Q%F%#$O!"0J2<$N$h$&$K!"%@%&%s%m!<%I$7$?%=!<%9$,E83+$5$l$?$+!"(Bsubversion $B$+$i%=!<%9$r%A%'%C%/%"%&%H$7$?>l=j$rI=$7$^$9!#(B + <source> + <![CDATA[ +# required Jetspeed 2 portal configuration property for building from the source +org.apache.jetspeed.project.home = /home/apache/jetspeed-2/]]> + </source> + <i> + $BCm0U(B: + <a + href="#Required_Application_Server_Properties"> + $BI,?\$N%"%W%j%1!<%7%g%s%5!<%P$N%W%m%Q%F%#(B + </a> + $B$G=R$Y$?%W%m%Q%F%#$K$D$$$F$O!";XDj$9$kI,MW$,$"$j$^$9!#(B + </i> + </p> + <div class="original"> + <p> + The Jetspeed 2 project.properties uses this property + to define the required + <code>org.apache.portal.home</code> + : + <source> + <![CDATA[ +org.apache.jetspeed.portal.home = ${org.apache.jetspeed.project.home}]]> + </source> + So, they are the same when you build the Jetspeed 2 + portal from the source. + </p> + </div> + <p> + Jetspeed 2 $B$N(B project.properties $B%U%!%$%k$OI,?\$N(B + <code>org.apache.portal.home</code> + $B$rDj5A$9$k$?$a$K!"0J2<$N$h$&$J%W%m%Q%F%#$r;H$$$^$9!#(B + <source> + <![CDATA[ +org.apache.jetspeed.portal.home = ${org.apache.jetspeed.project.home}]]> + </source> + Jetspeed 2 $B%]!<%?%k$r%=!<%9$+$i%S%k%I$9$k>l9g$HF1$8$G$9!%(B + </p> + <div class="original"> + <p> + When you are going to deploy the portal as described + further below, you'll see references to the + <code>org.apache.jetspeed.portal.home</code> + which you can translate with the root folder of your + Jetspeed 2 source. + </p> + </div> + <p> + $B8e$K=R$Y$k$h$&$K%]!<%?%k$rG[Hw$7$?$$$H$-$O!"(B + <code>org.apache.jetspeed.portal.home</code> + $B$r;2>H$7$^$9!#$3$l$O$"$J$?$N(B Jetspeed 2 $B$N%=!<%9$N%k!<%H%U%)%k%@$HFI$_BX$($k$3$H$b$G$-$^$9!#(B + </p> + <div class="original"> + <p> + If you want to run the testcases when building the + Jetspeed 2 sources + <i>and</i> + don't want to use the default HSQLDB test database, + you need to override the default test database + properties, similar to the production database + properties as described + <a href="#Optional_Database_Server_Properties"> + above + </a> + : + <ul> + <li> + <code> + org.apache.jetspeed.test.database.default.name + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.url + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.user + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.password + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.driver + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.drivers.path + </code> + </li> + </ul> + <i> + Note: due to outstanding issue + <a + href="http://issues.apache.org/jira/browse/JS2-320"> + JS2-320 + </a> + you currently + <b>must</b> + use hard coded values for the test database + properties. + </i> + </p> + </div> + <p> + $B$b$7!"(BJetspeed 2 $B$N%=!<%9$r%S%k%I$7$F$$$F!"%G%U%)%k%H$N(B HSQL $B%F%9%H%G!<%?%Y!<%9$r;H$o$J$$;~$K%F%9%H%1!<%9$rAv$i$;$?$$>l9g$O!$(B + <a href="#Optional_Database_Server_Properties"> + $B%*%W%7%g%J%k$N%G!<%?%Y!<%9%5!<%P$N%W%m%Q%F%#(B + </a> + $B$G=R$Y$?%W%m%@%/%7%g%s%G!<%?%Y!<%9$N%W%m%Q%F%#$HF1$8$h$&$K!"%G%U%)%k%H$N%F%9%H$N%G!<%?%Y!<%9%W%m%Q%F%#$r=$@5$9$kI,MW$,$"$j$^$9!#(B + <ul> + <li> + <code> + org.apache.jetspeed.test.database.default.name + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.url + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.user + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.password + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.driver + </code> + </li> + <li> + <code> + org.apache.jetspeed.test.database.drivers.path + </code> + </li> + </ul> + <i> + $BCm0U(B: $BL$2r7h$N(B + <a + href="http://issues.apache.org/jira/browse/JS2-320"> + JS2-320 + </a> + $B$NLdBj$N$?$a!"8=;~E@$G$O%F%9%H%G!<%?%Y!<%9$N%W%m%Q%F%#$O%O!<%I%3!<%I$5$l$?CM$r(B<b>$B;H$o$J$1$l$P$$$1$^$;$s(B</b>$B!#(B + </i> + </p> + </subsection> + <subsection name="[Initialize the maven-plugin] Maven $B%W%i%0%$%s$N=i4|2=(B"> + <div class="original"> + <p> + Instead of downloading and installing the Jetspeed 2 + maven-plugin, you are going to build and install it + directly from the source. You will need to repeat + this every time you update to a newer version of + Jetspeed 2 or change its project configuration, the + plugin itself or the resources used by the plugin. + </p> + </div> + <p> + Jetspeed 2 $B$N(B Maven $B%W%i%0%$%s$r%@%&%s%m!<%I$7!"%$%s%9%H!<%k$9$kBe$o$j$K!"%=!<%9$+$iD>@\%S%k%I$7$F @ 8@.$7$^$9!#$3$N:n6H$O(B Jetspeed 2 $B$N?7$7$$%P!<%8%g%s$K99?7$7$?$H$-$d%W%m%8%'%/%H$N @ _Dj$rJQ$($?$H$-!"%W%i%0%$%s<+?H$rJQ$($?$H$-!"%W%i%0%$%s$,;H$&%j%=!<%9$rJQ$($?$H$-$KKh2s<B9T7+$jJV$9I,MW$,$"$j$^$9!#(B + </p> + <div class="original"> + <p> + Build and install the maven-plugin as follows from + the root directory of the Jetspeed-2 source: + <source> + <![CDATA[ +cd ${org.apache.jetspeed.project.home} +maven initMavenPlugin]]> + </source> + </p> + </div> + <p> + Jetspeed 2 $B%=!<%9$N%k!<%H%G%#%l%/%H%j$G0J2<$N$h$&$K$7$F(B Maven $B%W%i%0%$%s$N%S%k%I$H%$%s%9%H!<%k$r$7$^$9!#(B + <source> + <![CDATA[ +cd ${org.apache.jetspeed.project.home} +maven initMavenPlugin]]> + </source> + </p> + </subsection> + <subsection + name="[Optional: start the HSQLDB test database first] $B%*%W%7%g%J%k(B: HSQLDB $B%F%9%H%G!<%?%Y!<%9$N5/F0(B"> + <div class="original"> + <p> + If you are going to run the testcases and are using + the default HSQLDB database configuration, you will + need to start the test database before building + Jetspeed 2 in a + <i>separate</i> + console: + <source> + <![CDATA[ +cd ${org.apache.jetspeed.project.home} +maven j2:start.test.server]]> + </source> + </p> + </div> + <p> + $B%F%9%H%1!<%9$rAv$i$;!"%G%U%)%k%H$N(B HSQLDB $B%G!<%?%Y!<%9$N @ _Dj$r;H$&$N$J$i!"(BJetspeed 2 $B$r%S%k%I$9$kA0$K%F%9%H%G!<%?%Y!<%9$r(B<i>$BJL$N(B</i>$B%3%s%=!<%k$G3+;O$7$F$*$/I,MW$,$"$j$^$9!#(B + <source> + <![CDATA[ +cd ${org.apache.jetspeed.project.home} +maven j2:start.test.server]]> + </source> + </p> + <div class="original"> + <p> + After the build is finished you can stop the + database and close this console with a + <code>Ctrl-C</code> + . + </p> + </div> + <p> + $B%S%k%I$,=*$o$C$?8e$G!"(B + <code>Ctrl-C</code> + $B$r2!$7$F!"%G!<%?%Y!<%9$r$r;_$a!"%3%s%=!<%k$rJD$8$^$9!#(B + </p> + </subsection> + <subsection + name="[Build the Jetspeed 2 portal and demo portlet applications] Jetspeed 2 $B%]!<%?%k$H%G%b%]!<%H%l%C%H%"%W%j%1!<%7%g%s$N%S%k%I(B"> + <div class="original"> + <p> + For a full build and installation of the portal and + the demo portlet applications in your local maven + repository run: + <source> + <![CDATA[ +cd ${org.apache.jetspeed.project.home} +maven allClean allBuild]]> + </source> + </p> + </div> + <p> + $B%m!<%+%k$N(B Maven $B%j%]%8%H%j$K%]!<%?%k$H%G%b%]!<%H%l%C%H$rA4$F%S%k%I$7%$%s%9%H!<%k$9$k$K$O!"(B + <source> + <![CDATA[ +cd ${org.apache.jetspeed.project.home} +maven allClean allBuild]]> + </source> + $B$r<B9T$7$^$9!#(B + </p> + <div class="original"> + <p> + But, if you also want to run the testcases during + the build run the following instead: + <source> + <![CDATA[ +cd ${org.apache.jetspeed.project.home} +maven -Dmaven.test.skip=false allClean allBuild]]> + </source> + </p> + </div> + <p> + $B$7$+$7!"$b$7%S%k%I$N4V$K%F%9%H%1!<%9$r<B9T$7$?$$$N$J$i!"Be$o$j$K0J2<$N$h$&$J%3%^%s%I$r<B9T$7$^$9!#(B + <source> + <![CDATA[ +cd ${org.apache.jetspeed.project.home} +maven -Dmaven.test.skip=false allClean allBuild]]> + </source> + </p> + <div class="original"> + <p> + You are now ready to deploy the Jetspeed 2 Portal. + </p> + </div> + <p> + $B$5$"!"$3$l$G(B Jetspeed 2 $B%]!<%?%k$rG[Hw$9$k=`Hw$,=PMh$^$7$?!#(B + </p> + </subsection> + </section> + <section name="[6. Deploy and Run] $BG[Hw$H<B9T(B"> + <subsection + name="[Optional: start the HSQLDB production database first] $B%*%W%7%g%J%k(B: HSQLDB $B%W%m%@%/%7%g%s%G!<%?%Y!<%9$N3+;O(B"> + <div class="original"> + <p> + If you are using the default HSQLDB database you + need to start it before deploying the portal. + </p> + </div> + <p> + $B$b$7%G%U%)%k%H$N(B HSQLDB $B%G!<%?%Y!<%9$r;H$&$N$G$"$l$P!"%]!<%?%k$rG[Hw$9$kA0$K%G!<%?%Y!<%9$r3+;O$9$kI,MW$,$"$j$^$9!#(B + </p> + <div class="original"> + <p> + To start the HSQLDB production database run the + following in a + <i>separate</i> + console: + <source> + <![CDATA[ +cd ${org.apache.jetspeed.portal.home} +maven j2:start.production.server]]> + </source> + </p> + </div> + <p> + HSQLDB $B%W%m%@%/%7%g%s%G!<%?%Y!<%9$r<B9T$9$k$K$O!"0J2<$N$h$&$J%3%^%s%I$r(B<i>$BJL$N(B</i>$B%3%s%=!<%k$G<B9T$7$^$9!#(B + <source> + <![CDATA[ +cd ${org.apache.jetspeed.portal.home} +maven j2:start.production.server]]> + </source> + </p> + <div class="original"> + <p> + You need to have this database running during the + deployment and while running the application server. + Afterwards you can stop the database and close this + console with a + <code>Ctrl-C</code> + . + </p> + </div> + <p> + $BG[Hw$N4V$H%"%W%j%1!<%7%g%s%5!<%P$,<B9TCf$N4V$O%G!<%?%Y!<%9$r<B9T$7$?$^$^$K$7$F$*$/I,MW$,$"$j$^$9!#=*N;8e$O(B + <code>Ctrl-C</code> + $B$r2!$7$F%G!<%?%Y!<%9$rDd;_$7!"%3%s%=!<%k$rJD$8$^$9!#(B + </p> + <div class="original"> + <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> + </div> + <p> + $BCm0U(B: $B$3$l$O8e$G=R$Y$k(B + <code>j2:quickStart</code> + $B%4!<%k$r;H$&;~$KI,MW$G$9!#(BJetspeed 2 $B$N(B Maven $B%W%i%0%$%s$K$O%W%m%@%/%7%g%s%G!<%?%Y!<%9$N(B ($B:F(B) $B:n @ .$J$7$K!"$=$7$F(B/$B$^$?$O%G%U%)%k%H$N%]!<%?%k @ _Dj%G!<%?$rA^F~$9$k;v$J$/;H$($k!"B>$N(B ($B%5%V(B) $B%4!<%k$,$"$j$^$9!#MxMQ2DG=$J%4!<%k$N$5$i$J$k>pJs$O(B + <a href="j2-maven-plugin.html"> + Plugin documentation + </a> + $B$r8+$F$/$@$5$$!#(B + </p> + </subsection> + <subsection name="[Deploy] é å"> + <div class="original"> + <p> + We currently only cover deploying to Tomcat 5 or + Tomcat 5.5. + </p> + </div> + <p> + $B8=;~E@$G$O(B Tomcat 5 $B$+(B 5.5 $B$X$NG[Hw$N$_%+%P!<$7$F$$$^$9!#(B + </p> + <div class="original"> + <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> + </div> + <p> + $BB>$N%"%W%j%1!<%7%g%s%5!<%P$X$NG[Hw$K$D$$$F$N>pJs$O(B Jetspeed 2 + <a + href="http://wiki.apache.org/portals/Jetspeed2"> + Wiki + </a> + $B$G8+IU$+$k$G$7$g$&!#(B + </p> + <div class="original"> + <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 customize + the deployment to your taste. + </i> + </p> + </div> + <p> + $B$G$b%]!<%H%l%C%H%"%W%j%1!<%7%g%s$r4^$`!"%G%U%)%k%H$N(B Jetspeed 2 $B%]!<%?%k$rG[Hw$9$k$?$a$K!"0J2<$N$h$&$J%3%^%s%I$r(B<i>$BJL$N(B</i>$B%3%s%=!<%k$G<B9T$7$^$9!#(B + <source> + <![CDATA[ +cd ${org.apache.jetspeed.portal.home} +maven j2:quickStart]]> + </source> + <i> + $BCm0U(B: + <a href="j2-maven-plugin.html"> + maven-plugin documentation + </a> + $B$K$"$J$?9%$_$NG[Hw$K%+%9%?%^%$%:$9$k$N$K;H$($kB>$N%4!<%k$K4X$9$k5-=R$,$"$j$^$9!#(B + </i> + </p> + </subsection> + <subsection name="[Run] $B<B9T(B"> + <div class="original"> + <p> + The final step is starting up your Tomcat server and + the portal will automatically install any deployed + portlet applications. + </p> + </div> + <p> + $B:G=i$N%9%F%C%W$O(B Tomcat $B%5!<%P$r5/F0$9$k$3$H$G$9!#$9$k$H!"%]!<%?%k$O<+F0E*$KG[Hw$9$Y$-%]!<%H%l%C%H%"%W%j%1!<%7%g%s$r<+F0E*$K%$%s%9%H!<%k$9$k$G$7$g$&!#(B + </p> + <div class="original"> + <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 you own portal application ( + <code> + ${org.apache.jetspeed.portal.artifactId} + </code> + ). + </p> + </div> + <p> + $B$=$N8e$G!"%V%i%&%6$G%]!<%?%k$K0J2<$+(B + <source><a href="http://localhost:8080/jetspeed">http://localhost:8080/jetspeed</a></source> + $B$b$7$/$O!"$3$N(B URL $B$N(B "jetspeed" $B$r$"$J$?$N%]!<%?%k%"%W%j%1!<%7%g%s$NL>A0(B ( + <code> + ${org.apache.jetspeed.portal.artifactId} + </code> + ) $B$KCV$-49$($k;v$G!"%]!<%?%k$K%"%/%;%9=PMh$^$9!#(B + </p> + </subsection> + <subsection name="[Default installed user accounts] $B%G%U%)%k%H$G%$%s%9%H!<%k$5$l$F$$$k%f!<%6%"%+%&%s%H(B"> + <div class="original"> + <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> + </div> + <p> + $B%G%U%)%k%H$N(B Jetspeed 2 $B$N%]!<%?%k$NG[Hw$G$O!"$$$/$D$+$N%5%s%W%k%f!<%6$N%"%+%&%s%H$,%]!<%?%k%G!<%?%Y!<%9$KEPO?$5$l$F$$$^$9!#$=$l$r;H$C$F!"%]!<%?%k$X$N%m%0%*%s$,2DG=$G$9!#(B + <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> + </section> + </body> +</document>