# provider element

Describes object of class:
  `oracle.portal.provider.v2.ProviderDefinition`
Known concrete implementations
  `oracle.portal.provider.v2.DefaultProviderDefinition
  `
Document element

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.ProviderDefinition`, e.g. `oracle.portal.provider.v2.DefaultProviderDefinition`.
Simple Elements
Optional
Name | Type | Default | Description
prefStoreName | string | Name of the first preferenceStore declared for the provider. | Selects the default `PreferenceStore` that should be used by the provider and all its child objects for which a preference store has not been chosen explicitly.

## Usage with class oracle.portal.provider.v2.DefaultProviderDefinition

Syntax
`<provider class="oracle.portal.provider.v2.DefaultProviderDefinition"> <cacheLevel trim="boolean">string</cacheLevel> <passAllUrlParams>boolean</passAllUrlParams> <prefStoreName trim="boolean">string</prefStoreName> <providerInstanceClass>java_class_name</providerInstanceClass> <rewriteUrls>boolean</rewriteUrls> <session>boolean</session> <portlet> ... </portlet> <preferenceStore> ... </preferenceStore> <containerRenderer> ... </containerRenderer> <providerBuilder> ... </providerBuilder> </provider>`
Simple Elements
Optional
Name | Type | Default | Description
cacheLevel | string | unspecified | Controls the level of caching used for portlet render requests for portlets belonging to this provider. Cache level can also be specified at the portlet level. Legal values for cache level are system user session unspecified, i.e. cache level is not explicitly added to the provider definition file. The cache level for a portlet render request is determined using the following order of precedence: If specified, with cacheLevel, the portlet setting is used. If specified, the provider setting is used. If the provider is registered as "public" then the portlet will be called using the "public" user and cached at the system level. If the provider is registered as "user" and "portal session data" is requested then portlet will be cached at the session level. Otherwise, the portlet will be cached at user level.
passAllUrlParams | boolean | false | Controls whether Portal will pass the requested page's URL parameters to the provider's portlets by default. If `true`, then each portlet whose definition doesn't explicitly override this setting (with passAllUrlParams) will receive all the (non-system) parameters from the page URL. If `false`, then each portlet which declares input parameters and doesn't explicitly override this setting (with passAllUrlParams) will only receive values for its declared input parameters and private parameters which have been generated using `oracle.portal.provider.v2.render.PortletRendererUtil.portletParameter()`. The parameter values will be determined by the usage of the portlet on a particular page.
prefStoreName | string | Name of the first preferenceStore declared for the provider. | Selects the default `PreferenceStore` that should be used by the provider and all its child objects for which a preference store has not been chosen explicitly.
providerInstanceClass | java_class_name | `oracle.portal.provider.v2.ProviderInstance` | Defines the `ProviderInstance` subclass that implements the provider's behaviour.
rewriteUrls | boolean | false | Controls whether or not URL rewriting will be performed on the results of portlet render requests for portlets belonging to this provider. When `true`, this tag enables URL rewriting to improve portlet caching. URL Rewriting can be specified at both the provider and portlet levels. The order of precedence is as follows: If specified, with rewriteUrls, the portlet setting is used. If specified, the provider setting is used. Otherwise, URL rewriting is not performed. URL rewriting is a technique that allows you to create links or HTML forms without Portal having to send the base URL to the web provider. This means that the URLs, which can vary alot, do not get used as part of the cache key for your portlet. In most cases, this will increase the effectiveness of portlet caching. For example, you might want to create a link based on the Page URL, but with your own parameters appended to it. If URL rewriting is disabled, the base URL is sent to the web provider, the PDK framework appends your parameters to the base URL and then you include the resulting URL in your portlet. If URL rewriting is enabled, the base URL is never sent to the web provider. Instead, when you call the methods to create URLs such as `UrlUtils.constructHTMLLink`, the framework constructs a specially formatted String that you embed in your portlet. This String is then processed by Portal to create the same URL that would have been constructed if URL rewriting was disabled. In order to enable URL rewriting you may need to make some small changes to your portlet code. You will need to make changes if you are submitting data via an HTML form or if you are appending encoded parameters to a simple link. In the case of HTML forms, you should use the `UrlUtils.htmlFormName` method to construct a qualified form name that is unique to the current portlet instance. In the case of simple links, you should use `UrlUtils.constructHTMLLink`. This method constructs an entire HTML <a>..</a> tag sequence embedding your link within it.
session | boolean | true | Controls whether the `ProviderInstance` starts a (servlet) session in its `initSession()` method.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
portlet | 0 or more | ``oracle.portal.provider.v2.PortletDefinition`` | Associates with the provider a PortletDefinition object containing the meta data for one of the portlets it owns.
preferenceStore | 0 or more | ``oracle.portal.provider.v2.preference.PreferenceStore`` | Adds to the set of PreferenceStore objects that may be used by the provider for persistent storage.
containerRenderer | 0 or 1 | ``oracle.portal.provider.v2.render.PortletContainerRenderer`` | Sets the default portlet container renderer.
providerBuilder | 0 or 1 | ``oracle.webdb.provider.v2.builder.BuilderMetaData`` | Sets the ProviderBuilder object that may be used to edit the provider in Provider UI.

# containerRenderer element

Sets the default portlet container renderer.

The container renderer is responsible for rendering the portlet container in each of the show modes the portlet supports.

Each portlet can specify its own container renderer and you can specify a default at the provider level to be used by any portlet that does not explicitly specify it's own container renderer.

Describes object of class:
  `oracle.portal.provider.v2.render.PortletContainerRenderer`
Known concrete implementations
  `oracle.portal.provider.v2.render.ContainerRenderer306
  ``oracle.portal.provider.v2.render.DefaultContainerRenderer
  ``oracle.portal.provider.v2.render.MocContainerRenderer
  `
May be a child of a
  provider

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.render.PortletContainerRenderer`, e.g. `oracle.portal.provider.v2.render.ContainerRenderer306,` `oracle.portal.provider.v2.render.DefaultContainerRenderer,` `oracle.portal.provider.v2.render.MocContainerRenderer`.

## Usage with class oracle.portal.provider.v2.render.ContainerRenderer306

Syntax
`<containerRenderer class="oracle.portal.provider.v2.render.ContainerRenderer306"> </containerRenderer>`

## Usage with class oracle.portal.provider.v2.render.DefaultContainerRenderer

Syntax
`<containerRenderer class="oracle.portal.provider.v2.render.DefaultContainerRenderer"> </containerRenderer>`

## Usage with class oracle.portal.provider.v2.render.MocContainerRenderer

Syntax
`<containerRenderer class="oracle.portal.provider.v2.render.MocContainerRenderer"> </containerRenderer>`

# portlet element

Associates with the provider a `PortletDefinition` object containing the meta data for one of the portlets it owns. Note that each `PortletDefinition` added should have a unique id.

Describes object of class:
  `oracle.portal.provider.v2.PortletDefinition`
Known concrete implementations
  `oracle.portal.provider.v2.DefaultPortletDefinition
  `
May be a child of a
  provider

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.PortletDefinition`, e.g. `oracle.portal.provider.v2.DefaultPortletDefinition`.
Simple Elements
Optional
Name | Type | Default | Description
acceptContentType | mime_type | text/html | Adds to the set of mime-types this portlet can render.
description | string | String under descriptionKey key in resource bundle specified by resource | A short description of what this portlet is. Displayed at design-time along with the name and thumbnail image when a user is choosing to add a portlet to a page.
descriptionKey | string | `PortletConstants.DESCRIPTION` | The key used to look up the portlet's description in the resource bundle specified by resource.
minEditAuthLevel | PUBLIC | WEAK | STRONG | STRONG | Sets the minimum user authentication level required for the customize link to be displayed in the portlet header. If the authentication level of a user is less than the specified value, the customize link will not be displayed in the portlet header. Value should be one of the following: `PUBLIC`: User is not logged on and does not have a persistent cookie `WEAK`: User is not logged on, but is weakly authenticated as a PUBLIC portal user using a persistent cookie. `STRONG`: User has logged into the portal, and has been authenticated by the login server within the current session.
name | string | String under nameKey key in resource bundle specified by resource | The Portlet's non-unique display name.
nameKey | string | `PortletConstants.NAME` | The key used to look up the portlet's name in the resource bundle specified by resource.
prefStoreName | string | prefStoreName of the provider. | Selects the default `PreferenceStore` that should be used by the portlet and all its child objects for which a preference store has not been chosen explicitly.
resource | java_class_name | none | Sets the name of the default resource bundle class for this Portlet.
shortTitle | string | String under shortTitleKey key in resource bundle specified by resource | Short title of this Portlet. This is the name used when real estate is at a premium such as when rendering a mobile link.
shortTitleKey | string | `PortletConstants.SHORTTITLE` | The key used to look up the portlet's short title in the resource bundle specified by resource.
timeoutMessage | string | String under timeoutMessageKey key in resource bundle specified by resource | The timeout messsage that the portal should use in its response when a request to this portlet times out.
timeoutMessageKey | string | `PortletConstants.TIMEOUTMSG` | The key used to look up the portlet's timeout message in the resource bundle specified by resource.
title | string | String under titleKey key in resource bundle specified by resource | The title of this Portlet. This is the name that shows up in a portlet's title bar.
titleKey | string | `PortletConstants.TITLE` | The key used to look up the portlet's title in the resource bundle specified by resource.

## Usage with class oracle.portal.provider.v2.DefaultPortletDefinition

Syntax
`<portlet class="oracle.portal.provider.v2.DefaultPortletDefinition"> <id>number</id> <acceptContentType>mime_type</acceptContentType> <cacheLevel trim="boolean">string</cacheLevel> <callGetPortlet>boolean</callGetPortlet> <callIsRunnable>boolean</callIsRunnable> <defaultLocale>locale</defaultLocale> <description trim="boolean">string</description> <descriptionKey trim="boolean">string</descriptionKey> <hasAbout>boolean</hasAbout> <hasHelp>boolean</hasHelp> <minEditAuthLevel>PUBLIC | WEAK | STRONG</minEditAuthLevel> <mobileFlags>MOBILE_GENERIC | MOBILE_ONLY | EXTERNAL_SHOW</mobileFlags> <name trim="boolean">string</name> <nameKey trim="boolean">string</nameKey> <passAllUrlParams>boolean</passAllUrlParams> <portletInstanceClass>java_class_name</portletInstanceClass> <prefStoreName trim="boolean">string</prefStoreName> <resource>java_class_name</resource> <rewriteUrls>boolean</rewriteUrls> <shortTitle trim="boolean">string</shortTitle> <shortTitleKey trim="boolean">string</shortTitleKey> <showDetails>boolean</showDetails> <showEdit>boolean</showEdit> <showEditDefault>boolean</showEditDefault> <showLink>boolean</showLink> <showPreview>boolean</showPreview> <timeout>number</timeout> <timeoutMessage trim="boolean">string</timeoutMessage> <timeoutMessageKey trim="boolean">string</timeoutMessageKey> <title trim="boolean">string</title> <titleKey trim="boolean">string</titleKey> <renderer> ... </renderer> <event> ... </event> <inputParameter> ... </inputParameter> <containerRenderer> ... </containerRenderer> <personalizationManager> ... </personalizationManager> <portletBuilder> ... </portletBuilder> <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.
Optional
Name | Type | Default | Description
acceptContentType | mime_type | text/html | Adds to the set of mime-types this portlet can render.
cacheLevel | string | Value of cacheLevel on the provider | Controls the level of caching used for portlet render requests for the portlet. Cache level can also be specified at the provider level. Legal values for cache level are system user session unspecified, i.e. cache level is not explicitly added to the provider definition file. The cache level for a portlet render request is determined using the following order of precedence: If specified, the portlet setting is used. If specified, the provider setting is used. If the provider is registered as "public" then the portlet will be called using the "public" user and cached at the system level. If the provider is registered as "user" and "portal session data" is requested then portlet will be cached at the session level. Otherwise, the portlet will be cached at user level.
callGetPortlet | boolean | false | Controls whether calls to retrieve this Portlet's meta data should be made before displaying it in the portlet repository.
callIsRunnable | boolean | false | Controls whether calls to `PortletDefinition.hasAccess()` should be made to determine whether this portlet is runnable, before displaying it in the portlet repository.
defaultLocale | locale | the Java VM's default locale | Sets the default Locale for this Portal. The Locale is specified using the standard ISO 2 letter language and country codes, e.g. `en.US`.
description | string | String under descriptionKey key in resource bundle specified by resource | A short description of what this portlet is. Displayed at design-time along with the name and thumbnail image when a user is choosing to add a portlet to a page.
descriptionKey | string | `PortletConstants.DESCRIPTION` | The key used to look up the portlet's description in the resource bundle specified by resource.
hasAbout | boolean | false | Controls whether this portlet displays about information.
hasHelp | boolean | false | Controls whether this portlet displays help information.
minEditAuthLevel | PUBLIC | WEAK | STRONG | STRONG | Sets the minimum user authentication level required for the customize link to be displayed in the portlet header. If the authentication level of a user is less than the specified value, the customize link will not be displayed in the portlet header. Value should be one of the following: `PUBLIC`: User is not logged on and does not have a persistent cookie `WEAK`: User is not logged on, but is weakly authenticated as a PUBLIC portal user using a persistent cookie. `STRONG`: User has logged into the portal, and has been authenticated by the login server within the current session.
mobileFlags | MOBILE_GENERIC | MOBILE_ONLY | EXTERNAL_SHOW | MOBILE_GENERIC | Sets the portlet's mobile settings. The value can be a concatenation of one or more of the following flag names, separated by "|". `MOBILE_GENERIC`: placeholder that means this is a default (or generic) portlet. `MOBILE_ONLY`: this flag indicates the portlet shouldn't be rendered in the desktop viewer. I.e. the portal shouldn't transform this portlet's mobileXML to HTML. `EXTERNAL_SHOW`: this flag indicates the portlet's show link is "external". I.e. rather then use the page URL to generate a portal relative link to the portlet, an absolute (external to the portal) link is generated. These types of portlets tyipcally won't render when accessed from the mobile viewer. By setting this flag, the portal can provide UI that indicates this to the user.
name | string | String under nameKey key in resource bundle specified by resource | The Portlet's non-unique display name.
nameKey | string | `PortletConstants.NAME` | The key used to look up the portlet's name in the resource bundle specified by resource.
passAllUrlParams | boolean | Value of passAllUrlParams on provider | Controls whether Portal will pass the requested page's URL parameters to the portlet. If `true`, then the portlet will receive all the (non-system) parameters from the page URL. If `false` and the portlet declares input parameters, then the portlet will only receive values for its declared input parameters and private parameters which have been generated using `oracle.portal.provider.v2.render.PortletRendererUtil.portletParameter()`. The parameter values will be determined by the usage of the portlet on a particular page. .
portletInstanceClass | java_class_name | oracle.portal.provider.v2.DefaultPortletInstance | Defines the `PortletInstance` subclass that implements the portlet's behaviour.
prefStoreName | string | prefStoreName of the provider. | Selects the default `PreferenceStore` that should be used by the portlet and all its child objects for which a preference store has not been chosen explicitly.
resource | java_class_name | none | Sets the name of the default resource bundle class for this Portlet.
rewriteUrls | boolean | Value of rewriteUrls on the provider | Controls whether or not URL rewriting will be performed on the results of portlet render requests for the portlet. When `true`, this tag enables URL rewriting to improve portlet caching. URL Rewriting can be specified at both the provider and portlet levels. The order of precedence is as follows: If specified, the portlet setting is used. If specified, the provider setting is used. Otherwise, URL rewriting is not performed. URL rewriting is a technique that allows you to create links or HTML forms without Portal having to send the base URL to the web provider. This means that the URLs, which can vary alot, do not get used as part of the cache key for your portlet. In most cases, this will increase the effectiveness of portlet caching. For example, you might want to create a link based on the Page URL, but with your own parameters appended to it. If URL rewriting is disabled, the base URL is sent to the web provider, the PDK framework appends your parameters to the base URL and then you include the resulting URL in your portlet. If URL rewriting is enabled, the base URL is never sent to the web provider. Instead, when you call the methods to create URLs such as `UrlUtils.constructHTMLLink`, the framework constructs a specially formatted String that you embed in your portlet. This String is then processed by Portal to create the same URL that would have been constructed if URL rewriting was disabled. In order to enable URL rewriting you may need to make some small changes to your portlet code. You will need to make changes if you are submitting data via an HTML form or if you are appending encoded parameters to a simple link. In the case of HTML forms, you should use the `UrlUtils.htmlFormName` method to construct a qualified form name that is unique to the current portlet instance. In the case of simple links, you should use `UrlUtils.constructHTMLLink`. This method constructs an entire HTML <a>..</a> tag sequence embedding your link within it.
shortTitle | string | String under shortTitleKey key in resource bundle specified by resource | Short title of this Portlet. This is the name used when real estate is at a premium such as when rendering a mobile link.
shortTitleKey | string | `PortletConstants.SHORTTITLE` | The key used to look up the portlet's short title in the resource bundle specified by resource.
showDetails | boolean | false | Controls whether this portlet displays "detailed" mode. Detailed mode is a full page mode where this portlet is expected to display a finer level of information.
showEdit | boolean | false | Controls whether this portlet supports per user personalization.
showEditDefault | boolean | false | Controls whether this portlet supports per portlet customization. Per portlet customizations means that all users of this instance see a customized version of the portlet vs. the generic version. Users are then free to further personalize this instance (via showEdit).
showLink | boolean | false | Controls whether this portlet is capable of rendering content for link mode.
showPreview | boolean | false | Controls whether this portlet is capable of displaying a design-time preview of itself (after customization or personalization).
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 | String under timeoutMessageKey key in resource bundle specified by resource | The timeout messsage that the portal should use in its response when a request to this portlet times out.
timeoutMessageKey | string | `PortletConstants.TIMEOUTMSG` | The key used to look up the portlet's timeout message in the resource bundle specified by resource.
title | string | String under titleKey key in resource bundle specified by resource | The title of this Portlet. This is the name that shows up in a portlet's title bar.
titleKey | string | `PortletConstants.TITLE` | The key used to look up the portlet's title in the resource bundle specified by resource.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
renderer | 1 | ``oracle.portal.provider.v2.render.PortletRenderer`` | Defines this portlet's renderer.
event | 0 or more | ``oracle.portal.provider.v2.EventDefinition`` | Adds to the array of events that this portlet can raise to Portal.
inputParameter | 0 or more | ``oracle.portal.provider.v2.ParameterDefinition`` | Adds to the array of (input) parameters that this portlet recognizes when requested to render to control/affect the rendering.
containerRenderer | 0 or 1 | ``oracle.portal.provider.v2.render.PortletContainerRenderer`` | The controller that will render this portlet's container.
personalizationManager | 0 or 1 | ``oracle.portal.provider.v2.personalize.PortletPersonalizationManager`` | Defines this portlet's personalization manager.
portletBuilder | 0 or 1 | ``oracle.webdb.provider.v2.builder.BuilderMetaData`` | Sets the PortletBuilder object that may be used to edit the portlet in Provider UI.
securityManager | 0 or 1 | ``oracle.portal.provider.v2.security.PortletSecurityManager`` | Defines this portlet's security manager.

# preferenceStore element

Adds to the set of `PreferenceStore` objects that may be used by the provider for persistent storage. Note that each `PreferenceStore` added should have a unique identifying name.

Describes object of class:
  `oracle.portal.provider.v2.preference.PreferenceStore`
Known concrete implementations
  `oracle.portal.provider.v2.preference.DBPreferenceStore
  ``oracle.portal.provider.v2.preference.FilePreferenceStore
  `
May be a child of a
  provider

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.preference.PreferenceStore`, e.g. `oracle.portal.provider.v2.preference.DBPreferenceStore,` `oracle.portal.provider.v2.preference.FilePreferenceStore`.
Simple Elements
Mandatory
Name | Type | Description
name | string | Sets the name that should be used to identify this `PreferenceStore`.

## Usage with class oracle.portal.provider.v2.preference.DBPreferenceStore

Syntax
`<preferenceStore class="oracle.portal.provider.v2.preference.DBPreferenceStore"> <connection>jndi_path</connection> <name trim="boolean">string</name> <table>database_table_name</table> </preferenceStore>`
Simple Elements
Mandatory
Name | Type | Description
connection | jndi_path | Sets the JNDI path to the `DataSource` from which this `DBPreferenceStore` should retrieve its database connections.
name | string | Sets the name that should be used to identify this `PreferenceStore`.
Optional
Name | Type | Default | Description
table | database_table_name | JPDK_PREFERENCE_STORE2 | Sets the name of the database table in which this `DBPreferenceStore` should store customization data.

## Usage with class oracle.portal.provider.v2.preference.FilePreferenceStore

Syntax
`<preferenceStore class="oracle.portal.provider.v2.preference.FilePreferenceStore"> <name trim="boolean">string</name> <rootDirectory>physical_path</rootDirectory> <useHashing>boolean</useHashing> </preferenceStore>`
Simple Elements
Mandatory
Name | Type | Description
name | string | Sets the name that should be used to identify this `PreferenceStore`.
Optional
Name | Type | Default | Description
rootDirectory | physical_path | Path to the directory of the provider's XML definition file | Sets the path to the filesystem directory under which preference data will be stored.
useHashing | boolean | false | Activates or deactivates the 'path hashing' feature. If `false`, then data files for all preferences with the same context path will be stored in a single directory corresponding to that context path. If `true`, then an extra level of directories below the context path directory, with names derived by a hash function of the preference data file name, will be used in order to limit the number of preference data files stored in a single directory.

# providerBuilder element

Sets the `ProviderBuilder` object that may be used to edit the provider in Provider UI.

Describes object of class:
  `oracle.webdb.provider.v2.builder.BuilderMetaData`
May be a child of a
  provider

Syntax
`<providerBuilder class="oracle.webdb.provider.v2.builder.BuilderMetaData"> <implementationStyle trim="boolean">string</implementationStyle> </providerBuilder>`
Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a class which is either `oracle.webdb.provider.v2.builder.BuilderMetaData` or a subclass.
Simple Elements
Mandatory
Name | Type | Description
implementationStyle | string | Sets the implementation style of the builder that should be used to identify this `ProviderBuilder`.

# renderer element

Defines this portlet's renderer.

Describes object of class:
  `oracle.portal.provider.v2.render.PortletRenderer`
Known concrete implementations
  `oracle.portal.provider.v2.render.RenderManager
  `
Must be a child of a
  portlet

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.render.PortletRenderer`, e.g. `oracle.portal.provider.v2.render.RenderManager`.

## Usage with class oracle.portal.provider.v2.render.RenderManager

Syntax
`<renderer class="oracle.portal.provider.v2.render.RenderManager"> <showPage trim="boolean">string</showPage> <autoInvalidate>boolean</autoInvalidate> <autoRedirect>boolean</autoRedirect> <charSet>iana_charset</charSet> <contentType>mime_type</contentType> <pageExpires>number</pageExpires> <pageParameterName trim="boolean">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 rendered by `ResourceRenderer` (e.g. servlet or JSP) whose path 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 `ManagedRenderer` inherits all its other properties from the 'defaults' set at `RenderManager` level.
Optional
Name | Type | Default | Description
autoInvalidate | boolean | false | Controls whether `RenderManager` invalidates webcache content for the portlet upon customization.
autoRedirect | boolean | false | Controls whether `RenderManager` automatically issues a redirect after the portlet has processed the customization form.
charSet | iana_charset | UTF-8 | Defines the default IANA character encoding to be used to decode static pages rendered by `FileRenderer`. This default may be overridden within an individual 'page' declaration (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).
pageExpires | number | 0 | Defines the default expiration time (in minutes) of pages produced by this `RenderManager`'s `ManagedRenderer`s (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' `ManagedRenderer`s. 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 `RenderManager` should automatically render the portlet's container (border and title) before and after processing/invoking the page.
renderCustomize | boolean | true | Defines whether `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.v2.render.ManagedRenderer`` | Registers a ManagedRenderer that renders this portlet's "Show" mode.
aboutPage | 0 or more | ``oracle.portal.provider.v2.render.ManagedRenderer`` | Registers a ManagedRenderer that renders this portlet's "About" mode.
defaultPage | 0 or more | ``oracle.portal.provider.v2.render.ManagedRenderer`` | Registers a ManagedRenderer that renders this portlet's 'default' page.
editDefaultsPage | 0 or more | ``oracle.portal.provider.v2.render.ManagedRenderer`` | Registers a ManagedRenderer that renders this portlet's "EditDefaults" mode.
editPage | 0 or more | ``oracle.portal.provider.v2.render.ManagedRenderer`` | Registers a ManagedRenderer that renders this portlet's "Edit" mode.
helpPage | 0 or more | ``oracle.portal.provider.v2.render.ManagedRenderer`` | Registers a ManagedRenderer that renders this portlet's "Help" mode.
linkPage | 0 or more | ``oracle.portal.provider.v2.render.ManagedRenderer`` | Registers a ManagedRenderer that renders this portlet's "Link" mode.
previewPage | 0 or more | ``oracle.portal.provider.v2.render.ManagedRenderer`` | Registers a ManagedRenderer that renders this portlet's "Preview" mode.
showDetailsPage | 0 or more | ``oracle.portal.provider.v2.render.ManagedRenderer`` | Registers a ManagedRenderer that renders this portlet's "ShowDetails" mode.

# containerRenderer element

The controller that will render this portlet's container.

The container renderer is responsible for rendering the portlet container in each of the show modes the portlet supports.

Describes object of class:
  `oracle.portal.provider.v2.render.PortletContainerRenderer`
Known concrete implementations
  `oracle.portal.provider.v2.render.ContainerRenderer306
  ``oracle.portal.provider.v2.render.DefaultContainerRenderer
  ``oracle.portal.provider.v2.render.MocContainerRenderer
  `
May be a child of a
  portlet

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.render.PortletContainerRenderer`, e.g. `oracle.portal.provider.v2.render.ContainerRenderer306,` `oracle.portal.provider.v2.render.DefaultContainerRenderer,` `oracle.portal.provider.v2.render.MocContainerRenderer`.

## Usage with class oracle.portal.provider.v2.render.ContainerRenderer306

Syntax
`<containerRenderer class="oracle.portal.provider.v2.render.ContainerRenderer306"> </containerRenderer>`

## Usage with class oracle.portal.provider.v2.render.DefaultContainerRenderer

Syntax
`<containerRenderer class="oracle.portal.provider.v2.render.DefaultContainerRenderer"> </containerRenderer>`

## Usage with class oracle.portal.provider.v2.render.MocContainerRenderer

Syntax
`<containerRenderer class="oracle.portal.provider.v2.render.MocContainerRenderer"> </containerRenderer>`

# event element

Adds to the array of events that this portlet can raise to Portal.

Describes object of class:
  `oracle.portal.provider.v2.EventDefinition`
May be a child of a
  portlet

Syntax
`<event class="oracle.portal.provider.v2.EventDefinition"> <name trim="boolean">string</name> <description trim="boolean">string</description> <descriptionKey trim="boolean">string</descriptionKey> <displayName trim="boolean">string</displayName> <displayNameKey trim="boolean">string</displayNameKey> <resource>java_class_name</resource> <parameter> ... </parameter> </event>`
Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a class which is either `oracle.portal.provider.v2.EventDefinition` or a subclass.
Simple Elements
Mandatory
Name | Type | Description
name | string | The event's name. This name must be unique across all events defined for this portlet.
Optional
Name | Type | Default | Description
description | string | String under descriptionKey key in resource bundle specified by resource | The event's description. This is displayed in the Portal UI to give the page designer a better idea of what it will be used for.
descriptionKey | string | none | The key used to look up the event's description in the resource bundle specified by resource.
displayName | string | String under displayNameKey key in resource bundle specified by resource | The event's display name. This is a short name used in the Portal UI.
displayNameKey | string | none | The key used to look up the event's display name in the resource bundle specified by resource.
resource | java_class_name | none | Sets the name of the default resource bundle class for this event.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
parameter | 0 or more | ``oracle.portal.provider.v2.ParameterDefinition`` | Adds a parameter to the event.

# inputParameter element

Adds to the array of (input) parameters that this portlet recognizes when requested to render to control/affect the rendering.

Describes object of class:
  `oracle.portal.provider.v2.ParameterDefinition`
May be a child of a
  portlet

Syntax
`<inputParameter class="oracle.portal.provider.v2.ParameterDefinition"> <name trim="boolean">string</name> <description trim="boolean">string</description> <descriptionKey trim="boolean">string</descriptionKey> <displayName trim="boolean">string</displayName> <displayNameKey trim="boolean">string</displayNameKey> <resource>java_class_name</resource> </inputParameter>`
Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a class which is either `oracle.portal.provider.v2.ParameterDefinition` or a subclass.
Simple Elements
Mandatory
Name | Type | Description
name | string | The parameter's name. This name should be unique from any other parameters under the parent. This name must also be a legal string that can be passed as a URL parameter to the portlet's renderer.
Optional
Name | Type | Default | Description
description | string | String under descriptionKey key in resource bundle specified by resource | The parameter's description. This is displayed in the Portal UI to give the page designer a better idea of what it will be used for.
descriptionKey | string | none | The key used to look up the parameter's description in the resource bundle specified by resource.
displayName | string | String under displayNameKey key in resource bundle specified by resource | The parameter's display name. This is a short name used in the Portal UI.
displayNameKey | string | none | The key used to look up the parameter's display name in the resource bundle specified by resource.
resource | java_class_name | none | Sets the name of the default resource bundle class for this parameter.

# personalizationManager element

Defines this portlet's personalization manager. If not specified it indicates this portlet doesn't support personalization.

Describes object of class:
  `oracle.portal.provider.v2.personalize.PortletPersonalizationManager`
Known concrete implementations
  `oracle.portal.provider.v2.personalize.PrefStorePersonalizationManager
  `
May be a child of a
  portlet

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.personalize.PortletPersonalizationManager`, e.g. `oracle.portal.provider.v2.personalize.PrefStorePersonalizationManager`.
Simple Elements
Mandatory
Name | Type | Description
dataClass | java_class_name | Class name for this portlet's customization data object, e.g. oracle.portal.provider.v2.PersonalizationObject.

## Usage with class oracle.portal.provider.v2.personalize.PrefStorePersonalizationManager

Syntax
`<personalizationManager class="oracle.portal.provider.v2.personalize.PrefStorePersonalizationManager"> <dataClass>java_class_name</dataClass> </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.v2.PersonalizationObject.

# portletBuilder element

Sets the `PortletBuilder` object that may be used to edit the portlet in Provider UI.

Describes object of class:
  `oracle.webdb.provider.v2.builder.BuilderMetaData`
May be a child of a
  portlet

Syntax
`<portletBuilder class="oracle.webdb.provider.v2.builder.BuilderMetaData"> <implementationStyle trim="boolean">string</implementationStyle> </portletBuilder>`
Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a class which is either `oracle.webdb.provider.v2.builder.BuilderMetaData` or a subclass.
Simple Elements
Mandatory
Name | Type | Description
implementationStyle | string | Sets the implementation style of the builder that should be used to identify this `PortletBuilder`.

# securityManager element

Defines this portlet's security manager. If not specified it indicates this portlet authorizes access to all users.

Describes object of class:
  `oracle.portal.provider.v2.security.PortletSecurityManager`
Known concrete implementations
  `oracle.portal.provider.v2.security.AuthLevelSecurityManager
  `
May be a child of a
  portlet

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.security.PortletSecurityManager`, e.g. `oracle.portal.provider.v2.security.AuthLevelSecurityManager`.

## Usage with class oracle.portal.provider.v2.security.AuthLevelSecurityManager

Syntax
`<securityManager class="oracle.portal.provider.v2.security.AuthLevelSecurityManager"> <securityLevel>STRONG | WEAK | PUBLIC</securityLevel> </securityManager>`
Simple Elements
Optional
Name | Type | Default | Description
securityLevel | STRONG | WEAK | PUBLIC | STRONG | Sets the security threshhold for this security manager. Values have same meaning as minEditAuthLevel.

# showPage element

Registers a `ManagedRenderer` that renders this portlet's "Show" mode. If multiple showPage tags with different contentType child tags are included, `RenderManager` will choose the first showPage definition whose content type matches the preferred content type of the incoming render request. This allows a `RenderManager` to be configured so that it supports 'standard' browsers (e.g. with a "text/html" content type) as well as mobile devices (e.g. with a "text/vnd.oracle.mobilexml" content type).

Describes object of class:
  `oracle.portal.provider.v2.render.ManagedRenderer`
Known concrete implementations
  `oracle.portal.provider.v2.render.http.FileRenderer
  ``oracle.portal.provider.v2.render.http.JavaRenderer
  ``oracle.portal.provider.v2.render.http.ResourceRenderer
  ``oracle.portal.provider.v2.webservice.DocWebServiceRenderer
  ``oracle.portal.provider.v2.webservice.HTMLStringWebServiceRenderer
  ``oracle.portal.provider.v2.webservice.RPCWebServiceRenderer
  ``oracle.portal.provider.v2.webservice.XMLStringWebServiceRenderer
  `
Must be a child of a
  renderer

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.render.ManagedRenderer`, e.g. `oracle.portal.provider.v2.render.http.FileRenderer,` `oracle.portal.provider.v2.render.http.JavaRenderer,` `oracle.portal.provider.v2.render.http.ResourceRenderer,` `oracle.portal.provider.v2.webservice.DocWebServiceRenderer,` `oracle.portal.provider.v2.webservice.HTMLStringWebServiceRenderer,` `oracle.portal.provider.v2.webservice.RPCWebServiceRenderer,` `oracle.portal.provider.v2.webservice.XMLStringWebServiceRenderer`.

## Usage with class oracle.portal.provider.v2.render.http.FileRenderer

Syntax
`<showPage class="oracle.portal.provider.v2.render.http.FileRenderer"> <appRoot trim="boolean">string</appRoot> <name trim="boolean">string</name> <charSet>iana_charset</charSet> <contentType>mime_type</contentType> <generatesESI>boolean</generatesESI> <pageExpires>number</pageExpires> <useInvalidationCaching>boolean</useInvalidationCaching> <parameter> ... </parameter> </showPage>`
Simple Elements
Mandatory
Name | Type | Description
appRoot | string | The root physical path for the renderer's pages.
name | string | The appRoot-relative name of the static file to be renderered.
Optional
Name | Type | Default | Description
charSet | iana_charset | charSet of parent renderer | Defines the default IANA character encoding to be used to decode the page renderered by this `FileRenderer`.
contentType | mime_type | Value of contentType on parent `RenderManager` | Defines the MIME type of the page produced by this `ManagedRenderer`
generatesESI | boolean | false | Indicates that ESI processing should be performed on the rendered portlet. When set to true, a header that enables ESI processing is included in the response HTTP headers.
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.
useInvalidationCaching | boolean | false | Indicates whether or not to use invalidation caching. Note that if invalidation caching is used on a page, the renderer will not be contacted to render the same page again until its expiry time has passed or the cached page is invalidated explicitly.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
parameter | 0 or more | ``oracle.portal.utils.v2.NameValuePair`` | Defines the names and values of additional static parameters to be made available in the request to this renderer.

## Usage with class oracle.portal.provider.v2.render.http.JavaRenderer

Syntax
`<showPage class="oracle.portal.provider.v2.render.http.JavaRenderer"> <className>java_class_name</className> <renderMethod trim="boolean">string</renderMethod> <contentType>mime_type</contentType> <generatesESI>boolean</generatesESI> <pageExpires>number</pageExpires> <useInvalidationCaching>boolean</useInvalidationCaching> <parameter> ... </parameter> </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`
generatesESI | boolean | false | Indicates that ESI processing should be performed on the rendered portlet. When set to true, a header that enables ESI processing is included in the response HTTP headers.
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.
useInvalidationCaching | boolean | false | Indicates whether or not to use invalidation caching. Note that if invalidation caching is used on a page, the renderer will not be contacted to render the same page again until its expiry time has passed or the cached page is invalidated explicitly.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
parameter | 0 or more | ``oracle.portal.utils.v2.NameValuePair`` | Defines the names and values of additional static parameters to be made available in the request to this renderer.

## Usage with class oracle.portal.provider.v2.render.http.ResourceRenderer

Syntax
`<showPage class="oracle.portal.provider.v2.render.http.ResourceRenderer"> <resourcePath>virtual_path</resourcePath> <charSet>iana_charset</charSet> <contentType>mime_type</contentType> <context>virtual_path</context> <generatesESI>boolean</generatesESI> <pageExpires>number</pageExpires> <useInvalidationCaching>boolean</useInvalidationCaching> <parameter> ... </parameter> </showPage>`
Simple Elements
Mandatory
Name | Type | Description
resourcePath | virtual_path | The path of the resource used for rendering. This path should be relative to the context root of the J2EE Application. It should fully locate the resource so, in the case of JSPs and static files, should include the file name.
Optional
Name | Type | Default | Description
charSet | iana_charset | UTF-8 | Defines the default IANA character encoding to be used to decode content pages rendered by `ResourceRenderer`. This overrides the default behaviour which is to use the character set specified in the contentType request header or ISO-8859-1.
contentType | mime_type | Value of contentType on parent `RenderManager` | Defines the MIME type of the page produced by this `ManagedRenderer`
context | virtual_path | none | Sets the context root of the `javax.servlet.ServletContext` containing the resource. This should only be set if the resource is located in a different servlet context than the current provider.
generatesESI | boolean | false | Indicates that ESI processing should be performed on the rendered portlet. When set to true, a header that enables ESI processing is included in the response HTTP headers.
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.
useInvalidationCaching | boolean | false | Indicates whether or not to use invalidation caching. Note that if invalidation caching is used on a page, the renderer will not be contacted to render the same page again until its expiry time has passed or the cached page is invalidated explicitly.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
parameter | 0 or more | ``oracle.portal.utils.v2.NameValuePair`` | Defines the names and values of additional static parameters to be made available in the request to this renderer.

## Usage with class oracle.portal.provider.v2.webservice.DocWebServiceRenderer

Syntax
`<showPage class="oracle.portal.provider.v2.webservice.DocWebServiceRenderer"> <endpointURL>URL</endpointURL> <responseXSL>String</responseXSL> <contentType>mime_type</contentType> <escapeOutput>boolean</escapeOutput> <generatesESI>boolean</generatesESI> <logging>boolean</logging> <loggingDirectory>physical_path</loggingDirectory> <pageExpires>number</pageExpires> <soapAction trim="boolean">string</soapAction> <useInvalidationCaching>boolean</useInvalidationCaching> <parameter> ... </parameter> <literal> ... </literal> </showPage>`
Simple Elements
Mandatory
Name | Type | Description
endpointURL | URL | The URL through which the web service should be contacted. This can be determined from the `<soap:address>` element of the service's WSDL document.
responseXSL | String | The filename of the XSL stylesheet used to transform the XML result document into a portlet response. The file is assumed to be stored in the provider 'repository' directory (usually the same directory as the XML provider definition).
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`
escapeOutput | boolean | true | Controls whether control characters in the response from the web service (such as '<' and '&') are escaped in the portlet response so that they display in HTML. Escaping should be disabled, e.g. if the web service returns a string containing HTML tags, which should be copied to the portlet response verbatim.
generatesESI | boolean | false | Indicates that ESI processing should be performed on the rendered portlet. When set to true, a header that enables ESI processing is included in the response HTTP headers.
logging | boolean | false | Controls whether the XML logging debug feature is activated (see class doc for more information).
loggingDirectory | physical_path | The provider 'repository path' (usually the directory of the XML provider definition) | The directory where files are created by the XML logging debug feature.
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.
soapAction | string | `""` | The value to be set for the `SOAPAction` HTTP header, if required. This can be determined from a web service's WSDL document by the `soapAction` attribute of the `<soap:operation>` element corresponding to the particular operation you want to invoke.
useInvalidationCaching | boolean | false | Indicates whether or not to use invalidation caching. Note that if invalidation caching is used on a page, the renderer will not be contacted to render the same page again until its expiry time has passed or the cached page is invalidated explicitly.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
parameter | 0 or more | ``oracle.portal.utils.v2.NameValuePair`` | Defines the names and values of additional static parameters to be made available in the request to this renderer.
literal | 0 or 1 | ``oracle.portal.provider.v2.webservice.LiteralXML`` | Defines the literal XML structure that should be sent in the request to the web service.

## Usage with class oracle.portal.provider.v2.webservice.HTMLStringWebServiceRenderer

Syntax
`<showPage class="oracle.portal.provider.v2.webservice.HTMLStringWebServiceRenderer"> <className>java_class_name</className> <renderMethod trim="boolean">string</renderMethod> <responseXSL>String</responseXSL> <contentType>mime_type</contentType> <escapeOutput>boolean</escapeOutput> <generatesESI>boolean</generatesESI> <logging>boolean</logging> <loggingDirectory>physical_path</loggingDirectory> <pageExpires>number</pageExpires> <param trim="boolean">string</param> <useInvalidationCaching>boolean</useInvalidationCaching> <param> ... </param> <parameter> ... </parameter> <literal> ... </literal> </showPage>`
Simple Elements
Mandatory
Name | Type | Description
className | java_class_name | The fully-qualified class name of the web service Java stub.
renderMethod | string | The name of the method to be called on an instance of the web service stub to render a request.
responseXSL | String | The filename of the XSL stylesheet used to transform the XML result document into a portlet response. The file is assumed to be stored in the provider 'repository' directory (usually the same directory as the XML provider definition).
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`
escapeOutput | boolean | true | Controls whether control characters in the response from the web service (such as '<' and '&') are escaped in the portlet response so that they display in HTML. Escaping should be disabled, e.g. if the web service returns a string containing HTML tags, which should be copied to the portlet response verbatim.
generatesESI | boolean | false | Indicates that ESI processing should be performed on the rendered portlet. When set to true, a header that enables ESI processing is included in the response HTTP headers.
logging | boolean | false | Controls whether the XML logging debug feature is activated (see class doc for more information).
loggingDirectory | physical_path | The provider 'repository path' (usually the directory of the XML provider definition) | The directory where files are created by the XML logging debug feature.
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.
param | string | none | Defines a constant parameter to be passed to the render method. The parameter value will be converted to the appropriate type, according to the argument list of the method. This is provided as a shorthand for the param element.
useInvalidationCaching | boolean | false | Indicates whether or not to use invalidation caching. Note that if invalidation caching is used on a page, the renderer will not be contacted to render the same page again until its expiry time has passed or the cached page is invalidated explicitly.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
param | 0 or more | ``oracle.portal.provider.v2.webservice.WebServiceRenderer$ParameterBinding`` | Defines a parameter to be passed to the render method.
parameter | 0 or more | ``oracle.portal.utils.v2.NameValuePair`` | Defines the names and values of additional static parameters to be made available in the request to this renderer.
literal | 0 or 1 | ``oracle.portal.provider.v2.webservice.LiteralXML`` | Defines the literal XML structure that should be sent in the request to the web service.

## Usage with class oracle.portal.provider.v2.webservice.RPCWebServiceRenderer

Syntax
`<showPage class="oracle.portal.provider.v2.webservice.RPCWebServiceRenderer"> <className>java_class_name</className> <renderMethod trim="boolean">string</renderMethod> <responseXSL>String</responseXSL> <contentType>mime_type</contentType> <escapeOutput>boolean</escapeOutput> <generatesESI>boolean</generatesESI> <logging>boolean</logging> <loggingDirectory>physical_path</loggingDirectory> <pageExpires>number</pageExpires> <param trim="boolean">string</param> <useInvalidationCaching>boolean</useInvalidationCaching> <param> ... </param> <parameter> ... </parameter> <literal> ... </literal> </showPage>`
Simple Elements
Mandatory
Name | Type | Description
className | java_class_name | The fully-qualified class name of the web service Java stub.
renderMethod | string | The name of the method to be called on an instance of the web service stub to render a request.
responseXSL | String | The filename of the XSL stylesheet used to transform the XML result document into a portlet response. The file is assumed to be stored in the provider 'repository' directory (usually the same directory as the XML provider definition).
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`
escapeOutput | boolean | true | Controls whether control characters in the response from the web service (such as '<' and '&') are escaped in the portlet response so that they display in HTML. Escaping should be disabled, e.g. if the web service returns a string containing HTML tags, which should be copied to the portlet response verbatim.
generatesESI | boolean | false | Indicates that ESI processing should be performed on the rendered portlet. When set to true, a header that enables ESI processing is included in the response HTTP headers.
logging | boolean | false | Controls whether the XML logging debug feature is activated (see class doc for more information).
loggingDirectory | physical_path | The provider 'repository path' (usually the directory of the XML provider definition) | The directory where files are created by the XML logging debug feature.
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.
param | string | none | Defines a constant parameter to be passed to the render method. The parameter value will be converted to the appropriate type, according to the argument list of the method. This is provided as a shorthand for the param element.
useInvalidationCaching | boolean | false | Indicates whether or not to use invalidation caching. Note that if invalidation caching is used on a page, the renderer will not be contacted to render the same page again until its expiry time has passed or the cached page is invalidated explicitly.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
param | 0 or more | ``oracle.portal.provider.v2.webservice.WebServiceRenderer$ParameterBinding`` | Defines a parameter to be passed to the render method.
parameter | 0 or more | ``oracle.portal.utils.v2.NameValuePair`` | Defines the names and values of additional static parameters to be made available in the request to this renderer.
literal | 0 or 1 | ``oracle.portal.provider.v2.webservice.LiteralXML`` | Defines the literal XML structure that should be sent in the request to the web service.

## Usage with class oracle.portal.provider.v2.webservice.XMLStringWebServiceRenderer

Syntax
`<showPage class="oracle.portal.provider.v2.webservice.XMLStringWebServiceRenderer"> <className>java_class_name</className> <renderMethod trim="boolean">string</renderMethod> <responseXSL>String</responseXSL> <contentType>mime_type</contentType> <escapeOutput>boolean</escapeOutput> <generatesESI>boolean</generatesESI> <logging>boolean</logging> <loggingDirectory>physical_path</loggingDirectory> <pageExpires>number</pageExpires> <param trim="boolean">string</param> <useInvalidationCaching>boolean</useInvalidationCaching> <param> ... </param> <parameter> ... </parameter> <literal> ... </literal> </showPage>`
Simple Elements
Mandatory
Name | Type | Description
className | java_class_name | The fully-qualified class name of the web service Java stub.
renderMethod | string | The name of the method to be called on an instance of the web service stub to render a request.
responseXSL | String | The filename of the XSL stylesheet used to transform the XML result document into a portlet response. The file is assumed to be stored in the provider 'repository' directory (usually the same directory as the XML provider definition).
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`
escapeOutput | boolean | true | Controls whether control characters in the response from the web service (such as '<' and '&') are escaped in the portlet response so that they display in HTML. Escaping should be disabled, e.g. if the web service returns a string containing HTML tags, which should be copied to the portlet response verbatim.
generatesESI | boolean | false | Indicates that ESI processing should be performed on the rendered portlet. When set to true, a header that enables ESI processing is included in the response HTTP headers.
logging | boolean | false | Controls whether the XML logging debug feature is activated (see class doc for more information).
loggingDirectory | physical_path | The provider 'repository path' (usually the directory of the XML provider definition) | The directory where files are created by the XML logging debug feature.
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.
param | string | none | Defines a constant parameter to be passed to the render method. The parameter value will be converted to the appropriate type, according to the argument list of the method. This is provided as a shorthand for the param element.
useInvalidationCaching | boolean | false | Indicates whether or not to use invalidation caching. Note that if invalidation caching is used on a page, the renderer will not be contacted to render the same page again until its expiry time has passed or the cached page is invalidated explicitly.
Child Complex Elements
Name | Multiplicity | Class or Interface | Description
param | 0 or more | ``oracle.portal.provider.v2.webservice.WebServiceRenderer$ParameterBinding`` | Defines a parameter to be passed to the render method.
parameter | 0 or more | ``oracle.portal.utils.v2.NameValuePair`` | Defines the names and values of additional static parameters to be made available in the request to this renderer.
literal | 0 or 1 | ``oracle.portal.provider.v2.webservice.LiteralXML`` | Defines the literal XML structure that should be sent in the request to the web service.

# parameter element

Adds a parameter to the event. These are the parameters which will be passed with the event when it is raised. They are rendered by the portlet with the event.

Describes object of class:
  `oracle.portal.provider.v2.ParameterDefinition`
May be a child of a
  event

Syntax
`<parameter class="oracle.portal.provider.v2.ParameterDefinition"> <name trim="boolean">string</name> <description trim="boolean">string</description> <descriptionKey trim="boolean">string</descriptionKey> <displayName trim="boolean">string</displayName> <displayNameKey trim="boolean">string</displayNameKey> <resource>java_class_name</resource> </parameter>`
Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a class which is either `oracle.portal.provider.v2.ParameterDefinition` or a subclass.
Simple Elements
Mandatory
Name | Type | Description
name | string | The parameter's name. This name should be unique from any other parameters under the parent. This name must also be a legal string that can be passed as a URL parameter to the portlet's renderer.
Optional
Name | Type | Default | Description
description | string | String under descriptionKey key in resource bundle specified by resource | The parameter's description. This is displayed in the Portal UI to give the page designer a better idea of what it will be used for.
descriptionKey | string | none | The key used to look up the parameter's description in the resource bundle specified by resource.
displayName | string | String under displayNameKey key in resource bundle specified by resource | The parameter's display name. This is a short name used in the Portal UI.
displayNameKey | string | none | The key used to look up the parameter's display name in the resource bundle specified by resource.
resource | java_class_name | none | Sets the name of the default resource bundle class for this parameter.

# aboutPage element

Registers a `ManagedRenderer` that renders this portlet's "About" mode. This tag is only required if the portlet enables/supports displaying an about screen. This tag supports all the properties of the showPage 'complex' tag, and also supports a shorthand 'simple' form, as per showPage.

Describes object of class:
  `oracle.portal.provider.v2.render.ManagedRenderer`
May be a child of a
  renderer

# defaultPage element

Registers a `ManagedRenderer` that renders this portlet's 'default' page. This page is used when no `ManagedRenderer` has been specified for the specific mode of the render request. This tag supports all the properties of the showPage 'complex' tag, and also supports a shorthand 'simple' form, as per showPage.

Describes object of class:
  `oracle.portal.provider.v2.render.ManagedRenderer`
May be a child of a
  renderer

# editDefaultsPage element

Registers a `ManagedRenderer` that renders this portlet's "EditDefaults" mode. If not specified for the preferred content type of the render request and the portlet enables user customization then the editPage must be specified for that content type as it becomes the default. This tag supports all the properties of the showPage 'complex' tag, and also supports a shorthand 'simple' form, as per showPage.

Describes object of class:
  `oracle.portal.provider.v2.render.ManagedRenderer`
May be a child of a
  renderer

# editPage element

Registers a `ManagedRenderer` that renders this portlet's "Edit" mode. If not specified for the preferred content type of the render request and the portlet enables user customization then the editDefaultsPage must be specified for that content type as it becomes the default. This tag supports all the properties of the showPage 'complex' tag, and also supports a shorthand 'simple' form, as per showPage.

Describes object of class:
  `oracle.portal.provider.v2.render.ManagedRenderer`
May be a child of a
  renderer

# helpPage element

Registers a `ManagedRenderer` that renders this portlet's "Help" mode. This tag is only required if the portlet enables/supports displaying help. This tag supports all the properties of the showPage 'complex' tag, and also supports a shorthand 'simple' form, as per showPage.

Describes object of class:
  `oracle.portal.provider.v2.render.ManagedRenderer`
May be a child of a
  renderer

# linkPage element

Registers a `ManagedRenderer` that renders this portlet's "Link" mode. This mode is generally only used by mobile devices to display a link to the Show mode page. Hence the tag should generally be used with the "text/vnd.oracle.mobilexml" content type. This tag supports all the properties of the showPage 'complex' tag, and also supports a shorthand 'simple' form, as per showPage.

Describes object of class:
  `oracle.portal.provider.v2.render.ManagedRenderer`
May be a child of a
  renderer

# previewPage element

Registers a `ManagedRenderer` that renders this portlet's "Preview" mode. This tag is only required if the portlet enables/supports preview. This tag supports all the properties of the showPage 'complex' tag, and also supports a shorthand 'simple' form, as per showPage.

Describes object of class:
  `oracle.portal.provider.v2.render.ManagedRenderer`
May be a child of a
  renderer

# showDetailsPage element

Registers a `ManagedRenderer` that renders this portlet's "ShowDetails" mode. If not specified for the preferred content type of the render request and the portlet enables showDetails then the showPage renderer is used. This tag supports all the properties of the showPage 'complex' tag, and also supports a shorthand 'simple' form, as per showPage.

Describes object of class:
  `oracle.portal.provider.v2.render.ManagedRenderer`
May be a child of a
  renderer

# literal element

Defines the literal XML structure that should be sent in the request to the web service. See class doc for more information.

Describes object of class:
  `oracle.portal.provider.v2.webservice.LiteralXML`
May be a child of a
  showPage

Syntax
`<literal class="oracle.portal.provider.v2.webservice.LiteralXML" handler="oracle.portal.provider.v2.webservice.LiteralXML$Handler"> </literal>`
Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a class which is either `oracle.portal.provider.v2.webservice.LiteralXML` or a subclass.
handler | oracle.portal.provider.v2.webservice.LiteralXML$Handler | The `NodeHandler` that should be used to process XML descriptions of a `LiteralXML` object.

# param element

Defines a parameter to be passed to the render method. The parameter value will be converted to the appropriate type, according to the argument list of the method.

Describes object of class:
  `oracle.portal.provider.v2.webservice.WebServiceRenderer$ParameterBinding`
Known concrete implementations
  `oracle.portal.provider.v2.webservice.WebServiceRenderer$ConstParam
  ``oracle.portal.provider.v2.webservice.WebServiceRenderer$EditData
  ``oracle.portal.provider.v2.webservice.WebServiceRenderer$RequestParam
  ``oracle.portal.provider.v2.webservice.WebServiceRenderer$SessionAttrib
  ``oracle.portal.provider.v2.webservice.WebServiceRenderer$URLParam
  `
May be a child of a
  showPage

Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a subclass of `oracle.portal.provider.v2.webservice.WebServiceRenderer$ParameterBinding`, e.g. `oracle.portal.provider.v2.webservice.WebServiceRenderer$ConstParam,` `oracle.portal.provider.v2.webservice.WebServiceRenderer$EditData,` `oracle.portal.provider.v2.webservice.WebServiceRenderer$RequestParam,` `oracle.portal.provider.v2.webservice.WebServiceRenderer$SessionAttrib,` `oracle.portal.provider.v2.webservice.WebServiceRenderer$URLParam`.
Simple Elements
Mandatory
Name | Type | Description
name | string | The binding name, which identifies the particular item of data it should be bound to.

## Usage with class oracle.portal.provider.v2.webservice.WebServiceRenderer$ConstParam

Syntax
`<param class="oracle.portal.provider.v2.webservice.WebServiceRenderer$ConstParam"> <name trim="boolean">string</name> </param>`
Simple Elements
Mandatory
Name | Type | Description
name | string | The binding name, which identifies the particular item of data it should be bound to.

## Usage with class oracle.portal.provider.v2.webservice.WebServiceRenderer$EditData

Syntax
`<param class="oracle.portal.provider.v2.webservice.WebServiceRenderer$EditData"> <name trim="boolean">string</name> <default trim="boolean">string</default> <mandatory>boolean</mandatory> <prompt trim="boolean">string</prompt> </param>`
Simple Elements
Mandatory
Name | Type | Description
name | string | The binding name, which identifies the particular item of data it should be bound to.
Optional
Name | Type | Default | Description
default | string | none | The default value for this binding, returned by `getValue` when the binding value is `null` or the empty string.
mandatory | boolean | false | Controls whether this binding is mandatory. If a `WebServiceRenderer` has any mandatory parameter bindings, its web service will not be invoked until all its bindings have a value which is non-null and not equal to the empty string. By default, all parameters are non-mandatory.
prompt | string | Enter value for name | The default prompt to use for the input field corresponding to this item in the generated HTML form.

## Usage with class oracle.portal.provider.v2.webservice.WebServiceRenderer$RequestParam

Syntax
`<param class="oracle.portal.provider.v2.webservice.WebServiceRenderer$RequestParam"> <name trim="boolean">string</name> <default trim="boolean">string</default> <mandatory>boolean</mandatory> </param>`
Simple Elements
Mandatory
Name | Type | Description
name | string | The binding name, which identifies the particular item of data it should be bound to.
Optional
Name | Type | Default | Description
default | string | none | The default value for this binding, returned by `getValue` when the binding value is `null` or the empty string.
mandatory | boolean | false | Controls whether this binding is mandatory. If a `WebServiceRenderer` has any mandatory parameter bindings, its web service will not be invoked until all its bindings have a value which is non-null and not equal to the empty string. By default, all parameters are non-mandatory.

## Usage with class oracle.portal.provider.v2.webservice.WebServiceRenderer$SessionAttrib

Syntax
`<param class="oracle.portal.provider.v2.webservice.WebServiceRenderer$SessionAttrib"> <name trim="boolean">string</name> <default trim="boolean">string</default> <mandatory>boolean</mandatory> </param>`
Simple Elements
Mandatory
Name | Type | Description
name | string | The binding name, which identifies the particular item of data it should be bound to.
Optional
Name | Type | Default | Description
default | string | none | The default value for this binding, returned by `getValue` when the binding value is `null` or the empty string.
mandatory | boolean | false | Controls whether this binding is mandatory. If a `WebServiceRenderer` has any mandatory parameter bindings, its web service will not be invoked until all its bindings have a value which is non-null and not equal to the empty string. By default, all parameters are non-mandatory.

## Usage with class oracle.portal.provider.v2.webservice.WebServiceRenderer$URLParam

Syntax
`<param class="oracle.portal.provider.v2.webservice.WebServiceRenderer$URLParam"> <name trim="boolean">string</name> <default trim="boolean">string</default> <mandatory>boolean</mandatory> <prompt trim="boolean">string</prompt> </param>`
Simple Elements
Mandatory
Name | Type | Description
name | string | The binding name, which identifies the particular item of data it should be bound to.
Optional
Name | Type | Default | Description
default | string | none | The default value for this binding, returned by `getValue` when the binding value is `null` or the empty string.
mandatory | boolean | false | Controls whether this binding is mandatory. If a `WebServiceRenderer` has any mandatory parameter bindings, its web service will not be invoked until all its bindings have a value which is non-null and not equal to the empty string. By default, all parameters are non-mandatory.
prompt | string | Enter value for name | The default prompt to use for the input field corresponding to this item in the generated HTML form.

# parameter element

Defines the names and values of additional static parameters to be made available in the request to this renderer.

Describes object of class:
  `oracle.portal.utils.v2.NameValuePair`
May be a child of a
  showPage

Syntax
`<parameter class="oracle.portal.utils.v2.NameValuePair"> <name trim="boolean">string</name> <value trim="boolean">string</value> </parameter>`
Attributes
Mandatory
Name | Type | Description
class | java_class_name | Names a class which is either `oracle.portal.utils.v2.NameValuePair` or a subclass.
Simple Elements
Mandatory
Name | Type | Description
name | string | Identifying name for the parameter.
value | string | Value of the parameter, expressed as a string.