oracle.uddi.client
Class TransportAuthenticationLiaison

java.lang.Object
  |
  +--oracle.uddi.client.TransportAuthenticationLiaison

All Implemented Interfaces:

AuthenticationLiaison

public class TransportAuthenticationLiaison

extends java.lang.Object

implements AuthenticationLiaison

Implements an authentication scheme (and hence session management function) that is entirely managed by the underlying transport. Examples include HTTP basic authentication, HTTP basic authentication with HTTP session, HTTPS certificate-based authentication, etc. Note that since this AuthenticationLiaison relies on the transport for authentication, it is important to use a SoapTransportLiaison which provides authentication functionality.

Note: Clients of the API should do nothing more than instantiate this class. Its methods are called indirectly by the UddiClient object.

Constructor Summary

TransportAuthenticationLiaison()
Instantiate an instance.

Method Summary

void	authenticate() Perform the proper authentication.
void	close() Close the authenticated session.
java.lang.String	getAuthInfo() Return the token of the authenticated session.
void	init(UddiClient uddiClient) Initialize the authentication liaison.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportAuthenticationLiaison

public TransportAuthenticationLiaison()

Instantiate an instance. This is all a UddiClient user needs to do.

Method Detail

init

public void init(UddiClient uddiClient)

Description copied from interface: AuthenticationLiaison

Initialize the authentication liaison.

Specified by:

init in interface AuthenticationLiaison

authenticate

public void authenticate()
                  throws UddiClientException,
                         org.apache.soap.SOAPException

Description copied from interface: AuthenticationLiaison

Perform the proper authentication. If the authentication is successful, AuthenticationLiaison.getAuthInfo() must return the token for the authenticated session.

Specified by:

authenticate in interface AuthenticationLiaison

UddiClientException

org.apache.soap.SOAPException

getAuthInfo

public java.lang.String getAuthInfo()

Description copied from interface: AuthenticationLiaison

Return the token of the authenticated session. This method is used by UddiClient to manage the session on behalf of the users.

Specified by:

getAuthInfo in interface AuthenticationLiaison

Returns:

the token of the authenticated session, null if not yet authenticated or token is not needed by the authentication scheme.

See Also:

UddiClient

close

public void close()
           throws UddiClientException,
                  org.apache.soap.SOAPException

Description copied from interface: AuthenticationLiaison

Close the authenticated session. AuthenticationLiaison.getAuthInfo() will return null from this point onwards. It should stay silent if it is called multiple times.

Specified by:

close in interface AuthenticationLiaison

UddiClientException

org.apache.soap.SOAPException