1 package FND_WEB_CONFIG AUTHID CURRENT_USER as
2 /* $Header: AFWBCFGS.pls 115.12 2002/04/11 17:39:35 pkm ship $ */
3
4
5 /* PLSQL_AGENT- get the name of the PLSQL web agent
6 **
7 ** Returns the value of the APPS_WEB_AGENT profile, with
8 ** a guaranteed trailing slash.
9 **
10 ** Note: if this routine fails, it will return NULL, and
11 ** there will be an error message on the message stack.
12 ** The caller is responsible for either displaying the message
13 ** or clearing the message stack upon failure.
14 **
15 ** IN:
16 ** help_mode - Look for HELP_WEB_AGENT profile over-ride
17 ** 'APPS' - Use APPS_WEB_AGENT
18 ** 'HELP' - Use HELP_WEB_AGENT
19 **
20 */
21 function PLSQL_AGENT (
22 help_mode in varchar2 default 'APPS')
23 return VARCHAR2;
24
25 /* WEB_SERVER- get the URL of the web server machine
26 **
27 ** Returns the value of the web server from the APPS_WEB_AGENT with
28 ** a guaranteed trailing slash.
29 **
30 ** e.g. if APPS_WEB_AGENT = 'http://mysun.us.oracle.com:1234/dad1'
31 ** it returns 'http://mysun.us.oracle.com:1234/'
32 **
33 ** Note: if this routine fails, it will return NULL, and
34 ** there will be an error message on the message stack.
35 ** The caller is responsible for either displaying the message
36 ** or clearing the message stack upon failure.
37 **
38 ** IN:
39 ** help_mode - Look for HELP_WEB_AGENT profile over-ride
40 ** 'APPS' - Use APPS_WEB_AGENT
41 ** 'HELP' - Use HELP_WEB_AGENT
42 **
43 */
44 function WEB_SERVER (
45 help_mode in varchar2 default 'APPS')
46 return VARCHAR2;
47
48 /* DAD- get the DAD component of the URL of the web server machine
49 **
50 ** Returns the value of the DAD (Database Access Descriptor) from the
51 ** APPS_WEB_AGENT with a guaranteed trailing slash.
52 **
53 ** e.g. if APPS_WEB_AGENT = 'http://mysun.us.oracle.com:1234/dad1'
54 ** it returns 'dad1/'
55 **
56 ** Note: if this routine fails, it will return NULL, and
57 ** there will be an error message on the message stack.
58 ** The caller is responsible for either displaying the message
59 ** or clearing the message stack upon failure.
60 **
61 ** IN:
62 ** help_mode - Look for HELP_WEB_AGENT profile over-ride
63 ** 'APPS' - Use APPS_WEB_AGENT
64 ** 'HELP' - Use HELP_WEB_AGENT
65 **
66 */
67 function DAD (
68 help_mode in varchar2 default 'APPS')
69 return VARCHAR2;
70
71 /* GFM_AGENT- get the GFM agent of the web server machine
72 **
73 ** Returns the value of the Generic File Manager agent by parsing
74 ** the APPS_WEB_AGENT. Has a guaranteed trailing slash.
75 **
76 ** Note: Now that we are using webdb, calling this routine is equivalent
77 ** to calling fnd_web_config.plsql_agent
78 **
79 ** Note: if this routine fails, it will return NULL, and
80 ** there will be an error message on the message stack.
81 ** The caller is responsible for either displaying the message
82 ** or clearing the message stack upon failure.
83 **
84 ** IN:
85 ** help_mode - Look for HELP_WEB_AGENT profile over-ride
86 ** 'APPS' - Use APPS_WEB_AGENT
87 ** 'HELP' - Use HELP_WEB_AGENT
88 **
89 */
90 function GFM_AGENT (
91 help_mode in varchar2 default 'APPS')
92 return VARCHAR2;
93
94 /* PROTOCOL- get the protocol identifier
95 **
96 ** Returns the protocol of the APPS_WEB_AGENT profile.
97 **
98 ** e.g. if APPS_WEB_AGENT = 'http://mysun.us.oracle.com:1234/dad1/plsql'
99 ** it returns 'http:'
100 **
101 ** Note: if this routine fails, it will return NULL, and
102 ** there will be an error message on the message stack.
103 ** The caller is responsible for either displaying the message
104 ** or clearing the message stack upon failure.
105 **
106 ** IN:
107 ** help_mode - Look for HELP_WEB_AGENT profile over-ride
108 ** 'APPS' - Use APPS_WEB_AGENT
109 ** 'HELP' - Use HELP_WEB_AGENT
110 **
111 */
112 function PROTOCOL (
113 help_mode in varchar2 default 'APPS')
114 return VARCHAR2;
115
116 /* TRAIL_SLASH- make sure there is a trailing slash on the URL passed in
117 **
118 ** If URL has a trailing slash, just returns URL
119 ** otherwise adds a trailing slash
120 **
121 */
122 function TRAIL_SLASH(INVAL in VARCHAR2) return VARCHAR2;
123
124 /* DATABASE_ID- get the database host id
125 **
126 ** Returns the database host id, lowercased.
127 **
128 ** The implementation will return an identifier which forms a unique
129 ** database identifier, suitable as a filename for the dbc file.
130 **
131 */
132 function DATABASE_ID return VARCHAR2;
133
134 /* JSP_AGENT- get the name of the apps JSP agent
135 **
136 ** Returns the value of the APPS_JSP_AGENT profile, with
137 ** a guaranteed trailing slash.
138 **
139 ** Note: if this routine fails, it will return NULL, and
140 ** there will be an error message on the message stack.
141 ** The caller is responsible for either displaying the message
142 ** or clearing the message stack upon failure.
143 **
144 */
145 function JSP_AGENT return VARCHAR2;
146
147 /*
148 ** check_enabled - Returns 'Y' if a PL/SQL procedure is enabled, 'N' otherwise.
149 */
150 function check_enabled (proc in varchar2) return varchar2;
151
152 END FND_WEB_CONFIG;
[Home] [Help]