[Basic Configuration Parameters] 基本的な設定パラメータ

[Required Portal Configuration Properties] 必須のポータル設定プロパティ

PropertyDescriptionDefault value
org.apache.jetspeed.portal.home The folder where the maven-plugin will (re)create or update your custom portal maven project configuration (with goal j2:portal.conf.project). This will be where you will be performing all of your future custom portal development.

Example: /home/myportal/
no default
org.apache.jetspeed.portal.groupId The (maven) short name of your portal project group.

This value is used for the maven repository folder in which the project artifacts (like the portal war file) is stored.

Example: myprojects
no default
org.apache.jetspeed.portal.artifactId The (maven) short name of your portal project.

This value is used for the portal war file and the (portal) web application context name.

Example: myportal
no default
org.apache.jetspeed.portal.name The (maven) full name of your portal project.

This value is used by maven for generating JavaDoc titles.

Example: My Test Portal
no default
org.apache.jetspeed.portal.currentVersion The current version of your portal project.

This value is used by maven as name postfix for the generated artifacts.

Example: 1.0
no default
プロパティ説明デフォルト値
org.apache.jetspeed.portal.home (j2:portal.conf.project ゴールで) Maven プラグインがあなたのカスタムポータル用 Maven プロジェクトを(再)構築したり更新したりするフォルダ。この場所はあなたがカスタムポータルの開発を今後全て行う場所になります。

例: /home/myportal/
デフォルト値なし
org.apache.jetspeed.portal.groupId あなたのポータルプロジェクトのグループの (Maven の) 短い名前。

この値は Maven リポジトリフォルダ内で (ポータル war ファイルのような) プロジェクトの成果物を保管しておく場所の名前として使われます。

例: myprojects
デフォルト値なし
org.apache.jetspeed.portal.artifactId あなたのポータルプロジェクトの (Maven での) 省略名。

この値はポータル war ファイルや (ポータル) ウェブアプリケーションのコンテキスト名に使われます。

例: myportal
デフォルト値なし
org.apache.jetspeed.portal.name あなたのポータルプロジェクトの (Maven での) フルネーム。

この値は JaveDoc のタイトルを生成するのに Maven が使います。

例: My Test Portal
デフォルト値なし
org.apache.jetspeed.portal.currentVersion あなたのポータルプロジェクトの現在のバージョン。

この値はプロジェクトの成果物の名前として最後に Maven に付け加えられます。

例:1.0
デフォルト値なし

[Optional Portal Configuration Properties] 省略可能なポータル設定プロパティ

The following properties all specify a subfolder of the ${org.apache.jetspeed.portal.home} location as defined above.

このあとに述べるプロパティは全て ${org.apache.jetspeed.portal.home} のサブフォルダを定義します。

PropertyDescriptionDefault value
org.apache.jetspeed.portal.conf.dir The folder where the maven-plugin will generate and copy application server specific configuration files as a tomcat application context descriptor.

This folder and its contents is created or updated by plugin goal j2:portal.conf.tomcat.
target/portal-conf
org.apache.jetspeed.portal.sql.dir The folder where the maven-plugin will generate and copy portal and database server specific sql DDL and DML scripts.

This folder and its contents is always (re)created by plugin goal j2:portal.conf.sql.
target/portal-sql
org.apache.jetspeed.portal.db.dir The folder where the maven-plugin will create its build-in HSQLDB database(s).

This folder and its contents is created or updated by plugin goal j2:start.production.server or j2:start.test.server.
target/portal-db
org.apache.jetspeed.portal.webapp.dir The folder where the maven-plugin will copy the standard jetspeed web application resources.

This folder and its contents is created or updated by plugin goal j2:portal.copy.webapp.
target/${org.apache.jetspeed.portal.artifactId}
org.apache.jetspeed.portal.target.dir The folder where the maven-plugin will generate and copy runtime portal configuration files.

These configuration files contain values derived from build/plugin properties for the portal and OJB.

This folder and its contents is created or updated by plugin goal j2:portal.conf.jetspeed and goal j2:portal.conf.ojb.
target/${org.apache.jetspeed.portal.artifactId}
プロパティ説明デフォルト値
org.apache.jetspeed.portal.conf.dir Maven プラグインが Tomcat のアプリケーションのコンテキスト記述子のようなアプリケーションサーバ固有の設定ファイルを生成しコピーするフォルダ。

このフォルダとフォルダ内のコンテンツは j2:portal.conf.tomcat プラグインゴールによって作成されたり更新されたりします。
target/portal-conf
org.apache.jetspeed.portal.sql.dir Maven プラグインがポータルやデータベースサーバの sql DDL と DML スクリプトを生成しコピーするフォルダ。

このフォルダとフォルダ内のコンテンツは常に j2:portal.conf.sql プラグインゴールによって (再) 生成されます。
target/portal-sql
org.apache.jetspeed.portal.db.dir Maven プラグインがビルドインの HSQLDB データベースを作成するフォルダ。

このフォルダとフォルダ内のコンテンツは j2:start.production.server もしくは j2:start.test.server プラグインゴールによって生成されたり更新されたりします。
target/portal-db
org.apache.jetspeed.portal.webapp.dir Maven プラグインが標準の Jetspeed のウェブアプリケーションのリソースをコピーするフォルダ。

このフォルダとフォルダ内のコンテンツは j2:portal.copy.webapp プラグインゴールによって生成されたり更新されたりします。
target/${org.apache.jetspeed.portal.artifactId}
org.apache.jetspeed.portal.target.dir Maven プラグインがランタイムのポータルの設定ファイルを生成したりコピーしたりするフォルダ。

これらの設定ファイルはポータルや OJB のビルド/プラグインプロパティから生成された値を含みます。

このフォルダとフォルダ内のコンテンツは j2:portal.conf.jetspeed もしくは j2:portal.conf.ojb プラグインゴールによって生成されたり更新されたりします。
target/${org.apache.jetspeed.portal.artifactId}

[Required Application Server Properties] 必須のアプリケーションサーバのプロパティ

Note: The maven-plugin currently only supports the Tomcat Server 5.0.x or 5.5.x

注意: Maven プラグインは現時点では Tomcat 5.0.x または 5.5.x のみをサポートします。

PropertyDescriptionDefault value
org.apache.jetspeed.server.home The root folder of your Tomcat server installation.

Example: ${CATALINA_HOME}/.
no default
org.apache.jetspeed.server.shared The location of the shared jars in your Tomcat installation.

Example: ${org.apache.jetspeed.server.home}/shared/lib/
no default
org.apache.jetspeed.deploy.war.dir The location of web applications in your Tomcat installation.

Example: ${org.apache.jetspeed.server.home}/webapps/
no default
org.apache.jetspeed.services.autodeployment.user A Tomcat user with the manager role.

Used to access the Tomcat Manager application from within the portal, explained below.
no default
org.apache.jetspeed.services.autodeployment.password The password of the Tomcat user above.

Used to access the Tomcat Manager application from within the portal, explained below.
no default
org.apache.jetspeed.catalina.version.major The major version of the Tomcat server you are using: 5 or 5.5

Example: 5.5
no default
プロパティ説明デフォルト値
org.apache.jetspeed.server.home Tomcat をインストールしたルートフォルダ。

例: ${CATALINA_HOME}/
デフォルト値なし
org.apache.jetspeed.server.shared インストールした Tomcat の共有の jar の置場。

例: ${org.apache.jetspeed.server.home}/shared/lib/
デフォルト値なし
org.apache.jetspeed.deploy.war.dir インストールした Tomcat のウェブアプリケーションの場所。

例: ${org.apache.jetspeed.server.home}/webapps/
デフォルト値なし
org.apache.jetspeed.services.autodeployment.user manager ロールに属する Tomcat のユーザ。

後で説明するように、ポータル内から Tomcat Manager アプリケーションへアクセスするのに使います。
デフォルト値なし
org.apache.jetspeed.services.autodeployment.password 前述の Tomcat ユーザのパスワード。

後で説明するように、ポータル内から Tomcat Manager アプリケーションへアクセスするのに使います。
デフォルト値
org.apache.jetspeed.catalina.version.major 使用する Tomcat のメジャーバージョン。5 もしくは 5.5 が使えます。

例: 5.5
デフォルト値なし

[Optional Database Server Properties] 省略可能なデータベースサーバのプロパティ

Jetspeed-2 and its maven-plugin uses, as well as provides, by default a HSQLDB database.

Jetspeed 2 と Jetspeed 2 の Maven プラグインはデフォルトでは提供される HSQLDB のデータベースを使用します。

If you want to use a different database you will need to override the following properties:

もし異なるデータベースを使用するのであれば、以下のプロパティを上書きする必要があります。

PropertyDescriptionDefault value
org.apache.jetspeed.production.database.default.name The type of database you are using. Used for sql script generation with Torque.

Currently supported databases (with corresponding Torque target database name):
  • hsql (hypersonic)
  • oracle (oracle)
  • mysql (mysql)
  • postgres (postresql)
  • mssql (mssql)
hsql
org.apache.jetspeed.production.database.url The jdbc connection urljdbc:hsqldb:hsql://127.0.0.1:9001
org.apache.jetspeed.production.database.user The database user name to connect with.sa
org.apache.jetspeed.production.database.password The database user its password to connect with. empty
org.apache.jetspeed.production.database.driver The jdbc driver class nameorg.hsqldb.jdbcDriver
org.apache.jetspeed.production.jdbc.drivers.path A Java classpath style path to the jdbc driver classes or jar(s) needed for connecting to the database.

Example: /lib/ojdbc14.jar;/lib/nls_charset12.jar
empty
プロパティ説明デフォルト値
org.apache.jetspeed.production.database.default.name あなたが使用するデータベースの種類。Torque が生成する SQL スクリプトのために使用します。

現時点でサポートするデータベースは以下の通りです。(Torque の対象のデータベース名も示します)
  • hsql (hypersonic)
  • oracle (oracle)
  • mysql (mysql)
  • postgres (postresql)
  • mssql (mssql)
hsql
org.apache.jetspeed.production.database.url JDBC の接続 urljdbc:hsqldb:hsql://127.0.0.1:9001
org.apache.jetspeed.production.database.user データベースに接続するためのユーザ名。sa
org.apache.jetspeed.production.database.password データベースに接続するためのユーザのパスワード。
org.apache.jetspeed.production.database.driver JDBC ドライバのクラス名org.hsqldb.jdbcDriver
org.apache.jetspeed.production.jdbc.drivers.path データベース接続に必要な JDBC ドライバクラスや jar への Java クラスパス形式のパス。

例: /lib/ojdbc14.jar;/lib/nls_charset12.jar

[Example: A minimal custom portal configuration] 例: 最小限のカスタムポータルの設定

Make sure you have define at least the required properties as described above in your ${USER_HOME}/build.properties. A minimal custom portal configuration using the default HSQLDB database can be something like:

            
# 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
          
Note: If you're going to build the default Jetspeed 2 portal directly from the source only the org.apache.jetspeed.portal.home property is required from the set of required portal configuration properties.

少なくとも前述の必須のプロパティは ${USER_HOME}/build.properties で定義してあることを確認してください。HSQLDB を使った最低限のカスタムポータルの設定は以下のようになります。

			
# 必須のポータルの設定プロパティ
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

# 必須のアプリケーションサーバのプロパティ
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
		
注意: もしデフォルトの Jetspeed 2 ポータルをソースから直接ビルドするのであれば、必須のポータルの設定プロパティのうち、 org.apache.jetspeed.portal.home だけが必要になります。