From Oracle
The UTL_HTTP package makes Hypertext Transfer Protocol (HTTP) callouts from SQL and PL/SQL. You
can use it to access data on the Internet over HTTP.
When the package fetches data from a Web site using HTTPS, it requires Oracle Wallet Manager which can be created by either Oracle Wallet Manager or the orapki utility. Non-HTTPS fetches do not require an Oracle wallet.
See Also:
-
Oracle Database Advanced Security Administrator's Guide for more information on Wallet Manager
This chapter contains the following topics:
-
-
Overview
-
Security Model
-
Constants
-
Datatypes
-
Operational Notes
-
Exceptions
-
Examples
-
-
-
Session Settings Subprograms
-
HTTP Requests Subprograms
-
HTTP Request Contexts Subprograms
-
HTTP Responses Subprograms
-
HTTP Cookies Subprograms
-
HTTP Persistent Connections Subprograms
-
Error Conditions Subprograms
-
Using UTL_HTTP
This section contains topics which relate to using the UTL_HTTP package.
Overview
With the UTL_HTTP package, you can write PL/SQL programs that communicate with Web (HTTP) servers. And UTL_HTTP contains
a function that can be used in SQL queries.
The package supports HTTP over the Secured Socket Layer protocol (SSL), also known as HTTPS. It also supports SSL client authentication by sending the client-certificate in a wallet to authenticate with the remote Web server.
Other Internet-related data-access protocols (such as the File Transfer Protocol (FTP) or the Gopher protocol) are also supported using an HTTP proxy server that supports those protocols.
Security Model
This package is an invoker's rights package and the invoking user will need the connect privilege granted in the access control list assigned to the remote network host to which he wants to connect,
as well as the use-client-certificates or the use-passwords privilege to authenticate himself with the remote Web server using the credentials stored in an Oracle wallet.
Note:
For more information, see Managing Fine-grained Access to External Network Services in Oracle Database Security GuideConstants
The UTL_HTTP package uses the constants shown in following tables.
Table 225-1 UTL_HTTP Constants - HTTP Versions
| Name | Type | Value | Description |
|---|---|---|---|
|
|
|
|
Denotes HTTP version 1.0 that can be used in the function |
|
|
|
|
Denotes HTTP version 1.1 that can be used in the function |
Table 225-2 UTL_HTTP Constants - Default Ports
| Name | Type | Value | Description |
|---|---|---|---|
|
|
|
|
The default TCP/IP port (80) at which a Web server or proxy server listens |
|
|
|
|
The default TCP/IP port (443) at which an HTTPS Web server listens |
Table 225-3 UTL_HTTP Constants - HTTP 1.1 Status Codes
| Name | Type | Value | Description |
|---|---|---|---|
|
|
|
|
The client should continue with its request. This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server. |
|
|
|
|
The server understands and is willing to comply with the client's request, through the Upgrade message header field, for a change in the application protocol being used on this connection. The server will switch protocols to those defined by the response's Upgrade header field immediately after the empty line which terminates the 101 response. |
|
|
|
|
The request has succeeded. The information returned with the response is dependent on the method used in the request |
|
|
|
|
The request has been fulfilled and resulted in a new resource being created. |
|
|
|
|
The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. |
|
|
|
|
The returned metainformation in the entity-header is not the definitive set as available from the origin server, but is gathered from a local or a third-party copy. |
|
|
|
|
The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation. |
|
|
|
|
The server has fulfilled the request and the user agent should reset the document view which caused the request to be sent. The response must not include an entity. |
|
|
|
|
The server has fulfilled the partial GET request for the resource. |
|
|
|
|
The requested resource corresponds to any one of a set of representations, each with its own specific location, and agent- driven negotiation information is being provided so that the user (or user agent) can select a preferred representation and redirect its request to that location. |
|
|
|
|
The requested resource has been assigned a new permanent URI and any future references to this resource should use one of the returned URIs. |
|
|
|
|
The requested resource resides temporarily under a different URI. |
|
|
|
|
The response to the request can be found under a different URI and should be retrieved using a GET method on that resource. |
|
|
|
|
If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server responds with this status code. |
|
|
|
|
The requested resource must be accessed through the proxy given by the Location field. The Location field gives the URI of the proxy. |
|
|
|
|
The requested resource resides temporarily under a different URI. |
|
|
|
|
The request could not be understood by the server due to malformed syntax. |
|
|
|
|
The request requires user authentication. The client may repeat the request with a suitable Authorization header field. If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. |
|
|
|
|
This code is reserved for future use. |
|
|
|
|
The server understood the request, but is refusing to fulfill it. |
|
|
|
|
The server has not found anything matching the Request-URI. |
|
|
|
|
The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request. |
|
|
|
|
This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy. |
|
|
|
|
The client did not produce a request within the time that the server was prepared to wait. |
|
|
|
|
The request could not be completed due to a conflict with the current state of the resource. |
|
|
|
|
The requested resource is no longer available at the server and no forwarding address is known. |
|
|
|
|
The server refuses to accept the request without a defined |
|
|
|
|
The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server. |
|
|
|
|
The server is refusing to process a request because the request entity is larger than the server is willing or able to process. |
|
|
|
|
The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret. |
|
|
|
|
The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method. |
|
|
|
|
A server returns a response with this status code if a request included a Range request-header field, and none of the range-specifier values in this field overlap the current extent of the selected resource, and the request did not include an If-Range request-header field. |
|
|
|
|
The expectation given in an Expect request-header field could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server. |
|
|
|
|
The server does not support the functionality required to fulfill the request. |
|
|
|
|
The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request |
|
|
|
|
The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. |
|
|
|
|
The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (for example, HTTP, FTP, LDAP) or some other auxiliary server (for example, DNS) it needed to access in attempting to complete the request. |
|
|
|
|
The server does not support, or refuses to support, the HTTP protocol version that was used in the request message. |
Datatypes
REQ Type
Use this PL/SQL record type to represent an HTTP request.
TYPE req IS RECORD ( url VARCHAR2(32767), method VARCHAR2(64), http_version VARCHAR2(64));
Table 225-4 REQ Type Parameters
| Parameter | Description |
|---|---|
|
|
The URL of the HTTP request. It is set after the request is created by |
|
|
The method to be performed on the resource identified by the URL. It is set after the request is created by |
|
|
The HTTP protocol version used to send the request. It is set after the request is created by |
The information returned in REQ from the interface begin_request is for read-only. Changing the field values in the record has no effect on the request.
There are other fields in REQ record type whose names begin with the prefix private_. The fields are private and are intended for use by implementation of theUTL_HTTP package.
You should not modify the fields.
REQUEST_CONTEXT_KEY Type
This type is used to represent the key to a request context. A request context is a context that holds a private wallet and cookie table to make a HTTP request. This private wallet and cookie table, unlike the session-wide ones maintained in the package, will not be shared with other HTTP requests within the database session.
SUBTYPE request_context_key IS PLS_INTEGER;
To provide enhanced security, UTL_HTTP allows PL/SQL programs to create request contexts. A request context is a private context
that holds a wallet and a cookie table that will not be shared with other programs in the same database session when making HTTP requests and receiving HTTP responses. PL/SQL programs should use request contexts when they need to use wallets or cookies that
contain sensitive information such as authentication credentials.
RESP Type
This PL/SQL record type is used to represent an HTTP response.
TYPE resp IS RECORD ( status_code PLS_INTEGER, reason_phrase VARCHAR2(256), http_version VARCHAR2(64));
Table 225-5 RESP Type Parameters
| Parameter | Description |
|---|---|
|
|
The status code returned by the Web server. It is a 3-digit integer that indicates the results of the HTTP request as handled by the Web server. It is set after the response is processed by |
|
|
The short textual message returned by the Web server that describe the status code. It gives a brief description of the results of the HTTP request as handled by the Web server. It is set after the
response is processed by |
|
|
The HTTP protocol version used in the HTTP response. It is set after the response is processed by |
The information returned in RESP from the interface GET_RESPONSE is read-only. There are other fields in the RESP record type
whose names begin with the prefixprivate_. The fields are private and are intended for use by implementation of the UTL_HTTP package.
You should not modify the fields.
COOKIE and COOKIE_TABLE Types
The COOKIE type is the PL/SQL record type that represents an HTTP cookie. The COOKIE_TABLE type is a PL/SQL index-by-table type that represents a collection of
HTTP cookies.
TYPE cookie IS RECORD ( name VARCHAR2(256), value VARCHAR2(1024), domain VARCHAR2(256), expire TIMESTAMP WITH TIME ZONE, path VARCHAR2(1024), secure BOOLEAN, version PLS_INTEGER, comment VARCHAR2(1024)); TYPE cookie_table IS TABLE OF cookie INDEX BY binary_integer;
Table 225-6 shows the fields for the COOKIE and COOKIE_TABLE record
types.
Table 225-6 Fields of COOKIE and COOKIE_TABLE Type
| Field | Description |
|---|---|
|
|
The name of the HTTP cookie |
|
|
The value of the cookie |
|
|
The domain for which the cookie is valid |
|
|
The time by which the cookie will expire |
|
|
The subset of URLs to which the cookie applies |
|
|
Should the cookie be returned to the Web server using secured means only. |
|
|
The version of the HTTP cookie specification the cookie conforms. This field is |
|
|
The comment that describes the intended use of the cookie. This field is |
PL/SQL programs do not usually examine or change the cookie information stored in the UTL_HTTP package. The cookies are maintained
by the package transparently. They are maintained inside the UTL_HTTP package, and they last for the duration of the database session only. PL/SQL applications
that require cookies to be maintained beyond the lifetime of a database session can read the cookies using GET_COOKIES, store them persistently in a database table, and re-store the cookies back in the package using ADD_COOKIES in
the next database session. All the fields in the cookie record, except for the comment field, must be stored. Do not alter the cookie information, which can result in an application error in the Web server or compromise
the security of the PL/SQL and the Web server applications. See "Retrieving and Restoring Cookies".
CONNECTION Type
Use the PL/SQL record type to represent the remote hosts and TCP/IP ports of a network connection that is kept persistent after an HTTP request is completed, according to the HTTP 1.1 protocol specification. The persistent network
connection may be reused by a subsequent HTTP request to the same host and port. The subsequent HTTP request may be completed faster because the network connection latency is avoided. connection_table is a PL/SQL table of connection.
For a direct HTTP persistent connection to a Web server, the host and port fields contain the host name and TCP/IP port number of the Web server. Theproxy_host and proxy_port fields
are not set. For an HTTP persistent connection that was previously used to connect to a Web server using a proxy, theproxy_host and proxy_port fields contain the host name and TCP/IP port
number of the proxy server. The host and port fields are not set, which indicates that the persistent connection, while connected to a proxy server, is not bound to any particular target Web server. An HTTP persistent connection to a proxy server can be used
to access any target Web server that is using a proxy.
The SSL field indicates if Secured Socket Layer (SSL) is being used in an HTTP persistent connection. An HTTPS request is an HTTP request made over SSL. For an HTTPS (SSL) persistent connection connected
using a proxy, the host and port fields contain the host name and TCP/IP port number of the target HTTPS Web server and the fields will always be set. An HTTPS persistent connection to an HTTPS Web server using a proxy server can only be reused to make another
request to the same target Web server.
TYPE connection IS RECORD ( host VARCHAR2(256), port PLS_INTEGER, proxy_host VARCHAR2(256), proxy_port PLS_INTEGER, ssl BOOLEAN); TYPE connection_table IS TABLE OF connection INDEX BY BINARY_INTEGER;
Operational Notes
Operational Flow
The UTL_HTTP package provides access to the HTTP protocol. The interfaces must be called in the order shown in Figure
225-1, or an exception will be raised.
Figure 225-1 Flow of the Core UTL_HTTP Package
Description of "Figure 225-1 Flow of the Core UTL_HTTP Package"
The following can be called at any time:
-
Non-protocol interfaces that manipulate cookies
-
GET_COOKIE_COUNT -
GET_COOKIES -
ADD_COOKIES -
CLEAR_COOKIES
-
-
Persistent connections
-
GET_PERSISTENT_CONN_COUNT -
GET_PERSISTENT_CONNS -
CLOSE_PERSISTENT_CONN -
CLOSE_PERSISTENT_CONNS
-
-
Interfaces that manipulate attributes and configurations of the
UTL_HTTPpackage in the current session-
SET_PROXY -
GET_PROXY -
SET_COOKIE_SUPPORT -
GET_COOKIE_SUPPORT -
SET_FOLLOW_REDIRECT -
GET_FOLLOW_REDIRECT -
SET_BODY_CHARSET -
GET_BODY_CHARSET -
SET_PERSISTENT_CONN_SUPPORT -
GET_PERSISTENT_CONN_SUPPORT -
SET_DETAILED_EXCP_SUPPORT -
GET_DETAILED_EXCP_SUPPORT -
SET_WALLET -
SET_TRANSFER_TIMEOUT -
GET_TRANSFER_TIMEOUT
-
-
Interfaces that retrieve the last detailed exception code and message
UTL_HTTPpackage in the current session-
GET_DETAILED_SQLCODE -
GET_DETAILED_SQLERRMNOTE:
Some of the request and response interfaces bear the same name as the interface that manipulates the attributes and configurations of the package in the current session. They are overloaded versions of the interface that manipulate a request or a response.
-
Simple HTTP Fetches
REQUEST and REQUEST_PIECES take a string uniform resource locator (URL), contact that site, and return the data (typically HTML) obtained from that site.
You should not expect REQUEST or REQUEST_PIECES to succeed in contacting a URL unless you can contact that URL by using a browser on the same machine (and with
the same privileges, environment variables, and so on.)
If REQUEST or REQUEST_PIECES fails (for example, if it raises an exception, or if it returns an HTML-formatted error message, but you believe that the URL argument
is correct), then try contacting that same URL with a browser to verify network availability from your machine. You may have a proxy server set in your browser that needs to be set with each REQUEST or REQUEST_PIECES call
using the optional proxy parameter.
Note:
UTL_HTTP can also use environment variables to specify its proxy behavior. For example, on UNIX, setting the environment variable http_proxy to
a URL uses that service as the proxy server for HTTP requests. Setting the environment variableno_proxy to a domain name does not use the HTTP proxy server for URLs in that domain. When the UTL_HTTP package
is executed in the Oracle database server, the environment variables are the ones that are set when the database instance is started.HTTP Requests
The HTTP Requests group of subprograms begin an HTTP request, manipulate attributes, and send the request information to the Web server. When a request is created, it inherits the default settings of the HTTP cookie support, follow-redirect, body character set, persistent-connection support, and transfer timeout of the current session. The settings can be changed by calling the request interface.
See Also:
HTTP Requests SubprogramsHTTP Responses
The HTTP Responses group of subprograms manipulate an HTTP response obtained from GET_RESPONSE and receive response information from the Web server. When a response is created for a request, it inherits settings of the HTTP cookie support, follow-redirect, body character set, persistent-connection support, and transfer timeout from the request. Only the body character set can be changed by calling the response interface.
See Also:
HTTP Responses SubprogramsHTTP Cookies
The UTL_HTTP package provides subprograms to manipulate HTTP cookies.
See Also:
HTTP Cookies SubprogramsHTTP Persistent Connections
The UTL_HTTP package provides subprograms to manipulate persistent connections.
See Also:
HTTP Persistent Connections SubprogramsError Conditions
The UTL_HTTP package provides subprograms to retrieve error information.
See Also:
Error Conditions SubprogramsSession Settings
Session settings manipulate the configuration and default behavior of UTL_HTTP when HTTP requests are executed within a database
user session. When a request is created, it inherits the default settings of the HTTP cookie support, follow-redirect, body character set, persistent-connection support, and transfer timeout of the current session. Those settings can be changed later by calling
the request interface. When a response is created for a request, it inherits those settings from the request. Only the body character set can be changed later by calling the response interface.
See Also:
Session Settings SubprogramsRequest Context
The UTL_HTTP package maintains a common wallet and cookie table within the database session that all HTTP requests and responses
share. This makes it easy for users to share the wallet or to maintain application state in the cookies within the session. However, if an application stores private information in the wallet or in the cookies that it does not want to share with other applications
in the same database session, it may define a request context to hold its own wallet and cookie table and use this request context to make HTTP requests.
See Also:
HTTP Requests SubprogramsExternal Password Store
The UTL_HTTP package allows HTTP password credentials to be stored in an Oracle wallet's external password store. The external
password store provides an easy but secure storage for passwords and frees the application developers from the need to maintain their own storage.
See Also:
SET_AUTHENTICATION_FROM_WALLET ProcedureExceptions
Table 225-7 lists the exceptions that the UTL_HTTP package
interface can raise. By default, UTL_HTTP raises the exception request_failed when a request fails to execute. If the
package is set to raise a detailed exception by set_detailed_excp_support, the rest of the exceptions will be raised directly (except for the exception end_of_body, which will be raised
by READ_TEXT, READ_LINE, and READ_RAW regardless of the setting).
Table 225-7 UTL_HTTP Exceptions
| Exception | Error Code | Reason | Where Raised |
|---|---|---|---|
|
|
|
The argument passed to the interface is bad |
Any HTTP request or response interface when |
|
|
|
The requested URL is badly formed |
|
|
|
|
The end of HTTP response body is reached |
|
|
|
|
The header is not found |
|
|
|
|
From |
|
|
|
|
From |
|
|
|
|
Access to the remote network host or credentials in an Oracle wallet is denied |
|
|
|
|
The call to |
|
|
|
|
No complete character is read and a partial multibyte character is found at the end of the response body |
|
|
|
|
An HTTP protocol error occurs when communicating with the Web server |
|
|
|
|
The request fails to executes |
Any HTTP request or response interface when |
|
|
|
Too many requests or responses are open |
|
|
|
|
No data is read and a read timeout occurred |
|
|
|
|
The scheme of the requested URL is unknown |
|
NOTE:
Thepartial_multibyte_char and transfer_timeout exceptions are duplicates of the same exceptions defined in UTL_TCP. They are defined in this package
so that the use of this package does not require the knowledge of the UTL_TCP. As those exceptions are duplicates, an exception handle that catches the partial_multibyte_char and transfer_timeout exceptions
in this package also catch the exceptions in the UTL_TCP.For REQUEST and REQUEST_PIECES, the request_failed exception is raised when any exception occurs and detailed_exception is
disabled.
Examples
The following examples demonstrate how to use UTL_HTTP.
General Usage
SET SERVEROUTPUT ON SIZE 40000 DECLARE req UTL_HTTP.REQ; resp UTL_HTTP.RESP; value VARCHAR2(1024); BEGIN UTL_HTTP.SET_PROXY('proxy.my-company.com', 'corp.my-company.com'); req := UTL_HTTP.BEGIN_REQUEST('http://www-hr.corp.my-company.com'); UTL_HTTP.SET_HEADER(req, 'User-Agent', 'Mozilla/4.0'); resp := UTL_HTTP.GET_RESPONSE(req); LOOP UTL_HTTP.READ_LINE(resp, value, TRUE); DBMS_OUTPUT.PUT_LINE(value); END LOOP; UTL_HTTP.END_RESPONSE(resp); EXCEPTION WHEN UTL_HTTP.END_OF_BODY THEN UTL_HTTP.END_RESPONSE(resp); END;
Retrieving HTTP Response Headers
SET SERVEROUTPUT ON SIZE 40000 DECLARE req UTL_HTTP.REQ; resp UTL_HTTP.RESP; name VARCHAR2(256); value VARCHAR2(1024); BEGIN UTL_HTTP.SET_PROXY('proxy.my-company.com', 'corp.my-company.com'); req := UTL_HTTP.BEGIN_REQUEST('http://www-hr.corp.my-company.com'); UTL_HTTP.SET_HEADER(req, 'User-Agent', 'Mozilla/4.0'); resp := UTL_HTTP.GET_RESPONSE(req); DBMS_OUTPUT.PUT_LINE('HTTP response status code: ' || resp.status_code); DBMS_OUTPUT.PUT_LINE('HTTP response reason phrase: ' || resp.reason_phrase); FOR i IN 1..UTL_HTTP.GET_HEADER_COUNT(resp) LOOP UTL_HTTP.GET_HEADER(resp, i, name, value); DBMS_OUTPUT.PUT_LINE(name || ': ' || value); END LOOP; UTL_HTTP.END_RESPONSE(resp); END;
Handling HTTP Authentication
SET serveroutput ON SIZE 40000
CREATE OR REPLACE PROCEDURE get_page (url IN VARCHAR2,
username IN VARCHAR2 DEFAULT NULL,
password IN VARCHAR2 DEFAULT NULL,
realm IN VARCHAR2 DEFAULT NULL) AS
req UTL_HTTP.REQ;
resp UTL_HTTP.RESP;
my_scheme VARCHAR2(256);
my_realm VARCHAR2(256);
name VARCHAR2(256);
value VARCHAR2(256);
BEGIN
-- Turn off checking of status code. We will check it by ourselves.
UTL_HTTP.SET_RESPONSE_ERROR_CHECK(FALSE);
req := UTL_HTTP.BEGIN_REQUEST(url);
IF (username IS NOT NULL) THEN
UTL_HTTP.SET_AUTHENTICATION(req, username, password); -- Use HTTP Basic Authen. Scheme
END IF;
resp := UTL_HTTP.GET_RESPONSE(req);
IF (resp.status_code = UTL_HTTP.HTTP_UNAUTHORIZED) THEN
UTL_HTTP.GET_AUTHENTICATION(resp, my_scheme, my_realm, FALSE);
DBMS_OUTPUT.PUT_LINE('Web proxy server is protected.');
DBMS_OUTPUT.PUT('Please supplied the required ' || my_scheme || ' authentication username/password for realm ' || my_realm || ' for the proxy server.');
UTL_HTTP.END_RESPONSE(resp);
RETURN;
ELSIF (resp.status_code = UTL_HTTP.HTTP_PROXY_AUTH_REQUIRED) THEN
UTL_HTTP.GET_AUTHENTICATION(resp, my_scheme, my_realm, TRUE);
DBMS_OUTPUT.PUT_LINE('Web page ' || url || ' is protected.');
DBMS_OUTPUT.PUT('Please supplied the required ' || my_scheme || ' authentication username/password for realm ' || my_realm || ' for the Web page.');
UTL_HTTP.END_RESPONSE(resp);
RETURN;
END IF;
FOR i IN 1..UTL_HTTP.GET_HEADER_COUNT(resp) LOOP
UTL_HTTP.GET_HEADER(resp, i, name, value);
DBMS_OUTPUT.PUT_LINE(name || ': ' || value);
END LOOP;
UTL_HTTP.END_RESPONSE(resp);
END;
Retrieving and Restoring Cookies
CREATE TABLE my_cookies (
session_id INTEGER,
name VARCHAR2(256),
value VARCHAR2(1024),
domain VARCHAR2(256),
expire DATE,
path VARCHAR2(1024),
secure VARCHAR2(1),
version INTEGER);
CREATE SEQUENCE session_id;
SET SERVEROUTPUT ON SIZE 40000
REM Retrieve cookies from UTL_HTTP
CREATE OR REPLACE FUNCTION save_cookies RETURN PLS_INTEGER AS
cookies UTL_HTTP.COOKIE_TABLE;
my_session_id PLS_INTEGER;
secure VARCHAR2(1);
BEGIN
/* assume that some cookies have been set in previous HTTP requests. */
UTL_HTTP.GET_COOKIES(cookies);
SELECT session_id.nextval INTO my_session_id FROM DUAL;
FOR i in 1..cookies.count LOOP
IF (cookies(i).secure) THEN
secure := 'Y';
ELSE
secure := 'N';
END IF;
INSERT INTO my_cookies
VALUES (my_session_id, cookies(i).name, cookies(i).value,
cookies(i).domain,
cookies(i).expire, cookies(i).path, secure, cookies(i).version);
END LOOP;
RETURN my_session_id;
END;
/
REM Retrieve cookies from UTL_HTTP
CREATE OR REPLACE PROCEDURE restore_cookies (this_session_id IN PLS_INTEGER)
AS
cookies UTL_HTTP.COOKIE_TABLE;
cookie UTL_HTTP.COOKIE;
i PLS_INTEGER := 0;
CURSOR c (c_session_id PLS_INTEGER) IS
SELECT * FROM my_cookies WHERE session_id = c_session_id;
BEGIN
FOR r IN c(this_session_id) LOOP
i := i + 1;
cookie.name := r.name;
cookie.value := r.value;
cookie.domain := r.domain;
cookie.expire := r.expire;
cookie.path := r.path;
IF (r.secure = 'Y') THEN
cookie.secure := TRUE;
ELSE
cookie.secure := FALSE;
END IF;
cookie.version := r.version;
cookies(i) := cookie;
END LOOP;
UTL_HTTP.CLEAR_COOKIES;
UTL_HTTP.ADD_COOKIES(cookies);
END;
/
Making HTTP Request with Private Wallet and Cookie Table
SET SERVEROUTPUT ON SIZE 40000 CREATE OR REPLACE PROCEDURE DISPLAY_PAGE(url IN VARCHAR2) AS request_context UTL_HTPT.REQUEST_CONTEXT_KEY; req UTL_HTTP.REQ; resp UTL_HTTP.RESP; data VARCHAR2(1024); BEGIN -- Create a request context with its wallet and cookie table request_context := UTL_HTTP.CREATE_REQUEST_CONTEXT( wallet_path => 'file:/oracle/wallets/test/wallet', wallet_password => '******', enable_cookies => TRUE, max_cookies => 300, max_cookies_per_site => 20); -- Make a HTTP request using the private wallet and cookie -- table in the request context req := UTL_HTTP.BEGIN_REQUEST( url => url, request_context => request_context); resp := UTL_HTTP.GET_RESPONSE(req); BEGIN LOOP UTL_HTTP.READ_TEXT(resp, data); DBMS_OUTPUT.PUT(data); END LOOP; EXCEPTION WHEN UTL_HTTP.END_OF_BODY THEN UTL_HTTP.END_RESPONSE(resp); END; -- Destroy the request context UTL_HTTP.DESTROY_REQUEST_CONTEXT(request_context); END; BEGIN DISPLAY_PAGE('https://www.example.com/'); END; /
Subprogram Groups
UTL_HTTP subprograms are grouped by function:
Simple HTTP Fetches in a Single Call Subprograms
REQUEST and REQUEST_PIECES take a string uniform resource locator (URL), contact that site, and return the data (typically HTML) obtained from that site.
Table 225-8 UTL_HTTP Subprograms—Simple HTTP Fetches in a Single Call
| Subprogram | Description |
|---|---|
|
Returns up to the first 2000 bytes of the data retrieved from the given URL. This function can be used directly in SQL queries. |
|
|
Returns a PL/SQL table of 2000-byte pieces of the data retrieved from the given URL |
Session Settings Subprograms
Table 225-9 UTL_HTTP Subprograms—Session Settings
| Subprogram | Description |
|---|---|
|
Retrieves the default character set of the body of all future HTTP requests |
|
|
Retrieves the current cookie support settings |
|
|
Checks if the |
|
|
Retrieves the follow-redirect setting in the current session |
|
|
Checks if the persistent connection support is enabled and gets the maximum number of persistent connections in the current session |
|
|
Retrieves the current proxy settings |
|
|
Checks if the response error check is set or not |
|
|
Retrieves the current network transfer timeout value |
|
|
Sets the default character set of the body of all future HTTP requests when the media type is |
|
|
Sets whether or not future HTTP requests will support HTTP cookies; sets the maximum number of cookies maintained in the current database user session |
|
|
Sets the |
|
|
Sets the maximum number of times |
|
|
Sets whether or not future HTTP requests will support the HTTP 1.1 persistent connection; sets the maximum number of persistent connections maintained in the current database user session |
|
|
Sets the proxy to be used for requests of HTTP or other protocols |
|
|
Sets whether or not |
|
|
Sets the timeout value for |
|
|
Sets the Oracle Wallet used for all HTTP requests over Secured Socket Layer (SSL), that is, HTTPS |
HTTP Requests Subprograms
Table 225-10 UTL_HTTP Subprograms—HTTP Requests
| Subprogram | Description |
|---|---|
|
Begins a new HTTP request. |
|
|
Sets an HTTP request header. The request header is sent to the Web server as soon as it is set. |
|
|
Sets HTTP authentication information in the HTTP request header. The Web server needs this information to authorize the request. |
|
|
Sets the HTTP authentication information in the HTTP request header needed for the request to be authorized by the Web server using the username and password credential stored in the Oracle wallet. |
|
|
Sets the character set of the request body when the media type is |
|
|
Enables or disables support for the HTTP cookies in the request |
|
|
S |
|
|
Enables or disables support for the HTTP 1.1 persistent-connection in the request |
|
|
Writes a text line in the HTTP request body and ends the line with new-line characters (CRLF as defined in |
|
|
Writes some binary data in the HTTP request body |
|
|
Writes some text data in the HTTP request body |
HTTP Request Contexts Subprograms
HTTP Responses Subprograms
Table 225-12 UTL_HTTP Subprograms—HTTP Responses
| Subprogram | Description |
|---|---|
|
Ends the HTTP response. It completes the HTTP request and response. |
|
|
Retrieves the HTTP authentication information needed for the request to be accepted by the Web server as indicated in the HTTP response header |
|
|
Returns the nth HTTP response header name and value returned in the response |
|
|
Returns the HTTP response header value returned in the response given the name of the header |
|
|
Returns the number of HTTP response headers returned in the response |
|
|
Reads the HTTP response. When the function returns, the status line and the HTTP response headers have been read and processed. |
|
|
Reads the HTTP response body in text form until the end of line is reached and returns the output in the caller-supplied buffer |
|
|
Reads the HTTP response body in binary form and returns the output in the caller-supplied buffer |
|
|
Reads the HTTP response body in text form and returns the output in the caller-supplied buffer |
|
|
Sets the character set of the response body when the media type is "text" but the character set is not specified in the |
HTTP Cookies Subprograms
Table 225-13 UTL_HTTP Subprograms—HTTP Cookies
| Subprogram | Description |
|---|---|
|
Add the cookies either to a request context or to the |
|
|
Clears all the cookies maintained either in a request context or in the |
|
|
Returns the number of cookies maintained either in a request context or in the |
|
|
Returns all the cookies maintained either in a request context or in the |
HTTP Persistent Connections Subprograms
Table 225-14 UTL_HTTP Subprograms—HTTP Persistent Connections
| Subprogram | Description |
|---|---|
|
Closes an HTTP persistent connection maintained by the |
|
|
Closes a group of HTTP persistent connections maintained by the |
|
|
Returns the number of network connections currently kept persistent by the |
|
|
Returns all the network connections currently kept persistent by the |
Summary of UTL_HTTP Subprograms
Table 225-16 UTL_HTTP Package Subprograms
| Subprogram | Description | Group |
|---|---|---|
|
Add the cookies either to a request context or to the |
||
|
Begins a new HTTP request. |
||
|
Clears all the cookies maintained either in a request context or in the |
||
|
Closes an HTTP persistent connection maintained by the |
||
|
Closes a group of HTTP persistent connections maintained by the |
||
|
Creates a request context in |
||
|
Destroys a request context in |
||
|
Ends the HTTP request |
||
|
Ends the HTTP response. It completes the HTTP request and response |
||
|
Retrieves the HTTP authentication information needed for the request to be accepted by the Web server as indicated in the HTTP response header |
||
|
Retrieves the default character set of the body of all future HTTP requests |
||
|
Returns the number of cookies currently maintained by the |
||
|
Retrieves the current cookie support settings |
||
|
Returns all the cookies currently maintained by the |
||
|
Checks if the |
||
|
Retrieves the detailed |
||
|
Retrieves the detailed |
||
|
Retrieves the follow-redirect setting in the current session |
||
|
Returns the nth HTTP response header name and value returned in the response |
||
|
Returns the HTTP response header value returned in the response given the name of the header |
||
|
Returns the number of HTTP response headers returned in the response |
||
|
Returns the number of network connections currently kept persistent by the |
||
|
Sees whether or not future HTTP requests will support the HTTP 1.1 persistent connection; sets the maximum number of persistent connections maintained in the current database user session |
||
|
Checks if the persistent connection support is enabled and gets the maximum number of persistent connections in the current session (see Session Settings Subprograms) |
||
|
Returns all the network connections currently kept persistent by the |
||
|
Retrieves the current proxy settings |
||
|
Reads the HTTP response. When the function returns, the status line and the HTTP response headers have been read and processed |
||
|
Checks if the response error check is set or no |
||
|
Retrieves the current network transfer timeout value |
||
|
Reads the HTTP response body in text form until the end of line is reached and returns the output in the caller-supplied buffer |
||
|
Reads the HTTP response body in binary form and returns the output in the caller-supplied buffer |
||
|
Reads the HTTP response body in text form and returns the output in the caller-supplied buffer |
||
|
Returns up to the first 2000 bytes of the data retrieved from the given URL. This function can be used directly in SQL queries. |
||
|
Returns a PL/SQL table of 2000-byte pieces of the data retrieved from the given URL |
||
|
Sets HTTP authentication information in the HTTP request header. The Web server needs this information to authorize the request. |
||
|
Sets the HTTP authentication information in the HTTP request header needed for the request to be authorized by the Web server using the username and password credential stored in the Oracle wallet. |
||
|
Sets the default character set of the body of all future HTTP requests when the media type is |
||
|
Sets the character set of the request body when the media type is |
||
|
Sets the character set of the response body when the media type is "text" but the character set is not specified in the |
||
|
Enables or disables support for the HTTP cookies in the request |
||
|
Sets whether or not future HTTP requests will support HTTP cookies; sets the maximum number of cookies maintained in the current database user session |
||
|
Sets the |
||
|
Sets the maximum number of times |
||
|
Sets the maximum number of times |
||
|
Sets an HTTP request header. The request header is sent to the Web server as soon as it is set. |
||
|
Enables or disables support for the HTTP 1.1 persistent-connection in the request |
||
|
Sets the proxy to be used for requests of HTTP or other protocols |
||
|
Sets whether or not |
||
|
Sets the timeout value for |
||
|
Sets the Oracle Wallet used for all HTTP requests over Secured Socket Layer (SSL), that is, HTTPS |
||
|
Writes a text line in the HTTP request body and ends the line with new-line characters (CRLF as defined in UTL_TCP |
||
|
Writes some binary data in the HTTP request body |
||
|
Writes some text data in the HTTP request body |
ADD_COOKIES Procedure
This procedure adds the cookies either to a request context or to the UTL_HTTP package's session state.
UTL_HTTP.ADD_COOKIES (
cookies IN cookie_table,
request_context IN request_context_key DEFAULT NULL);
BEGIN_REQUEST Function
This functions begins a new HTTP request. UTL_HTTP establishes the network connection to the target Web server or the proxy server
and sends the HTTP request line. The PL/SQL program continues the request by calling some other interface to complete the request. The URL may contain the username and password needed to authenticate the request to the server. The format is
scheme://[user[:password]@]host[:port]/[...]
UTL_HTTP.BEGIN_REQUEST (
url IN VARCHAR2,
method IN VARCHAR2 DEFAULT 'GET',
http_version IN VARCHAR2 DEFAULT NULL,
request_context IN request_context_key DEFAULT NULL)
RETURN req;
Table 225-18 BEGIN_REQUEST Function Parameters
| Parameter | Description |
|---|---|
|
|
The URL of the HTTP request |
|
|
The method performed on the resource identified by the URL |
|
|
The HTTP protocol version that sends the request. The format of the protocol version is |
|
|
Request context that holds the private wallet and the cookie table to use in this |
-
The URL passed as an argument to this function is not examined for illegal characters, such as spaces, according to URL specification RFC 2396. You should escape those characters with the
UTL_URLpackage to return illegal and reserved characters. URLs should consist of US-ASCII characters only. See Chapter 239, "UTL_URL" for a list of legal characters in URLs. Note that URLs should consist of US-ASCII characters only. The use of non-US-ASCII characters in a URL is generally unsafe. -
BEGIN_REQUESTcan send a URL whose length is up to 32767 bytes. However, different Web servers impose different limits on the length of the URL they can accept. This limit is often about 4000 bytes. If this limit is exceeded, the outcome will depend on the Web server. For example, a Web server might simply drop the HTTP connection without returning a response of any kind. If this happens, a subsequent invocation of the GET_RESPONSE Function will raise thePROTOCOL_ERRORexception.A URL will be long when its
QUERY_STRING(that is, the information that follows the question mark (?)) is long. In general, it is better to send this parameterization in the body of the request using thePOSTmethod.req := UTL_HTTP.BEGIN_REQUEST (url=>the_url, method=>'POST'); UTL_HTTP.SET_HEADER (r => req, name => 'Content-Type', value => 'application/x-www-form-urlencoded'); UTL_HTTP.SET_HEADER (r => req, name => 'Content-Length', value =>' <length of data posted in bytes>'); UTL_HTTP.WRITE_TEXT (r => req, data => 'p1 = value1&p2=value2...'); resp := UTL_HTTP.GET_RESPONSE (r => req); ...
The programmer must determine whether a particular Web server may, or may not, accept data provided in this way.
-
An Oracle wallet must be set before accessing Web servers over HTTPS. See the SET_WALLET Procedure procedure on how to set up an Oracle wallet. To use SSL client authentication, the client certificate should be stored in the wallet and the caller must have the
use-client-certificatesprivilege on the wallet. See "Managing Fine-grained Access to External Network Services" in the Oracle Database Security Guide to grant the privilege. -
To connect to the remote Web server directly, or indirectly through a HTTP proxy, the
UTL_HTTPmust have theconnectACL privilege to the remote Web server host or the proxy host respectively.
CLEAR_COOKIES Procedure
This procedure clears all the cookies maintained either in a request context or in the UTL_HTTP package's session state.
CLOSE_PERSISTENT_CONN Procedure
This procedure closes an HTTP persistent connection maintained by the UTL_HTTP package in the current database session.
CLOSE_PERSISTENT_CONNS Procedure
This procedure closes a group of HTTP persistent connections maintained by the UTL_HTTP package in the current database session.
This procedure uses a pattern-match approach to decide which persistent connections to close.
To close a group of HTTP persistent connection that share a common property (for example, all connections to a particular host, or all SSL connections), set the particular parameters and leave the rest of the parameters NULL.
If a particular parameter is set to NULL when this procedure is called, that parameter will not be used to decide which connections to close.
For example, the following call to the procedure closes all persistent connections to foobar:
UTL_HTTP.CLOSE_PERSISTENT_CONNS(host => 'foobar');
And the following call to the procedure closes all persistent connections through the foobar at TCP/IP port 80:
UTL_HTTP.CLOSE_PERSISTENT_CONNS(proxy_host => 'foobar',
proxy_port => 80);
And the following call to the procedure closes all persistent connections:
UTL_HTTP.CLOSE_PERSISTENT_CONNS;
UTL_HTTP.CLOSE_PERSISTENT_CONNS (
host IN VARCHAR2 DEFAULT NULL,
port IN PLS_INTEGER DEFAULT NULL,
proxy_host IN VARCHAR2 DEFAULT NULL,
proxy_port IN PLS_INTEGER DEFAULT NULL,
ssl IN BOOLEAN DEFAULT NULL);
Table 225-21 CLOSE_PERSISTENT_CONNS Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The host for which persistent connections are to be closed |
|
|
The port number for which persistent connections are to be closed |
|
|
The proxy host for which persistent connections are to be closed |
|
|
The proxy port for which persistent connections are to be closed |
|
|
Close persistent SSL connection |
Connections to the same Web server at different TCP/IP ports are counted individually. The host names of the Web servers are identified as specified in the URL of the original HTTP requests. Therefore, fully qualified host names with domain names will be counted differently from the host names without domain names.
Note that the use of a NULL value in a parameter when this procedure is called means that the caller does not care about its value when the package decides which persistent connection to close. If
you want a NULL value in a parameter to match only a NULL value of the parameter of a persistent connection (which is when you want to close a specific persistent connection), you should
use the CLOSE_PERSISTENT_CONN procedure that closes a specific persistent connection.
CREATE_REQUEST_CONTEXT Function
This function creates a request context. A request context is a context that holds a wallet and a cookie for private use in making a HTTP request. This allows the HTTP request to use a wallet and a cookie table that will not be shared with other applications making HTTP requests in the same database session.
UTL_HTTP.CREATE_REQUEST_CONTEXT (
wallet_path IN VARCHAR2 DEFAULT NULL,
wallet_password IN VARCHAR2 DEFAULT NULL,
enable_cookies IN BOOLEAN DEFAULT TRUE,
max_cookies IN PLS_INTEGER DEFAULT 300,
max_cookies_per_site IN PLS_INTEGER DEFAULT 20)
RETURN request_context_key;
Table 225-22 CREATE_REQUEST_CONTEXT Function Parameters
| Parameter | Description |
|---|---|
|
|
Directory path that contains the Oracle wallet. The format is |
|
|
The password needed to open the wallet. If the wallet is auto-login enabled, the password may be omitted and should be set to |
|
|
Sets whether HTTP requests using this request context should support HTTP cookies or not: |
|
|
Sets the maximum total number of cookies that will be maintained in this request context |
|
|
Sets the maximum number of cookies per each Web site that will be maintained in this request context |
DECLARE request_context UTL_HTTP.REQUEST_CONTEXT_KEY; req utl_http.req; BEGIN request_context := UTL_HTTP.CREATE_REQUEST_CONTEXT( wallet_path => 'file:/oracle/wallets/test_wallets', wallet_password => NULL, enable_cookies => TRUE, max_cookies => 300, max_cookies_per_site => 20); req := UTL_HTTP.BEGIN_REQUEST( url => 'http://www.example.com/', request_context => request_context); END;
DESTROY_REQUEST_CONTEXT Procedure
This procedure destroys a request context in UTL_HTTP. A request context cannot be destroyed when it is in use by a HTTP request
or response.
END_REQUEST Procedure
This procedure ends the HTTP request. To terminate the HTTP request without completing the request and waiting for the response, the program can call this procedure. Otherwise, the program should go through the normal sequence of beginning a request, getting the response, and closing the response. The network connection will always be closed and will not be reused.
END_RESPONSE Procedure
This procedure ends the HTTP response. It completes the HTTP request and response. Unless HTTP 1.1 persistent connection is used in this request, the network connection is also closed.
GET_AUTHENTICATION Procedure
This procedure retrieves the HTTP authentication information needed for the request to be accepted by the Web server as indicated in the HTTP response header.
UTL_HTTP.GET_AUTHENTICATION(
r IN OUT NOCOPY resp,
scheme OUT VARCHAR2,
realm OUT VARCHAR2,
for_proxy IN BOOLEAN DEFAULT FALSE);
Table 225-26 GET_AUTHENTICATION Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The HTTP response |
|
|
The scheme for the required HTTP authentication |
|
|
The realm for the required HTTP authentication |
|
|
Returns the HTTP authentication information required for the access to the HTTP proxy server instead of the Web server? Default is |
When a Web client is unaware that a document is protected, at least two HTTP requests are required for the document to be retrieved. In the first HTTP request, the Web client makes the request without supplying required authentication
information; so the request is denied. The Web client can determine the authentication information required for the request to be authorized by calling GET_AUTHENTICATION. The Web client makes the second request and supplies
the required authentication information with SET_AUTHORIZATION. If the authentication information can be verified by the Web server, the request will succeed and the requested document is returned. Before making the request,
if the Web client knows that authentication information is required, it can supply the required authentication information in the first request, thus saving an extra request.
GET_BODY_CHARSET Procedure
This procedure retrieves the default character set of the body of all future HTTP requests.
GET_COOKIE_COUNT Function
This function returns the number of cookies maintained either in a request context or in the UTL_HTTP package's session state.
UTL_HTTP.GET_COOKIE_COUNT (
request_context IN request_context_key DEFAULT NULL)
RETURN PLS_INTEGER;
GET_COOKIE_SUPPORT Procedure
This procedure retrieves the current cookie support settings.
UTL_HTTP.GET_COOKIE_SUPPORT (
enable OUT BOOLEAN,
max_cookies OUT PLS_INTEGER,
max_cookies_per_site OUT PLS_INTEGER);
Table 225-29 GET_COOKIE_SUPPORT Procedure Parameters
| Parameter | Description |
|---|---|
|
|
Indicates whether future HTTP requests should support HTTP cookies ( |
|
|
Indicates the maximum total number of cookies maintained in the current session |
|
|
Indicates the maximum number of cookies maintained in the current session for each Web site |
GET_COOKIES Function
This function returns all the cookies maintained either in a request context or in the UTL_HTTP package's session state.
UTL_HTTP.GET_COOKIES (
cookies IN OUT NOCOPY cookie_table,
request_context IN request_context_key DEFAULT NULL);
GET_DETAILED_EXCP_SUPPORT Procedure
This procedure checks if the UTL_HTTP package will raise a detailed exception or not.
GET_DETAILED_SQLCODE Function
This function retrieves the detailed SQLCODE of the last exception raised.
GET_DETAILED_SQLERRM Function
This function retrieves the detailed SQLERRM of the last exception raised.
GET_FOLLOW_REDIRECT Procedure
This procedure retrieves the follow-redirect setting in the current session
GET_HEADER Procedure
This procedure returns the nth HTTP response header name and value returned in the response.
UTL_HTTP.GET_HEADER (
r IN OUT NOCOPY resp,
n IN PLS_INTEGER,
name OUT NOCOPY VARCHAR2,
value OUT NOCOPY VARCHAR2);
If the response body returned by the remote Web server is encoded in chunked transfer encoding format, the trailer headers that are returned at the end of the response body will be added to the response, and the response header count will be updated. You can retrieve the additional headers after the end of the response body is reached and before you end the response.
GET_HEADER_BY_NAME Procedure
This procedure returns the HTTP response header value returned in the response given the name of the header.
UTL_HTTP.GET_HEADER_BY_NAME(
r IN OUT NOCOPY resp,
name IN VARCHAR2,
value OUT NOCOPY VARCHAR2,
n IN PLS_INTEGER DEFAULT 1);
Table 225-34 GET_HEADER_BY_NAME Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The HTTP response |
|
|
The name of the HTTP response header for which the value is to return |
|
|
The value of the HTTP response header |
|
|
The nth occurrence of an HTTP response header by the specified name to return. The default is 1. |
If the response body returned by the remote Web server is encoded in chunked transfer encoding format, the trailer headers that are returned at the end of the response body will be added to the response, and the response header count will be updated. You can retrieve the additional headers after the end of the response body is reached and before you end the response.
GET_HEADER_COUNT Function
This function returns the number of HTTP response headers returned in the response.
If the response body returned by the remote Web server is encoded in chunked transfer encoding format, the trailer headers that are returned at the end of the response body will be added to the response, and the response header count will be updated. You can retrieve the additional headers after the end of the response body is reached and before you end the response.
GET_PERSISTENT_CONN_COUNT Function
This function returns the number of network connections currently kept persistent by the UTL_HTTP package to the Web servers.
Connections to the same Web server at different TCP/IP ports are counted individually. The host names of the Web servers are identified as specified in the URL of the original HTTP requests. Therefore, fully qualified host names with domain names will be counted differently from the host names without domain names.
GET_PERSISTENT_CONN_SUPPORT Procedure
This procedure checks:
-
If the persistent connection support is enabled
-
Gets the maximum number of persistent connections in the current session
GET_PERSISTENT_CONNS Procedure
This procedure returns all the network connections currently kept persistent by the UTL_HTTP package to the Web servers.
Connections to the same Web server at different TCP/IP ports are counted individually. The host names of the Web servers are identified as specified in the URL of the original HTTP requests. Therefore, fully qualified host names with domain names will be counted differently from the host names without domain names.
GET_RESPONSE Function
This function reads the HTTP response. When the function returns, the status line and the HTTP response headers have been read and processed. The status code, reason phrase, and the HTTP protocol version are stored in the response record. This function completes the HTTP headers section.
UTL_HTTP.GET_RESPONSE (
r IN OUT NOCOPY req,
return_info_response IN BOOLEAN DEFAULT FALSE)
RETURN resp;
Table 225-39 GET_RESPONSE Function Parameters
| Parameter | Description |
|---|---|
|
|
The HTTP response |
|
|
Return 100 informational response or not.
|
-
When detailed-exception is disabled:
ORA-29273 REQUEST_FAILED- the request fails to execute. Use the GET_DETAILED_EXCP_SUPPORT Procedure and the GET_DETAILED_SQLERRM Functionto get the detailed error message. -
When detailed-exception is enabled:
ORA-29261 BAD_ARGUMENT- some arguments passed are not valid -
When response error check is enabled:
ORA-29268 HTTP_CLIENT_ERROR- the response code is in 400 rangeORA-29269 HTTP_SERVER_ERROR- the response code is in 500 range
-
The request will be ended when this functions returns regardless of whether an exception is raised or not. There is no need to invoke theEND_REQUEST Procedure.
-
If URL redirection occurs, the URL and method fields in the
reqrecord will be updated to the last redirected URL and the method used to access the URL.
In certain situations (initiated by the HTTP client or not), the HTTP server may return a 1xx informational response. The user who does not expect such a response may indicate to GET_RESPONSE to
ignore the response and proceed to receive the regular response. In the case when the user expects such a response, the user can indicate to GET_RESPONSE to return the response.
For example, when a user is issuing a HTTP POST request with a large request body, the user may want to check with the HTTP server to ensure that the server will
accept the request before sending the data. To do so, the user will send the additional EXPECT: 100-CONTINUE request header, and check for 100 CONTINUEresponse from the server before proceeding
to send the request body. Then, the user will get the regular HTTP response.
The following code example illustrates this:
DECLARE data VARCHAR2(1024) := '...'; req utl_http.req; resp utl_http.resp; BEGIN req := utl_http.begin_request('http://www.acme.com/receiver', 'POST'); utl_http.set_header(req, 'Content-Length', length(data)); -- Ask HTTP server to return "100 Continue" response utl_http.set_header(req, 'Expect', '100-continue'); resp := utl_http.get_response(req, TRUE); -- Check for and dispose "100 Continue" response IF (resp.status_code <> 100) THEN utl_http.end_response(resp); raise_application_error(20000, 'Request rejected'); END IF; utl_http.end_response(resp); -- Now, send the request body utl_http.write_text(req, data); -- Get the regular response resp := utl_http.get_response(req); utl_http.read_text(resp, data); utl_http.end_response(resp); END;
GET_TRANSFER_TIMEOUT Procedure
This procedure retrieves the default timeout value for all future HTTP requests.
READ_LINE Procedure
This procedure reads the HTTP response body in text form until the end of line is reached and returns the output in the caller-supplied buffer. The end of line is as defined in the function read_line of
UTL_TCP. The end_of_body exception will be raised if the end of the HTTP response body is reached. Text data is automatically converted from the response body character set to the database character set.
UTL_HTTP.READ_LINE(
r IN OUT NOCOPY resp,
data OUT NOCOPY VARCHAR2 CHARACTER SET ANY_CS,
remove_crlf IN BOOLEAN DEFAULT FALSE);
The UTL_HTTP package supports HTTP 1.1 chunked transfer-encoding. When the response body is returned in chunked transfer-encoding
format as indicated in the response header, the package automatically decodes the chunks and returns the response body in de-chunked format.
If transfer timeout is set in the request of this response, read_line waits for each data packet to be ready to read until timeout occurs. If it occurs, this procedure stops reading and returns all
the data read successfully. If no data is read successfully, the transfer_timeout exception is raised. The exception can be handled and the read operation can be retried later.
If a partial multibyte character is found at the end of the response body, read_line stops reading and returns all the complete multibyte characters read successfully. If no complete character is
read successfully, the partial_multibyte_char exception is raised. The exception can be handled and the bytes of that partial multibyte character can be read as binary by the read_raw procedure.
If a partial multibyte character is seen in the middle of the response body because the remaining bytes of the character have not arrived and read timeout occurs, the transfer_timeout exception is raised instead. The exception
can be handled and the read operation can be retried later.
When the Content-Type response header specifies the character set of the response body and the character set is unknown or unsupported by Oracle, the "ORA-01482: unsupported character set" exception
is raised if you try to read the response body as text. You can either read the response body as binary using the READ_RAW procedure, or set the character set of the response body explicitly using the SET_BODY_CHARSET procedure
and read the response body as text again.
READ_RAW Procedure
This procedure reads the HTTP response body in binary form and returns the output in the caller-supplied buffer. The end_of_body exception will be raised if the end of the HTTP response body is reached.
UTL_HTTP.READ_RAW(
r IN OUT NOCOPY resp,
data OUT NOCOPY RAW,
len IN PLS_INTEGER DEFAULT NULL);
Table 225-43 READ_RAW Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The HTTP response |
|
|
The HTTP response body in binary form |
|
|
The number of bytes of data to read. If |
The UTL_HTTP package supports HTTP 1.1 chunked transfer-encoding. When the response body is returned in chunked transfer-encoding
format as indicated in the response header, the package automatically decodes the chunks and returns the response body in de-chunked format.
If transfer timeout is set in the request of this response, read_raw waits for each data packet to be ready to read until timeout occurs. If it occurs, read_rawstops
reading and returns all the data read successfully. If no data is read successfully, the transfer_timeout exception is raised. The exception can be handled and the read operation can be retried later.
READ_TEXT Procedure
This procedure reads the HTTP response body in text form and returns the output in the caller-supplied buffer. The end_of_body exception will be raised if the end of the HTTP response body is reached.
Text data is automatically converted from the response body character set to the database character set.
UTL_HTTP.READ_TEXT(
r IN OUT NOCOPY resp,
data OUT NOCOPY VARCHAR2 CHARACTER SET ANY_CS,
len IN PLS_INTEGER DEFAULT NULL);
Table 225-44 READ_TEXT Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The HTTP response |
|
|
The HTTP response body in text form |
|
|
The maximum number of characters of data to read. If |
The UTL_HTTP package supports HTTP 1.1 chunked transfer-encoding. When the response body is returned in chunked transfer-encoding
format as indicated in the response header, the package automatically decodes the chunks and returns the response body in de-chunked format.
If transfer timeout is set in the request of this response, read_text waits for each data packet to be ready to read until timeout occurs. If it occurs, this procedure stops reading and returns all
the data read successfully. If no data is read successfully, the transfer_timeout exception is raised. The exception can be handled and the read operation can be retried later.
If a partial multibyte character is found at the end of the response body, read_text stops reading and returns all the complete multibyte characters read successfully. If no complete character is
read successfully, the partial_multibyte_char exception is raised. The exception can be handled and the bytes of that partial multibyte character can be read as binary by the read_raw procedure.
If a partial multibyte character is seen in the middle of the response body because the remaining bytes of the character have not arrived and read timeout occurs, the transfer_timeout exception is raised instead. The exception
can be handled and the read operation can be retried later.
When the Content-Type response header specifies the character set of the response body and the character set is unknown or unsupported by Oracle, the "ORA-01482: unsupported
character set" exception is raised if you try to read the response body as text. You can either read the response body as binary using the READ_RAW procedure, or set the character set of the response body explicitly
using the SET_BODY_CHARSET procedure and read the response body as text again.
REQUEST Function
This function returns up to the first 2000 bytes of data retrieved from the given URL. This function can be used directly in SQL queries. The URL may contain the username and password needed to authenticate the request to the server. The format is
scheme://[user[:password]@]host[:port]/[...]
You can define a username/password for the proxy to be specified in the proxy string. The format is
[http://][user[:password]@]host[:port][/]
UTL_HTTP.REQUEST (
url IN VARCHAR2,
proxy IN VARCHAR2 DEFAULT NULL,
wallet_path IN VARCHAR2 DEFAULT NULL,
wallet_password IN VARCHAR2 DEFAULT NULL)
RETURN VARCHAR2;
Table 225-45 REQUEST Function Parameters
| Parameter | Description |
|---|---|
|
|
Uniform resource locator |
|
|
(Optional) Specifies a proxy server to use when making the HTTP request. See |
|
|
(Optional) Specifies a client-side wallet. The client-side wallet contains the list of trusted certificate authorities required for HTTPS request. The format of When the |
|
|
(Optional) Specifies the password required to open the wallet |
The return type is a string of length 2000 or less, which contains up to the first 2000 bytes of the HTML result returned from the HTTP request to the argument URL.
The URL passed as an argument to this function is not examined for illegal characters, for example, spaces, according to URL specification RFC 2396. The caller should escape those characters with the UTL_URL package. See the comments of the package for the list of legal characters in URLs. Note that URLs should consist of US-ASCII characters only. The use of non-US-ASCII characters in a URL is generally unsafe.
Please see the documentation of the function SET_WALLET on the use of an Oracle wallet, which is required for accessing HTTPS Web servers.
Unless response error check is turned on, this function does not raise an exception when a 4xx or 5xx response is received from the Web server. Instead, it returns the formatted error message from the Web server:
<HTML> <HEAD> <TITLE>Error Message</TITLE> </HEAD> <BODY> <H1>Fatal Error 500</H1> Can't Access Document: http://home.nothing.comm. <P> <B>Reason:</B> Can't locate remote host: home.nothing.comm. <P> <P><HR> <ADDRESS><A HREF="http://www.w3.org"> CERN-HTTPD3.0A</A></ADDRESS> </BODY> </HTML>
SQL> SELECT UTL_HTTP.REQUEST('http://www.my-company.com/') FROM DUAL; UTL_HTTP.REQUEST('HTTP://WWW.MY-COMPANY.COM/') <html> <head><title>My Company Home Page</title> <!--changed Jan. 16, 19 1 row selected.
If you are behind a firewall, include the proxy parameter. For example, from within the Oracle firewall, where there might be a proxy server named www-proxy.my-company.com:
SQLPLUS> SELECT
UTL_HTTP.REQUEST('http://www.my-company.com', 'www-proxy.us.my-company.com') FROM DUAL;
REQUEST_PIECES Function
This function returns a PL/SQL table of 2000-byte pieces of the data retrieved from the given URL. You can define a username/password for the proxy to be specified in the proxy string. The format is
[http://][user[:password]@]host[:port][/]
TYPE html_pieces IS TABLE OF VARCHAR2(2000) INDEX BY BINARY_INTEGER;
UTL_HTTP.REQUEST_PIECES (
url IN VARCHAR2,
max_pieces IN NATURAL DEFAULT 32767,
proxy IN VARCHAR2 DEFAULT NULL,
wallet_path IN VARCHAR2 DEFAULT NULL,
wallet_password IN VARCHAR2 DEFAULT NULL)
RETURN html_pieces;
Table 225-46 REQUEST_PIECES Function Parameters
| Parameter | Description |
|---|---|
|
|
Uniform resource locator |
|
|
(Optional) The maximum number of pieces (each 2000 characters in length, except for the last, which may be shorter), that |
|
|
(Optional) Specifies a proxy server to use when making the HTTP request. See |
|
|
(Optional) Specifies a client-side wallet. The client-side wallet contains the list of trusted certificate authorities required for HTTPS request. The format of wallet_path on a PC is, for example, See |
|
|
(Optional) Specifies the password required to open the wallet |
REQUEST_PIECES returns a PL/SQL table of type UTL_HTTP.HTML_PIECES.
Each element of that PL/SQL table is a string of maximum length 2000. The elements of the PL/SQL table returned by REQUEST_PIECES are successive pieces of the data obtained from the HTTP request to that URL.
The URL passed as an argument to this function will not be examined for illegal characters, for example, spaces, according to URL specification RFC 2396. The caller should escape those characters with the UTL_URL package.
See the comments of the package for the list of legal characters in URLs. Note that URLs should consist of US-ASCII characters only. The use of non-US-ASCII characters in a URL is generally unsafe.
Each entry of the PL/SQL table (the "pieces") returned by this function may not be filled to their fullest capacity. The function may start filling the data in the next piece before the previous "piece" is totally full.
Please see the documentation of the function SET_WALLET on the use of an Oracle wallet, which is required for accessing HTTPS Web servers.
Unless response error check is turned on, this function does not raise an exception when a 4xx or 5xx response is received from the Web server. Instead, it returns the formatted error message from the Web server:
<HTML> <HEAD> <TITLE>Error Message</TITLE> </HEAD> <BODY> <H1>Fatal Error 500</H1> Can't Access Document: http://home.nothing.comm. <P> <B>Reason:</B> Can't locate remote host: home.nothing.comm. <P> <P><HR> <ADDRESS><A HREF="http://www.w3.org"> CERN-HTTPD3.0A</A></ADDRESS> </BODY> </HTML>
SET SERVEROUTPUT ON DECLARE x UTL_HTTP.HTML_PIECES; len PLS_INTEGER; BEGIN x := UTL_HTTP.REQUEST_PIECES('http://www.oracle.com/', 100); DBMS_OUTPUT.PUT_LINE(x.count || ' pieces were retrieved.'); DBMS_OUTPUT.PUT_LINE('with total length '); IF x.count < 1 THEN DBMS_OUTPUT.PUT_LINE('0'); ELSE len := 0; FOR i in 1..x.count LOOP len := len + length(x(i)); END LOOP; DBMS_OUTPUT.PUT_LINE(len); END IF; END; / -- Output Statement processed. 4 pieces were retrieved. with total length 7687
SET_AUTHENTICATION Procedure
This procedure sets HTTP authentication information in the HTTP request header. The Web server needs this information to authorize the request.
UTL_HTTP.SET_AUTHENTICATION(
r IN OUT NOCOPY req,
username IN VARCHAR2,
password IN VARCHAR2,
scheme IN VARCHAR2 DEFAULT 'Basic',
for_proxy IN BOOLEAN DEFAULT FALSE);
Table 225-47 SET_AUTHENTICATION Procedure Parameters
| Parameter | Description |
|---|---|
|
|
HTTP request |
|
|
Username for the HTTP authentication |
|
|
Password for the HTTP authentication |
|
|
HTTP authentication scheme. Either |
|
|
Identifies if the HTTP authentication information is for access to the HTTP proxy server instead of the Web server. Default is |
SET_AUTHENTICATION_FROM_WALLET Procedure
This procedure sets the HTTP authentication information in the HTTP request header needed for the request to be authorized by the Web server using the username and password credential stored in the Oracle wallet.
UTL_HTTP.SET_AUTHENTICATION_FROM_WALLET(
r IN OUT NOCOPY req,
alias IN VARCHAR2,
scheme IN VARCHAR2 DEFAULT 'Basic',
for_proxy IN BOOLEAN DEFAULT FALSE);
Table 225-48 SET_AUTHENTICATION_FROM_WALLET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The HTTP request |
|
|
Alias to identify and retrieve the username and password credential stored in the Oracle wallet |
|
|
HTTP authentication scheme. Either |
|
|
Identifies if the HTTP authentication information is for access to the HTTP proxy server instead of the Web server. Default is |
-
To use the password credentials in a wallet, the
UTL_HTTPuser must have theuse-passwordsprivilege on the wallet. -
The supported authentication schemes are HTTP basic and Amazon S3 authentication schemes.
Creating a wallet and entering username and password in the wallet
> mkstore -wrl /oracle/wallets/test_wallet -create Enter password: ****** Enter password again: ****** > mkstore –wrl /oracle/wallets/test_wallet –createCredential hr-access jsmith Your secret/Password is missing in the command line Enter your secret/Password: **** Re-enter your secret/Password: **** Enter wallet password: ******
Granting the use-passwords privilege on the wallet to a user by the database administrator
BEGIN
DBMS_NETWORK_ACL_ADMIN.CREATE_ACL(
acl => 'wallet-acl.xml',
description => 'Wallet ACL',
principal => 'SCOTT',
is_grant => TRUE,
privilege => 'use-passwords');
DBMS_NETWORK_ACL_ADMIN.ASSIGN_WALLET_acl(
acl => 'wallet-acl.xml',
wallet_path => 'file: /oracle/wallets/test_wallet');
END;
Using username and password from the wallet
DECLARE req UTL_HTTP.req; BEGIN UTL_HTTP.SET_WALLET(path => 'file:/oracle/wallets/test_wallet'); req := UTL_HTTP.BEGIN_REQUEST(…); UTL_HTTP.SET_AUTHENTICATION_FROM_WALLET(req, 'hr-access'); … END;
SET_BODY_CHARSET Procedures
This procedure is overloaded. The description of different functionality is located alongside the syntax declarations.
See Also:
Sets the default character set of the body of all future HTTP requests when the media type is text and the character set is not specified in the Content-Typeheader.
Following the HTTP protocol standard specification, if the media type of a request or a response is text, but the character set information is missing in the Content-Type header, the character
set of the request or response body should default to ISO-8859-1. A response created for a request inherits the default body character set of the request instead of the body character set of the current session. The default
body character set is ISO-8859-1 in a database user session. The default body character set setting affects only future requests and has no effect on existing requests. After a request is created, the body character set can be changed by using the other SET_BODY_CHARSET procedure
that operates on a request:
UTL_HTTP.SET_BODY_CHARSET (
charset IN VARCHAR2 DEFAULT NULL);
Sets the character set of the request body when the media type is text but the character set is not specified in the Content-Type header. According to the HTTP
protocol standard specification, if the media type of a request or a response is "text" but the character set information is missing in the Content-Type header, the character set of the request or response body should default
to "ISO-8859-1". Use this procedure to change the default body character set a request inherits from the session default setting:
UTL_HTTP.SET_BODY_CHARSET(
r IN OUT NOCOPY req,
charset IN VARCHAR2 DEFAULT NULL);
Sets the character set of the response body when the media type is "text" but the character set is not specified in the Content-Type header. For each the HTTP protocol standard specification, if
the media type of a request or a response is "text" but the character set information is missing in the Content-Type header, the character set of the request or response body should default to "ISO-8859-1". Use this procedure
to change the default body character set a response inherits from the request:
UTL_HTTP.SET_BODY_CHARSET(
r IN OUT NOCOPY resp,
charset IN VARCHAR2 DEFAULT NULL);
Table 225-49 SET_BODY_CHARSET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The HTTP response. |
|
|
The default character set of the response body. The character set can be in Oracle or Internet Assigned Numbers Authority (IANA) naming convention. If |
SET_COOKIE_SUPPORT Procedures
This procedure is overloaded. The description of different functionality is located alongside the syntax declarations.
This procedure
See Also:
Enables or disables support for the HTTP cookies in the request. Use this procedure to change the cookie support setting a request inherits from the session default setting:
UTL_HTTP.SET_COOKIE_SUPPORT(
r IN OUT NOCOPY REQ,
enable IN BOOLEAN DEFAULT TRUE);
Sets whether or not future HTTP requests will support HTTP cookies, and the maximum number of cookies maintained in the current database user session:
UTL_HTTP.SET_COOKIE_SUPPORT (
enable IN BOOLEAN,
max_cookies IN PLS_INTEGER DEFAULT 300,
max_cookies_per_site IN PLS_INTEGER DEFAULT 20);
Table 225-50 SET_COOKIE_SUPPORT Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The HTTP request |
|
|
Set enable to |
|
|
Sets the maximum total number of cookies maintained in the current session |
|
|
Sets the maximum number of cookies maintained in the current session for each Web site |
If cookie support is enabled for an HTTP request, all cookies saved in the current session and applicable to the request are returned to the Web server in the request in accordance with HTTP cookie specification standards. Cookies
set in the response to the request are saved in the current session for return to the Web server in the subsequent requests if cookie support is enabled for those requests. If the cookie support is disabled for an HTTP request, no cookies are returned to the
Web server in the request and the cookies set in the response to the request are not saved in the current session, although the Set-CookieHTTP headers can still be retrieved from the response.
Cookie support is enabled by default for all HTTP requests in a database user session. The default setting of the cookie support (enabled versus disabled) affects only the future requests and has no effect on the existing ones. After
your request is created, the cookie support setting may be changed by using the other SET_COOKIE_SUPPORT procedure that operates on a request.
The default maximum number of cookies saved in the current session is 20 for each site and 300 total.
If you lower the maximum total number of cookies or the maximum number of cookies for each Web site, the oldest cookies will be purged first to reduce the number of cookies to the lowered maximum. HTTP cookies saved in the current session last for the duration of the database session only; there is no persistent storage for the cookies. Cookies saved in the current session are not cleared if you disable cookie support.
See "Examples" for how to use GET_COOKIES and ADD_COOKIES to
retrieve, save, and restore cookies.
SET_DETAILED_EXCP_SUPPORT Procedure
This procedure sets the UTL_HTTP package to raise a detailed exception. By default, UTL_HTTP raises
the request_failed exception when an HTTP request fails. Use GET_DETAILED_SQLCODE and GET_DETAILED_SQLEERM for more detailed information about the error.
SET_FOLLOW_REDIRECT Procedures
This procedure sets the maximum number of times UTL_HTTP follows the HTTP redirect instruction in the HTTP response to this request,
or future requests, in the GET_RESPONSE function.
See Also:
Use this procedure to set the maximum number of redirections:
UTL_HTTP.SET_FOLLOW_REDIRECT (
max_redirects IN PLS_INTEGER DEFAULT 3);
Use this procedure to change the maximum number of redirections a request inherits from the session default setting:
UTL_HTTP.SET_FOLLOW_REDIRECT(
r IN OUT NOCOPY req,
max_redirects IN PLS_INTEGER DEFAULT 3);
If max_redirects is set to a positive number, the GET_RESPONSE
Function will automatically follow the redirected URL for the HTTP response status code 301, 302, and 307 for the HTTP HEAD and GET methods, and 303 for all HTTP methods, and retry the HTTP request (the request method will be changed to HTTP GET for the
status code 303) at the new location. It follows the redirection until the final, non-redirect location is reached, or an error occurs, or the maximum number of redirections has been reached (to prevent an infinite loop). The URL and method fields in the REQ record
will be updated to the last redirected URL and the method used to access the URL. Set the maximum number of redirects to zero to disable automatic redirection.
While it is set not to follow redirect automatically in the current session, it is possible to specify individual HTTP requests to follow redirect instructions the function FOLLOW_REDIRECT and vice
versa.
The default maximum number of redirections in a database user session is 3. The default value affects only future requests and has no effect on existing requests.
The SET_FOLLOW_REDIRECT procedure must be called before GET_RESPONSE for any redirection to take effect.
SET_HEADER Procedure
This procedure sets an HTTP request header. The request header is sent to the Web server as soon as it is set.
Multiple HTTP headers with the same name are allowed in the HTTP protocol standard. Therefore, setting a header does not replace a prior header with the same name.
If the request is made using HTTP 1.1, UTL_HTTP sets the Host header automatically for you.
When you set the Content-Type header with this procedure, UTL_HTTP looks for the character
set information in the header value. If the character set information is present, it is set as the character set of the request body. It can be overridden later by using the SET_BODY_CHARSET procedure.
When you set the Transfer-Encoding header with the value chunked, UTL_HTTP automatically encodes
the request body written by the WRITE_TEXT, WRITE_LINEand WRITE_RAW procedures. Note that some HTTP-1.1-based Web servers or CGI programs do not support
or accept the request body encoding in the HTTP 1.1 chunked transfer-encoding format.
SET_PERSISTENT_CONN_SUPPORT Procedure
This procedure is overloaded. The description of different functionality is located alongside the syntax declarations.
Sets whether future HTTP requests should support the HTTP 1.1 persistent connection or not, and the maximum numbers of persistent connections to be maintained in the current database user session.
UTL_HTTP.SET_PERSISTENT_CONN_SUPPORT(
enable IN BOOLEAN DEFAULT FALSE,
max_conns IN PLS_INTEGER DEFAULT 0);
Enables or disables support for the HTTP 1.1 persistent-connection in the request.
UTL_HTTP.SET_PERSISTENT_CONN_SUPPORT(
r IN OUT NOCOPY req,
enable IN BOOLEAN DEFAULT FALSE);
If the persistent-connection support is enabled for an HTTP request, the package will keep the network connections to a Web server or the proxy server open in the package after the request is completed properly for a subsequent request to the same server to reuse for each HTTP 1.1 protocol specification. With the persistent connection support, subsequent HTTP requests may be completed faster because the network connection latency is avoided. If the persistent-connection support is disabled for a request, the package will always send the HTTP header "Connection: close" automatically in the HTTP request and close the network connection when the request is completed. This setting has no effect on HTTP requests that follows HTTP 1.0 protocol, for which the network connections will always be closed after the requests are completed.
When a request is being made, the package attempts to reuse an existing persistent connection to the target Web server (or proxy server) if one is available. If none is available, a new network connection will be initiated. The persistent-connection support setting for a request affects only whether the network connection should be closed after a request completes.
Use this procedure to change the persistent-connection support setting a request inherits from the session default setting.
Users should note that while the use of persistent connections in UTL_HTTP may reduce the time it takes to fetch multiple Web pages
from the same server, it consumes precious system resources (network connections) in the database server. Also, excessive use of persistent connections may reduce the scalability of the database server when too many network connections are kept open in the
database server. Network connections should be kept open only if they will be used immediately by subsequent requests and should be closed immediately when they are no longer needed. Set the default persistent connection support as disabled in the session,
and enable persistent connection in individual HTTP requests as shown below.
The default value of the maximum number of persistent connections in a database session is zero. To truly enable persistent connections, you must also set the maximum number of persistent connections to a positive value or no connections will be kept persistent.
Using SET_PERSISTENT_CONN_SUPPORT in http requests at the session level, showing the active persistent connection after each request
DECLARE pieces utl_http.html_pieces; conns utl_http.connection_table; BEGIN -- Turns on persistent connection support for the request_pieces call. utl_http.set_persistent_conn_support(true, 1); FOR i IN 1..10 LOOP pieces := utl_http.request_pieces('http://www.example.com/'); -- Shows the active persistent connection utl_http.get_persistent_conns(conns); FOR j IN 1..conns.count LOOP dbms_output.put_line('Persistent connection '||j||': '||conns(j).host||':'||conns(j).port); END LOOP; END LOOP; -- Turns off persistent connection support. Set active max persistent connection to 0 to close all active connections. utl_http.set_persistent_conn_support(false, 0); END; /
Using SET_PERSISTENT_CONN_SUPPORT in HTTP requets showing how to use persistent connection individually in each request to fetch multiple URLs at the same host
DECLARE -- Table to store the URLs TYPE vc2_table IS TABLE OF VARCHAR2(256) INDEX BY BINARY_INTEGER; paths VC2_TABLE; PROCEDURE fetch_pages(paths IN vc2_table) AS req UTL_HTTP.REQ; resp UTL_HTTP.RESP; data VARCHAR2(1024); BEGIN -- Set the proxy server UTL_HTTP.SET_PROXY('www-proxy.us.oracle.com:80', ''); FOR i IN 1..paths.count LOOP req := UTL_HTTP.BEGIN_REQUEST(paths(i)); -- Use persistent connections except for the last request IF (i < paths.count) THEN -- Use a persistent connection for the current request UTL_HTTP.SET_PERSISTENT_CONN_SUPPORT(req, TRUE); END IF; resp := UTL_HTTP.GET_RESPONSE(req); -- Display the results of the response DBMS_OUTPUT.PUT_LINE('-'); DBMS_OUTPUT.PUT_LINE('URL: ' || paths(i)); DBMS_OUTPUT.PUT_LINE('HTTP Response Status Code: ' || resp.status_code); DBMS_OUTPUT.PUT_LINE('HTTP Response Reason Phrase: ' || resp.reason_phrase); DBMS_OUTPUT.PUT_LINE('HTTP Response Version: ' || resp.http_version); BEGIN LOOP UTL_HTTP.READ_TEXT(resp, data); -- do something with the data END LOOP; EXCEPTION WHEN UTL_HTTP.END_OF_BODY THEN NULL; END; UTL_HTTP.END_RESPONSE(resp); END LOOP; END; BEGIN -- Set a maximum of 1 persistent connection, but start with persistent connections -- off UTL_HTTP.SET_PERSISTENT_CONN_SUPPORT(FALSE, 1); -- Create a list of URLs paths(1) := 'http://www.oracle.com/technetwork/index.html'; paths(2) := 'http://www.oracle.com/us/products/index.html'; fetch_pages(paths); END; /
SET_PROXY Procedure
This procedure sets the proxy to be used for requests of the HTTP or other protocols, excluding those for hosts that belong to the domain specified inno_proxy_domains.no_proxy_domains is a comma-,
semi-colon-, or space-separated 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.
The proxy may include an optional TCP/IP port number at which the proxy server listens. The syntax is [http://]host[:port][/], for example, www-proxy.my-company.com:80.
If the port is not specified for the proxy, port 80 is assumed.
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 the port of the particular domain or host, for example, corp.my-company.com,
eng.my-company.com:80. When no_proxy_domains is NULL and the proxy is set, all requests go through the proxy. When the proxy is not set, UTL_HTTP sends
requests to the target Web servers directly.
You can define a username/password for the proxy to be specified in the proxy string. The format is
[http://][user[:password]@]host[:port][/]
If proxy settings are set when the database server instance is started, the proxy settings in the environment variables http_proxy and no_proxy are assumed. Proxy
settings set by this procedure override the initial settings.
SET_RESPONSE_ERROR_CHECK Procedure
This procedure sets whether or not GET_RESPONSE raises an exception when the Web server returns a status code that indicates an error—a status code in the 4xx or 5xx ranges. For example, when the
requested URL is not found in the destination Web server, a 404 (document not found) response status code is returned.
If the status code indicates an error—a 4xx or 5xx code—and this procedure is enabled, GET_RESPONSE will raise the HTTP_CLIENT_ERROR or HTTP_SERVER_ERRORexception.
If SET_RESPONSE_ERROR_CHECK is set to FALSE, GET_RESPONSE will not raise an exception when the status code indicates an error.
Response error check is turned off by default.
The GET_RESPONSE function can raise other exceptions when SET_RESPONSE_ERROR_CHECK is set to FALSE.
SET_TRANSFER_TIMEOUT Procedure
This procedure sets the default time out value for all future HTTP requests that the UTL_HTTP package should attempt while reading
the HTTP response from the Web server or proxy server. This time out value may be used to avoid the PL/SQL programs from being blocked by busy Web servers or heavy network traffic while retrieving Web pages from the Web servers.
SET_WALLET Procedure
This procedure sets the Oracle wallet used for all HTTP requests over Secured Socket Layer (SSL), namely HTTPS. When the UTL_HTTP package
communicates with an HTTP server over SSL, the HTTP server presents its digital certificate, which is signed by a certificate authority, to the UTL_HTTPpackage
for identification purpose. The Oracle wallet contains the list of certificate authorities that are trusted by the user of the UTL_HTTP package. An Oracle
wallet is required to make an HTTPS request.
See Also:
-
"Managing Fine-Grained Access in PL/SQL Network Utility Packages" in the Oracle Database Security Guide
Table 225-58 SET_WALLET Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The directory path that contains the Oracle wallet. The format is The format of wallet_path on a PC is, for example, f |
|
|
The password needed to open the wallet. If the wallet is auto-login enabled, the password may be omitted and should be set to |
To set up an Oracle wallet, use the Oracle Wallet Manager to create a wallet. In order for the HTTPS request to succeed, the certificate authority that signs the certificate of the remote HTTPS Web server must be a trust point set in the wallet.
When a wallet is created, it is populated with a set of well-known certificate authorities as trust points. If the certificate authority that signs the certificate of the remote HTTPS Web server is not among the trust points, or the certificate authority has new root certificates, you should obtain the root certificate of that certificate authority and install it as a trust point in the wallet using Oracle Wallet Manager
See Also:
Oracle Database Advanced Security Administrator's Guide for more information on Wallet ManagerWRITE_LINE Procedure
This procedure writes a text line in the HTTP request body and ends the line with new-line characters (CRLF as defined in UTL_TCP). As soon as some data is sent as the HTTP request body, the HTTP
request headers section is completed. Text data is automatically converted from the database character set to the request body character set.
An HTTP client must always let the remote Web server know the length of the request body it is sending. If the amount of data is known beforehand, you can set the Content-Length header in the request,
where the length of the content is measured in bytes instead of characters. If the length of the request body is not known beforehand, you can send the request body using the HTTP 1.1 chunked transfer-encoding format. The request body is sent in chunks, where
the length of each chunk is sent before the chunk is sent. The UTL_HTTP package performs chunked transfer-encoding on the request body transparently when
the Transfer-Encoding: chunked header is set. Note that some HTTP-1.1-based Web servers or CGI programs do not support or accept the request body encoding in the HTTP 1.1 chunked transfer-encoding format. See the SET_HEADER procedure
for details.
If you send the Content-Length header, you should note that the length specified in the header should be the byte-length of the textual request body after it is converted from the database character
set to the request body character set. When either one of the two character sets is a multibyte character set, the precise byte-length of the request body in the request body character set cannot be known beforehand. In this case, you can perform the character
set conversion explicitly, determine the byte-length of the results, send the Content-Length header, and the results using the WRITE_RAW procedure to avoid the automatic character set
conversion. Or, if the remove Web server or CGI programs allow, you can send the request body using the HTTP 1.1 chunked transfer-encoding format, where UTL_HTTP handles
the length of the chunks transparently.
WRITE_RAW Procedure
This procedure writes some binary data in the HTTP request body. As soon as some data is sent as the HTTP request body, the HTTP request headers section is completed.
An HTTP client must always let the remote Web server know the length of the request body it is sending. If the amount of data is known beforehand, you can set the Content-Length header in the request,
where the length of the content is measured in bytes instead of characters. If the length of the request body is not known beforehand, you can send the request body using the HTTP 1.1 chunked transfer-encoding format. The request body is sent in chunks, where
the length of each chunk is sent before the chunk is sent. UTL_HTTP performs chunked transfer-encoding on the request body transparently when the Transfer-Encoding:chunked header
is set. Note that some HTTP-1.1-based Web servers or CGI programs do not support or accept the request body encoding in the HTTP 1.1 chunked transfer-encoding format. See the SET_HEADER procedure for details.
WRITE_TEXT Procedure
This procedure writes some text data in the HTTP request body. As soon as some data is sent as the HTTP request body, the HTTP request headers section is completed. Text data is automatically converted from the database character set to the request body character set.
An HTTP client must always let the remote Web server know the length of the request body it is sending. If the amount of data is known beforehand, you can set the Content-Length header in the request,
where the length of the content is measured in bytes instead of characters. If the length of the request body is not known beforehand, you can send the request body using the HTTP 1.1 chunked transfer-encoding format. The request body is sent in chunks, where
the length of each chunk is sent before the chunk is sent. UTL_HTTP performs chunked transfer-encoding on the request body transparently when the Transfer-Encoding:
chunked header is set. Note that some HTTP-1.1-based Web servers or CGI programs do not support or accept the request body encoding in the HTTP 1.1 chunked transfer-encoding format. See the SET_HEADER procedure for
details.
If you send the Content-Length header, you should note that the length specified in the header should be the byte-length of the textual request body after it is converted from the database character
set to the request body character set. When either one of the two character sets is a multibyte character set, the precise byte-length of the request body in the request body character set cannot be known beforehand. In this case, you can perform the character
set conversion explicitly, determine the byte-length of the results, send the Content-Length header, and the results using the WRITE_RAW procedure to avoid the automatic character set
conversion. Or, if the remove Web server or CGI programs allow, you can send the request body using the HTTP 1.1 chunked transfer-encoding format, where UTL_HTTP handles
the length of the chunks transparently.
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
From Others
Oracle UTL_HTTP Version 10.2
| General Information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Note: Makes Hypertext Transfer Protocol (HTTP) callouts from SQL and PL/SQL. Can be used to access data on the Internet over the HTTP protocol. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Source | {ORACLE_HOME}/rdbms/admin/utlhttp.sql | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| First Availability | 7.3.4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Constants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Data Types |
-- represent the remote hosts and TCP/IP ports of a network connection that is kept persistent after an HTTP request is completed, according to the HTTP 1.1 protocol specification.TYPE
connection IS RECORD ( host VARCHAR2(256), port PLS_INTEGER, proxy_host VARCHAR2(256), proxy_port PLS_INTEGER, ssl BOOLEAN); TYPE connection_table IS TABLE OF connection INDEX BY BINARY_INTEGER; -- A PL/SQL record type that represents a HTTP cookie TYPE cookie IS RECORD ( name VARCHAR2(256), -- Cookie name value VARCHAR2(1024), -- Cookie value domain VARCHAR2(256), -- Domain for which the cookie applies expire TIMESTAMP WITH TIME ZONE -- When should the cookie expire? path VARCHAR2(1024), -- Virtual path for which the cookie applies secure BOOLEAN, -- Transfer cookies by HTTPS only version PLS_INTEGER, -- Cookie specification version comment VARCHAR2(1024)); -- Comments about this cookie -- PL/SQL table of cookiesTYPE cookie_table IS TABLE OF cookie INDEX BY BINARY_INTEGER; -- VARCHAR2 table for returning HTML from request_pieces TYPE html_pieces IS TABLE OF VARCHAR2(2000) INDEX BY BINARY_INTEGER; -- A PL/SQL record type that represents a HTTP request TYPE req IS RECORD ( url VARCHAR2(32767 byte), -- Requested URL method VARCHAR2(64), -- Requested method http_version VARCHAR2(64), -- Requested HTTP version private_hndl PLS_INTEGER); -- For internal use only -- PL/SQL record type that represents a HTTP response TYPE resp IS RECORD ( status_code PLS_INTEGER, -- Response status code reason_phrase VARCHAR2(256), -- Response reason phrase http_version VARCHAR2(64), -- Response HTTP version private_hndl PLS_INTEGER); -- For internal use only /* Note: * - the "private_xxxx" field(s) in the req and resp record types are for * internal use only and users should not try to modify them. * - the HTTP information returned in the req and resp from the API * begin_request and get_response are for read only. Changing the * field values in the records has no effect to request or reesponse * when making calls to the API in this package. */ |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Dependencies |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Constants |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Security Model | ? | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ADD_COOKIES | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Adds the cookies maintained by UTL_HTTP |
utl_http.add_cookies(cookies IN cookie_table); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CREATE OR REPLACE PROCEDURE restore_cookies(this_session_id IN BINARY_INTEGER) AS cookies utl_http.cookie_table; cookie utl_http.cookie; i PLS_INTEGER := 0; CURSOR c (c_session_id BINARY_INTEGER) IS SELECT * FROM my_cookies WHERE session_id = c_session_id; BEGIN FOR r IN c(this_session_id) LOOP i := i + 1; cookie.name := r.name; cookie.value := r.value; cookie.domain := r.domain; cookie.expire := r.expire; cookie.path := r.path; IF (r.secure = 'Y') THEN cookie.secure := TRUE; ELSE cookie.secure := FALSE; END IF; cookie.version := r.version; cookies(i) := cookie; END LOOP; utl_http.clear_cookies; utl_http.add_cookies(cookies); END; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BEGIN_REQUEST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Begins a new HTTP request. When the function returns, the UTL_HTTP package has established the network connection to the target Web server, or the proxy server if a proxy server is to be used, and has sent the HTTP request line. The PL/SQL program should continue the request by calling some other API to complete the request. |
utl_http.begin_request( url IN VARCHAR2, method IN VARCHAR2 DEFAULT 'GET', http_version IN VARCHAR2 DEFAULT NULL) RETURN req; |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| set serveroutput on DECLARE req utl_http.req; resp utl_http.resp; value VARCHAR2(1024); BEGIN req := utl_http.begin_request('http://www.psoug.org'); utl_http.set_header(req, 'User-Agent', 'Mozilla/4.0'); resp := utl_http.get_response(req); LOOP utl_http.read_line(resp, value, TRUE); dbms_output.put_line(value); END LOOP; utl_http.end_response(resp); EXCEPTION WHEN utl_http.end_of_body THEN utl_http.end_response(resp); END; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CLEAR_COOKIES | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Clears all the cookies currently maintained by the UTL_HTTP package | utl_http.clear_cookies | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See ADD_COOKIES Demo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CLOSE_PERSISTENT_CONN | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Closes a HTTP persistent connection in the current session | utl_http.close_persistent_conn(conn IN connection); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CLOSE_PERSISTENT_CONNS | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Closes a group of HTTP persistent connections maintained by the UTL_HTTP package in the current database session. This procedure uses a pattern-match approach to decide which persistent connections to close. | utl_http.close_persistent_conns( host IN VARCHAR2 DEFAULT NULL, port IN PLS_INTEGER DEFAULT NULL, proxy_host IN VARCHAR2 DEFAULT NULL, proxy_port IN PLS_INTEGER DEFAULT NULL, ssl IN BOOLEAN DEFAULT NULL); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| exec utl_http.close_persistent_conns(host => 'washington.edu', proxy_port => 80); | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| END_REQUEST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Ends the HTTP request | utl_http.end_request(r IN OUT NOCOPY req); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| END_RESPONSE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Ends the HTTP response. This completes the HTTP request and response. Unless HTTP 1.1 persistent connection is used in this request, the network connection is closed. | utl_http.end_response(r IN OUT NOCOPY resp); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See BEGIN_REQUEST Demo / See SET_AUTHENTICATION Demo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_AUTHENTICATION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Retrieves the HTTP authentication information needed for the request to be accepted by the Web server as indicated in the HTTP response header | utl_http.get_authentication( r IN OUT NOCOPY resp, scheme OUT NOCOPY VARCHAR2, realm OUT NOCOPY VARCHAR2, for_proxy IN BOOLEAN DEFAULT FALSE); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD set serveroutput on DECLARE req utl_http.req; resp utl_http.resp; s VARCHAR2(100); rlm VARCHAR2(200); BEGIN req := utl_http.begin_request('http://www.psoug.org'); resp := utl_http.get_response(req); utl_http.get_authentication(resp, s, rlm); dbms_output.put_line(s); dbms_output.put_line(rlm); utl_http.end_response(resp); END; / --================================ alt. set serveroutput on CREATE OR REPLACE PROCEDURE get_page (url IN VARCHAR2, username IN VARCHAR2 DEFAULT NULL, password IN VARCHAR2 DEFAULT NULL, realm IN VARCHAR2 DEFAULT NULL) AS req utl_http.req; resp utl_http.resp; my_scheme VARCHAR2(256); my_realm VARCHAR2(256); my_proxy BOOLEAN; BEGIN -- Turn off checking of status code. We will check it by ourselves. utl_http.http_response_error_check(FALSE); req := utl_http.begin_request(url); IF (username IS NOT NULL) THEN utl_http.set_authentication(req, username, password); END IF; resp := utl_http.get_response(req); IF (resp.status_code = utl_http.HTTP_UNAUTHORIZED) THEN utl_http.get_authentication(resp, my_scheme, my_realm, my_proxy); IF (my_proxy) THEN dbms_output.put_line('Web proxy server is protected.'); dbms_output.put('Please supplied the required ' || my_scheme || ' authentication username/password for realm ' || my_realm || ' for the proxy server.'); ELSE dbms_output.put_line('Web page ' || url || ' is protected.'); dbms_output.put('Please supplied the required ' || my_scheme || ' authentication username/password for realm ' || my_realm || ' for the Web page.'); END IF; utl_http.end_response(resp); RETURN; END IF; FOR i IN 1..utl_http.get_header_count(resp) LOOP utl_http.get_header(resp, i, name, value); dbms_output.put_line(name || ': ' || value); END LOOP; utl_http.end_response(resp); END; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_BODY_CHARSET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Gets the default character of the body of all HTTP requests for use by the UTL_URL package. Overload 1 |
utl_http.get_body_charset(charset OUT NOCOPY VARCHAR2); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| set severoutput on DECLARE x VARCHAR2(20); BEGIN utl_http.get_body_charset(x); dbms_output.put_line(x); END; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Overload 2 | utl_http.get_body_charset RETURN VARCHAR2; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SELECT utl_http.get_body_charset FROM dual; |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_COOKIES | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Returns the all the cookies currently maintained by the UTL_HTTP package set by all Web servers | utl_http.get_cookies(cookies IN OUT NOCOPY cookie_table); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CREATE TABLE my_cookies ( session_id INTEGER, name VARCHAR2(256), value VARCHAR2(1024), domain VARCHAR2(256), expire DATE, path VARCHAR2(1024), secure VARCHAR2(1), version INTEGER); CREATE SEQUENCE session_id; CREATE OR REPLACE FUNCTION save_cookies RETURN BINARY_INTEGER AS cookies utl_http.cookie_table; my_session_id BINARY_INTEGER; secure VARCHAR2(1); BEGIN -- assume that some cookies have been set in previous HTTP requests utl_http.get_cookies(cookies); SELECT session_id.nextval INTO my_session_id FROM dual; FOR i in 1..cookies.COUNT LOOP IF (cookies(i).secure) THEN secure := 'Y'; ELSE secure := 'N'; END IF; INSERT INTO my_cookies (session_id, name, value, domain, expire, path, secure, version) VALUES (my_session_id, cookies(i).name, cookies(i).value, cookies(i).domain, cookies(i).expire, cookies(i).path, secure, cookies(i).version); END LOOP; COMMIT; RETURN my_session_id; END save_cookies; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_COOKIE_COUNT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Returns the number of cookies currently maintained by the UTL_HTTP package set by all Web servers | utl_http.get_cookie_count RETURN PLS_INTEGER | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SELECT utl_http.get_cookie_count FROM dual; |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_COOKIE_SUPPORT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| This procedure retrieves the current cookie support settings | utl_http.get_cookie_support( (enable OUT BOOLEAN, max_cookies OUT PLS_INTEGER, max_cookies_per_site OUT PLS_INTEGER); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_DETAILED_EXCP_SUPPORT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Checks if the UTL_HTTP package will raise a detailed exception | utl_http.get_detailed_excp_support(enable OUT BOOLEAN); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| set serveroutput on DECLARE x BOOLEAN; BEGIN IF utl_http.get_detailed_excp_support THEN dbms_output.put_line('Enabled'); ELSE dbms_output.put_line('Disabled'); END IF; END; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_DETAILED_SQLCODE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Retrieves the detailed SQLCODE of the last exception raised | utl_http.get_detailed_sqlcode RETURN PLS_INTEGER; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SELECT utl_http.get_detailed_sqlcode FROM dual |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_DETAILED_SQLERRM | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Retrieves the detailed SQLERRM of the last exception raised | utl_http.get_detailed_sqlerrm RETURN VARCHAR2; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SELECT utl_http.get_detailed_sqlerrm FROM dual; |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_FOLLOW_REDIRECT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Retrieves the follow-redirect setting in the current session | utl_http.get_follow_redirect(max_redirects OUT PLS_INTEGER); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| set serveroutput on DECLARE i PLS_INTEGER; BEGIN utl_http.get_follow_redirect(i); dbms_output.put_line('Maximum Redirects Is: ' || TO_CHAR(i)); END; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_HEADER | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Returns the n-th HTTP response header name and value returned in the response | utl_http.get_header( r IN OUT NOCOPY resp, n IN PLS_INTEGER, name OUT NOCOPY VARCHAR2, value OUT NOCOPY VARCHAR2); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See SET_AUTHENTICATION Demo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_HEADER_BY_NAME | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Returns the HTTP response header value returned in the response given the name of the header |
utl_http.get_header_by_name( r IN OUT NOCOPY resp, name IN VARCHAR2, value OUT NOCOPY VARCHAR2, n IN PLS_INTEGER DEFAULT 1); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_HEADER_COUNT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Returns the number of HTTP response headers returned in the response | utl_http.get_header_count(r IN OUT NOCOPY resp) RETURN PLS_INTEGER; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See SET_AUTHENTICATION Demo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_PERSISTENT_CONNS | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Returns all the network connections currently kept persistent by the UTL_HTTP package to the Web servers |
utl_http.get_persistent_conns( connections IN OUT NOCOPY connection_table); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_PERSISTENT_CONN_COUNT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Returns the number of network connections currently kept persistent by the UTL_HTTP package to the Web servers | utl_http.get_persistent_conn_count RETURN PLS_INTEGER; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SELECT utl_http.get_persistent_conn_count FROM dual; |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_PERSISTENT_CONN_SUPPORT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Checks if the persistent connection support is enabled and returns the maximum number of persistent connections maintained in the current session | utl_http.get_persistent_conn_support( enable OUT BOOLEAN, max_conns OUT PLS_INTEGER); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_PROXY | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Retrieves the current proxy settings | utl_http.get_proxy( proxy OUT NOCOPY VARCHAR2, no_proxy_domains OUT NOCOPY VARCHAR2); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_RESPONSE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Reads the HTTP response. When this procedure returns, the status line and the HTTP response headers have been read and processed. The status code, reason phrase and the HTTP protocol version are stored in the response record. | utl_http.get_response( r IN OUT NOCOPY req, return_info_response IN BOOLEAN DEFAULT FALSE) RETURN resp; |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See BEGIN_REQUEST Demo / See SET_AUTHENTICATION Demo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_RESPONSE_ERROR_CHECK | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Checks if response error check is set | utl_http.get_response_error_check(enable OUT BOOLEAN); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GET_TRANSFER_TIMEOUT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Retrieves the default time-out value for all future HTTP requests | utl_http.get_transfer_timeout(timeout OUT PLS_INTEGER DEFAULT 60); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| set serveroutput on DECLARE x PLS_INTEGER; BEGIN utl_http.get_transfer_timeout(x); dbms_output.put_line(x); END; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| READ_LINE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Reads the HTTP response body in text form until the end of line is reached and returns the output in the caller-supplied buffer |
utl_http.read_line( r IN OUT NOCOPY resp, data OUT NOCOPY VARCHAR2 CHARACTER SET ANY_CS, remove_crlf IN BOOLEAN DEFAULT FALSE); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See BEGIN_REQUEST Demo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| READ_RAW | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Reads the HTTP response body in binary form and returns the output in the caller-supplied buffer. The end_of_body exception is raised if the end of the HTTP response body is reached |
utl_http.read_raw( r IN OUT NOCOPY resp, data OUT NOCOPY RAW, len IN PLS_INTEGER DEFAULT NULL); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TBD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| READ_TEXT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Reads the HTTP response body in text form and returns the output in the caller-supplied buffer. The end_of_body exception will be raised if the end of the HTTP response body is reached. Text data is automatically converted from the response body character set to the database character set. | utl_http.read_text( r IN OUT NOCOPY resp, data OUT NOCOPY VARCHAR2 CHARACTER SET ANY_CS, len IN PLS_INTEGER DEFAULT NULL); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See SET_AUTHENTICATION Demo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| REQUEST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Fetches a Web page. This function returns the first 2000 bytes of the page at most. | utl_http.request( url IN VARCHAR2, proxy IN VARCHAR2 DEFAULT NULL, wallet_path IN VARCHAR2 DEFAULT NULL, wallet_password IN VARCHAR2 DEFAULT NULL) RETURN VARCHAR2; |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| set serveroutput on DECLARE req utl_http.req; resp utl_http.resp; value VARCHAR2(32000); BEGIN req := utl_http.begin_request('http://www.psoug.org'); resp := utl_http.get_response(req); value := utl_http.request('http://www.psoug.org/'); dbms_output.put_line(value); utl_http.end_response(resp); EXCEPTION WHEN utl_http.end_of_body THEN utl_http.end_response(resp); END; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| REQUEST_PIECES | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Fetches a Web page. The page is returned in a PL/SQL-table of VARCHAR2(2000) pieces. The elements of the PLSQL-table returned by request_pieces are successive pieces of the data obtained from the HTTP request to that URL. |
utl_http.request_pieces( url IN VARCHAR2, max_pieces IN NATURAL DEFAULT 32767, proxy IN VARCHAR2 DEFAULT NULL, wallet_path IN VARCHAR2 DEFAULT NULL, wallet_password IN VARCHAR2 DEFAULT NULL) RETURN html_pieces; |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| set serveroutput on DECLARE x utl_http.html_pieces; len PLS_INTEGER; BEGIN x := utl_http.request_pieces('http://www.psoug.org/', 100); dbms_output.put_line(x.count || ' pieces were retrieved.'); dbms_output.put_line('with total length '); len := 0; FOR i IN 1..x.COUNT LOOP len := len + length(x(i)); END LOOP; dbms_output.put_line(len); END; / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SET_AUTHENTICATION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sets the HTTP authentication information in the HTTP request header needed for the request to be authorized by the Web server |
utl_http.set_authentication( r IN OUT NOCOPY req, username IN VARCHAR2, password IN VARCHAR2 DEFAULT NULL, scheme IN VARCHAR2 DEFAULT 'Basic', for_proxy IN BOOLEAN DEFAULT FALSE); |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| set serveroutput on DECLARE req utl_http.req; resp utl_http.resp; name VARCHAR2(255); value VARCHAR2(1023); v_msg VARCHAR2(80); v_url VARCHAR2(32767) := '/'; begin -- request that exceptions are raised for error status codes utl_http.set_response_error_check(enable => TRUE); -- allow testing for exceptions like Utl_Http.Http_Server_Error utl_http.set_proxy( req := utl_http.begin_request(url => v_url, method => 'GET'); utl_http.set_authentication(r => req, username => 'SomeUser', utl_http.set_header(r=>req,name=>'User-Agent',value=>'Mozilla/4.0'); resp := utl_http.get_response(r => req); dbms_output.put_line('Status code: ' || resp.status_code); FOR i IN 1..utl_http.get_header_count(r => resp) |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||