public interface Listener
FtpIoSession
sModifier and Type | Method and Description |
---|---|
Set<FtpIoSession> |
getActiveSessions()
Returns the currently active sessions for this listener.
|
List<InetAddress> |
getBlockedAddresses()
Deprecated.
Replaced by IpFilter. Retrieves the
InetAddress for
which this listener blocks connections. |
List<org.apache.mina.filter.firewall.Subnet> |
getBlockedSubnets()
Deprecated.
Replaced by IpFilter. Retrieves the
Subnet s for this
listener blocks connections. |
DataConnectionConfiguration |
getDataConnectionConfiguration()
Get configuration for data connections made within this listener
|
int |
getIdleTimeout()
Get the number of seconds during which no network activity
is allowed before a session is closed due to inactivity.
|
int |
getPort()
Get the port on which this listener is waiting for requests.
|
String |
getServerAddress()
Get the
InetAddress used for binding the local socket. |
SessionFilter |
getSessionFilter()
Returns the
SessionFilter associated with this listener. |
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 |
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.
|
void start(FtpServerContext serverContext)
serverContext
- The current FtpServerContext
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()
Set<FtpIoSession> getActiveSessions()
Set
would be returned.boolean isImplicitSsl()
SslConfiguration getSslConfiguration()
SslConfiguration
used for this listenerSslConfiguration
int getPort()
String getServerAddress()
InetAddress
used for binding the local socket. Defaults
to null, that is, the server binds to all available network interfacesInetAddress
, if setDataConnectionConfiguration getDataConnectionConfiguration()
int getIdleTimeout()
@Deprecated List<InetAddress> getBlockedAddresses()
InetAddress
for
which this listener blocks connections.InetAddress
es. This method returns a valid
list if and only if there is an IpFilter
set, and,
if it is an instance of DefaultIpFilter
and it is of
type IpFilterType.DENY
. This functionality is
provided for backward compatibility purpose only.@Deprecated List<org.apache.mina.filter.firewall.Subnet> getBlockedSubnets()
Subnet
s for this
listener blocks connections.Subnet
s. This method returns a valid list if
and only if there is an IpFilter
set, and, if it is
an instance of DefaultIpFilter
and it is of type
IpFilterType.DENY
. This functionality is provided
for backward compatibility purpose only.SessionFilter getSessionFilter()
SessionFilter
associated with this listener. May
return null
.SessionFilter
associated with this listener. May
return null
.Copyright © 2003–2025 The Apache Software Foundation. All rights reserved.