18
DBMS_AQELM

The DBMS_AQELM package provides procedures to manage the configuration of Oracle Streams Advanced Queuing (AQ) asynchronous notification by e-mail and HTTP.

See Also: Oracle Streams Advanced Queuing User's Guide and Reference for detailed information about DBMS_AQELM

This chapter contains the following topic:

• Summary of DBMS_AQELM Subprograms

---

Summary of DBMS_AQELM Subprograms

Table 18-1 DBMS_ALERT Package Subprograms

Subprogram	Description
GET_MAILHOST Procedure	Gets the host name set by DBMS_AQELM.SET_MAILHOST for the SMTP server
GET_MAILPORT Procedure	Gets the port number for the SMTP server set by the DBMS_AQELM. SET_MAILPORT procedure or the default value, which is 25
GET_PROXY Procedure	Gets the proxy server name and no_proxy_domains set by DBMS_AQELM.SET_PROXY for HTTP notifications
GET_SENDFROM Procedure	Gets the sent-from e-mail address set by DBMS_AQELM.SET_SENDFROM procedure
SET_MAILHOST Procedure	Sets the host name for the SMTP server that the database will uses send out e-mail notifications
SET_MAILPORT Procedure	Sets the port number for the SMTP server
GET_MAILHOST Procedure	Gets the host name set by DBMS_AQELM.SET_MAILHOST for the SMTP server
SET_PROXY Procedure	Sets the proxy server name to be used for requests of HTTP protocol, excluding requests for hosts that belong to the domain specified in no_proxy_domains
SET_SENDFROM Procedure	Sets the sent-from e-mail address

---

GET_MAILHOST Procedure

This procedure gets the host name set by DBMS_AQELM.SET_MAILHOST for the SMTP server.

Syntax

DBMS_AQELM.GET_MAILHOST (
   mailhost  OUT VARCHAR2);

Parameters

Table 18-2  GET_MAILHOST Procedure Parameters

Parameter	Description
mailhost	SMTP server host name.

---

GET_MAILPORT Procedure

This procedure gets the port number for the SMTP server set by the DBMS_AQELM. SET_MAILPORT procedure or the default value, which is 25.

Syntax

DBMS_AQELM.GET_MAILPORT (
   mailport  OUT NUMBER);

Parameters

Table 18-3  GET_MAILPORT Procedure Parameters

Parameter	Description
mailport	SMTP server port number.

---

GET_PROXY Procedure

This procedure gets the proxy server name and no_proxy_domains set by DBMS_AQELM.SET_PROXY for HTTP notifications.

Syntax

DBMS_AQELM.GET_PROXY (
   proxy            OUT VARCHAR2,
   no_proxy_domains OUT VARCHAR2);

Parameters

Table 18-4  GET_PROXY Procedure Parameters

Parameter	Description
proxy	Proxy server host and port number.
no_proxy_domains	List of no-proxy domains or hosts.

---

GET_SENDFROM Procedure

This procedure gets the sent-from e-mail address set by DBMS_AQELM.SET_SENDFROM procedure.

Syntax

DBMS_AQELM.GET_SENDFROM (
   sendfrom  OUT  VARCHAR2);

Parameters

Table 18-5  GET_SENDFROM Procedure Parameters

Parameter	Description
sendfrom	The sent-from e-mail address.

---

SET_MAILHOST Procedure

This procedure sets the host name for the SMTP server. The database uses this SMTP server host name to send out e-mail notifications.

Syntax

DBMS_AQELM.SET_MAILHOST (
   mailhost  IN  VARCHAR2);

Parameters

Table 18-6  SET_MAILHOST Procedure Parameters

Parameter	Description
mailhost	SMTP server host name.

Usage Notes

As part of the configuration for e-mail notifications, a user with AQ_ADMINISTRATOR_ROLE or with EXECUTE permissions on the DBMS_AQELM package needs to set the host name before registering for e-mail notifications.

---

SET_MAILPORT Procedure

This procedure sets the port number for the SMTP server.

Syntax

DBMS_AQELM.SET_MAILPORT (
   mailport  IN NUMBER);

Parameters

Table 18-7  SET_MAILPORT Procedure Parameters

Parameter	Description
mailport	SMTP server port number.

Usage Notes

As part of the configuration for e-mail notifications, a user with AQ_ADMINISTRATOR_ROLE or with EXECUTE permissions on DBMS_AQELM package needs to set the port number before registering for e-mail notifications. The database uses this SMTP server port number to send out e-mail notifications. If not set, the SMTP mailport defaults to 25

---

SET_PROXY Procedure

This procedure sets the proxy server name to be used for requests of HTTP protocol, excluding requests for hosts that belong to the domain specified in no_proxy_domains.

Syntax

DBMS_AQELM.SET_PROXY (
   proxy            IN VARCHAR2,
   no_proxy_domains IN VARCHAR2 DEFAULT NULL);

Parameters

Table 18-8  SET_PROXY Procedure Parameters

Parameter	Description
proxy	Proxy server host and port number. The syntax is "[http://]host[:port][/]". For example, "www-proxy.my-company.com:80".
no_proxy_domains	List of no-proxy domains or hosts. The syntax is a list of host or domains, with optional port numbers separated by a comma, a semi-colon, or a space. For example, "corp.my-company.com, eng.my-company.com:80".

Usage Notes

The proxy server name can include an optional TCP/IP port number at which the proxy server listens. If the port is not specified for the proxy server, port 80 is assumed.

no_proxy_domains is a list of domains or hosts for which HTTP requests should be sent directly to the destination HTTP server instead of going through a proxy server. Optionally, a port number can be specified for each domain or host. If the port number is specified, the no-proxy restriction is only applied to the request at that port of the particular domain or host. When no_proxy_domains is NULL and the proxy server is set, all requests go through the proxy server. When the proxy server is not set, http_send sends the requests to the target Web servers directly.

As part of the configuration for HTTP notifications, a user with AQ_ADMINISTRATOR_ROLE or with EXECUTE permissions on the DBMS_AQELM package can choose to set the proxy server name and a list of no_proxy_domains, if required, before registering for HTTP notifications. The database will use this information to post HTTP notifications.

---

SET_SENDFROM Procedure

This procedure sets the sent-from e-mail address. This e-mail address is used in the sent-from field in all the e-mail notifications sent out by the database to the registered e-mail addresses.

Syntax

DBMS_AQELM.SET_SENDFROM (
   sendfrom  IN  VARCHAR2);

Parameters

Table 18-9  SET_SENDFROM Procedure Parameters

Parameter	Description
sendfrom	The sent-from e-mail address.

Usage Notes

As part of the configuration for e-mail notifications, a user with AQ_ADMINISTRATOR_ROLE or with EXECUTE permissions on the DBMS_AQELM package should set the sent-from address before registering for e-mail notifications