oracle.uddi.client
Class OracleSoapHttpTransportLiaison

java.lang.Object
oracle.uddi.client.OracleSoapHttpTransportLiaison

All Implemented Interfaces:

SoapHttpTransportLiaison, SoapTransportLiaison

public class OracleSoapHttpTransportLiaison

extends java.lang.Object

implements SoapHttpTransportLiaison

An implementation of SoapHttpTransportLiaison based on OracleSOAP (which is based on ApacheSOAP). This implementation provides the transport layer between a UDDI client and a UDDI server, using the SOAP protocol and HTTP transport protocol.

For specific method details, see the descriptions in the implemented interface.

To make use of this transport mechanism, instantiate it and set any HTTP transport-related properties that need to be set based on your environment and intended usage - proxies, realms, username, password, wallet, ciphers, etc. Then instantiate a UddiClient object, passing this object to it. You may also want to pass an instance of a TransportAuthenticationLiaison object to tell UddiClient to rely on this transport object for authentication and session management. Now you may use the UddiClient as your client-side interface to the UDDI registry.

See Also:

SoapHttpTransportLiaison

Field Summary

Fields inherited from interface oracle.uddi.client.SoapHttpTransportLiaison

HTTP_AUTH_TYPE_BASIC, HTTP_AUTH_TYPE_DIGEST, HTTP_PROXY_AUTH_TYPE_BASIC, HTTP_PROXY_AUTH_TYPE_DIGEST, ORAUDDI_INQUIRY_DEFAULT_REALM, ORAUDDI_PUBLISHING_DEFAULT_REALM

Fields inherited from interface oracle.uddi.client.SoapTransportLiaison

DEBUG_PROP_NAME

Constructor Summary

OracleSoapHttpTransportLiaison()
Constructor: gets a new instance of this transport mechanism.

Method Summary

void	close() Closes the connection and frees up all dedicated resources, such as TCP connections, opened readers/writers, etc.
java.lang.String	getAuthType() Get the HTTP authentication type.
java.lang.String	getCiphers() Get the cipher suites.
boolean	getMaintainSession() Return session maintanence status.
java.lang.String	getPassword() Get the password for HTTP authentication.
java.lang.String	getProxyAuthType() Get the HTTP proxy authentication type.
java.lang.String	getProxyHost() Get HTTP proxy host.
java.lang.String	getProxyPassword() Get the password for HTTP proxy authentication.
int	getProxyPort() Get HTTP proxy port.
java.lang.String	getProxyRealm() Get the name of the realm for HTTP proxy authentication.
java.lang.String	getProxyUserName() Get the username for HTTP proxy authentication.
java.lang.String	getRealm() Get the name of the realm for HTTP authentication.
int	getTimeout() Get the HTTP read timeout.
boolean	getUserInteraction() Get user interaction.
java.lang.String	getUserName() Get the username for HTTP authentication.
java.lang.String	getWalletLocation() Get the Wallet Location.
java.lang.String	getWalletPassword() Get the Wallet password.
org.w3c.dom.Element	sendUddiRequest(org.w3c.dom.Element eltUddiRequest, java.lang.String endPointURL) Take the named UDDI request in the form of DOM element and send it using SOAP protocol.
org.w3c.dom.Element	sendUddiRequest(UddiElement uddiRequest, java.lang.String endPointURL, UddiElementFactory uddiEltFactory) Take the named UDDI request and send it using SOAP protocol.
void	setAuthType(java.lang.String authType) Set the HTTP authentication type.
void	setCiphers(java.lang.String ciphers) Set the cipher suites
void	setDebug(boolean isDebug)
void	setMaintainSession(boolean maintainSession) Indicate whether to maintain HTTP sessions.
void	setPassword(java.lang.String password) Set the password for HTTP authentication.
void	setProxyAuthType(java.lang.String authType) Set the HTTP proxy authentication type.
void	setProxyHost(java.lang.String szHost) Set HTTP proxy host.
void	setProxyPassword(java.lang.String password) Set the password for HTTP proxy authentication.
void	setProxyPort(int iPort) Set HTTP proxy port.
void	setProxyRealm(java.lang.String szProxyRealm) Set the name of the realm for HTTP proxy authentication.
void	setProxyUserName(java.lang.String username) Set the username for HTTP proxy authentication.
void	setRealm(java.lang.String szRealm) Set the name of the realm for HTTP authentication.
void	setTimeout(int timeout) Set the HTTP read timeout.
void	setUserInteraction(boolean bUserInteraction) Set user interaction.
void	setUserName(java.lang.String username) Set the username for HTTP authentication.
void	setWalletLocation(java.lang.String wltLoc) Set the Wallet Location for SSL communication.
void	setWalletPassword(java.lang.String wltPassword) Set the Wallet password.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OracleSoapHttpTransportLiaison

public OracleSoapHttpTransportLiaison()

Constructor: gets a new instance of this transport mechanism. Once you have the instance, set any necessary transport properties and hand this object to the UddiClient, which will take care of all transport details from that point onward.

Method Detail

setUserInteraction

public void setUserInteraction(boolean bUserInteraction)

Description copied from interface: SoapHttpTransportLiaison

Set user interaction.

Specified by:

setUserInteraction in interface SoapHttpTransportLiaison

Parameters:

bUserInteraction - allow userInteraction if true.

getUserInteraction

public boolean getUserInteraction()

Description copied from interface: SoapHttpTransportLiaison

Get user interaction.

Specified by:

getUserInteraction in interface SoapHttpTransportLiaison

Returns:

the flag indicating user interaction.

setProxyHost

public void setProxyHost(java.lang.String szHost)

Description copied from interface: SoapHttpTransportLiaison

Set HTTP proxy host.

Specified by:

setProxyHost in interface SoapHttpTransportLiaison

Parameters:

szHost - the HTTP proxy host or null if no proxy.

getProxyHost

public java.lang.String getProxyHost()

Description copied from interface: SoapHttpTransportLiaison

Get HTTP proxy host.

Specified by:

getProxyHost in interface SoapHttpTransportLiaison

Returns:

the HTTP proxy host or null if no proxy.

setProxyPort

public void setProxyPort(int iPort)

Description copied from interface: SoapHttpTransportLiaison

Set HTTP proxy port.

Specified by:

setProxyPort in interface SoapHttpTransportLiaison

Parameters:

iPort - the HTTP proxy port.

getProxyPort

public int getProxyPort()

Description copied from interface: SoapHttpTransportLiaison

Get HTTP proxy port.

Specified by:

getProxyPort in interface SoapHttpTransportLiaison

Returns:

the HTTP proxy port. Invalid if getProxyHost() returns null.

setAuthType

public void setAuthType(java.lang.String authType)

Description copied from interface: SoapHttpTransportLiaison

Set the HTTP authentication type.

Specified by:

setAuthType in interface SoapHttpTransportLiaison

See Also:

HTTP_AUTH_TYPE_BASIC, HTTP_AUTH_TYPE_DIGEST

getAuthType

public java.lang.String getAuthType()

Description copied from interface: SoapHttpTransportLiaison

Get the HTTP authentication type.

Specified by:

getAuthType in interface SoapHttpTransportLiaison

getRealm

public java.lang.String getRealm()

Description copied from interface: SoapHttpTransportLiaison

Get the name of the realm for HTTP authentication.

Specified by:

getRealm in interface SoapHttpTransportLiaison

setRealm

public void setRealm(java.lang.String szRealm)

Description copied from interface: SoapHttpTransportLiaison

Set the name of the realm for HTTP authentication.

Specified by:

setRealm in interface SoapHttpTransportLiaison

setUserName

public void setUserName(java.lang.String username)

Description copied from interface: SoapHttpTransportLiaison

Set the username for HTTP authentication.

Specified by:

setUserName in interface SoapHttpTransportLiaison

getUserName

public java.lang.String getUserName()

Description copied from interface: SoapHttpTransportLiaison

Get the username for HTTP authentication.

Specified by:

getUserName in interface SoapHttpTransportLiaison

setPassword

public void setPassword(java.lang.String password)

Description copied from interface: SoapHttpTransportLiaison

Set the password for HTTP authentication.

Specified by:

setPassword in interface SoapHttpTransportLiaison

getPassword

public java.lang.String getPassword()

Description copied from interface: SoapHttpTransportLiaison

Get the password for HTTP authentication.

Specified by:

getPassword in interface SoapHttpTransportLiaison

setProxyAuthType

public void setProxyAuthType(java.lang.String authType)

Description copied from interface: SoapHttpTransportLiaison

Set the HTTP proxy authentication type.

Specified by:

setProxyAuthType in interface SoapHttpTransportLiaison

See Also:

HTTP_PROXY_AUTH_TYPE_BASIC, HTTP_PROXY_AUTH_TYPE_DIGEST

getProxyAuthType

public java.lang.String getProxyAuthType()

Description copied from interface: SoapHttpTransportLiaison

Get the HTTP proxy authentication type.

Specified by:

getProxyAuthType in interface SoapHttpTransportLiaison

getProxyRealm

public java.lang.String getProxyRealm()

Description copied from interface: SoapHttpTransportLiaison

Get the name of the realm for HTTP proxy authentication.

Specified by:

getProxyRealm in interface SoapHttpTransportLiaison

setProxyRealm

public void setProxyRealm(java.lang.String szProxyRealm)

Description copied from interface: SoapHttpTransportLiaison

Set the name of the realm for HTTP proxy authentication.

Specified by:

setProxyRealm in interface SoapHttpTransportLiaison

setProxyUserName

public void setProxyUserName(java.lang.String username)

Description copied from interface: SoapHttpTransportLiaison

Set the username for HTTP proxy authentication.

Specified by:

setProxyUserName in interface SoapHttpTransportLiaison

getProxyUserName

public java.lang.String getProxyUserName()

Description copied from interface: SoapHttpTransportLiaison

Get the username for HTTP proxy authentication.

Specified by:

getProxyUserName in interface SoapHttpTransportLiaison

setProxyPassword

public void setProxyPassword(java.lang.String password)

Description copied from interface: SoapHttpTransportLiaison

Set the password for HTTP proxy authentication.

Specified by:

setProxyPassword in interface SoapHttpTransportLiaison

getProxyPassword

public java.lang.String getProxyPassword()

Description copied from interface: SoapHttpTransportLiaison

Get the password for HTTP proxy authentication.

Specified by:

getProxyPassword in interface SoapHttpTransportLiaison

setWalletLocation

public void setWalletLocation(java.lang.String wltLoc)

Description copied from interface: SoapHttpTransportLiaison

Set the Wallet Location for SSL communication.

Specified by:

setWalletLocation in interface SoapHttpTransportLiaison

getWalletLocation

public java.lang.String getWalletLocation()

Description copied from interface: SoapHttpTransportLiaison

Get the Wallet Location.

Specified by:

getWalletLocation in interface SoapHttpTransportLiaison

setWalletPassword

public void setWalletPassword(java.lang.String wltPassword)

Description copied from interface: SoapHttpTransportLiaison

Set the Wallet password.

Specified by:

setWalletPassword in interface SoapHttpTransportLiaison

getWalletPassword

public java.lang.String getWalletPassword()

Description copied from interface: SoapHttpTransportLiaison

Get the Wallet password.

Specified by:

getWalletPassword in interface SoapHttpTransportLiaison

setCiphers

public void setCiphers(java.lang.String ciphers)

Set the cipher suites

Specified by:

setCiphers in interface SoapHttpTransportLiaison

getCiphers

public java.lang.String getCiphers()

Description copied from interface: SoapHttpTransportLiaison

Get the cipher suites.

Specified by:

getCiphers in interface SoapHttpTransportLiaison

setMaintainSession

public void setMaintainSession(boolean maintainSession)

Description copied from interface: SoapHttpTransportLiaison

Indicate whether to maintain HTTP sessions.

Specified by:

setMaintainSession in interface SoapHttpTransportLiaison

getMaintainSession

public boolean getMaintainSession()

Description copied from interface: SoapHttpTransportLiaison

Return session maintanence status.

Specified by:

getMaintainSession in interface SoapHttpTransportLiaison

setTimeout

public void setTimeout(int timeout)

Description copied from interface: SoapHttpTransportLiaison

Set the HTTP read timeout.

Specified by:

setTimeout in interface SoapHttpTransportLiaison

Parameters:

timeout - the amount of time, in ms, to block on reading data. A zero value indicates an infinite timeout.

getTimeout

public int getTimeout()

Description copied from interface: SoapHttpTransportLiaison

Get the HTTP read timeout.

Specified by:

getTimeout in interface SoapHttpTransportLiaison

Returns:

the amount of time, in ms, to block on reading data.

close

public void close()

Description copied from interface: SoapTransportLiaison

Closes the connection and frees up all dedicated resources, such as TCP connections, opened readers/writers, etc. It should remain silent if it has been called repeatedly.

Specified by:

close in interface SoapTransportLiaison

setDebug

public void setDebug(boolean isDebug)

Specified by:

setDebug in interface SoapTransportLiaison

sendUddiRequest

public org.w3c.dom.Element sendUddiRequest(UddiElement uddiRequest,
                                           java.lang.String endPointURL,
UddiElementFactory uddiEltFactory)
                                    throws org.apache.soap.SOAPException

Description copied from interface: SoapTransportLiaison

Take the named UDDI request and send it using SOAP protocol. When the soap endpoint returns a Fault message, it should not throw a SOAPException. The caller of the method is expected to handle Fault message.

Specified by:

sendUddiRequest in interface SoapTransportLiaison

Returns:

the first entry under the body of the soap response.

Throws:

org.apache.soap.SOAPException

sendUddiRequest

public org.w3c.dom.Element sendUddiRequest(org.w3c.dom.Element eltUddiRequest,
                                           java.lang.String endPointURL)
                                    throws org.apache.soap.SOAPException

Description copied from interface: SoapTransportLiaison

Take the named UDDI request in the form of DOM element and send it using SOAP protocol. When the soap endpoint returns a Fault message, it should not throw a SOAPException. The caller of the method is expected to handle Fault message.

Specified by:

sendUddiRequest in interface SoapTransportLiaison

Returns:

the first entry under the body of the soap response.

Throws:

org.apache.soap.SOAPException