Jetspeed Portlet Bridges

Delivered-To: mailing list jetspeed-dev@portals.apache.org Received: (qmail 83473 invoked by uid 99); 2 Dec 2008 08:55:37 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 02 Dec 2008 00:55:37 -0800 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 02 Dec 2008 08:54:06 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 560962388AC3; Tue, 2 Dec 2008 00:53:32 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r722405 [10/17] - in /portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade: ./ src/ src/site/ src/site/resources/ src/site/resources/css/ src/site/resources/images/ src/site/resources/images/layouts/ src/site/resources/images/portle... Date: Tue, 02 Dec 2008 08:53:28 -0000 To: jetspeed-dev@portals.apache.org From: woonsan@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20081202085332.560962388AC3@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-portlet-bridges.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-portlet-bridges.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-portlet-bridges.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-portlet-bridges.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,84 @@ + + + + + Jetspeed Portlet Bridges + Documentation for Apache Portals Portlet Bridges + + + + + +

+The Portals Bridges project provides a Portlet bridge for Struts which can be used with Jetspeed 2. +Please visit the Apache Portals Struts Portlet Bridge +sub project documentation. +

+The Bridges project also provides a great Struts Portlet demo application: +

The iBATIS JPetstore Demo Portlet application

+The Portals Bridges project provides a Portlet bridge for JSF which can be used with Jetspeed 2. +Please visit the Apache Portals JSF Portlet Bridge +sub project documentation. +

+Portals Bridges also provides a JSF portlet demo application based on MyFaces JSF implementation: +

The JSF Portlet Demo application using Apache Portals JSF Portlet Bridge

+ +

+The Portals Bridges project provides a Portlet bridge for Velocity which is used extensively within Jetspeed 2 itself. +Please visit the Apache Portals Velocity Portlet Bridge +sub project documentation. +

+An example of the Velocity Bridge usage within Jetspeed 2 is: +

The Jetspeed 2 Administration and Security application

+ +

+The Portals Bridges project provides a Portlet bridge for Perl applications. Please visit the Apache Portals Perl Portlet Bridge +sub project documentation. +

+ +

+The Portals Bridges project provides a Portlet bridge for PHP applications. Please visit the Apache Portals PHP Portlet Bridge +sub project documentation. +

+ + + + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-portlet-bridges.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-portlet-bridges.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiler.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiler.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiler.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiler.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,604 @@ + + + + + Profiler + Documentation for Jetspeed-2 Profiler + + + + + +

+The Jetspeed Profiler is a portal resource location rule-based engine. +The profiler locates the following kinds of portal resources: +

PSML pages
Folders
Menus
Links

+When a request is received by the portal, the profiler will compute a normalized instruction set, known +as a profile locator. The locator is then added to the request context, from which subsequent components on the +Jetspeed pipeline, most notably the Page Manager and Portal Site components, can take the profile locator +and use it to find a requested resource. For example, the Page Manager uses the locator to find a page or folder. +The Portal Site component uses the locator build the options on a menu. +

+The profile locator is the output from the profiler. The input is a normalized set of runtime parameters and state. +The profiler input is defined in profiling rules, and can be made of any Java class available on the pipeline. +Jetspeed comes with quite a few predefined rules for taking criteria from request parameters, HTTP headers, +security information, language and session attributes. The profiler is invoked during the Jetspeed request +processing pipeline in the profiler valve. + +

+All of these runtime parameters are called the profile criterion, which the profiler uses to locate +portal resources. +

+The Profiler searches over a directory tree of PSML pages trying to locate a +PSML page to be displayed. By default, this directory structure is found under WEB-INF/pages. +The pages directory can also be stored in the database. This directory structure, comprised of +portal resources (pages, folders, menus, links), is a physical representation of the portal site. +The Jetspeed team plans to also support logical views of the portal site in future releases. +

+Analogous to a file system, there is one physical root to the portal site. However, using the concept of subsites, +the Jetspeed site can support entire subsites that are not visible to other subsites, or the main site. +There are several reserved (system) directories standardized by the profiler: + + + + + + + + + + + + + + + + + + + + + +
Reserved Folder Description
_user holds all user-specific folders and pages
_role holds all role-organized folders and pages
_group holds all group-organized folders and pages
_subsite-root contains complete subsite trees, exactly like root tree
+ +

Reserved Folder	Description
_user	holds all user-specific folders and pages
_role	holds all role-organized folders and pages
_group	holds all group-organized folders and pages
_subsite-root	contains complete subsite trees, exactly like root tree

By applying profiling rules, the profiler locates pages in the portal site directory.

+ +A ProfilingRule defines a list of criteria used when evaluating a request +to determine the location of a specific resource. Profiling rules are +used by the profiler to locate portal resources +based on the decoupled criteria for known portlet request data. +A rule consists of an ordered list of criteria which should be applied +in a given order. Following this rule's order, the profiling engine applies +each criteria of the rule using a less-specific algorithm until the least +specific resource criterion is considered. When all criteria are exhausted, +the rule will fail and a fallback resource will be required. +

+ +

+A Rule Criterion specifies one criterion in a list of profiling rule criteria. +The rule is used to build a normalized profiling locator and then +locate a portal resource based on the current user request. +Rule Criteria are templates for locating profile properties. +Criteria consist of: + + + + + + + + + + + + + + + + + + + + +
Type The type of criterion. Types are configured in the profiler spring configuraiton. + Each type maps to a rule criterion resolver. A resolver is a Java class which maps request input + to a normalized location instruction. Valid resolvers are provided in the table below. +
Fallback Order The sequential in which to apply this criterion within the profiling rule.
Fallback Type After evaluation this criterion, the rule can either continue processing the remaining + criteria, or stop processing. The fallback type determines how to continue processing. + Valid values are: + + + + + + + + + + + + + +
FALLBACK_CONTINUE evaluate this criterion and if it fails continue to the next criterion
FALLBACK_STOP evaluate this criterion and if it fails stop evaluation criteria for this rule
FALLBACK_LOOP evaluate this criterion and if it fails continue evaluating
+
Name The unique name (per rule) of this criterion. Upon matches, the name is mapped to the profile locator property name.
Value The default value (not required) to use for this criterion when resolution fails.
+More complex implementations will need to use other inputs in mapping to resources such as Cookies, IP Address Ranges, Statistical Resource Usage Analysis, or Business Rules. +

+ + +

+The table below displays all default rule criterion resolvers available with Jetspeed out of the box. +Resolvers are Java classes, implementing the interface from the Jetspeed API org.apache.jetspeed.profiler.rules.RuleCriterionResolver. +You may use this default set of resolvers to build your own profiling rules. Rules are currently stored in the +Jetspeed database. Portal administrators may edit the rules using an administrative portlet. In the demo system, +login as the user "admin" to see an example of the Jetspeed Profiler Administration portlet. +

Additionally, you may add your own resolvers to Jetspeed. You will need to create a jar file + holding your custom resolvers, and then drop them into the Jetspeed webapp's class path. Resolvers + will need to be given a unique name. This is done by modifying the profiler.xml in the Spring assembly. + See the section below on configuration to see where to add a resolver to the Spring configuration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Resolver Description
request resolve by matching a request parameter by name, returning the request parameter value for a locator property taking the name of the criterion
session resolve by matching a session attribute by name, returning the session attribute value for a locator property taking the name of the criterion
request.session resolve by first matching a request parameter by name. If not matched, try matching a session attribute name, returning the request parameter or session attribute value for a locator property taking the name of the criterion
path resolve by matching the PSML page path value of the current request. The path is typically the path and name of a page, such as default-page for a locator property named path
path.session resolve by matching the PSML page path value of the current request. The path is typically the path and name of a page, such as default-page. If fails to find a valid path in the request, will then look in the session for the page value. The locator property will be named path
hard.coded resolve to a hard.coded default value, for example, set a locator property named page to /my-account.psml
user resolve by matching the name of the current authenticated user. The username is mapped to a locator property named user
role resolve by matching all of the security roles of the current authenticated user (in the JAAS Subject of the request context) and putting them in a comma-separated list. The locator property should be named role. The role criterion is often used in combination with path criteria, to create a role-fallback rule that searches over all security roles for a given user.
group resolve by matching all of the groups of the current authenticated user (in the JAAS Subject of the request context) and putting them in a comma-separated list. The locator property should be named group. The group criteion is often used in combination with path criteria, to create a group-fallback rule that searches over all security groups for a given user.
rolecombo resolve by matching all of the security roles of the current authenticated user (in the JAAS Subject of the request context) and putting them in a dash-separated string, for example: (role1-role2-role3). The locator property should be named role. The role criterion is often used in combination with path criteria, to create a role-fallback rule that searches over all security roles for a given user.
mediatype resolve by matching the media type (HTML,XHTML,WML...) from the request context. Sets a locator property named mediatype
language resolve by matching the browser's language from the request context locale (originating from the HTML headers). Sets a locator property named language
country resolve by matching the browser's country code from the request context locale (originating from the HTML headers). Sets a locator property named country
group.role.user resolve by first matching on a request parameter named group. If that fails, resolve on a request parameter named role. If that fails, resolve by matching the name of the current authenticated user. The username is mapped to a locator property named user
user.attribute resolve by matching a Portlet API User Attribute by name, returning the user attribute value for a locator property taking the name of the criterion
user.agent resolve by matching the browser's (client) user agent from the request context device capabilities (originating from the HTML headers)
hostname resolve by matching the host name from the server name in the request, returning the host name
domain resolve by matching the domain from the server name in the request, returning the domain
navigation A directive to changes the current navigation path during a profile location resolution performed by the page manager. The value can be the location of a folder, for example /pages/freecontent
+Note that all criteria will fall back to the default value when no match is made. Locator property expects a criterion named navigation +

Resolver	Description
request	resolve by matching a request parameter by name, returning the request parameter value for a locator property taking the name of the criterion
session	resolve by matching a session attribute by name, returning the session attribute value for a locator property taking the name of the criterion
request.session	resolve by first matching a request parameter by name. If not matched, try matching a session attribute name, returning the request parameter or session attribute value for a locator property taking the name of the criterion
path	resolve by matching the PSML page path value of the current request. The path is typically the path and name of a page, such as default-page for a locator property named path
path.session	resolve by matching the PSML page path value of the current request. The path is typically the path and name of a page, such as default-page. If fails to find a valid path in the request, will then look in the session for the page value. The locator property will be named path
hard.coded	resolve to a hard.coded default value, for example, set a locator property named page to /my-account.psml
user	resolve by matching the name of the current authenticated user. The username is mapped to a locator property named user
role	resolve by matching all of the security roles of the current authenticated user (in the JAAS Subject of the request context) and putting them in a comma-separated list. The locator property should be named role. The role criterion is often used in combination with path criteria, to create a role-fallback rule that searches over all security roles for a given user.
group	resolve by matching all of the groups of the current authenticated user (in the JAAS Subject of the request context) and putting them in a comma-separated list. The locator property should be named group. The group criteion is often used in combination with path criteria, to create a group-fallback rule that searches over all security groups for a given user.
rolecombo	resolve by matching all of the security roles of the current authenticated user (in the JAAS Subject of the request context) and putting them in a dash-separated string, for example: (role1-role2-role3). The locator property should be named role. The role criterion is often used in combination with path criteria, to create a role-fallback rule that searches over all security roles for a given user.
mediatype	resolve by matching the media type (HTML,XHTML,WML...) from the request context. Sets a locator property named mediatype
language	resolve by matching the browser's language from the request context locale (originating from the HTML headers). Sets a locator property named language
country	resolve by matching the browser's country code from the request context locale (originating from the HTML headers). Sets a locator property named country
group.role.user	resolve by first matching on a request parameter named group. If that fails, resolve on a request parameter named role. If that fails, resolve by matching the name of the current authenticated user. The username is mapped to a locator property named user
user.attribute	resolve by matching a Portlet API User Attribute by name, returning the user attribute value for a locator property taking the name of the criterion
user.agent	resolve by matching the browser's (client) user agent from the request context device capabilities (originating from the HTML headers)
hostname	resolve by matching the host name from the server name in the request, returning the host name
domain	resolve by matching the domain from the server name in the request, returning the domain
navigation	A directive to changes the current navigation path during a profile location resolution performed by the page manager. The value can be the location of a folder, for example /pages/freecontent

+ + +

+Several rules are provided by default with the Jetspeed system. +The rules in the table below display the criterion in a most-specific to least-specific ordering. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Rule

Description

Implements the Jetspeed-1 hard-coded profiler fallback algorithm, resolving in a most-specific to least-specific algorithm:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

criterion	name	value	fallback
country	country		continue
language	language		continue
mediatype	mediatype		continue
group.role.user	user\|group\|role		stop
path.session	page	default-page	stop

role-fallback

A role based fallback algorithm, trying to find the most-specific resource by searching over all security roles for the current authenticated user.

+ + + + + + + + + + + + + + + + + + + +

criterion	name	value	fallback
path.session	page	default-page	stop
role	role		continue

group-fallback

A group based fallback algorithm, trying to find the most-specific resource by searching over all security groups for the current authenticated user.

+ + + + + + + + + + + + + + + + + + + +

criterion	name	value	fallback
path.session	page	default-page	stop
group	group		continue

The default profiling rule for users and mediatype minus language and country.

+ + + + + + + + + + + + + + + + + + + + + + + + + +

criterion	name	value	fallback
mediatype	mediatype		continue
group.role.user	user\|group\|role		stop
path.session	page	default-page	stop

security

The security profiling rule needed to force credential change requirements.

+ + + + + + + + + + + + + +

criterion	name	value	fallback
hard.coded	page	/my-account.psml	stop

path

Only criterion applied is the path portion of the portal URL.

+ + + + + + + + + + + + + +

criterion	name	value	fallback
path	page	/	stop

user-role-fallback

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

criterion	name	value	fallback
path.session	page	default-page	continue
role	role		continue
navigation	navigation	/	loop
user	user		continue

user-rolecombo-fallback

Rule will first look for the resource in the user's home folder. If not found there, a role based fallback algorithm is applied, trying to find the most-specific resource by searching over all security roles for the current authenticated user. Creates a locater property named role that is the concatenation of all roles into one string, such as role1-role2-role3. This combined string is used as the role name in the locator.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

criterion	name	value	fallback
path.session	page	default-page	continue
rolecombo	role		continue
navigation	navigation	/	loop
user	user		continue

subsite-role-fallback-home

A rule based on role fallback algorithm with specified subsite and home page

+ + + + + + + + + + + + + + + + + + + + + + + + + +

criterion	name	value	fallback
path	path	subsite-default-page	stop
role	role		continue
navigation	navigation	subsite-root	loop

+ +

+Profile Locators are used to locate profiled portal resources such as +pages, folders, menus and links. A locator contains a collection of properties +(name value pairs) describing the actual resource to be located. +

+The profiler takes runtime information as input, generalized into +generalized profile locators that are passed on to the page manager to locate a page or menu. +The profile locators are normalized and not coupled to the profiler or page manager implementation. +

Each user principal can be mapped to specific profiling rule. This association is stored in the Jetspeed database. +The association is three-way, combining the PRINCIPAL + PROFILING RULE + LOCATOR, where the locator values +currently supported are menu or page. Thus we can have two different profiling rules +applied for locating resources per user: locate pages and locate menus. When the profiler attempts to locate a page +for the current user, it will apply the profiling rule for the given user. The Jetspeed User Administration portlet +has a tab for editing user profile information: +

+ +

+Often, profiling rules are determined and then associated by portal-specific logic during user registration (or self-registration). +A Jetspeed-specific self-registration portlet could handle the registration process of adding a user to the system, granting roles, +setting user attributes, and assigning the profiling rule for the user. +

+The profiler.xml Spring configuration file configures the profiler component. + + + + + + + + + + + + + + + + + +
Constructor Argument Description
(0) JETSPEED-INF/ojb/profiler_repository.xml Holds the OJB database to POJO mapper for marshalling profile information to and from the persistent store.
(1) j1 The default profiling rule. If a user does not have a profiling rule defined in the association table, this profiling rule is used.
(2) ProfileResolvers (ref bean) The map of profiler resolver names to implementing resolver classes. New resolvers should be added to the ProfileResolver table.
+

Constructor Argument	Description
(0) JETSPEED-INF/ojb/profiler_repository.xml	Holds the OJB database to POJO mapper for marshalling profile information to and from the persistent store.
(1) j1	The default profiling rule. If a user does not have a profiling rule defined in the association table, this profiling rule is used.
(2) ProfileResolvers (ref bean)	The map of profiler resolver names to implementing resolver classes. New resolvers should be added to the ProfileResolver table.

+ + + + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiler.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiler.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiling-ip.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiling-ip.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiling-ip.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiling-ip.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,79 @@ + + + + + Guide to Profiling IP Addresses + Documentation for Using the ip-address Profiler rule + + + + + +

+ Jetspeed has a built in mechanism to serve custom content + to a specific IP address. This feature uses the Profiler + to negociate pages based on the requesting clients IP address. +

+ +

+ The rule is identified by the key ip-address. There is one criterion + called ip resolved using the IP Criterion Resolver. This class implements + the resolve method of the Rule Criterion Resolver in order to obtain the IP address + from the request. +

+ + public String resolve(RequestContext context, RuleCriterion criterion) + { + // look for override + String value = super.resolve(context, criterion); + if (value != null) { return value.toLowerCase(); } + + // Note IP addresses can vary depending on the client + // Konqueror 3.4.2 returns IPv6 e.g. 0:0:0:0:0:0:0:1 + // Firefox 1.0.7 returns IPv4 e.g. 127.0.0.1 + // This is the value used to resolve pages in the _ip directory + // TODO create an option to convert all IPv4 addresses to IPv6 + return context.getRequest().getRemoteAddr(); + } + + + +

+ Users with this profile rule set to the page locator are served pages from the _ip + directory of the psml site tree. Example, if a request is made for + http://www.apache.org/jetspeed/portal/default-page.psml from 81.29.65.234 + then the rule will match /WEB-INF/pages/_ip/81.29.65.234/default-page.psml before + falling back to /WEB-INF/pages/default-page.psml +

+ + +

+ You have a location in Tokyo serving content specific to that + location. Your kiosk is configured with a fixed IP address. The annonymous + user (guest by default) uses this profile rule. Anyone using + the portal from that kiosk would be served content from the _ip directory. +

+ It could also be used to profile robots. Or keep out unwanted visitors. And can be the basis for + profiling IP ranges or IP prefixes, networks and subnetworks, and geographic locations. +

+ +

+ + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiling-ip.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-profiling-ip.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-properties.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-properties.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-properties.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-properties.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,411 @@ + + + + + Guide to configuration properties + Getting ready to build your own portal + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Property	Description	Default 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 +

+ + +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Property	Description	Default 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 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.derbydatabase.path` +	+ The folder where the maven-plugin will create its built-in Derby database(s). + + This folder and its contents is created or updated by plugin goal `j2:quickStart`. +	+ /tmp +
+ `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} +

+ + +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Property	Description	Default 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 +

+ + +

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

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Property	Description	Default 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): + + derby (derby) + hsql (hypersonic) + oracle (oracle) + mysql (mysql) + postgres (postresql) + mssql (mssql) + sapdb (sapdb) + db2 (db2) + +	derby
+ `org.apache.jetspeed.production.database.url` +	The jdbc connection url	jdbc:derby:${org.apache.jetspeed.derbydatabase.path}/productiondb;create=true
+ `org.apache.jetspeed.production.database.user` +	The database user name to connect with.	empty
+ `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 name	org.apache.derby.jdbc.EmbeddedDriver
+ `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 +

+ + +

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

+ +

+ + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-properties.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-properties.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-psml-dtd.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-psml-dtd.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-psml-dtd.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-psml-dtd.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,915 @@ + + + + + Guide to PSML DTDs and XML Schema + Guide to PSML DTDs and XML Schema + + + + + +

+The following PSML DTDs and XML Schema are included to further define the XML documents defined in these guides: +

+The DTDs and XML Schema included here are organized by PSML document: +

Page, (*.psml)
Folder Metadata, (folder.metadata)
Link, (*.link)
Page Security, (page.security)

+ +

Page documents, (*.psml), are described by the following DTD:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> +

Page documents, (*.psml), are described by the following XML Schema:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> +

+ +

Folder Metadata documents, (folder.metadata), are described by the following DTD:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> +

Folder Metadata documents, (folder.metadata), are described by the following XML Schema:

+ +

Link documents, (*.link), are described by the following DTD:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> +

Link documents, (*.link), are described by the following XML Schema:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> +

+ +

Page Security documents, (page.security), are described by the following DTD:

+ + + + + + + + + + + + + + + + + + + + + +]]> +

Page Security documents, (page.security), are described by the following XML Schema:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> +

+ + + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-psml-dtd.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-psml-dtd.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