20
Package oracle.soap.transport.http

This chapter documents package package oracle.soap.transport.http. This package contains the classes that provide support for Oracle SOAP in the XDK for Java.

Oracle SOAP is an implementation of the Simple Object Access Protocol. Oracle SOAP is based on the SOAP open source implementation developed by the Apache Software Foundation.

This chapter contains these sections:

• Package oracle.soap.transport.http Description
• Package oracle.soap.transport.http Summary
• Class OracleSOAPHTTPConnection

---

Package oracle.soap.transport.http Description

The Simple Object Access Protocol (SOAP) is a transport protocol for sending and receiving requests and responses across the Internet. It is based on XML and HTTP.

SOAP is transport protocol-independent and operating system-independent. It provides the standard XML message format for all applications. SOAP uses the XML Schema standard of the World Wide Web Consortium (W3C).

Package oracle.soap.transport.http contains class OracleSOAPHTTPConnection, which implements OracleSOAPTransport.

The Oracle SOAP client API supports a pluggable transport, allowing the client to easily change the transport. Available transports include HTTP and HTTPS (secure HTTP).

---

Package oracle.soap.transport.http Summary

Package oracle.soap.transport.http contains class oracle.soap.transport.http.OracleSOAPHTTPConnection, which implements Oracle- specific transport extensions in OracleSOAPTransport.

Table 20-1  Fields in class OracleSOAPHTTPConnection

Field	Description
ALLOW_USER_INTERACTION	Sets user interaction.
AUTH_TYPE	Defines http auth type (basic/digest).
CIPHERS	Defines cipher suites used for HTTPS (colon separated list of cipher suites).
PASSWORD	Defines HTTP password.
PROXY_AUTH_TYPE	Defines proxy auth type (basic/digest).
PROXY_HOST	Defines proxy host.
PROXY_PASSWORD	Defines proxy password.
PROXY_PORT	Defines proxy ports.
PROXY_USERNAME	Defines proxy username.
STATUS_LINE	Used to get HTTP status line from HTTP headers (getHeaders).
USERNAME	Defines HTTP username.
WALLET_LOCATION	Defines wallet location used for HTTPS.
WALLET_PASSWORD	Defines password used for HTTPS.

Table 20-2  Constructor and Methods in class OracleSOAPHTTPConnection

Member	Description
Constructor	--
OracleSOAPHTTPConnection	Constructor that takes Properties as an arg.
Methods	--
getProperties	Get the connection properties.
close	Close the transport and perform any clean up.
finalize	Overrides finalize in class Object.
getHeaders	Return access to headers generated by the protocol.
getProperties	Get the connection properties.
receive	Return a buffered reader to receive back the response to whatever was sent to x.
send	Request that an envelope be posted to the given URL.
setProperties	Set the connection properties.

---

Class OracleSOAPHTTPConnection

oracle.soap.transport.http.OracleSOAPHTTPConnection

java.lang.Object
   |
   +----oracle.soap.transport.http.OracleSOAPHTTPConnection

public class OracleSOAPHTTPConnection
extends Object

Implements OracleSOAPTransport.

---

Fields

ALLOW_USER_INTERACTION

public static final String ALLOW_USER_INTERACTION

property to set user interaction

STATUS_LINE

public static final String STATUS_LINE

property used to get HTTP status line from HTTP headers (getHeaders)

PROXY_HOST

public static final String PROXY_HOST

property used for defining proxy host

PROXY_PORT

public static final String PROXY_PORT

property used for defining proxy port

PROXY_AUTH_TYPE

public static final String PROXY_AUTH_TYPE

property used for defining proxy auth type (basic/digest)

PROXY_USERNAME

public static final String PROXY_USERNAME

property used for defining proxy username

PROXY_PASSWORD

public static final String PROXY_PASSWORD

property used for defining proxy password

AUTH_TYPE

public static final String AUTH_TYPE

property used for defining http auth type (basic/digest)

USERNAME

public static final String USERNAME

property used for defining http username

PASSWORD

public static final String PASSWORD

property used for defining http password

WALLET_LOCATION

public static final String WALLET_LOCATION

property used for defining wallet location used for HTTPS

WALLET_PASSWORD

public static final String WALLET_PASSWORD

property used for defining wallet password used for HTTPS

CIPHERS

public static final String CIPHERS

property used for defining cipher suites used for HTTPS (colon separated list of cipher suites).

---

Constructors

OracleSOAPHTTPConnection

public OracleSOAPHTTPConnection(Properties prop)

Constructor that takes Properties as an arg.

Parameters

prop - connection properties.

---

Methods

setProperties

public void setProperties(Properties prop)

Set the connection properties.

Parameters

prop - connection properties

getProperties

public Properties getProperties()

Get the connection properties.

Returns

connection properties

send

 public void send(URL sendTo,
                  String action,
                  Hashtable headers,
                  Envelope env,
                  SOAPMappingRegistry smr,
                  int timeout) throws SOAPException

This method is used to request that an envelope be posted to the given URL. The response (if any) must be gotten by calling the receive() function. Soap clients should not use this method directly, but should instead use org.apache.soap.rpc.Call.

Parameters

sendTo - the URL to send the envelope to

action - the SOAPAction header field value

headers - any other header fields to go to as protocol headers

env - the envelope to send

smr - the XML<->Java type mapping registry (passed on)

ctx - the request SOAPContext

Throws

SOAPException with appropriate reason code if problem.

receive

public BufferedReader receive()

Return a buffered reader to receive back the response to whatever was sent to whatever. Soap clients should not use this method directly but use org.apache.soap.rpc.Call instead.

Returns

A reader to read the results from or null if that's not possible.

getHeaders

public Hashtable getHeaders()

Return access to headers generated by the protocol. Soap clients should not use this method directly but use org.apache.soap.rpc.Call instead.

Returns

A hashtable containing all the headers.

close

public void close()

Closes the connection. Once this method has been called, the BufferedReader returned by receive method may be closed and should not be used. Calling this method will free resources without having the garbage collector run.

finalize

public void finalize()
              throws Throwable

Overrides

finalize in class Object