oracle.ifs.protocols.utils

Class IfsProtocolClientChannel

java.lang.Object

oracle.ifs.protocols.utils.IfsProtocolClientChannel

public class IfsProtocolClientChannel
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseMain	m_BaseMain If the user wishes to get Cc'd on the replies
protected boolean	m_BinaryTransfer transfer mode (bin or ascii)
protected byte[]	m_Buff instance buffer for data transfers
protected boolean	m_Connected Are we connected?
protected Socket	m_ControlSocket used for control messages (non-data)
protected PrintWriter	m_ControlStream control messages are sent on this stream
protected Socket	m_DataSocket data socket
protected InetAddress	m_ftpHost address of data socketServer
protected boolean	m_ReissuePassiveModeCommand should we re-issue PASV for every new data transfer?
protected int	m_remotePort port of data socketServer
protected BufferedReader	m_ReplyStream control replies are received on this stream
protected String	m_ServerName For re-connect: what was the server?
protected int	m_ServerPort For re-connect: what was the port?
static int	REPLY_STATUS_ERROR
static int	REPLY_STATUS_INCOMPLETE
static int	REPLY_STATUS_NOOP
static int	REPLY_STATUS_SUCCESS
static int	s_TransferBufferSize size of the content transfer buffer

Constructor Summary

Constructors

Constructor and Description
IfsProtocolClientChannel() default constructor

Method Summary

Modifier and Type	Method and Description
String	checkReply() read replies until "done".
String	checkReply(boolean returnOnPreliminaryReply)
void	connect(String hostname)
void	connect(String hostname, int port)
void	disconnect()
protected Socket	getDataSocket()
String	getFile(String path)
String	getFile(String remotePath, String localPath)
String	getReplyArgument(String reply)
int	getReplyStatus(String reply)
String	invokeControlOnlyCommand(String command)
String	invokeMultiLineTextResultCommand(String command, IfsProtocolClientCallback writer)
void	log(String msg)
protected void	openDataConnection()
String	putFile(String path)
String	putFile(String localPath, String remotePath)
void	reconnect()
void	releaseSockets()
void	reset()
void	sendCommand(String command)
void	setLogger(BaseMain logger) set the logger
void	setReissuePassiveModeCommand(boolean mode)
void	setType(boolean binary)
void	traceTime(String msg)
protected int	transferContent(InputStream iss, OutputStream os)
boolean	validateCookie(String cookie)

Methods inherited from class java.lang.Object

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

Field Detail

REPLY_STATUS_INCOMPLETE

public static final int REPLY_STATUS_INCOMPLETE

See Also:

Constant Field Values

REPLY_STATUS_SUCCESS

public static final int REPLY_STATUS_SUCCESS

See Also:

Constant Field Values

REPLY_STATUS_NOOP

public static final int REPLY_STATUS_NOOP

See Also:

Constant Field Values

REPLY_STATUS_ERROR

public static final int REPLY_STATUS_ERROR

See Also:

Constant Field Values

s_TransferBufferSize

public static final int s_TransferBufferSize

size of the content transfer buffer

See Also:

Constant Field Values

m_ReissuePassiveModeCommand

protected boolean m_ReissuePassiveModeCommand

should we re-issue PASV for every new data transfer?

m_ControlSocket

protected Socket m_ControlSocket

used for control messages (non-data)

m_ControlStream

protected PrintWriter m_ControlStream

control messages are sent on this stream

m_ReplyStream

protected BufferedReader m_ReplyStream

control replies are received on this stream

m_BaseMain

protected BaseMain m_BaseMain

If the user wishes to get Cc'd on the replies

m_BinaryTransfer

protected boolean m_BinaryTransfer

transfer mode (bin or ascii)

m_Buff

protected byte[] m_Buff

instance buffer for data transfers

m_DataSocket

protected Socket m_DataSocket

data socket

m_ftpHost

protected InetAddress m_ftpHost

address of data socketServer

m_remotePort

protected int m_remotePort

port of data socketServer

m_Connected

protected boolean m_Connected

Are we connected?

m_ServerName

protected String m_ServerName

For re-connect: what was the server?

m_ServerPort

protected int m_ServerPort

For re-connect: what was the port?

Constructor Detail

IfsProtocolClientChannel

public IfsProtocolClientChannel()

default constructor

Method Detail

setLogger

public void setLogger(BaseMain logger)

set the logger

setReissuePassiveModeCommand

public void setReissuePassiveModeCommand(boolean mode)

reconnect

public void reconnect()
               throws Exception

Throws:

Exception

connect

public void connect(String hostname)
             throws IOException,
                    UnknownHostException

Throws:

IOException

UnknownHostException

connect

public void connect(String hostname,
                    int port)
             throws IOException,
                    UnknownHostException

Throws:

IOException

UnknownHostException

validateCookie

public boolean validateCookie(String cookie)
                       throws Exception

Throws:

Exception

disconnect

public void disconnect()
                throws IOException,
                       Exception

Throws:

IOException

Exception

reset

public void reset()

releaseSockets

public void releaseSockets()
                    throws IOException

Throws:

IOException

invokeControlOnlyCommand

public String invokeControlOnlyCommand(String command)
                                throws Exception

Throws:

Exception

invokeMultiLineTextResultCommand

public String invokeMultiLineTextResultCommand(String command,
                                               IfsProtocolClientCallback writer)
                                        throws Exception,
                                               IOException

Throws:

Exception

IOException

getFile

public String getFile(String path)
               throws IOException,
                      Exception

Throws:

IOException

Exception

getFile

public String getFile(String remotePath,
                      String localPath)
               throws IOException,
                      Exception

Throws:

IOException

Exception

putFile

public String putFile(String path)
               throws IOException,
                      Exception

Throws:

IOException

Exception

putFile

public String putFile(String localPath,
                      String remotePath)
               throws Exception,
                      IOException

Throws:

Exception

IOException

setType

public void setType(boolean binary)
             throws Exception

Throws:

Exception

transferContent

protected int transferContent(InputStream iss,
                              OutputStream os)
                       throws IOException

Throws:

IOException

openDataConnection

protected void openDataConnection()
                           throws Exception,
                                  IOException

Throws:

Exception

IOException

getDataSocket

protected Socket getDataSocket()

checkReply

public String checkReply()
                  throws IOException

read replies until "done". You are done if: - you want "preliminary" replies and you get a 100 message - you get a 200,300,400, or 500 that doesn't have a "-" after the number.

Throws:

IOException

checkReply

public String checkReply(boolean returnOnPreliminaryReply)
                  throws IOException

Throws:

IOException

getReplyStatus

public int getReplyStatus(String reply)

getReplyArgument

public String getReplyArgument(String reply)

sendCommand

public void sendCommand(String command)
                 throws Exception

Throws:

Exception

log

public void log(String msg)

traceTime

public void traceTime(String msg)