|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Listener
Interface for the component responsible for waiting for incoming
socket requests and kicking off FtpIoSession
s
Method Summary | |
---|---|
java.util.Set<FtpIoSession> |
getActiveSessions()
Returns the currently active sessions for this listener. |
DataConnectionConfiguration |
getDataConnectionConfiguration()
Get configuration for data connections made within this listener |
int |
getPort()
Get the port on which this listener is waiting for requests. |
java.net.InetAddress |
getServerAddress()
Get the InetAddress used for binding the local socket. |
SslConfiguration |
getSslConfiguration()
Get the SslConfiguration used for this listener |
boolean |
isImplicitSsl()
Is this listener in SSL mode automatically or must the client explicitly request to use SSL |
boolean |
isStopped()
Checks if the listener is currently started. |
boolean |
isSuspended()
Checks if the listener is currently suspended |
void |
resume()
Resumes a suspended listener. |
void |
setDataConnectionConfiguration(DataConnectionConfiguration dataConnectionConfig)
Set configuration for data connections made within this listener |
void |
setImplicitSsl(boolean implicitSsl)
Should this listener be in SSL mode automatically or must the client explicitly request to use SSL |
void |
setPort(int port)
Set the port on which this listener will accept requests. |
void |
setServerAddress(java.net.InetAddress serverAddress)
Set the InetAddress used for binding the local socket. |
void |
setSslConfiguration(SslConfiguration sslConfiguration)
Set the SslConfiguration used for this listener |
void |
start(FtpServerContext serverContext)
Start the listener, will initiate the listener waiting on the socket. |
void |
stop()
Stop the listener, it should no longer except socket requests. |
void |
suspend()
Temporarily stops the listener from accepting socket requests. |
Method Detail |
---|
void start(FtpServerContext serverContext) throws java.lang.Exception
java.lang.Exception
- On error during start upvoid stop()
boolean isStopped()
void suspend()
resume()
method.
The method should not return until the listener has stopped
accepting socket requests.
void resume()
boolean isSuspended()
java.util.Set<FtpIoSession> getActiveSessions()
Set
would be returned.
boolean isImplicitSsl()
void setImplicitSsl(boolean implicitSsl)
implicitSsl
- true is the listener should automatically be in SSL mode, false otherwiseSslConfiguration getSslConfiguration()
SslConfiguration
used for this listener
SslConfiguration
void setSslConfiguration(SslConfiguration sslConfiguration)
SslConfiguration
used for this listener
sslConfiguration
- The SslConfiguration
int getPort()
void setPort(int port)
port
- The port to use.java.net.InetAddress getServerAddress()
InetAddress
used for binding the local socket. Defaults
to null, that is, the server binds to all available network interfaces
InetAddress
, if setvoid setServerAddress(java.net.InetAddress serverAddress)
InetAddress
used for binding the local socket. Defaults
to null, that is, the server binds to all available network interfaces
serverAddress
- The local socket InetAddress
DataConnectionConfiguration getDataConnectionConfiguration()
void setDataConnectionConfiguration(DataConnectionConfiguration dataConnectionConfig)
dataConnectionConfig
- The data connection configuration
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |