Overview | Package | Object Type | Deprecated | Index | Help
| Oracle Application Server Portal PL/SQL API Reference - 10.1.4
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES
SUMMARY: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE | DETAIL: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE

## Package wwpob_smd

wwpob_smd - security metadata package The ESI stub in Web Cache calls the SMD API has_privilege to determine whether or not the user has permission to access a URL.

Scope:
  Public

Type Summary
`smd_status_record` Record for storing SMD status information. | `record`

Constant Summary
`STATUS_ACCESS_DENIED` | `number`
`STATUS_ACCESS_DENIED_PAGE_PTL` | `number`
`STATUS_ACCESS_GRANTED` | `number`
`STATUS_ACCESS_GRANTED_ITEM` | `number`
`STATUS_LOGIN_REQUIRED` | `number`
`STATUS_OBJECT_NOT_FOUND` | `number`
`STATUS_REDIRECT` | `number`
`STATUS_REDIRECT_SPLASH` | `number`
`STATUS_UNEXPECTED_ERROR` | `number`
`STATUS_USER_LEVEL_CACHED_PAGE` | `number`

Variable Summary
`empty_vc_arr` | `owa.vc_arr`

Function/Procedure Summary
`get_smd_login_url` Utility function for generating SMD related login URL. | `varchar2`
`has_privilege` The ESI stub calls this procedure to determine whether or not the user has permission to access the requested URL. | ``
`login` Performs a redirect to the login server and forwards the request URL to the login server. | ``
`redirect` Performs a redirect to the given URL. | ``
`show_error` Displays an error message in HTML. | ``

Type Detail

### smd_status_record

    type smd_status_record is record (
        code number,
        redirect_url varchar(32767),
        is_system_level_cached boolean,
        has_tabs boolean,
        search_key_header varchar(32767)
    )

  Record for storing SMD status information.

  Fields:
    `code` - a status code indicating the result of performing a URL validation, including URL parsing and security checks.
    `redirect_url` - during URL validation, if a URL other than the requested URL should be displayed, then that URL is placed in this field. The redirect URL is used to handle URL completion, custom error message handlers, and redirecting to login server.
    `is_system_level_cached` - TRUE if SMD should be cached at the system level. SMD can be system level cached if the URL is accessible by all users and the same pages or item would be rendered for all users. A public system level cached page with public tabs is accessible by all users. All users see the same page and tabset. A public user level cached page with public tabs is accessible by all users but all users may not see the same tabset since the visible tabs can be customized.
    `has_tabs` - TRUE if page being rendered has any tab regions.

Constant Detail

### STATUS_ACCESS_DENIED

    STATUS_ACCESS_DENIED constant number := 1

### STATUS_ACCESS_DENIED_PAGE_PTL

    STATUS_ACCESS_DENIED_PAGE_PTL constant number := 7

### STATUS_ACCESS_GRANTED

    STATUS_ACCESS_GRANTED constant number := 0

### STATUS_ACCESS_GRANTED_ITEM

    STATUS_ACCESS_GRANTED_ITEM constant number := 9

### STATUS_LOGIN_REQUIRED

    STATUS_LOGIN_REQUIRED constant number := 2

### STATUS_OBJECT_NOT_FOUND

    STATUS_OBJECT_NOT_FOUND constant number := 4

### STATUS_REDIRECT

    STATUS_REDIRECT constant number := 3

### STATUS_REDIRECT_SPLASH

    STATUS_REDIRECT_SPLASH constant number := 6

### STATUS_UNEXPECTED_ERROR

    STATUS_UNEXPECTED_ERROR constant number := 5

### STATUS_USER_LEVEL_CACHED_PAGE

    STATUS_USER_LEVEL_CACHED_PAGE constant number := 8

Variable Detail

### empty_vc_arr

    empty_vc_arr owa.vc_arr

Function/Procedure Detail

### get_smd_login_url

    function get_smd_login_url(
        p_url in varchar2,
        p_params in varchar2 default null,
        p_url_param_rewrite in boolean default false
    ) return varchar2

  Utility function for generating SMD related login URL.

  Parameters:
    `p_url` - the URL to be redirected to after logging in
    `p_params` - optional, parameters to be added to the given URL
    `p_url_param_rewrite` - optional, if TRUE then the constructed URL supports PPE URL parameter rewriting
  Returns:
    an SMD login URL that can be used by a midtier component to perform login and have the browser be redirected to the given URL after login

### has_privilege

    procedure has_privilege(
        name_array in owa.vc_arr default empty_vc_arr,
        value_array in owa.vc_arr default empty_vc_arr
    )

  The ESI stub calls this procedure to determine whether or not the user has permission to access the requested URL.

  Parameters:
    `name_array` - array of query string parameter names
    `value_array` - array of query string parameter values

### login

    procedure login(
        name_array in owa.vc_arr default empty_vc_arr,
        value_array in owa.vc_arr default empty_vc_arr
    )

  Performs a redirect to the login server and forwards the request URL to the login server.

  This procedure uses flexible parameter passing. The only parameters currently utilized are '_smd_login_url' and '_smd_forced_login'. This procedure returns an HTTP redirect response code specifying the login server as the redirect location. After a successful login, the user will be redirected again to the '_smd_login_url'. The '_smd_forced_login' parameter is optional, the default value is 'false', which results in normal authentication. A forced authentication request is made when this parameter is passed as 'true'.

  Parameters:
    `name_array` - names of URL querystring parameters
    `value_array` - values of URL querystring parameters

### redirect

    procedure redirect(
        name_array in owa.vc_arr default empty_vc_arr,
        value_array in owa.vc_arr default empty_vc_arr
    )

  Performs a redirect to the given URL.

  This procedure use flexible parameter passing. The only parameter currently utilized is the '_smd_redirect_url' parameter. This procedure returns an HTTP redirect response code specifying the value of the above parameter as the redirect location.

  Parameters:
    `name_array` - names of URL querystring parameters
    `value_array` - values of URL querystring parameters

### show_error

    procedure show_error(
        name_array in owa.vc_arr default empty_vc_arr,
        value_array in owa.vc_arr default empty_vc_arr
    )

  Displays an error message in HTML.

  This procedure use flexible parameter passing. The only parameters utilized are

  1. p_error_code
  2. p_domain
  3. p_sub_domain
  4. p_name
  5. p_context
  6. p_p1
  7. p_p2
  8. p_p3
  9. p_p4
  10. p_p5
  11. p_p6
  12. p_p7
  13. p_p8
  14. p_p9
  15. p_show_to_user

  Parameters:
    `name_array` - names of URL querystring parameters
    `value_array` - values of URL querystring parameters

Overview | Package | Object Type | Deprecated | Index | Help
| Oracle Application Server Portal PL/SQL API Reference - 10.1.4
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES
SUMMARY: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE | DETAIL: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE