invalidate_cache procedure

Related topics

Contained in package wwpro_api_invalidation.

Call this procedure to invalidate the Web cache, given a set of parameters that together define a URL.

Note: The only required parameter is p_provider_id, all other parameters are optional and any combination of these parameters can be specified.

This API is provided for the more experienced user. Given the correct parameters, it invalidates the same content as the other invalidation APIs. It is provided as an additional invalidation utility for portlet developers.

procedure invalidate_cache
(

p_provider_id in NUMBER,
p_portletid in NUMBER default null,
p_instance_id in VARCHAR2 default null,
p_user in VARCHAR2 default null,
p_content_type in varchar2 default null,
p_language in varchar2 default null,
p_subscriber_id in NUMBER default null,
p_auth_level in varchar2 default null

);

Version: Oracle9iAS Portal 9.0.2 or later

Parameters:

p_provider_id

The ID of the provider.

Datatype: in number

p_portletid

The ID of the portlet.

Datatype: in number
Default: null

p_instance_id

The portlet instance ID.

A portlet instance is the display of a portlet on a single page. The same portlet may be displayed multiple times on the same page. Each time a portlet is added to a page, Oracle Portal generates a unique portlet instance ID that is the instance's reference path.

Datatype: in varchar2
Default: null

p_user

The Oracle Portal user.

Datatype: in varchar2
Default: null

p_content_type

The portal content type of the request, i.e. GENERIC_HTML, MOBILE, etc.

Datatype: in varchar2
Default: null

p_language

The language of the portlet content.

Datatype: in varchar2
Default: null

p_subscriber_id

The subscriber ID.

Note: This parameter is only relevant when Oracle Portal is run in hosted mode. For example, if a provider sending data to different subscribers wants to invalidate data for a particular subscriber, they would use this parameter.

Datatype: in number
Default: null

p_auth_level

(Applicable only when using Weak Authentication.)

The level of authentication used when caching content

Note: Currently Oracle Portal only supports values 0 (weakly authenticated) and 10 (strongly authenticated).

Datatype: in varchar2
Default: null

Exceptions:

This procedure raises no user-defined exceptions.

Example:

wwpro_api_invalidation.invalidate_cache
(

p_provider_id => 5,
p_portlet_id => 22,
p_instance_id => 80,
p_user => wwctx_api.get_user,
p_content_type => 'GENERIC_HTML’,
p_language => en_us,
p_subscriber_id => 1

);

Version: Oracle9iAS Portal 9.0.2 or later
Parameters:
p_provider_id	The ID of the provider. Datatype: in number
p_portletid	The ID of the portlet. Datatype: in number Default: null
p_instance_id	The portlet instance ID. A portlet instance is the display of a portlet on a single page. The same portlet may be displayed multiple times on the same page. Each time a portlet is added to a page, Oracle Portal generates a unique portlet instance ID that is the instance's reference path. Datatype: in varchar2 Default: null
p_user	The Oracle Portal user. Datatype: in varchar2 Default: null
p_content_type	The portal content type of the request, i.e. GENERIC_HTML, MOBILE, etc. Datatype: in varchar2 Default: null
p_language	The language of the portlet content. Datatype: in varchar2 Default: null
p_subscriber_id	The subscriber ID. Note: This parameter is only relevant when Oracle Portal is run in hosted mode. For example, if a provider sending data to different subscribers wants to invalidate data for a particular subscriber, they would use this parameter. Datatype: in number Default: null
p_auth_level	(Applicable only when using Weak Authentication.) The level of authentication used when caching content Note: Currently Oracle Portal only supports values 0 (weakly authenticated) and 10 (strongly authenticated). Datatype: in varchar2 Default: null
Exceptions: This procedure raises no user-defined exceptions. Example: wwpro_api_invalidation.invalidate_cache ( p_provider_id => 5, p_portlet_id => 22, p_instance_id => 80, p_user => wwctx_api.get_user, p_content_type => 'GENERIC_HTML’, p_language => en_us, p_subscriber_id => 1 );

Related topics
Provider invalidation API package	PDK PL/SQL API Reference - Home