Oracle® Database PL/SQL Packages and Types Reference 10g Release 2 (10.2) Part Number B14258-02 |
|
|
View PDF |
The UTL_DBWS
package provides database web services.
This chapter contains the following topics:
Supported Keys and Default Settings for Standard Call Properties
Table 166-1 Supported Keys and Default Settings for Standard Call Properties
Key | Explanation of Value, Default value |
---|---|
|
User name for authentication. |
|
Password for authentication. |
|
Encoding style specified as a namespace URI. The default value is the SOAP 1.1 encoding http://schemas.xmlsoap.org/soap/encoding/. |
|
Standard property for operation style. Set to ' |
|
This boolean property is used by a service client to indicate whether or not it wants to participate in a session with a service endpoint.If this property is set to ' |
|
This boolean property indicates whether or not SOAPAction is to be used. The default value of this property is ' |
|
Indicates the SOAPAction URI if the |
Table 166-2 UTL_DBWS Subprograms
Subprogram | Description |
---|---|
Creates a Call instance |
|
Creates a Service instance |
|
Lists the XML type of the input parameters of the Call that is returned |
|
Lists the XML type of the output parameters of the Call that is returned |
|
Obtains the output arguments after a Call invocation |
|
Lists the qualified names of all of the ports in a service |
|
Returns the value of a particular property on a Call |
|
Lists the XML type that is returned by the given Call |
|
Lists the qualified names of the services defined in a WDSL document |
|
Invokes a specific operation using a synchronous request-response interaction mode |
|
Releases all Service instances |
|
Releases a particular Call instance |
|
Releases a particular Service instance |
|
Clears the value of a particular property on a Call |
|
Sets the value of a particular property on a Call |
This procedure creates a Call instance.
Syntax
UTL_DBWS.CREATE_CALL ( service_handle SERVICE, port_name QNAME, operation_name QNAME) RETURN CALL;
Parameters
Table 166-3 CREATE_CALL Function Parameters
Parameter | Description |
---|---|
|
The Service instance to be called. |
|
The |
|
The qualified name for the operation. |
Return Values
Table 166-4 CREATE_CALL Return Values
Parameter | Description |
---|---|
|
Returns a handle to the Call instance. |
This procedure creates a Service instance.
Syntax
UTL_DBWS.CREATE_SERVICE( wsdl_document_location URITYPE, service_name QNAME) RETURN SERVICE;
Parameters
Table 166-5 CREATE_SERVICE Function Parameters
Parameter | Description |
---|---|
|
The URL for the WSDL document location for the service |
|
The qualified name for the service. Use the first service if this is |
Return Values
Table 166-6 CREATE_SERVICE Return Values
Parameter | Description |
---|---|
|
Returns a handle to the Service instance. |
This procedure lists the XML type of the input parameters of the Call that is returned.
Syntax
UTL_DBWS.GET_IN_PARAMETER_TYPES( call_handle CALL) RETURN QNAME_LIST;
Parameters
Table 166-7 GET_IN_PARAMETER_TYPES Function Parameters
Parameter | Description |
---|---|
|
The Service instance whose input types are returned. |
Return Values
Table 166-8 GET_IN_PARAMETER_TYPES Function Return Values
Parameter | Description |
---|---|
|
The list of the XML type of the input parameters of the Call that is returned. |
This procedure lists the XML type of the output parameters of the Call that is returned.
Syntax
UTL_DBWS.GET_OUT_PARAMETER_TYPES( call_handle CALL) RETURN QNAME_LIST;
Parameters
Table 166-9 GET_OUT_PARAMETER_TYPES Function Parameters
Parameter | Description |
---|---|
|
The Service instance whose output types are returned. |
Return Values
Table 166-10 GET_OUT_PARAMETER_TYPES Function Return Values
Parameter | Description |
---|---|
|
The list of the XML type of the input parameters of the Call that is returned. |
This procedure obtains the output arguments after a Call invocation.
Syntax
UTL_DBWS.GET_OUTPUT_VALUES( call_handle CALL) RETURN ANYDATA_LIST;
Parameters
Table 166-11 GET_OUTPUT_VALUES Function Parameters
Parameter | Description |
---|---|
|
The instance of the Call. |
Return Values
Table 166-12 GET_OUTPUT_VALUES Function Return Values
Parameter | Description |
---|---|
|
Returns the output arguments in order. |
This procedure lists the qualified names of all of the ports in a service.
Syntax
UTL_DBWS.GET_PORTS( service_handle SERVICE) RETURN QNAME_LIST;
Parameters
Table 166-13 GET_PORTS Function Parameters
Parameter | Description |
---|---|
|
The service instance whose ports are returned |
Return Values
Table 166-14 GET_PORTS Function Return Values
Parameter | Description |
---|---|
|
Returns a list of the qualified names of all ports in a service |
This procedure returns the value of a particular property on a Call.
Syntax
UTL_DBWS.GET_PROPERTY( call_handle CALL, key VARCHAR2) RETURN value VARCHAR2;
Parameters
Table 166-15 GET_PROPERTY Function Parameters
Parameter | Description |
---|---|
|
The the instance of the Call. |
|
The key for the property (see Using UTL_DBWS) |
Return Values
Table 166-16 GET_PROPERTY Function Return Values
Parameter | Description |
---|---|
|
Returns the value of a particular property on a Call. |
This procedure lists the XML type that is returned by the given Call.
Syntax
UTL_DBWS.GET_RETURN_TYPE ( call_handle CALL) RETURN QNAME;
Parameters
Table 166-17 GET_RETURN_TYPE Function Parameters
Parameter | Description |
---|---|
|
The Service instance whose return type is returned. |
Return Values
Table 166-18 GET_RETURN_TYPE Function Return Values
Parameter | Description |
---|---|
|
The type that is returned. |
This function lists the qualified names of the services defined in a WDSL document.
Syntax
UTL_DBWS.GET_SERVICES( wsdl_document_location URITYPE) RETURN QNAME_LIST;
Parameters
Table 166-19 GET_SERVICES Function Parameters
Parameter | Description |
---|---|
|
The Service instance whose return type is returned. |
Return Values
Table 166-20 GET_SERVICES Function Return Values
Parameter | Description |
---|---|
|
A list of the qualified names of the services defined in the WSDL document. |
This procedure invokes a specific operation using a synchronous request-response interaction mode.
Syntax
UTL_DBWS.INVOKE( call_handle CALL, input_params ANYDATA_LIST) RETURN ANYDATA;
Parameters
Table 166-21 INVOKE Function Parameters
Parameter | Description |
---|---|
|
The Service instance whose return type is returned. |
|
The input parameters for this invocation. |
Return Values
Table 166-22 INVOKE Function Return Values
Parameter | Description |
---|---|
|
|
This procedure releases all Service instances.
Syntax
UTL_DBWS.RELEASE_ALL_SERVICES;
This procedure releases a particular Call instance.
Syntax
UTL_DBWS.RELEASE_CALL( call_handle CALL);
Parameters
Table 166-23 RELEASE_CALL Procedure Parameters
Parameter | Description |
---|---|
|
The call instance that is to be released. |
This procedure releases a particular Service instance.
Syntax
UTL_DBWS.RELEASE_SERVICE ( service_handle SERVICE);
Parameters
Table 166-24 RELEASE_SERVICE Procedure Parameters
Parameter | Description |
---|---|
service_handle |
The call instance that is to be released. |
Usage Notes
This will implicitly release all Call instances that have been created for this Service instance.
This procedure clears the value of a particular property on a Call.
Syntax
UTL_DBWS.REMOVE_PROPERTY( call_handle CALL, key VARCHAR2);
Parameters
Table 166-25 REMOVE_PROPERTY Procedure Parameters
Parameter | Description |
---|---|
|
The call instance. |
|
The key for the property (see Using UTL_DBWS). |
This procedure sets the value of a particular property on a Call.
Syntax
UTL_DBWS.SET_PROPERTY( call_handle CALL, key VARCHAR2, value VARCHAR2);
Parameters
Table 166-26 SET_PROPERTY Function Parameters
Parameter | Description |
---|---|
|
The instance of the Call. |
|
The key for the property (see Using UTL_DBWS). |
|
The value for the property. |