portlet-prototyping:run

Full name:

net.jlehtinen.portlet:portlet-prototyping-maven-plugin:0.6:run

Description:

Runs the portlet or portlets being developed directly from the Maven source project using the Jetty servlet container and the Apache Pluto portlet container. Extends the maven-jetty-plugin. Notice that in addition to parameters defined here, the parameters defined for the extended jetty:run goal are also available.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Optional Parameters

Name Type Since Description
cssUrls List -

List of URLs for CSS files to be included in the portal. CSS files can also be specified at runtime by setting the cssUrls property to a semicolon (";") separated list of URLs.

By default some Pluto-specific CSS files are included by the portal. Any CSS URLs specified override the default CSS files.

The following example shows how to use custom CSS files.

<cssUrls>
  <url>http://my.server/custom.css</url>
  <url>http://my.server/another.css</url>
</cssUrls>

disableOtherPortlets boolean -

Whether to disable portlets other than the ones specified in portletNames. If this is set to true, the other portlets are disabled by filtering them away from the portlet.xml before the portlet project is deployed. The default is not to disable other portlets.

This parameter can be used if some of the other portlets depend on portal implementation specific features that are not available in the prototyping environment.


Default value is: false.
jsUrls List -

List of URLs for Javascript files to be included in the portal. Javascript files can also be specified at runtime by setting the jsUrls property to a semicolon (";") separated list of URLs.

By default some Pluto-specific Javascript is included by the portal. Any Javascript URLs specified override the default Javascript.

The following example shows how to use custom Javascript files.

<jsUrls>
  <url>http://my.server/custom.js</url>
  <url>http://my.server/another.js</url>
</jsUrls>

plutoContextPath String - Context path for the portal implementation.
Default value is: /pluto.
plutoRealmName String - Name of the user realm passed on to Pluto.
Default value is: Pluto Realm.
plutoVersion String - Version of the Pluto portal implementation to be used. This only affects the default portal libraries if they have not been explicitly specified using portalLibraries. To use a different version of the Pluto portal, you have to specify a portal implementation using the portal parameter.
Default value is: 2.0.2.
portal ArtifactIdentity -

Portal implementation to use. By default a slightly modified Pluto portal implementation is used but this parameter can be used to override it. For example, it is possible to create a customized portal style by creating a WAR overlay on the default portal and then specify the custom portal version using this parameter.

You can either specify a Maven artifact using groupId, artifactId and version, or a direct path to the WAR using file.

The following example demonstrates how to use Maven artifact resolution:

<portal>
  <groupId>net.jlehtinen.portlet</groupId>
  <artifactId>portlet-prototyping-portal</artifactId>
  <version>0.5</version>
  <packaging>war</packaging>
</portal>

portalLibraries List -

Portal libraries to be installed into the shared class path. By default the libraries needed by the Pluto portal implementation are included but this parameter can be used to override the default set of libraries.

Each library can be specified either as a Maven artifact using groupId, artifactId and version, or as a direct path to the JAR using file.

The following example demonstrates both kinds of library referrals:

<portalLibraries>
  <library>
    <groupId>org.apache.portals.pluto</groupId>
    <artifactId>pluto-container-api</artifactId>
    <version>2.0.2</version>
    <packaging>jar</packaging>
  </library>
  <library>
    <file>/opt/j2ee/libs/portlet-api-2.0.jar</file>
  </library>
</portalLibraries>

portletNames String -

Specifies the names of the portlets to be prototyped under Pluto as a comma separated list. The names must match exactly the name provided in the portlet-name element of the portlet descriptor. The default is to include all portlets found in the portlet.xml.

Example: <portletNames>MyPortlet,Another Portlet</portletNames>

The portlets can also be specified at runtime using the portletNames property.
portletXml File - The portlet.xml file to be used. The default location is in ${basedir}/src/main/webapp/WEB-INF. The file can also be specified at runtime using the maven.war.portletxml property.
users List -

List of users to be added in the user realm. By default a single user pluto with password pluto and role pluto is included in the user realm but this parameter can be used to override user realm data.

The following example demonstrates the use of this parameter:

<users>
  <user>
    <name>myuser</name>
    <password>mypass</passsword>
    <roles>myrole,admin</roles>
  </user>
</users>

Parameter Details

cssUrls:

List of URLs for CSS files to be included in the portal. CSS files can also be specified at runtime by setting the cssUrls property to a semicolon (";") separated list of URLs.

By default some Pluto-specific CSS files are included by the portal. Any CSS URLs specified override the default CSS files.

The following example shows how to use custom CSS files.

<cssUrls>
  <url>http://my.server/custom.css</url>
  <url>http://my.server/another.css</url>
</cssUrls>
  • Type: java.util.List
  • Required: No

disableOtherPortlets:

Whether to disable portlets other than the ones specified in portletNames. If this is set to true, the other portlets are disabled by filtering them away from the portlet.xml before the portlet project is deployed. The default is not to disable other portlets.

This parameter can be used if some of the other portlets depend on portal implementation specific features that are not available in the prototyping environment.

  • Type: boolean
  • Required: No
  • Expression: ${disableOtherPortlets}
  • Default: false

jsUrls:

List of URLs for Javascript files to be included in the portal. Javascript files can also be specified at runtime by setting the jsUrls property to a semicolon (";") separated list of URLs.

By default some Pluto-specific Javascript is included by the portal. Any Javascript URLs specified override the default Javascript.

The following example shows how to use custom Javascript files.

<jsUrls>
  <url>http://my.server/custom.js</url>
  <url>http://my.server/another.js</url>
</jsUrls>
  • Type: java.util.List
  • Required: No

plutoContextPath:

Context path for the portal implementation.
  • Type: java.lang.String
  • Required: No
  • Default: /pluto

plutoRealmName:

Name of the user realm passed on to Pluto.
  • Type: java.lang.String
  • Required: No
  • Default: Pluto Realm

plutoVersion:

Version of the Pluto portal implementation to be used. This only affects the default portal libraries if they have not been explicitly specified using portalLibraries. To use a different version of the Pluto portal, you have to specify a portal implementation using the portal parameter.
  • Type: java.lang.String
  • Required: No
  • Default: 2.0.2

portal:

Portal implementation to use. By default a slightly modified Pluto portal implementation is used but this parameter can be used to override it. For example, it is possible to create a customized portal style by creating a WAR overlay on the default portal and then specify the custom portal version using this parameter.

You can either specify a Maven artifact using groupId, artifactId and version, or a direct path to the WAR using file.

The following example demonstrates how to use Maven artifact resolution:

<portal>
  <groupId>net.jlehtinen.portlet</groupId>
  <artifactId>portlet-prototyping-portal</artifactId>
  <version>0.5</version>
  <packaging>war</packaging>
</portal>
  • Type: net.jlehtinen.portlet.prototyping.maven.ArtifactIdentity
  • Required: No

portalLibraries:

Portal libraries to be installed into the shared class path. By default the libraries needed by the Pluto portal implementation are included but this parameter can be used to override the default set of libraries.

Each library can be specified either as a Maven artifact using groupId, artifactId and version, or as a direct path to the JAR using file.

The following example demonstrates both kinds of library referrals:

<portalLibraries>
  <library>
    <groupId>org.apache.portals.pluto</groupId>
    <artifactId>pluto-container-api</artifactId>
    <version>2.0.2</version>
    <packaging>jar</packaging>
  </library>
  <library>
    <file>/opt/j2ee/libs/portlet-api-2.0.jar</file>
  </library>
</portalLibraries>
  • Type: java.util.List
  • Required: No

portletNames:

Specifies the names of the portlets to be prototyped under Pluto as a comma separated list. The names must match exactly the name provided in the portlet-name element of the portlet descriptor. The default is to include all portlets found in the portlet.xml.

Example: <portletNames>MyPortlet,Another Portlet</portletNames>

The portlets can also be specified at runtime using the portletNames property.

  • Type: java.lang.String
  • Required: No
  • Expression: ${portletNames}

portletXml:

The portlet.xml file to be used. The default location is in ${basedir}/src/main/webapp/WEB-INF. The file can also be specified at runtime using the maven.war.portletxml property.
  • Type: java.io.File
  • Required: No
  • Expression: ${maven.war.portletxml}

users:

List of users to be added in the user realm. By default a single user pluto with password pluto and role pluto is included in the user realm but this parameter can be used to override user realm data.

The following example demonstrates the use of this parameter:

<users>
  <user>
    <name>myuser</name>
    <password>mypass</passsword>
    <roles>myrole,admin</roles>
  </user>
</users>
  • Type: java.util.List
  • Required: No