Jetspeed-2 Capabilities

- - Jetspeed-2 Capabilities - - - - - -

- Jetspeed-2 capabilities provides a mechanism for mapping the client used to access Jetspeed-2 to media types - for page rendering. -

- -

- The Jetspeed-2 capability engine maps clients to media types to mime types. Here are some more detailed - definitions: -

Clients: The application that initiates a request to the Jetspeed-2 portal engine. Jetspeed-2 uses - the User-Agent to determine the client that initiates a request.
Media Type: The type of media requesting the content (HTML, WML, etc.). Content in Jetspeed-2 - can be requested by different type of devices through different media.
Mime Type: The type of content being requested.

- Jetspeed-2 works with the following media types: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Name Character Set Description
html UTF-8 Rich HTML for HTML 4.0 compliants browsers
wml UTF-8 Format for mobile phones and PDAs compatible with WML 1.1
vxml UTF-8 Format suitable for use with an audio VoiceXML server
xml XML 1.0
xhtml-basic UTF-8 XHTML Basic used in WAP devices
-

Name	Character Set	Description
html	UTF-8	Rich HTML for HTML 4.0 compliants browsers
wml	UTF-8	Format for mobile phones and PDAs compatible with WML 1.1
vxml	UTF-8	Format suitable for use with an audio VoiceXML server
xml		XML 1.0
xhtml-basic	UTF-8	XHTML Basic used in WAP devices

- Jetspeed-2 is configured to recognize the following clients: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Client User Agent Pattern Manufacturer Preferred Mime Type
ie5 .*MSIE 5.* Microsoft html
ie6 .*MSIE 6.* Microsoft html
ns4 .*Mozilla/4.* Netscape html
mozilla .*Mozilla/5.* Mozilla html
lynx Lynx.* GNU html
opera7 .*Opera/7.* Opera html
ie5mac .*MSIE 5.*Mac.* Microsoft html
safari .*Mac.*Safari.* Apple html
xhtml-basic DoCoMo/2.0.*|KDDI-.*UP\.Browser.*|J-PHONE/5.0.*|Vodafone/1.0/.* N/A xhtml
agentxml agentxml/1.0.* N/A xml
nokia_generic Nokia.* Nokia wml
up UP.*|.*UP\.Browser.* United Planet wml
sonyericsson Ercis.*|SonyE.* SonyEricsson wml
wapalizer Wapalizer.* Wapalizer wml
klondike Klondike.* Klondike wml
wml_generic .*WML.*|.*WAP.*|.*Wap.*|.*wml.* N/A wml
vxml_generic .*VoiceXML.* N/A vxml
nuance Nuance.* Nuance vxml
-

Client	User Agent Pattern	Manufacturer	Preferred Mime Type
ie5	.MSIE 5.	Microsoft	html
ie6	.MSIE 6.	Microsoft	html
ns4	.Mozilla/4.	Netscape	html
mozilla	.Mozilla/5.	Mozilla	html
lynx	Lynx.*	GNU	html
opera7	.Opera/7.	Opera	html
ie5mac	.MSIE 5.Mac.*	Microsoft	html
safari	.Mac.Safari.*	Apple	html
xhtml-basic	DoCoMo/2.0.\|KDDI-.UP\.Browser.\|J-PHONE/5.0.\|Vodafone/1.0/.*	N/A	xhtml
agentxml	agentxml/1.0.*	N/A	xml
nokia_generic	Nokia.*	Nokia	wml
up	UP.\|.UP\.Browser.*	United Planet	wml
sonyericsson	Ercis.\|SonyE.	SonyEricsson	wml
wapalizer	Wapalizer.*	Wapalizer	wml
klondike	Klondike.*	Klondike	wml
wml_generic	.WML.\|.WAP.\|.Wap.\|.wml.	N/A	wml
vxml_generic	.VoiceXML.	N/A	vxml
nuance	Nuance.*	Nuance	vxml

- - -

- The media-type is used to locate the appropriate decorations template for the given media-type. - See the portal design guide for more information. -

- - -

- The Capabilities component derive a CapabilityMap from the information provided - by the User-Agent request header: - -cm = capabilities.getCapabilityMap(agent); - -

- This operation occurs at the very beginning of Jetspeed-2 request pipeline processing. Once the - CapabilityMap is retrieved, it is added to the Jetspeed-2 org.apache.jetspeed.request.RequestContext - and made available to the portal engine for processing the request. -

- The two pictures below describes the Capabilities interfaces and the relational database model - backing the implementation.

-

- -

- -

- + 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. +--> + + + Jetspeed-2 Capabilities + + + + + +

+ Jetspeed-2 capabilities provides a mechanism for mapping the client used to access Jetspeed-2 to media types + for page rendering. +

+ +

+ The Jetspeed-2 capability engine maps clients to media types to mime types. Here are some more detailed + definitions: +

Clients: The application that initiates a request to the Jetspeed-2 portal engine. Jetspeed-2 uses + the User-Agent to determine the client that initiates a request.
Media Type: The type of media requesting the content (HTML, WML, etc.). Content in Jetspeed-2 + can be requested by different type of devices through different media.
Mime Type: The type of content being requested.

+ Jetspeed-2 works with the following media types: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name Character Set Description
html UTF-8 Rich HTML for HTML 4.0 compliants browsers
wml UTF-8 Format for mobile phones and PDAs compatible with WML 1.1
vxml UTF-8 Format suitable for use with an audio VoiceXML server
xml XML 1.0
xhtml-basic UTF-8 XHTML Basic used in WAP devices
+

Name	Character Set	Description
html	UTF-8	Rich HTML for HTML 4.0 compliants browsers
wml	UTF-8	Format for mobile phones and PDAs compatible with WML 1.1
vxml	UTF-8	Format suitable for use with an audio VoiceXML server
xml		XML 1.0
xhtml-basic	UTF-8	XHTML Basic used in WAP devices

+ Jetspeed-2 is configured to recognize the following clients: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Client User Agent Pattern Manufacturer Preferred Mime Type
ie5 .*MSIE 5.* Microsoft html
ie6 .*MSIE 6.* Microsoft html
ns4 .*Mozilla/4.* Netscape html
mozilla .*Mozilla/5.* Mozilla html
lynx Lynx.* GNU html
opera7 .*Opera/7.* Opera html
ie5mac .*MSIE 5.*Mac.* Microsoft html
safari .*Mac.*Safari.* Apple html
xhtml-basic DoCoMo/2.0.*|KDDI-.*UP\.Browser.*|J-PHONE/5.0.*|Vodafone/1.0/.* N/A xhtml
agentxml agentxml/1.0.* N/A xml
nokia_generic Nokia.* Nokia wml
up UP.*|.*UP\.Browser.* United Planet wml
sonyericsson Ercis.*|SonyE.* SonyEricsson wml
wapalizer Wapalizer.* Wapalizer wml
klondike Klondike.* Klondike wml
wml_generic .*WML.*|.*WAP.*|.*Wap.*|.*wml.* N/A wml
vxml_generic .*VoiceXML.* N/A vxml
nuance Nuance.* Nuance vxml
+

Client	User Agent Pattern	Manufacturer	Preferred Mime Type
ie5	.MSIE 5.	Microsoft	html
ie6	.MSIE 6.	Microsoft	html
ns4	.Mozilla/4.	Netscape	html
mozilla	.Mozilla/5.	Mozilla	html
lynx	Lynx.*	GNU	html
opera7	.Opera/7.	Opera	html
ie5mac	.MSIE 5.Mac.*	Microsoft	html
safari	.Mac.Safari.*	Apple	html
xhtml-basic	DoCoMo/2.0.\|KDDI-.UP\.Browser.\|J-PHONE/5.0.\|Vodafone/1.0/.*	N/A	xhtml
agentxml	agentxml/1.0.*	N/A	xml
nokia_generic	Nokia.*	Nokia	wml
up	UP.\|.UP\.Browser.*	United Planet	wml
sonyericsson	Ercis.\|SonyE.	SonyEricsson	wml
wapalizer	Wapalizer.*	Wapalizer	wml
klondike	Klondike.*	Klondike	wml
wml_generic	.WML.\|.WAP.\|.Wap.\|.wml.	N/A	wml
vxml_generic	.VoiceXML.	N/A	vxml
nuance	Nuance.*	Nuance	vxml

+ + +

+ The media-type is used to locate the appropriate decorations template for the given media-type. + See the portal design guide for more information. +

+ + +

+ The Capabilities component derive a CapabilityMap from the information provided + by the User-Agent request header: + +cm = capabilities.getCapabilityMap(agent); + +

+ This operation occurs at the very beginning of Jetspeed-2 request pipeline processing. Once the + CapabilityMap is retrieved, it is added to the Jetspeed-2 org.apache.jetspeed.request.RequestContext + and made available to the portal engine for processing the request. +

+ The two pictures below describes the Capabilities interfaces and the relational database model + backing the implementation.

+

+ +

+ +

+ \ No newline at end of file Propchange: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-capability/index.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-cm/index.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-cm/index.xml?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-cm/index.xml (original) +++ portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-cm/index.xml Fri Dec 12 04:06:29 2008 @@ -1,46 +1,46 @@ - - - - - Jetspeed-2 Component Manager - - - - - -

- The ComponentManager provides a layer of abstraction on top of the component framework that - will be used by Jetspeed-2. This provides a flexible architecture where the component framework used can - easily be "swapped". By default Jetspeed-2 uses the spring - framework. -

- -

- The ComponentManager delegates the initialization of the component framework engine - to an implementation specific to the component framework as illustrated below. The SpringComponentManager - is responsible for initializing the spring engine and calls to spring components within the Jetspeed-2 engines are wrapped - behind generic methods such as getComponent(). -

-

-

- -

+ The ComponentManager provides a layer of abstraction on top of the component framework that + will be used by Jetspeed-2. This provides a flexible architecture where the component framework used can + easily be "swapped". By default Jetspeed-2 uses the spring + framework. +

+ +

+ The ComponentManager delegates the initialization of the component framework engine + to an implementation specific to the component framework as illustrated below. The SpringComponentManager + is responsible for initializing the spring engine and calls to spring components within the Jetspeed-2 engines are wrapped + behind generic methods such as getComponent(). +

+

+

+ +

+ \ No newline at end of file Propchange: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-cm/index.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/deploy-tools.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/deploy-tools.xml?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/deploy-tools.xml (original) +++ portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/deploy-tools.xml Fri Dec 12 04:06:29 2008 @@ -1,89 +1,89 @@ - - - - - Jetspeed-2 Deploy Tools - - - - - -

- -

- JetspeedDeploy prepares portlet applications for deployment within Jetspeed-2. When a new - portlet deployment event is registered, the DeployPortletAppEventListener invokes JetspeedDeploy - to prepare the portlet application for deployment. - - new JetspeedDeploy(event.getPath(), toFile.getAbsolutePath(), stripLoggers); - -

- JetspeedDeploy copies the web application archives (.war) from the input directory to the - output directory and parses the web.xml, portlet.xml, and context.xml - to ensure their compliance with the Jetspeed-2 portal engine. -

-

-

- JetspeedDeploy invokes the JetspeedWebApplicationRewriter to infuse the web.xml - with the JetspeedContainer servlet if it does not already exist: - - <servlet> - <servlet-name>JetspeedContainer</servlet-name> - <display-name>Jetspeed Container</display-name> - <description>MVC Servlet for Jetspeed Portlet Applications</description> - <servlet-class>org.apache.jetspeed.container.JetspeedContainerServlet</servlet-class> - <init-param> - <param-name>contextName</param-name> - <param-value>${portlet-application-name}</param-value> - </init-param> - <load-on-startup>0</load-on-startup> - </servlet> - ... - <servlet-mapping> - <servlet-name>JetspeedContainer</servlet-name> - <url-pattern>/container/*</url-pattern> - </servlet-mapping> - -

- In the same fashion, the JetspeedDeploy invokes the JetspeedContextRewriter to manipulate - a portlet application context.xml file. For more information about Tomcat context.xml, - see tomcat's documentation. -

- - -

- JetspeedDeploy can also be invoke through the command line: - - java -jar jetspeed-deploy-tools-<version>.jar -s inputWarPath outputWarPath - - where: -

-s: flag indicating whether or not to strip to loggers from the application. When the flag is present, the - loggers available in the application will be removed.
inputWarPath: the path of the war to process.
outputWarPath: the path of the processed war.

- -

+ +

+ JetspeedDeploy prepares portlet applications for deployment within Jetspeed-2. When a new + portlet deployment event is registered, the DeployPortletAppEventListener invokes JetspeedDeploy + to prepare the portlet application for deployment. + + new JetspeedDeploy(event.getPath(), toFile.getAbsolutePath(), stripLoggers); + +

+ JetspeedDeploy copies the web application archives (.war) from the input directory to the + output directory and parses the web.xml, portlet.xml, and context.xml + to ensure their compliance with the Jetspeed-2 portal engine. +

+

+

+ JetspeedDeploy invokes the JetspeedWebApplicationRewriter to infuse the web.xml + with the JetspeedContainer servlet if it does not already exist: + + <servlet> + <servlet-name>JetspeedContainer</servlet-name> + <display-name>Jetspeed Container</display-name> + <description>MVC Servlet for Jetspeed Portlet Applications</description> + <servlet-class>org.apache.jetspeed.container.JetspeedContainerServlet</servlet-class> + <init-param> + <param-name>contextName</param-name> + <param-value>${portlet-application-name}</param-value> + </init-param> + <load-on-startup>0</load-on-startup> + </servlet> + ... + <servlet-mapping> + <servlet-name>JetspeedContainer</servlet-name> + <url-pattern>/container/*</url-pattern> + </servlet-mapping> + +

+ In the same fashion, the JetspeedDeploy invokes the JetspeedContextRewriter to manipulate + a portlet application context.xml file. For more information about Tomcat context.xml, + see tomcat's documentation. +

+ + +

+ JetspeedDeploy can also be invoke through the command line: + + java -jar jetspeed-deploy-tools-<version>.jar -s inputWarPath outputWarPath + + where: +

-s: flag indicating whether or not to strip to loggers from the application. When the flag is present, the + loggers available in the application will be removed.
inputWarPath: the path of the war to process.
outputWarPath: the path of the processed war.

+ +

+ \ No newline at end of file Propchange: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/deploy-tools.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/index.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/index.xml?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/index.xml (original) +++ portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/index.xml Fri Dec 12 04:06:29 2008 @@ -1,86 +1,86 @@ - - - - - Jetspeed-2 Deploy Tools - - - - - -

- -

- Deploying custom portlets in Jetspeed-2 is simple. Portlets are very similar to servlets. - They require a deployment descriptor, portlet.xml which goes in WEB-INF - and need to be packaged in a war-like format. You can find quite a few example portlet.xml files within the Jetspeed-2 source tree. - For starters take a look at the one under /portal/src/webapp/WEB-INF. In order to deploy a portlet, Jetspeed-2 requires the user - to follow those steps: -

Build you portlet as a portlet application just as you would a web application.
Package your portlet application into a .war file.
Copy the .war file to Jetspeed's deployment directory, by default this is WEB-INF/deploy. - Jetspeed will take care of automatically deplying the portlet into the portlet registry and will also deploy the portlet - as a web application into the app server Jetspeed is deployed to.
The easiest way to view your portlet is to add an entry to the default-page.psml under jetspeed/WEB-INF/pages. - The id for the portlet fragment uses a unique combination of ${portlet.application.id}::${portlet.name} - where ${portlet.application.id} is the actual name of the war file (minus the ".war") that contains your portlet app and - ${portlet.name} needs to be the value in the portlet name tags, <portlet-name>MyPortlet</portlet-name>. - Changes to the psml will be picked up automatically and you should now be able to view your portlet! -

- - -

- The component hierarchy below describes the assembly dependencies supporting Jetspeed-2 deployment functionality. -

-

-

- The DeploymentManager is configured with the properties specified in - WEB-INF/conf/jetspeed.properties: -

autodeployment.staging.dir: The directory scanned for autodeployment.
autodeployment.delay: The frequency of the deploy directory scanning.

- The DeploymentManager is also configured with 2 types of DeploymentEventListener: -

-

-

The DeployPortletAppEventListener handles the hot deployment of portlet applications.
The DeployDecoratorEventListener: handles the hot deployment of decorators. See - guide to decorators for more information.

- Jetspeed-2 provides a StandardDeploymentManager. The StandardDeploymentManager leverages - a FileSystemScanner to scan for new assets to deploy. It leverages Jetspeed-2 - deploy tools to prepare portlet applications prior to deployment. -

-

-

- -

+ +

+ Deploying custom portlets in Jetspeed-2 is simple. Portlets are very similar to servlets. + They require a deployment descriptor, portlet.xml which goes in WEB-INF + and need to be packaged in a war-like format. You can find quite a few example portlet.xml files within the Jetspeed-2 source tree. + For starters take a look at the one under /portal/src/webapp/WEB-INF. In order to deploy a portlet, Jetspeed-2 requires the user + to follow those steps: +

Build you portlet as a portlet application just as you would a web application.
Package your portlet application into a .war file.
Copy the .war file to Jetspeed's deployment directory, by default this is WEB-INF/deploy. + Jetspeed will take care of automatically deplying the portlet into the portlet registry and will also deploy the portlet + as a web application into the app server Jetspeed is deployed to.
The easiest way to view your portlet is to add an entry to the default-page.psml under jetspeed/WEB-INF/pages. + The id for the portlet fragment uses a unique combination of ${portlet.application.id}::${portlet.name} + where ${portlet.application.id} is the actual name of the war file (minus the ".war") that contains your portlet app and + ${portlet.name} needs to be the value in the portlet name tags, <portlet-name>MyPortlet</portlet-name>. + Changes to the psml will be picked up automatically and you should now be able to view your portlet! +

+ + +

+ The component hierarchy below describes the assembly dependencies supporting Jetspeed-2 deployment functionality. +

+

+

+ The DeploymentManager is configured with the properties specified in + WEB-INF/conf/jetspeed.properties: +

autodeployment.staging.dir: The directory scanned for autodeployment.
autodeployment.delay: The frequency of the deploy directory scanning.

+ The DeploymentManager is also configured with 2 types of DeploymentEventListener: +

+

+

The DeployPortletAppEventListener handles the hot deployment of portlet applications.
The DeployDecoratorEventListener: handles the hot deployment of decorators. See + guide to decorators for more information.

+ Jetspeed-2 provides a StandardDeploymentManager. The StandardDeploymentManager leverages + a FileSystemScanner to scan for new assets to deploy. It leverages Jetspeed-2 + deploy tools to prepare portlet applications prior to deployment. +

+

+

+ +

+ \ No newline at end of file Propchange: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-deploy-tools/index.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/index.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/index.xml?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/index.xml (original) +++ portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/index.xml Fri Dec 12 04:06:29 2008 @@ -1,38 +1,38 @@ - - - - - Jetspeed-2 Portal - - - - - -

- The core portal components are: -

The portal engine
The request pipeline
The aggregation engine
The portlet container engine integration

- - + 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. +--> + + + Jetspeed-2 Portal + + + + + +

+ The core portal components are: +

The portal engine
The request pipeline
The aggregation engine
The portlet container engine integration

+ + Propchange: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/index.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/pipeline.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/pipeline.xml?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/pipeline.xml (original) +++ portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/pipeline.xml Fri Dec 12 04:06:29 2008 @@ -1,88 +1,88 @@ - - - - - Jetspeed-2 Portal - - - - - -

- In Jetspeed-2, a request pipeline performs individual operations to the request. -

- -

- A Pipeline is made of Valves chained together in a chain of responsibility pattern. - The JetspeedPipeline implementation assembles a ordered list of Valves that are - processed sequentially. -

-

- -

- - -

- Jetspeed-2 provides various type of Valve as illustrated below:

-
- The above valves serve the following purpose: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Valve Name Description
ActionValve Check if PortletAction needs to be processed and process it, if required. - Used in the portlet pipeline.
AggregateValve Invokes all Layout components in render mode to aggregate the generated contents and - send the result to the client.
CapabilityValve Identifies the browser and adds a CapabilityMap to the RequestContext.
CleanupValve Looks for JSP pages that were pushed onto the org.apache.jetspeed.renderStack - request attribute, and attempts to include them.
LoginValidationValve Checks if a login attempt failed and determines the cause.
PasswordCredentialValve Checks the PasswordCredential (only once) after a User is logged in and redirects to a - change password page if necessary.
SecurityValve Authenticates the user or redirects to Login if necessary, adds the - authenticated Subject to the RequestContext.
-

- -

Valve Name	Description
ActionValve	Check if `PortletAction` needs to be processed and process it, if required. - Used in the portlet pipeline.
AggregateValve	Invokes all Layout components in render mode to aggregate the generated contents and - send the result to the client.
CapabilityValve	Identifies the browser and adds a `CapabilityMap` to the `RequestContext`.
CleanupValve	Looks for JSP pages that were pushed onto the `org.apache.jetspeed.renderStack` - request attribute, and attempts to include them.
LoginValidationValve	Checks if a login attempt failed and determines the cause.
PasswordCredentialValve	Checks the PasswordCredential (only once) after a User is logged in and redirects to a - change password page if necessary.
SecurityValve	Authenticates the user or redirects to Login if necessary, adds the - authenticated Subject to the `RequestContext`.

+ In Jetspeed-2, a request pipeline performs individual operations to the request. +

+ +

+ A Pipeline is made of Valves chained together in a chain of responsibility pattern. + The JetspeedPipeline implementation assembles a ordered list of Valves that are + processed sequentially. +

+

+ +

+ + +

+ Jetspeed-2 provides various type of Valve as illustrated below:

+
+ The above valves serve the following purpose: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Valve Name Description
ActionValve Check if PortletAction needs to be processed and process it, if required. + Used in the portlet pipeline.
AggregateValve Invokes all Layout components in render mode to aggregate the generated contents and + send the result to the client.
CapabilityValve Identifies the browser and adds a CapabilityMap to the RequestContext.
CleanupValve Looks for JSP pages that were pushed onto the org.apache.jetspeed.renderStack + request attribute, and attempts to include them.
LoginValidationValve Checks if a login attempt failed and determines the cause.
PasswordCredentialValve Checks the PasswordCredential (only once) after a User is logged in and redirects to a + change password page if necessary.
SecurityValve Authenticates the user or redirects to Login if necessary, adds the + authenticated Subject to the RequestContext.
+

+ +

Valve Name	Description
ActionValve	Check if `PortletAction` needs to be processed and process it, if required. + Used in the portlet pipeline.
AggregateValve	Invokes all Layout components in render mode to aggregate the generated contents and + send the result to the client.
CapabilityValve	Identifies the browser and adds a `CapabilityMap` to the `RequestContext`.
CleanupValve	Looks for JSP pages that were pushed onto the `org.apache.jetspeed.renderStack` + request attribute, and attempts to include them.
LoginValidationValve	Checks if a login attempt failed and determines the cause.
PasswordCredentialValve	Checks the PasswordCredential (only once) after a User is logged in and redirects to a + change password page if necessary.
SecurityValve	Authenticates the user or redirects to Login if necessary, adds the + authenticated Subject to the `RequestContext`.

+ + Propchange: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-portal/pipeline.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-rdbms/dao.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-rdbms/dao.xml?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-rdbms/dao.xml (original) +++ portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-rdbms/dao.xml Fri Dec 12 04:06:29 2008 @@ -1,73 +1,73 @@ - - - - - Jetspeed-2 RDBMS - - - - - -

- Jetspeed-2 RDBMS component provide some of level of abstraction from the underlying persistence mechanism. -

- -

- Jetspeed-2 uses object relational mapping as the underlying technology for persistence. By default, - Apache OJB is used as an ORM engine. In order to minimize Jetspeed-2 - OJB dependencies, the InitablePersistenceBrokerDaoSupport provides a layer of abstraction that minimizes - the dependencies on a specific ORM engine. The class diagram below illustration the Jetspeed-2 implementation classes - that leverage InitablePersistenceBrokerDaoSupport:
- -

- The InitablePersistenceBrokerDaoSupport extends org.springframework.orm.ojb.support.PersistenceBrokerDaoSupport. -

- - -

- Spring's adds significant support when using the O/R mapping layer of your choice to create data access applications. The - InitablePersistenceBrokerDaoSupport extends spring layer of abstraction for persistence support, specifically the - OJB PersistenceBroker API support. -

- Using such a layer of abstraction has many advantages. Some of the advantages outlined in Spring's documentation are: -

Ease of testing. Spring's inversion of control approach makes it easy to swap the implementations and config locations of persistence manager instances, - JDBC DataSources, transaction managers, and mapper object implementations (if needed). This makes it much easier to isolate and test each piece of - persistence-related code in isolation.
Common data access exceptions. Spring can wrap exceptions from you O/R mapping tool of choice, converting them from proprietary (potentially checked) exceptions - to a common runtime DataAccessException hierarchy. This allows you to handle most persistence exceptions, which are non-recoverable, only in the appropriate layers, - without annoying boilerplate catches/throws, and exception declarations. You can still trap and handle exceptions anywhere you need to. Remember that JDBC exceptions - (including DB specific dialects) are also converted to the same hierarchy, meaning that you can perform some operations with JDBC within a consistent programming model.
General resource management. Spring application contexts can handle the location and configuration of persistence managers instances, JDBC DataSources, - and other related resources. This makes these values easy to manage and change. Spring offers efficient, easy and safe handling of persistence resources.
Integrated transaction management. Spring allows you to wrap your O/R mapping code with either a declarative, AOP style method interceptor, - or an explicit 'template' wrapper class at the Java code level. In either case, transaction semantics are handled for you, and proper transaction handling (rollback, etc) - in case of exceptions is taken care of. As discussed below, you also get the benefit of being able to use and swap various transaction managers, without your ORM specific code being affected: - for example, between local transactions and JTA, with the same full services (such as declarative transactions) available in both scenarios. As an additional benefit, - JDBC-related code can fully integrate transactionally with the code you use to do O/R mapping. This is useful for data access that's not suitable for O/R mapping, - such as batch processing or streaming of BLOBs, which still needs to share common transactions with O/R mapping operations.
To avoid vendor lock-in, and allow mix-and-match implementation strategies.

- -

+ Jetspeed-2 RDBMS component provide some of level of abstraction from the underlying persistence mechanism. +

+ +

+ Jetspeed-2 uses object relational mapping as the underlying technology for persistence. By default, + Apache OJB is used as an ORM engine. In order to minimize Jetspeed-2 + OJB dependencies, the InitablePersistenceBrokerDaoSupport provides a layer of abstraction that minimizes + the dependencies on a specific ORM engine. The class diagram below illustration the Jetspeed-2 implementation classes + that leverage InitablePersistenceBrokerDaoSupport:
+ +

+ The InitablePersistenceBrokerDaoSupport extends org.springframework.orm.ojb.support.PersistenceBrokerDaoSupport. +

+ + +

+ Spring's adds significant support when using the O/R mapping layer of your choice to create data access applications. The + InitablePersistenceBrokerDaoSupport extends spring layer of abstraction for persistence support, specifically the + OJB PersistenceBroker API support. +

+ Using such a layer of abstraction has many advantages. Some of the advantages outlined in Spring's documentation are: +

Ease of testing. Spring's inversion of control approach makes it easy to swap the implementations and config locations of persistence manager instances, + JDBC DataSources, transaction managers, and mapper object implementations (if needed). This makes it much easier to isolate and test each piece of + persistence-related code in isolation.
Common data access exceptions. Spring can wrap exceptions from you O/R mapping tool of choice, converting them from proprietary (potentially checked) exceptions + to a common runtime DataAccessException hierarchy. This allows you to handle most persistence exceptions, which are non-recoverable, only in the appropriate layers, + without annoying boilerplate catches/throws, and exception declarations. You can still trap and handle exceptions anywhere you need to. Remember that JDBC exceptions + (including DB specific dialects) are also converted to the same hierarchy, meaning that you can perform some operations with JDBC within a consistent programming model.
General resource management. Spring application contexts can handle the location and configuration of persistence managers instances, JDBC DataSources, + and other related resources. This makes these values easy to manage and change. Spring offers efficient, easy and safe handling of persistence resources.
Integrated transaction management. Spring allows you to wrap your O/R mapping code with either a declarative, AOP style method interceptor, + or an explicit 'template' wrapper class at the Java code level. In either case, transaction semantics are handled for you, and proper transaction handling (rollback, etc) + in case of exceptions is taken care of. As discussed below, you also get the benefit of being able to use and swap various transaction managers, without your ORM specific code being affected: + for example, between local transactions and JTA, with the same full services (such as declarative transactions) available in both scenarios. As an additional benefit, + JDBC-related code can fully integrate transactionally with the code you use to do O/R mapping. This is useful for data access that's not suitable for O/R mapping, + such as batch processing or streaming of BLOBs, which still needs to share common transactions with O/R mapping operations.
To avoid vendor lock-in, and allow mix-and-match implementation strategies.

+ +

+ + Propchange: portals/jetspeed-2/portal/trunk/src/site/xdoc/components/jetspeed-rdbms/dao.xml ------------------------------------------------------------------------------ svn:eol-style = native --------------------------------------------------------------------- To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org For additional commands, e-mail: jetspeed-dev-help@portals.apache.org