unlimited.fc.client.engine

Class FCClientControlSocket

java.lang.Object

unlimited.fc.client.engine.FCClientControlSocket

public final class FCClientControlSocket
extends java.lang.Object

Supports client-side FileCatalyst operations The protocol used by FC (FileCatalyst client) is similar with FTP protocol

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FCClientControlSocket.FCSiteDO

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Supplier<java.lang.Boolean>	USE_STICKY_SESSIONS

Constructor Summary

Constructors

Constructor and Description
FCClientControlSocket(java.net.Socket controlSocket, boolean sslSocket, LogUtils fileLog, int timeout)

Method Summary

Modifier and Type	Method and Description
void	addLostReply(FCReply lostReply)
void	addLostReply(java.lang.String reply)
FCSiteIfc	checkIfConnectedToLoadBalancer()
void	close()
void	connectToHost(java.lang.String remoteHost, int controlPort)
void	connectToServer(java.lang.String remoteHost, int controlPort)
java.net.Socket	createDataSocket()
java.net.Socket	createDataSocket(boolean nio)
java.net.Socket	createDataSocketActive()
java.net.Socket	createDataSocketActiveSendCommand(java.lang.String command)
java.net.Socket	createDataSocketPassive()
java.net.Socket	createDataSocketPassive(boolean nio) Request a data socket be created on the server, connect to it and return our connected socket.
java.net.Socket[]	createDataSocketPassive(int num)
java.net.Socket[]	createDataSocketPassive(int num, boolean nio) Request several data sockets be created on the server, connect and return our connected sockets.
java.net.Socket[]	createDataSockets(int num)
javax.net.ssl.SSLSocket	createSSLSocket(java.lang.String host, int port)
javax.net.ssl.SSLSocket	createSSLSocket(java.lang.String host, int port, boolean needHandshake)
void	debugResponses(boolean on) Switch debug of responses on or off
java.net.InetAddress	getAddress()
int	getAvgRTT()
int	getControlPort()
static FCClientControlSocket	getControlSocket(FCClientControlSocketRequestData requestData)
int	getCurrentRTT()
java.lang.String	getHost()
java.lang.String	getLocalHost() Get the name of the remote host
LogUtils	getLog()
FCReply	getLostReplies(java.lang.String... replyCodes)
FCReply	getLostReply(java.lang.String replyCode)
int	getLowRTT()
int	getPort()
java.lang.String	getRemoteHostName() Get the name of the remote host
int	getRemotePort()
FCSiteIfc	getResolvedSiteDO()
java.lang.String	getSysKey()
java.lang.String	getWelcomeMessage()
boolean	isIPv6()
boolean	isSsl()
boolean	isSSL()
long	lastActivity()
void	logout() Quit this FileCatalyst session and clean up.
java.util.List<java.lang.String>	parseHosts(java.lang.String remoteHost)
static int	parsePort(int parseFirst, int parseSecond)
java.lang.String	readReply()
java.lang.String	readReply(boolean log) Read the FileCatalyst server's reply to a previously issued command.
void	reconnect()
void	registerLookUp(FCSiteIfc lookup)
java.lang.String	sendCommand(java.lang.String command) Send a command to the FileCatalyst server and return the server's reply
java.lang.String	sendCommand(java.lang.StringBuffer command) Send a command to the FileCatalyst server and return the server's reply
void	sendCommandNoReply(java.lang.String command) Send a command to the FileCatalyst server and return the server's reply
void	setConnectTimeout()
void	setIPTOSIfRequired()
void	setLogStream(LogUtils fileLog) Set the logging stream, replacing stdout
void	setTimeout(int millis) Set the TCP timeout on the underlying control socket.
void	setWelcomeMessage(java.lang.String welcomeMessage)

Methods inherited from class java.lang.Object

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

Field Detail

USE_STICKY_SESSIONS

public static final java.util.function.Supplier<java.lang.Boolean> USE_STICKY_SESSIONS

Constructor Detail

FCClientControlSocket

public FCClientControlSocket(java.net.Socket controlSocket,
                             boolean sslSocket,
                             LogUtils fileLog,
                             int timeout)
                      throws java.io.IOException,
                             FCException

Throws:

java.io.IOException

FCException

Method Detail

getControlSocket

public static FCClientControlSocket getControlSocket(FCClientControlSocketRequestData requestData)
                                              throws java.io.IOException,
                                                     FCException

Throws:

java.io.IOException

FCException

connectToHost

public void connectToHost(java.lang.String remoteHost,
                          int controlPort)
                   throws java.io.IOException

Throws:

java.io.IOException

parseHosts

public java.util.List<java.lang.String> parseHosts(java.lang.String remoteHost)

checkIfConnectedToLoadBalancer

public FCSiteIfc checkIfConnectedToLoadBalancer()
                                         throws java.io.IOException

Throws:

java.io.IOException

connectToServer

public void connectToServer(java.lang.String remoteHost,
                            int controlPort)
                     throws java.io.IOException,
                            java.net.SocketException

Throws:

java.io.IOException

java.net.SocketException

createSSLSocket

public javax.net.ssl.SSLSocket createSSLSocket(java.lang.String host,
                                               int port)
                                        throws java.io.IOException

Throws:

java.io.IOException

createSSLSocket

public javax.net.ssl.SSLSocket createSSLSocket(java.lang.String host,
                                               int port,
                                               boolean needHandshake)
                                        throws java.io.IOException

Throws:

java.io.IOException

getRemoteHostName

public java.lang.String getRemoteHostName()

Get the name of the remote host

Returns:

remote host name

isSSL

public boolean isSSL()

getLog

public LogUtils getLog()

getAddress

public java.net.InetAddress getAddress()

getRemotePort

public int getRemotePort()

isIPv6

public boolean isIPv6()

reconnect

public void reconnect()
               throws java.io.IOException,
                      FCException

Throws:

java.io.IOException

FCException

getLocalHost

public java.lang.String getLocalHost()

Get the name of the remote host

Returns:

remote host name

setTimeout

public void setTimeout(int millis)
                throws java.net.SocketException

Set the TCP timeout on the underlying control socket. If a timeout is set, then any operation which takes longer than the timeout value will be killed with a java.io.InterruptedException.

Parameters:

millis - The length of the timeout, in milliseconds

Throws:

java.io.IOException - if the timeout can not be set

java.net.SocketException

setConnectTimeout

public void setConnectTimeout()
                       throws java.net.SocketException

Throws:

java.net.SocketException

close

public void close()
           throws java.lang.Exception

Throws:

java.lang.Exception

logout

public void logout()
            throws java.io.IOException

Quit this FileCatalyst session and clean up.

Throws:

java.io.IOException - if an IOException is caught

sendCommandNoReply

public void sendCommandNoReply(java.lang.String command)
                        throws java.io.IOException

Send a command to the FileCatalyst server and return the server's reply

Parameters:

command - the command to be send to FTP server

Throws:

java.io.IOException - if the send is failing

sendCommand

public java.lang.String sendCommand(java.lang.String command)
                             throws java.io.IOException

Send a command to the FileCatalyst server and return the server's reply

Parameters:

command - the command to be send to FTP server

Returns:

reply to the supplied command

Throws:

java.io.IOException - if the send is failing

lastActivity

public long lastActivity()

sendCommand

public java.lang.String sendCommand(java.lang.StringBuffer command)
                             throws java.io.IOException

Send a command to the FileCatalyst server and return the server's reply

Parameters:

command - the command to be send to FTP server

Returns:

reply to the supplied command

Throws:

java.io.IOException - if the send is failing

getAvgRTT

public int getAvgRTT()

getLowRTT

public int getLowRTT()

getCurrentRTT

public int getCurrentRTT()

readReply

public java.lang.String readReply()
                           throws java.io.IOException

Throws:

java.io.IOException

readReply

public java.lang.String readReply(boolean log)
                           throws java.io.IOException

Read the FileCatalyst server's reply to a previously issued command. RFC 959 states that a reply consists of the 3 digit code followed by text. The 3 digit code is followed by a hyphen if it is a multiline response, and the last line starts with the same 3 digit code.

Returns:

reply string

Throws:

java.io.IOException - if an IOException is caught.

debugResponses

public void debugResponses(boolean on)

Switch debug of responses on or off

Parameters:

on - true if you wish to have responses to stdout, false otherwise

setLogStream

public void setLogStream(LogUtils fileLog)

Set the logging stream, replacing stdout

Parameters:

logFile - the new logging stream

createDataSocketPassive

public java.net.Socket[] createDataSocketPassive(int num)
                                          throws java.io.IOException,
                                                 FCException

Throws:

java.io.IOException

FCException

createDataSocketPassive

public java.net.Socket[] createDataSocketPassive(int num,
                                                 boolean nio)
                                          throws java.io.IOException,
                                                 FCException

Request several data sockets be created on the server, connect and return our connected sockets.

Returns:

connected data sockets

Throws:

java.io.IOException - if an IOException is caught.

FtpException - if the server socket can not be created

FCException

parsePort

public static int parsePort(int parseFirst,
                            int parseSecond)

createDataSocketPassive

public java.net.Socket createDataSocketPassive()
                                        throws java.io.IOException,
                                               FCException

Throws:

java.io.IOException

FCException

createDataSocketPassive

public java.net.Socket createDataSocketPassive(boolean nio)
                                        throws java.io.IOException,
                                               FCException

Request a data socket be created on the server, connect to it and return our connected socket.

Returns:

connected data socket

Throws:

java.io.IOException - if an IOException is caught.

FtpException - if the server socket can not be created

FCException

createDataSocketActive

public java.net.Socket createDataSocketActive()
                                       throws java.io.IOException,
                                              FCException

Throws:

java.io.IOException

FCException

createDataSocketActiveSendCommand

public java.net.Socket createDataSocketActiveSendCommand(java.lang.String command)
                                                  throws java.io.IOException,
                                                         FCException

Throws:

java.io.IOException

FCException

createDataSocket

public java.net.Socket createDataSocket()
                                 throws java.io.IOException,
                                        FCException

Throws:

java.io.IOException

FCException

createDataSocket

public java.net.Socket createDataSocket(boolean nio)
                                 throws java.io.IOException,
                                        FCException

Throws:

java.io.IOException

FCException

createDataSockets

public java.net.Socket[] createDataSockets(int num)
                                    throws java.io.IOException,
                                           FCException

Throws:

java.io.IOException

FCException

setWelcomeMessage

public void setWelcomeMessage(java.lang.String welcomeMessage)

getWelcomeMessage

public java.lang.String getWelcomeMessage()

addLostReply

public final void addLostReply(java.lang.String reply)

addLostReply

public final void addLostReply(FCReply lostReply)

getLostReplies

public final FCReply getLostReplies(java.lang.String... replyCodes)

getLostReply

public final FCReply getLostReply(java.lang.String replyCode)

setIPTOSIfRequired

public void setIPTOSIfRequired()
                        throws java.io.IOException

Throws:

java.io.IOException

getSysKey

public java.lang.String getSysKey()

getControlPort

public int getControlPort()

isSsl

public boolean isSsl()

getHost

public java.lang.String getHost()

getPort

public int getPort()

getResolvedSiteDO

public FCSiteIfc getResolvedSiteDO()

registerLookUp

public void registerLookUp(FCSiteIfc lookup)