com.adventnet.management.transport
Interface TransportProvider

All Known Implementing Classes:

TcpClientTransportImpl, TcpServerTransportImpl

public interface TransportProvider

Interface that creates a session transport between the client and server. Users who want to provide their own transport mechanism should implement this interface and provide implementation for creating their transport protocol and plug it in the transport architecture framework.

Method Summary

void	close() Closes the transport interface after communication is over.
void	init(java.lang.Object[] params) Initializes the SAS transport session over which the data is sent/received.
SessionTransportProvider	open(java.lang.String[] params) Creates an instance of the transport session object and returns a handle to it.
void	setLogInterface(LogInterface log) Sets the log interface to the specified Log.

Method Detail

init

public void init(java.lang.Object[] params)
          throws TransportException

Initializes the SAS transport session over which the data is sent/received.

Parameters:

params - parameters that are used for creating the session.

Throws:

TransportException - in case of an error during initializing the transport interface.

open

public SessionTransportProvider open(java.lang.String[] params)
                              throws TransportException

Creates an instance of the transport session object and returns a handle to it.

Parameters:

params - parameters that are used for creating the client session.

Returns:

reference to the SessionTransportProvider object that represents the client session.

Throws:

TransportException - in case of an error during opening the transport interface.

close

public void close()
           throws TransportException

Closes the transport interface after communication is over.

Throws:

TransportException - in case of an error during closing.

setLogInterface

public void setLogInterface(LogInterface log)

Sets the log interface to the specified Log.