Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.server.SftpErrorStatusDataHandler

Modifier and Type	Field and Description
public static final SftpErrorStatusDataHandler	DEFAULT

Method Summary

Modifier and Type	Method and Description
public default String	Returns: The error message language tag - recommend returning empty string resolveErrorLanguage(SftpSubsystemEnvironment The SFTP subsystem instance sftpSubsystem, int The command identifier id, Throwable Thrown exception e, int The sub-status code obtained from invocation of `resolveSubStatus` subStatus, int The command that was attempted cmd, Object... The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version args)
public default String	Returns: The human readable text message that explains the failure reason resolveErrorMessage(SftpSubsystemEnvironment The SFTP subsystem instance sftpSubsystem, int The command identifier id, Throwable Thrown exception e, int The sub-status code obtained from invocation of `resolveSubStatus` subStatus, int The command that was attempted cmd, Object... The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version args)
public default int	Returns: The relevant sub-status to send as failure indication for the failed command resolveSubStatus(SftpSubsystemEnvironment The SFTP subsystem instance sftpSubsystem, int The command identifier id, Throwable Thrown exception e, int The command that was attempted cmd, Object... The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version args)

DEFAULT	back to summary
public static final SftpErrorStatusDataHandler DEFAULT

Method Detail

resolveErrorLanguage back to summary

resolveErrorLanguage	back to summary
public default String resolveErrorLanguage(SftpSubsystemEnvironment sftpSubsystem, int id, Throwable e, int subStatus, int cmd, Object... args) Parameters sftpSubsystem:SftpSubsystemEnvironment The SFTP subsystem instance id:int The command identifier e:Throwable Thrown exception subStatus:int The sub-status code obtained from invocation of `resolveSubStatus` cmd:int The command that was attempted args:Object[] The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version Returns:String The error message language tag - recommend returning empty string

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

Parameters

sftpSubsystem:SftpSubsystemEnvironment: The SFTP subsystem instance
id:int: The command identifier
e:Throwable: Thrown exception
subStatus:int: The sub-status code obtained from invocation of resolveSubStatus
cmd:int: The command that was attempted
args:Object[]: The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version

Returns:String

The error message language tag - recommend returning empty string

resolveErrorMessage back to summary

resolveErrorMessage	back to summary
public default String resolveErrorMessage(SftpSubsystemEnvironment sftpSubsystem, int id, Throwable e, int subStatus, int cmd, Object... args) Parameters sftpSubsystem:SftpSubsystemEnvironment The SFTP subsystem instance id:int The command identifier e:Throwable Thrown exception subStatus:int The sub-status code obtained from invocation of `resolveSubStatus` cmd:int The command that was attempted args:Object[] The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version Returns:String The human readable text message that explains the failure reason See Also `SftpHelper#resolveStatusMessage(int)`

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

Parameters

sftpSubsystem:SftpSubsystemEnvironment: The SFTP subsystem instance
id:int: The command identifier
e:Throwable: Thrown exception
subStatus:int: The sub-status code obtained from invocation of resolveSubStatus
cmd:int: The command that was attempted
args:Object[]: The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version

Returns:String

The human readable text message that explains the failure reason

See Also

SftpHelper#resolveStatusMessage(int)

resolveSubStatus back to summary

resolveSubStatus	back to summary
public default int resolveSubStatus(SftpSubsystemEnvironment sftpSubsystem, int id, Throwable e, int cmd, Object... args) Parameters sftpSubsystem:SftpSubsystemEnvironment The SFTP subsystem instance id:int The command identifier e:Throwable Thrown exception cmd:int The command that was attempted args:Object[] The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version Returns:int The relevant sub-status to send as failure indication for the failed command See Also `SftpHelper#resolveSubstatus(Throwable)`

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

Parameters

sftpSubsystem:SftpSubsystemEnvironment: The SFTP subsystem instance
id:int: The command identifier
e:Throwable: Thrown exception
cmd:int: The command that was attempted
args:Object[]: The relevant command arguments - Note: provided only for logging purposes and subject to type and/or order change at any version

Returns:int

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

public Interface SftpErrorStatusDataHandler

Field Summary

Method Summary

Field Detail

Method Detail