org.apache.sshd.server.subsystem.sftp

Interface SftpErrorStatusDataHandler

public interface SftpErrorStatusDataHandler

Invoked in order to format failed commands messages

Field Summary

Fields

Modifier and Type	Field and Description
static SftpErrorStatusDataHandler	DEFAULT

Method Summary

Modifier and Type	Method and Description
default java.lang.String	resolveErrorLanguage(SftpSubsystemEnvironment sftpSubsystem, int id, java.lang.Throwable e, int subStatus, int cmd, java.lang.Object... args)
default java.lang.String	resolveErrorMessage(SftpSubsystemEnvironment sftpSubsystem, int id, java.lang.Throwable e, int subStatus, int cmd, java.lang.Object... args)
default int	resolveSubStatus(SftpSubsystemEnvironment sftpSubsystem, int id, java.lang.Throwable e, int cmd, java.lang.Object... args)

Field Detail

DEFAULT

static final SftpErrorStatusDataHandler DEFAULT

Method Detail

resolveSubStatus

default int resolveSubStatus(SftpSubsystemEnvironment sftpSubsystem,
                             int id,
                             java.lang.Throwable e,
                             int cmd,
                             java.lang.Object... args)

Parameters:

sftpSubsystem - The SFTP subsystem instance

id - The command identifier

e - Thrown exception

cmd - The command that was attempted

args - The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version

Returns:

The relevant sub-status to send as failure indication for the failed command

See Also:

SftpHelper.resolveSubstatus(Throwable)

resolveErrorMessage

default java.lang.String resolveErrorMessage(SftpSubsystemEnvironment sftpSubsystem,
                                             int id,
                                             java.lang.Throwable e,
                                             int subStatus,
                                             int cmd,
                                             java.lang.Object... args)

Parameters:

sftpSubsystem - The SFTP subsystem instance

id - The command identifier

e - Thrown exception

subStatus - The sub-status code obtained from invocation of resolveSubStatus

cmd - The command that was attempted

args - The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version

Returns:

The human readable text message that explains the failure reason

See Also:

SftpHelper.resolveStatusMessage(int)

resolveErrorLanguage

default java.lang.String resolveErrorLanguage(SftpSubsystemEnvironment sftpSubsystem,
                                              int id,
                                              java.lang.Throwable e,
                                              int subStatus,
                                              int cmd,
                                              java.lang.Object... args)

Parameters:

sftpSubsystem - The SFTP subsystem instance

id - The command identifier

e - Thrown exception

subStatus - The sub-status code obtained from invocation of resolveSubStatus

cmd - The command that was attempted

args - The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version

Returns:

The error message language tag - recommend returning empty string