oracle.calendar.soap.client
Class CalendarWebService

java.lang.Object
oracle.calendar.soap.client.CalendarWebService

Direct Known Subclasses:

Calendarlet

public class CalendarWebService

extends java.lang.Object

Base class for all XML SOAP based services available for accessing the Calendar Server through HTTP.

Constructor Summary

CalendarWebService()
The default constructor for the class.

Method Summary

void	enableOracleSSL(java.lang.String in_oracleWalletLocation, java.lang.String in_oracleWalletPassword) Explicitly enables SSL comunication between the Calendarlet and Calendar Web services using Oracle Wallet and Oracle password.
org.w3c.dom.Element	getAuthenticationHeader() Retrieves the SOAP authentication header.
java.lang.String	getEndPointURL() Retrieve the Web services host URL.
java.lang.String	getOracleWalletLocation() Retrieves the Oracle Wallet location.
java.lang.String	getOracleWalletPassword() Retrieves the Oracle Wallet password.
Proxy	getProxy() Retrieves the proxy connection information.
boolean	getWantIOBuffers() Returns the flag that indicates that buffer capture is enabled version 2002-12-19 fix008359
boolean	isOracleSSLEnabled() Determines whether SSL has been enabled.
void	setAuthenticationHeader(org.w3c.dom.Element in_headerElem) Specifies the SOAP authentication header element from an XML DOM.
void	setEndPointURL(java.lang.String in_endPointURL) Assigns the Web services host URL.
void	setProxy(Proxy in_proxy) Specifies the proxy connection information.
void	setWantIOBuffers(boolean in_wantBuffers) Sets the flag to enable the capture of the outgoing and incoming XML SOAP buffers.

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarWebService

public CalendarWebService()

The default constructor for the class. version 2002-12-19 fix008359

Method Detail

enableOracleSSL

public void enableOracleSSL(java.lang.String in_oracleWalletLocation,
                            java.lang.String in_oracleWalletPassword)

Explicitly enables SSL comunication between the Calendarlet and Calendar Web services using Oracle Wallet and Oracle password.

If communication with the Calendar web services using SSL is desired, the URL's protocol must be 'https'.

By default, this will trigger the Calendarlet to communicate with Calendar Web services, which will use SSL to authenticate and provide integrity and protection for the data transmitted. This form of SSL will not make use of private and public keys to secure the network link; it will only obfuscate the information transmitted. This method of protection is more then adequate when Calendarlet and Calendar Web services are behind a firewall in a secure environment.

To enalble this form of SSL, the Wallet location and Wallet password can be null.

For better and more secure SSL, you should provide an Oracle Wallet location along with the Oracle Wallet password. This form of SSL will provide the maximum protection between Calendarlet and Calendar Web services.

version 2004-03-22 fix010260

Parameters:

in_oracleWalletLocation - the Oracle Wallet to be used to do SSL

in_oracleWalletPassword - the Oracle Wallet password to be used

isOracleSSLEnabled

public boolean isOracleSSLEnabled()

Determines whether SSL has been enabled. version 2004-03-23 fix010260

Returns:

boolean - true if SSL has been enabled

getEndPointURL

public java.lang.String getEndPointURL()

Retrieve the Web services host URL. version 2002-12-19 fix008359

Returns:

String - Web services host URL

setEndPointURL

public void setEndPointURL(java.lang.String in_endPointURL)

Assigns the Web services host URL. version 2004-03-22 fix010260

Parameters:

in_endPointURL - Web services host URL

setWantIOBuffers

public void setWantIOBuffers(boolean in_wantBuffers)

Sets the flag to enable the capture of the outgoing and incoming XML SOAP buffers. version 2002-12-19 fix008359

Parameters:

in_wantBuffers - true if the buffers are to be captured

getWantIOBuffers

public boolean getWantIOBuffers()

Returns the flag that indicates that buffer capture is enabled version 2002-12-19 fix008359

Returns:

boolean - true if buffer capture is enabled

getAuthenticationHeader

public org.w3c.dom.Element getAuthenticationHeader()

Retrieves the SOAP authentication header. version 2002-12-19 fix008359

Returns:

Element - XML header element

setAuthenticationHeader

public void setAuthenticationHeader(org.w3c.dom.Element in_headerElem)

Specifies the SOAP authentication header element from an XML DOM. Typically, the Calendarlet classes have a getElement() method to generate the XML DOM representation of the object. version 2002-12-19 fix008359

Parameters:

in_headerElem - XML header element

getProxy

public Proxy getProxy()

Retrieves the proxy connection information. version 2003-01-09 fix008389

Returns:

Proxy - information for the proxy settings

getOracleWalletLocation

public java.lang.String getOracleWalletLocation()

Retrieves the Oracle Wallet location. version 2004-03-22 fix010260

Returns:

String - Oracle Wallet location

getOracleWalletPassword

public java.lang.String getOracleWalletPassword()

Retrieves the Oracle Wallet password. version 2004-03-22 fix010260

Returns:

String - Oracle Wallet password

setProxy

public void setProxy(Proxy in_proxy)

Specifies the proxy connection information. This information will be used to initialize an HTTP Connection to the Web services host. version 2003-01-09 fix008389

Parameters:

in_proxy - - proxy object