AcceptConnection Event

Fired when a client connects.

Syntax

public open class DefaultOftpserverEventListener : OftpserverEventListener {
  ...
  public override fun acceptConnection(e: OftpserverAcceptConnectionEvent) {}
  ...
}

public class OftpserverAcceptConnectionEvent {
  val connectionId: String?
  val clientSSIDCode: String?
  val clientPassword: String?
  val clientVersion: Int
  var serverVersion: Int
  var accept: Boolean
  var errorCode: Int
  var errorDescription: String?
}

Remarks

This event fires when a new OFTP connection is made to the server. Use the parameters of this event to verify the identify of the client identified by the ConnectionId. By default the connection will be accepted. To reject the connection set Accept to false.

ClientVersion specifies the OFTP protocol version the client supports. By default the component will use the version requested by the client for the connection. If you wish to restrict connections to a specific OFTP protocol version use this value when determining whether or not to accept the connection. When rejecting the connection based on the OFTP protocol version use ErrorCode 10. Possible values are:

ServerVersion specifies the OFTP protocol version the server will use for the connection. By default this will be the same as ClientVersion. This may be set to a different version which will be sent back to the client. Possible values are:

When rejecting a connection the ErrorCode and ErrorDescription may optionally be set. Possible common values are: