io

Class AsciiSocketDriver

java.lang.Object

util.PropertyContainer

io.AbstractDriver

io.AbstractSocketDriver

io.AsciiSocketDriver

All Implemented Interfaces:

Driver, StreamIODriver, Cloneable, ExitCleaning, Initializable, PropertySupplying

public class AsciiSocketDriver
extends AbstractSocketDriver

A class that reads and writes ASCII commands to the socket.

Author:

wooz

Field Summary

Fields

Modifier and Type	Field and Description
private BufferedReader	bin Wrapped around the socket output stream on open.
private BufferedWriter	bout Wrapped around the socket output stream on open.
static String	KEY_ALWAYSCLOSE The wait period for a sender to check its queue.
static String	KEY_SENDNEWLINE If true, send a new line after a command.

Fields inherited from class io.AbstractSocketDriver

KEY_CLOSETIMEOUT, KEY_SOCKETPORT, KEY_SOCKETSERVER, KEY_SOCKETTIMEOUT

Fields inherited from class io.AbstractDriver

KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
AsciiSocketDriver(Map<String,String> prop)

Method Summary

Modifier and Type	Method and Description
List<String>	commandAndResponse(String cmd)
boolean	open() Connect to remote host.
private String	readLine()
private void	writeString(String cmd) Writes a string to the strean

Methods inherited from class io.AbstractSocketDriver

authenticate, close, exit, getInputStream, getOutputStream, getSocket, init, isOpen, setTimeout

Methods inherited from class io.AbstractDriver

createDriver, equals, getDriverName, hashCode

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.Driver

getDriverName

Field Detail

KEY_ALWAYSCLOSE

public static final String KEY_ALWAYSCLOSE

The wait period for a sender to check its queue. Can be long.

See Also:

Constant Field Values

KEY_SENDNEWLINE

public static final String KEY_SENDNEWLINE

If true, send a new line after a command.

See Also:

Constant Field Values

bin

private BufferedReader bin

Wrapped around the socket output stream on open.

bout

private BufferedWriter bout

Wrapped around the socket output stream on open.

Constructor Detail

AsciiSocketDriver

public AsciiSocketDriver(Map<String,String> prop)

Parameters:

prop -

Method Detail

open

public boolean open()
             throws IOException

Connect to remote host. If we have already connected in persistent mode, reconnection is

Specified by:

open in interface Driver

Overrides:

open in class AbstractSocketDriver

Returns:

True if initialization was successful.

Throws:

IOException - Exception to throw on connection error

writeString

private void writeString(String cmd)
                  throws IOException

Writes a string to the strean

Parameters:

cmd -

Throws:

IOException

readLine

private String readLine()
                 throws IOException

Throws:

IOException

commandAndResponse

public List<String> commandAndResponse(String cmd)
                                throws IOException

Throws:

IOException