| Syntax |
<portlet class="oracle.portal.provider.v1.http.DefaultPortlet">
<id>number</id>
<name>string</name>
<title>string</title>
<acceptContentType>mime_type</acceptContentType>
<defaultLocale>locale</defaultLocale>
<description>string</description>
<hasAbout>boolean</hasAbout>
<hasHelp>boolean</hasHelp>
<resource>java_class_name</resource>
<showDetails>boolean</showDetails>
<showEdit>boolean</showEdit>
<showEditDefault>boolean</showEditDefault>
<showEditToPublic>boolean</showEditToPublic>
<showPreview>boolean</showPreview>
<timeout>number</timeout>
<timeoutMessage>string</timeoutMessage>
<renderer>
...
</renderer>
<inputParameter>
...
</inputParameter>
<personalizationManager>
...
</personalizationManager>
<securityManager>
...
</securityManager>
</portlet>
|
| Simple Elements |
| Mandatory |
| Name | Type | Description |
| id | number | Specifies this portlet's unique identifier within this
provider. It need not be sequential but must be unique within this
provider. |
| name | string | Defines the portlet's internal portal name. The name
must contain only alphanumeric characters without
spaces. |
| title | string | Specifies this portlet's display name. |
| Optional |
| Name | Type | Default | Description |
| acceptContentType | mime_type | text/html | Adds to the set of mime-types this portlet can render.
Currently unused, this will ultimately be used by the portal to
determine if the portlet can render appropriately for the target
user device. |
| defaultLocale | locale | the language and country represented by the the Java VMs
default locale | Specifies the language this portlet renders by default.
The value is the two letter ISO language and country codes expressed
as "language.country". |
| description | string | none | Provides more detail about the portlet. The description
is displayed to the user when she views the portlet repository
(adds a portlet). |
| hasAbout | boolean | false | Specifies whether this portlet can render an about
screen. |
| hasHelp | boolean | false | Specifies whether this portlet can render a help
screen. |
| resource | java_class_name | none | Names the Java ResourceBundle class for this portlet,
e.g.
oracle.portal.sample.devguide.helloworld.resource.HelloWorldBundle.
Mutli-language portlets put their Portlet meta-data (title, name,
etc) in resource bundles. This tag identifies the resource bundle
containing these values. Note: if you use a resource bundle for the
Portlet meta-data strings you must not have (default) entries for
these strings in the portlet definition. |
| showDetails | boolean | false | Specifies whether this portlet supports the detailed
view mode. |
| showEdit | boolean | false | Specifies whether this portlet supports user customization.
|
| showEditDefault | boolean | false | Specifies whether this portlet supports default (system)
customization. |
| showEditToPublic | boolean | false | Specifies whether the public user can customize this
portlet. |
| showPreview | boolean | false | Specifies whether this portlet supports the preview
mode. |
| timeout | number | provider timeout registered by the administrator | Defines the maximum number of seconds the portal will
wait for a response from this portlet before timing out. |
| timeoutMessage | string | provider timeout message registered by the administrator | Specifies the message the portal displays to the user if
a response from this portlet times out. |
| Child Complex Elements |
| Name | Multiplicity | Class or Interface | Description |
| renderer | 1 | oracle.portal.provider.v1.PortletRenderer | Defines this portlet's renderer. |
| inputParameter | 0 or more | oracle.portal.provider.v1.PortletParameter | Adds to the set of parameters this portlet
recognizes. |
| personalizationManager | 0 or 1 | oracle.portal.provider.v1.PortletPersonalizationManager | Defines this portlet's personalization manager. |
| securityManager | 0 or 1 | oracle.portal.provider.v1.PortletSecurityManager | Defines this portlet's security manager. |
| Syntax |
<renderer class="oracle.portal.provider.v1.RenderManager">
<showPage>string</showPage>
<appPath>virtual_path</appPath>
<appRoot>physical_path</appRoot>
<charSet>iana_charset</charSet>
<contentType>mime_type</contentType>
<editFormParameter>string</editFormParameter>
<pageExpires>number</pageExpires>
<pageParameterName>string</pageParameterName>
<renderContainer>boolean</renderContainer>
<renderCustomize>boolean</renderCustomize>
<showPage>
...
</showPage>
<aboutPage>
...
</aboutPage>
<defaultPage>
...
</defaultPage>
<editDefaultsPage>
...
</editDefaultsPage>
<editPage>
...
</editPage>
<helpPage>
...
</helpPage>
<linkPage>
...
</linkPage>
<previewPage>
...
</previewPage>
<showDetailsPage>
...
</showDetailsPage>
</renderer>
|
| Simple Elements |
| Mandatory |
| Name | Type | Description |
| showPage | string | Registers a ManagedRenderer that renders this
portlet's "Show" mode. In this 'simple' form, the tag is
assumed to describe a 'Page' ManagedRenderer (JspRenderer or
FileRenderer) for a page whose name is denoted by the enclosed
text, and content type is defined by the
contentType tag of the parent
tag (or "text/html" if there
is no such tag). The specific class of Page ManagedRenderer is
decided by the page name - JspRenderer if the name is suffixed
with ".jsp" or ".sqljsp", or FileRenderer otherwise. The
ManagedRenderer inherits all its other properties from the
'defaults' set at RenderManager level. |
| Optional |
| Name | Type | Default | Description |
| appPath | virtual_path | none | Specifies the default virtual path root used by this
RenderManager's 'Page' ManagedRenderers (e.g. JspRenderer and
FileRenderer). This default may be overridden for an individual
Page ManagedRenderer by defining an appPath within its 'Page'
tag (see 'showPage'). This tag must be specified if a 'Page'
definition exists that does not define an
appPath. |
| appRoot | physical_path | none | Specifies the default physical path root used by
this RenderManager's 'Page' ManagedRenderers. This default may
be overridden for an individual Page ManagedRenderer by
defining an appRoot within its 'Page' tag (see 'showPage').
This tag must be specified if a 'Page' definition exists that
does not define an appRoot. |
| charSet | iana_charset | UTF-8 | Defines the default IANA character encoding to be
used to decode pages used by this RenderManager's 'Page'
ManagedRenderers. This default may be overridden for an
individual Page ManagedRenderer by defining a charSet within
its 'Page' tag (see 'showPage'). |
| contentType | mime_type | text/html | Defines the MIME type to be used as the default
content type for each ManagedRenderer owned by this
RenderManager. This default may be overridden for an individual
ManagedRenderer by defining a content type within a 'Page' tag
(see 'showPage'). |
| editFormParameter | string | Derived from the portlet id. | Defines the name of the hidden parameter used on
customize forms to hold the submitted 'action' (e.g. "OK" or
"APPLY"). |
| pageExpires | number | 0 | Defines the default expiration time (in minutes) of
pages produced by this RenderManager's ManagedRenderers
(excluding pages produced in "Edit" or "EditDefaults" mode). If
zero, indicates that pages should not be cached by default.
This default may be overridden for an individual
ManagedRenderer by defining a pageExpires within its 'Page' tag
(see 'showPage'). |
| pageParameterName | string | none | Defines the the default name of the request
parameter that is used to override the name of the page used by
this RenderManager's 'Page' ManagedRenderers. Used by portlets
that render a series of screens to indicate to the
RenderManager the request parameter that identifies the "next"
page. This default may be overridden for an individual Page
ManagedRenderer by defining a pageParameterName within its
'Page' tag (see 'showPage'). |
| renderContainer | boolean | true | Defines whether the RenderManager should
automatically render the portlet's container (border and title)
before and after processing/invoking the page. |
| renderCustomize | boolean | true | Defines whether the RenderManager should
automatically render the portlet's container (border and title)
in "Edit" and "EditDefaults" modes before and after
processing/invoking the page. |
| Child Complex Elements |
| Name | Multiplicity | Class or Interface | Description |
| showPage | 1 or more | oracle.portal.provider.v1.ManagedRenderer | Registers a ManagedRenderer that renders this
portlet's "Show" mode. |
| aboutPage | 0 or more | oracle.portal.provider.v1.ManagedRenderer | Registers a ManagedRenderer that renders this
portlet's "About" mode. |
| defaultPage | 0 or more | oracle.portal.provider.v1.ManagedRenderer | Registers a ManagedRenderer that renders this
portlet's 'default' page. |
| editDefaultsPage | 0 or more | oracle.portal.provider.v1.ManagedRenderer | Registers a ManagedRenderer that renders this
portlet's "EditDefaults" mode. |
| editPage | 0 or more | oracle.portal.provider.v1.ManagedRenderer | Registers a ManagedRenderer that renders this
portlet's "Edit" mode. |
| helpPage | 0 or more | oracle.portal.provider.v1.ManagedRenderer | Registers a ManagedRenderer that renders this
portlet's "Help" mode. |
| linkPage | 0 or more | oracle.portal.provider.v1.ManagedRenderer | Registers a ManagedRenderer that renders this
portlet's "Link" mode. |
| previewPage | 0 or more | oracle.portal.provider.v1.ManagedRenderer | Registers a ManagedRenderer that renders this
portlet's "Preview" mode. |
| showDetailsPage | 0 or more | oracle.portal.provider.v1.ManagedRenderer | Registers a ManagedRenderer that renders this
portlet's "ShowDetails" mode. |
| Syntax |
<personalizationManager class="oracle.portal.provider.v1.FilePersonalizationManager">
<dataClass>java_class_name</dataClass>
<rootDirectory>physical_path</rootDirectory>
<useHashing>boolean</useHashing>
</personalizationManager>
|
| Simple Elements |
| Mandatory |
| Name | Type | Description |
| dataClass | java_class_name | Class name for this portlet's customization data
object, e.g.
oracle.portal.provider.v1.PersonalizationObject. |
| Optional |
| Name | Type | Default | Description |
| rootDirectory | physical_path | The provider's application root directory, specified
via the "provider_root" initArg | Sets the path to the filesystem directory under
which customization data will be stored for the portlet
owning this personalization manager. |
| useHashing | boolean | false | Specifies whether the 'path hashing' feature
should be used when determining the filesystem path in which
to store a customization data file for a particular portlet
instance. If the value is false, then all customization data
files for a portlet instance will be stored in a single
directory corresponding to that portlet instance. If the
value is true, then an extra level of directories below the
portlet instance directory, with names derived by a hash
function of the customization data file name, will be used in
order to limit the number of customization data files stored
in a single directory. |
| Syntax |
<showPage class="oracle.portal.provider.v1.http.FileRenderer">
<name>string</name>
<appPath>virtual_path</appPath>
<appRoot>physical_path</appRoot>
<charSet>iana_charset</charSet>
<contentType>mime_type</contentType>
<pageExpires>number</pageExpires>
<pageParameterName>string</pageParameterName>
</showPage>
|
| Simple Elements |
| Mandatory |
| Name | Type | Description |
| name | string | Defines the appRoot
relative name of the file used to render the contents of
this page. |
| Optional |
| Name | Type | Default | Description |
| appPath | virtual_path | Value of appPath on parent RenderManager | Specifies the virtual path root used by this
ManagedRenderer. |
| appRoot | physical_path | Value of appRoot on parent RenderManager | Specifies the physical path root used by this
ManagedRenderer. |
| charSet | iana_charset | Value of charSet on
parent RenderManager | Defines the default IANA character encoding to
be used to decode pages used by
ManagedRenderer. |
| contentType | mime_type | Value of contentType on parent RenderManager | Defines the MIME type of the page produced by this ManagedRenderer |
| pageExpires | number | Value of pageExpires on parent RenderManager | Defines the expiration time (in minutes) of the
page produced by this ManagedRenderer. If zero, indicates
that the page should not be cached. |
| pageParameterName | string | Value of
pageParameterName on parent
RenderManager | Defines the the default name of the request
parameter that is used to override the name of the page
used by this ManagedRenderer. Used by portlets that
render a series of screens to indicate to the
RenderManager the request parameter that identifies the
"next" page. |
| Syntax |
<showPage class="oracle.portal.provider.v1.http.JavaRenderer">
<className>java_class_name</className>
<renderMethod>string</renderMethod>
<contentType>mime_type</contentType>
<pageExpires>number</pageExpires>
</showPage>
|
| Simple Elements |
| Mandatory |
| Name | Type | Description |
| className | java_class_name | Defines the fully-qualified name of the class
which will be instantiated to render this page. |
| renderMethod | string | Defines the method name which will be called
on an instance of the class named by
className to render the contents
for this page. The named class must have a method with
this given name which takes a PortletRenderRequest as its
single parameter. |
| Optional |
| Name | Type | Default | Description |
| contentType | mime_type | Value of contentType on parent RenderManager | Defines the MIME type of the page produced by this ManagedRenderer |
| pageExpires | number | Value of pageExpires on parent RenderManager | Defines the expiration time (in minutes) of the
page produced by this ManagedRenderer. If zero, indicates
that the page should not be cached. |
| Syntax |
<showPage class="oracle.portal.provider.v1.http.JspRenderer">
<name>string</name>
<appPath>virtual_path</appPath>
<appRoot>physical_path</appRoot>
<charSet>iana_charset</charSet>
<contentType>mime_type</contentType>
<pageExpires>number</pageExpires>
<pageParameterName>string</pageParameterName>
<parameter>
...
</parameter>
</showPage>
|
| Simple Elements |
| Mandatory |
| Name | Type | Description |
| name | string | Defines the appRoot
relative name of the file used to render the contents of
this page. |
| Optional |
| Name | Type | Default | Description |
| appPath | virtual_path | Value of appPath on parent RenderManager | Specifies the virtual path root used by this
ManagedRenderer. |
| appRoot | physical_path | Value of appRoot on parent RenderManager | Specifies the physical path root used by this
ManagedRenderer. |
| charSet | iana_charset | Value of charSet on
parent RenderManager | Defines the default IANA character encoding to
be used to decode pages used by
ManagedRenderer. |
| contentType | mime_type | Value of contentType on parent RenderManager | Defines the MIME type of the page produced by this ManagedRenderer |
| pageExpires | number | Value of pageExpires on parent RenderManager | Defines the expiration time (in minutes) of the
page produced by this ManagedRenderer. If zero, indicates
that the page should not be cached. |
| pageParameterName | string | Value of
pageParameterName on parent
RenderManager | Defines the the default name of the request
parameter that is used to override the name of the page
used by this ManagedRenderer. Used by portlets that
render a series of screens to indicate to the
RenderManager the request parameter that identifies the
"next" page. |
| Child Complex Elements |
| Name | Multiplicity | Class or Interface | Description |
| parameter | 0 or more | oracle.portal.utils.v1.NameValuePair | Defines the names and values of additional
request parameters to be made available from the
HttpServletRequest object given to the JSP or servlet
used to render this page. |
| Syntax |
<showPage class="oracle.portal.provider.v1.http.Servlet20Renderer">
<servletClass>java_class_name</servletClass>
<contentType>mime_type</contentType>
<pageExpires>number</pageExpires>
<parameter>
...
</parameter>
</showPage>
|
| Simple Elements |
| Mandatory |
| Name | Type | Description |
| servletClass | java_class_name | Defines the fully-qualified name of the
servlet class used to render this page. |
| Optional |
| Name | Type | Default | Description |
| contentType | mime_type | Value of contentType on parent RenderManager | Defines the MIME type of the page produced by this ManagedRenderer |
| pageExpires | number | Value of pageExpires on parent RenderManager | Defines the expiration time (in minutes) of the
page produced by this ManagedRenderer. If zero, indicates
that the page should not be cached. |
| Child Complex Elements |
| Name | Multiplicity | Class or Interface | Description |
| parameter | 0 or more | oracle.portal.utils.v1.NameValuePair | Defines the names and values of additional
request parameters to be made available from the
HttpServletRequest object given to the JSP or servlet
used to render this page. |