Provider API packages

Related topics

This package topic gives an overview of the methods in the following API packages: wwpro_api_provider_registry. Use the provider registration methods to register and deregister providers and to do related tasks. wwpro_api_provider. Use the provider implementation methods to work with installed portlets. wwpro_api_parameters. Use the provider parameters methods to get the values of portlet parameters. wwpro_api_progrp_registry. Use the provider group registration methods to register and deregister provider groups and to do related tasks. wwpro_api_invalidation. Use the provider invalidation methods to invalidate the Web cache. wwpro_api_adapter. Use the provider adapter methods to work with portlets deployed via the PL/SQL HTTP Adapter. SNP portlet repository synchronization scripts. Use the portlet repository synchronization scripts to set and update an SNP job to synchronize portlet repositories and to remove an SNP synchronization job. Provider schema synonym scripts. Use the drop/create provider schema synonym scripts to associate a provider schema with a new portal schema. wwpro_api_node_registry. Use the node registration methods to register and deregister remote nodes and to do related tasks. (Deprecated Oracle9iAS Portal 9.0.2) SNP provider synchronization scripts. Use the provider synchronization scripts to set and update an SNP job to synchronize remote node providers and to remove an SNP provider synchronization job. (Deprecated Oracle9iAS Portal 9.0.2)   Provider registry API (wwpro_api_provider_registry) topic names and descriptions Installing a provider package and registering as a portlet provider Presents how to install a provider package and register as a portlet provider. provider_record record structure Presents the structure of the provider_record record and field descriptions. node_provider_ record record structure Presents the node_provider_record record structure and related information. Provider registry package constants Presents the constants that may be used by APIs in the provider registry package. register_provider function Registers a portlet provider and returns the provider ID. edit_provider procedure Updates portlet provider settings for a registered provider. deregister_provider procedure (id) Removes a provider's registration record from Oracle Portal, given the provider ID. deregister_provider procedure (owner) Removes a provider's registration record from Oracle Portal, given the name of the schema that owns the provider. is_null function Determines if a provider record has content. find_provider function (id) Returns a provider record in the language requested, given a provider ID. find_provider function (name) Returns a provider record in the language requested, given a provider name. get_provider function Returns a provider ID and a provider record, in the language requested, if available, and raises an exception if no provider is found. get_provider_list function Returns a provider name or a list of all portlet providers that match a specified name. get_encryption_key Returns the encryption key for a Web provider. print_provider procedure Prints, as dbms_output, the specified provider information. provider_exist function Determines whether a provider of a particular name exists. add_portlet_to_repository procedure Adds portlets to the portlet repository. remove_portlet_from_repository procedure Deletes portlets from the portlet repository. refresh_portlet_repository procedure Refreshes the portlet repository. Provider implementation API (wwpro_api_provider) topic names and descriptions Portlets Introduces portlets. Database provider implementation Introduces the provider implementation PL/SQL methods. Constants that providers can use Presents constants that can be used by the provider framework methods. Exceptions that providers can raise Presents exceptions that can be raised by the provider framework methods. portlet_record record structure and table Describes the portlet_record record structure and presents related information. portlet_parameter_record record structure and table Describes the portlet_parameter_record record structure and presents related information. portlet_instance_ record record structure and table Describes the portlet_instance_record record structure and presents related information. portlet_runtime_ record record structure Describes the portlet_runtime_record_record structure and presents related information. copy_portlet_record record structure and table Contains the details necessary to copy a portlet. cookie_record record structure and table Describes the cookie_record record structure and presents related information. get_portlet function Returns details of the specified portlet in portlet_record record structure. get_portlet_list function Returns a list of portlets available from a provider. get_api_version function Returns the API version of the provider's implementation. do_login procedure Allows a provider to do special processing before a portlet is executed. show_portlet procedure Displays a portlet page based on a mode. is_portlet_runnable function Determines if a portlet can be run. It can be used to determine if a user can execute the portlet. It runs before exposing a portlet instance. register_portlet procedure Allows a portlet to do instance-level initialization. deregister_portlet procedure Allows a portlet to do instance-level cleanup. copy_portlet procedure Copies a portlet's customization and default settings from a portlet instance to a new portlet instance. describe_portlet_ parameters function Returns the portlet parameter table. register_provider procedure Allows providers to do provider-level initializations. deregister_provider procedure Allows the provider to do provider-level processing due to deregistration. Provider parameters API (wwpro_api_parameters) topic names and descriptions Passing public parameters Introduces the methods of the provider parameters API package. Scoping parameters Explains how to use scoped names with the parameters in the wwpro_api_parameters API package. get_value function Returns a parameter value, given the parameter name and reference path. get_values function (single parameter name) Returns all the values associated with a single parameter name. If no match, returns an empty list. get_values function (multiple parameter names) Returns all the values associated with a list of parameter names. If no match, returns an empty list. get_names function Returns a list of parameter names, given the portlet's reference path. retrieve procedure Retrieves a list of all the URL parameters (names and values), unchanged. retrieve function Retrieves a list of all the URL parameters (names and values), unchanged. Provider group API (wwpro_api_progrp_registry) topic names and descriptions Provider groups Introduces provider groups. Provider group API exceptions Presents the exceptions defined in the provider group API package. Provider group record and table structure Presents the record whose instances represent a single provider group. register function Registers a provider group for use with Oracle Portal. get_providers function Returns a list of providers defined in a particular provider group. register_provider procedure Registers a provider using registration metadata provided by a provider group service. edit procedure Updates the properties of a provider group. remove procedure Deletes a provider group. get_provider_group_list function Obtains a list of provider groups. find function (ID) Finds a provider group, given an ID. find function (name) Finds a provider group, given a name. Provider invalidation API (wwpro_api_invalidation) topic names and descriptions Web cache invalidation APIs Introduces Web cache invalidation APIs. invalidate_by_provider procedure Invalidates the Web cache, given a provider ID. invalidate_by_portlet procedure Invalidates the Web cache, given a portlet ID invalidate_by_user_provider procedure Invalidates the Web cache, given a user and provider ID. invalidate_by_user_portlet procedure Invalidates the Web cache, given a user and portlet ID. invalidate_by_instance procedure Invalidates the Web cache, given a portlet instance ID. invalidate_cache procedure Invalidates the Web cache, given a set of parameters that together define a URL. Provider adapter API (wwpro_api_adapter) topic names and descriptions PL/SQL HTTP Adapter Introduces the PL/SQL HTTP Adapter. is_call_via_adapter function Returns whether or not the current call is via the PL/SQL HTTP Adapter. open_form procedure Opens a form on a portlet's customize page. SNP portlet repository synchronization scripts Portlet repository synchronization scripts Introduces the portlet repository synchronization scripts. ptljbmng.sql synchronization script Synchronizes Oracle Portal portlet repositories at a specified interval. ptlrmsyn.sql synchronization script Removes the ptljbmng.sql job from the SNP job queue. Provider synonym scripts Provider synonym scripts Create/drop synonyms for Portal objects using provsynr.sql and provsyns.sql. Node registry API (wwpro_api_node_registry) topic names and descriptions Methods in this package are deprecated in Oracle9iAS Portal 9.0.2. Only the get_local_node_id function remains valid. The functionality has been replaced with provider group APIs, see above. Node registration Introduces and explains node registry concepts. node_record record structure and tables Describes the node_registry_record record structure and related information. Node registry constants and variables Presents the constants and variables used by the node registry methods. Node registry exceptions Presents the exceptions that may be raised by node registry methods. register_node function Registers a remote provider node and returns the remote provider node's ID. edit_node procedure Changes registration information for a previously registered remote node. remove_node procedure Deregisters a remote provider node. get_node_list function Returns a list of all remote nodes that are registered with the host (local) node. find_node function (by ID) Returns the details of a registered remote node. Does not retrieve DBLink information. find_node function (by name) Returns the details of a registered node. Retrieves the node record and DBLink information. get_provider_list function (by ID) Returns a list of registered remote providers that belong to a specified node. get_provider_list function (by name) Returns a list of registered providers that belong to a specified node. sync_providers procedure Synchronizes the providers on remote nodes. get_local_node_id function Returns the ID of the local node. get_node function Returns node information for a specified provider. SNP provider synchronization scripts Deprecated in Oracle9iAS Portal 9.0.2 due to the introduction of provider groups. Provider synchronization scripts Introduces SNP processes and the provider synchronization scripts. projbmng.sql synchronization script Synchronizes Oracle Portal remote providers at a specified interval. prormsyn.sql synchronization script Removes the projbmng.sql job from the SNP job queue.

Related topics
PDK PL/SQL API Reference - Home

Back to top

The PL/SQL API Reference is part of the Portal Developer Kit on Portal Studio