Oracle UDDI Client - API Specification: Interface SoapHttpTransportLiaison

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.uddi.client
Interface SoapHttpTransportLiaison

All Known Implementing Classes:: OracleSoapHttpTransportLiaison

public abstract interface SoapHttpTransportLiaison
extends SoapTransportLiaison

Defines an interface for a transport layer between a UDDI client and a UDDI server. Specifically, a SOAP-based interface which uses HTTP as its underlying transport protocol.

Many of the methods defined in this interface are related to authentication using the HTTP protocol. An implementation of this interface can be used in conjunction with the TransportAuthenticationLiaison, which specifies that the underlying transport (and hence, the implementation of this interface) will handle the authentication and session management on behalf of the user.

This interface should be implemented and the resulting instance can be used to specify transport parameters; it is then passed to UddiClient and transport handling becomes transparent to the user of the API.

Field Summary

Type	Field
`static java.lang.String`	`HTTP_AUTH_TYPE_BASIC`
`static java.lang.String`	`HTTP_AUTH_TYPE_DIGEST`
`static java.lang.String`	`HTTP_PROXY_AUTH_TYPE_BASIC`
`static java.lang.String`	`HTTP_PROXY_AUTH_TYPE_DIGEST`
`static java.lang.String`	`ORAUDDI_INQUIRY_DEFAULT_REALM` The default HTTP authentication realm name for Oracle UDDI registry inquiry.
`static java.lang.String`	`ORAUDDI_PUBLISHING_DEFAULT_REALM` The default HTTP authentication realm name for Oracle UDDI registry publishing.

Fields inherited from class oracle.uddi.client.SoapTransportLiaison

DEBUG_PROP_NAME

Method Summary

Type	Method
`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.
`void`	`setAuthType(java.lang.String authType)` Set the HTTP authentication type.
`void`	`setCiphers(java.lang.String ciphers)` Set the cipher suites.
`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 host)` Set HTTP proxy host.
`void`	`setProxyPassword(java.lang.String password)` Set the password for HTTP proxy authentication.
`void`	`setProxyPort(int port)` 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 userInteraction)` 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 interface oracle.uddi.client.SoapTransportLiaison

close, 
sendUddiRequest, 
sendUddiRequest, 
setDebug

Field Detail

ORAUDDI_PUBLISHING_DEFAULT_REALM

public static final java.lang.String ORAUDDI_PUBLISHING_DEFAULT_REALM

The default HTTP authentication realm name for Oracle UDDI registry publishing.

ORAUDDI_INQUIRY_DEFAULT_REALM

public static final java.lang.String ORAUDDI_INQUIRY_DEFAULT_REALM

The default HTTP authentication realm name for Oracle UDDI registry inquiry.

HTTP_AUTH_TYPE_BASIC

public static final java.lang.String HTTP_AUTH_TYPE_BASIC

HTTP_AUTH_TYPE_DIGEST

public static final java.lang.String HTTP_AUTH_TYPE_DIGEST

HTTP_PROXY_AUTH_TYPE_BASIC

public static final java.lang.String HTTP_PROXY_AUTH_TYPE_BASIC

HTTP_PROXY_AUTH_TYPE_DIGEST

public static final java.lang.String HTTP_PROXY_AUTH_TYPE_DIGEST

Method Detail

setUserInteraction

public void setUserInteraction(boolean userInteraction)

Set user interaction.

Parameters:: userInteraction - allow userInteraction if true.

getUserInteraction

public boolean getUserInteraction()

Get user interaction.

Returns:: the flag indicating user interaction.

setProxyHost

public void setProxyHost(java.lang.String host)

Set HTTP proxy host.

Parameters:: host - the HTTP proxy host or null if no proxy.

getProxyHost

public java.lang.String getProxyHost()

Get HTTP proxy host.

Returns:: the HTTP proxy host or null if no proxy.

setProxyPort

public void setProxyPort(int port)

Set HTTP proxy port.

Parameters:: port - the HTTP proxy port.

getProxyPort

public int getProxyPort()

Get HTTP proxy port.

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

setAuthType

public void setAuthType(java.lang.String authType)

Set the HTTP authentication type.

See Also:: HTTP_AUTH_TYPE_BASIC, HTTP_AUTH_TYPE_DIGEST

getAuthType

public java.lang.String getAuthType()

Get the HTTP authentication type.

getRealm

public java.lang.String getRealm()

Get the name of the realm for HTTP authentication.

setRealm

public void setRealm(java.lang.String szRealm)

Set the name of the realm for HTTP authentication.

setUserName

public void setUserName(java.lang.String username)

Set the username for HTTP authentication.

getUserName

public java.lang.String getUserName()

Get the username for HTTP authentication.

setPassword

public void setPassword(java.lang.String password)

Set the password for HTTP authentication.

getPassword

public java.lang.String getPassword()

Get the password for HTTP authentication.

setProxyAuthType

public void setProxyAuthType(java.lang.String authType)

Set the HTTP proxy authentication type.

See Also:: HTTP_PROXY_AUTH_TYPE_BASIC, HTTP_PROXY_AUTH_TYPE_DIGEST

getProxyAuthType

public java.lang.String getProxyAuthType()

Get the HTTP proxy authentication type.

getProxyRealm

public java.lang.String getProxyRealm()

Get the name of the realm for HTTP proxy authentication.

setProxyRealm

public void setProxyRealm(java.lang.String szProxyRealm)

Set the name of the realm for HTTP proxy authentication.

setProxyUserName

public void setProxyUserName(java.lang.String username)

Set the username for HTTP proxy authentication.

getProxyUserName

public java.lang.String getProxyUserName()

Get the username for HTTP proxy authentication.

setProxyPassword

public void setProxyPassword(java.lang.String password)

Set the password for HTTP proxy authentication.

getProxyPassword

public java.lang.String getProxyPassword()

Get the password for HTTP proxy authentication.

setWalletLocation

public void setWalletLocation(java.lang.String wltLoc)

Set the Wallet Location for SSL communication.

getWalletLocation

public java.lang.String getWalletLocation()

Get the Wallet Location.

setWalletPassword

public void setWalletPassword(java.lang.String wltPassword)

Set the Wallet password.

getWalletPassword

public java.lang.String getWalletPassword()

Get the Wallet password.

setCiphers

public void setCiphers(java.lang.String ciphers)

Set the cipher suites.

getCiphers

public java.lang.String getCiphers()

Get the cipher suites.

setMaintainSession

public void setMaintainSession(boolean maintainSession)

Indicate whether to maintain HTTP sessions.

getMaintainSession

public boolean getMaintainSession()

Return session maintanence status.

setTimeout

public void setTimeout(int timeout)

Set the HTTP read timeout.

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

getTimeout

public int getTimeout()

Get the HTTP read timeout.

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