org.jSyncManager.Transport
Class TCPSocketTransport

java.lang.Object
  org.jSyncManager.API.Transport.SLPTransportInterface
      org.jSyncManager.API.Transport.USBTransportInterface
          org.jSyncManager.Transport.TCPSocketTransport

All Implemented Interfaces:

java.io.Serializable

public final class TCPSocketTransport

extends USBTransportInterface

TCP Socket-based Transport. This class provides the transport code for TCP Socket access.

Version:

$Revision: 1.4 $

Author:

Brad BARCLAY <bbarclay@jsyncmanager.org>
Last modified by: $Author: yaztromo $ on $Date: 2004/07/14 04:31:15 $.

See Also:

Serialized Form

Field Summary

static int

LISTENER_PORT

Fields inherited from class org.jSyncManager.API.Transport.USBTransportInterface

CLIE_VENDOR_ID, HANDSPRING_DEVICE_IDS, HANDSPRING_TREO_ID, HANDSPRING_VENDOR_ID, HANDSPRING_VISOR_ID, PALM_DEVICE_IDS, PALM_I705_ID, PALM_M100_ID, PALM_M125_ID, PALM_M130_ID, PALM_M500_ID, PALM_M505_ID, PALM_M515_ID, PALM_TUNGSTEN_T_ID, PALM_TUNGSTEN_Z_ID, PALM_VENDOR_ID, PALM_ZIRE_ID, SAMSUNG_DEVICE_IDS, SAMSUNG_SCH_I330_ID, SAMSUNG_VENDOR_ID, SONY_CLIE_3_5_ID, SONY_CLIE_4_0_ID, SONY_CLIE_4_1_ID, SONY_CLIE_NX60_ID, SONY_CLIE_NZ90V_ID, SONY_CLIE_S360_ID, SONY_DEVICE_IDS

Fields inherited from class org.jSyncManager.API.Transport.SLPTransportInterface

configPanel, connected

Constructor Summary

TCPSocketTransport()

Method Summary

void	close() Closes the implemented transport.
protected javax.swing.JPanel	constructConfigPanel() Constructs this transports configuration panel.
void	flush() Flushes the input buffer of any remaining data.
java.lang.String	getResourceBundleName() Returns the fully-qualified classname for the resources package to use for this transport.
java.lang.String	getTransportDescription() Returns the description for this Transport Interface.
java.lang.String	getTransportExceptionText(TransportException ex) Retrieves error information for a given TransportInitException.
java.lang.String	getTransportName() Returns the name of this Transport Interface.
void	initialize() Initialize the port.
void	initialize(java.util.Properties properties, int id) Initialize the port.
void	open() Opens a read/write connection to the implemented transport.
byte	readByte() Read a single byte from the underlying data stream.
void	writeBytes(byte[] data) Write an array of bytes to the underlying data stream.

Methods inherited from class org.jSyncManager.API.Transport.USBTransportInterface

isKnownPDA

Methods inherited from class org.jSyncManager.API.Transport.SLPTransportInterface

getConfigPanel, getResourceBundle, isConnected, loadResourceBundle, setConnected

Methods inherited from class java.lang.Object

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

Field Detail

LISTENER_PORT

public static final int LISTENER_PORT

See Also:

Constant Field Values

Constructor Detail

TCPSocketTransport

public TCPSocketTransport()
                   throws TransportException

Method Detail

close

public void close()
           throws TransportException

Closes the implemented transport. This method should close the transport device being implemented.

Specified by:

close in class SLPTransportInterface

Throws:

TransportException - throws any required exception.

flush

public void flush()
           throws TransportException

Flushes the input buffer of any remaining data.

Specified by:

flush in class SLPTransportInterface

Throws:

thrown - when a problem occurs with flushing the stream.

TransportException

getTransportName

public java.lang.String getTransportName()

Returns the name of this Transport Interface. This method will return a string containing the name of this transport interface. This is used when searching for and selecting from one of many available transport interfaces that are installed on the system.

Specified by:

getTransportName in class SLPTransportInterface

Returns:

the name of this transport interface.

open

public void open()
          throws TransportException

Opens a read/write connection to the implemented transport. This method should open the transport device being implemented using default parameters.

Specified by:

open in class SLPTransportInterface

Throws:

TransportException - any exception the underlying code may throw.

readByte

public byte readByte()

Read a single byte from the underlying data stream. This method call should abstract the underlying data connection stream to allow the SLP protocol to read a single byte from the stream. This method shouldn't throw any exceptions. Instead, if you can't read data, return 0. The protocol stack will eventually detect that no valid data is being transmitted and will time-out automatically.

Specified by:

readByte in class SLPTransportInterface

writeBytes

public void writeBytes(byte[] data)

Write an array of bytes to the underlying data stream. This method call should abstract the underlying data connection stream to allow the SLP protocol to write an array of bytes to the stream. This method shouldn't throw any exceptions. If the data cannot be written, it should be discarded. The protocol stack will eventually detect that its transmissions are no longer acknowledged, and will time out automatically.

Specified by:

writeBytes in class SLPTransportInterface

Parameters:

data - the bytes to be written to the underlying stream.

constructConfigPanel

protected javax.swing.JPanel constructConfigPanel()

Constructs this transports configuration panel. This method will be called the first time a transports configuration panel is requested. It is up to the specific transport implementation to handle its own configuration via a configuration JPanel. This JPanel may contain whatever controls you require.

Specified by:

constructConfigPanel in class SLPTransportInterface

Returns:

a javax.swing.JPanel containing the transports settings panel.

initialize

public void initialize()
                throws TransportException

Initialize the port. This method is called to initialize this transport using the objects stored settings. You should perform whatever setup you require here. These objects may be serialized, however it isn't guaranteed that the underlying API classes are also serializable. As such you should store any user settings as non-transient fields, and setup the transport based on those settings here. This method will be called whenever the port requires initialization. Note you may also call this method in your event handlers for when the user changes the transport settings. Your implementation should throw a TransportInitException if there isn't sufficient information to setup the transport. Applications can catch this exception and use it to display the necessary settings dialog to the use.

Specified by:

initialize in class SLPTransportInterface

Throws:

TransportException - thrown if there isn't sufficient info to setup the transport, or if another exception has occurred.

initialize

public void initialize(java.util.Properties properties,
                       int id)
                throws TransportException

Initialize the port. This initializer is called when the port needs to be configured from a properties file. This is necessary for when the jConduit is constructed in a text-only or daemon application, which is unable to display the GUI configuration panel. The method accepts a transport ID number 'id', which should be used to differentiate the different ports defined in the properties file by using keys of the form "header.property.". This is necessary as such a property file may contain multiple sets of properties for different ports. Once the properties have been loaded, it is acceptable to call the initialize() method from within this method to initialize the connection, so long as the initialize() method contains no GUI code.

Specified by:

initialize in class SLPTransportInterface

Parameters:

properties - a reference to the properties file containing configuration information.

id - the transport ID number to load data for.

Throws:

TransportException - if there is a problem initializing the transport.

getTransportExceptionText

public java.lang.String getTransportExceptionText(TransportException ex)

Retrieves error information for a given TransportInitException. To ensure that we can keep code that uses the transport subclasses as generic as possible, this method should take a TransportInitException instance, inspect it, and provide a plaintext explaination for the error that can be shown to the user.

Specified by:

getTransportExceptionText in class SLPTransportInterface

Parameters:

ex - the TransportInitException to be inspected.

Returns:

a String object containing a text explaination for the exception.

getResourceBundleName

public java.lang.String getResourceBundleName()

Returns the fully-qualified classname for the resources package to use for this transport. Your Transport implementation should return a String containing the name of your ResourceBundle class here.

Specified by:

getResourceBundleName in class SLPTransportInterface

Returns:

a String object containing the fully qualified classname for a ResoureBundle class to use for this transport.

getTransportDescription

public java.lang.String getTransportDescription()

Returns the description for this Transport Interface. This method will return a string containing the description for this transport interface.

Specified by:

getTransportDescription in class SLPTransportInterface

Returns:

the description for this transport interface.