Class AuthenticationMechanism

The base class for an authentication mechanism.

Inheritance
Object
AuthenticationMechanism
TlsAuthenticationMechanism
Inherited Members
Namespace: FubarDev.FtpServer.Authentication
Assembly: FubarDev.FtpServer.Abstractions.dll
Syntax
public abstract class AuthenticationMechanism : IAuthenticationMechanism

Constructors

| Improve this Doc View Source

AuthenticationMechanism(IFtpConnection)

Initializes a new instance of the AuthenticationMechanism class.

Declaration
protected AuthenticationMechanism(IFtpConnection connection)
Parameters
Type Name Description
IFtpConnection connection

The required FTP connection.

Properties

| Improve this Doc View Source

Connection

Gets the FTP connection.

Declaration
public IFtpConnection Connection { get; }
Property Value
Type Description
IFtpConnection

Methods

| Improve this Doc View Source

CanHandle(String)

Declaration
public abstract bool CanHandle(string methodIdentifier)
Parameters
Type Name Description
String methodIdentifier
Returns
Type Description
Boolean
| Improve this Doc View Source

HandleAdatAsync(Byte[], CancellationToken)

Declaration
public abstract Task<IFtpResponse> HandleAdatAsync(byte[] data, CancellationToken cancellationToken)
Parameters
Type Name Description
Byte[] data
CancellationToken cancellationToken
Returns
Type Description
Task<IFtpResponse>
| Improve this Doc View Source

HandleAuthAsync(String, CancellationToken)

Declaration
public abstract Task<IFtpResponse> HandleAuthAsync(string methodIdentifier, CancellationToken cancellationToken)
Parameters
Type Name Description
String methodIdentifier
CancellationToken cancellationToken
Returns
Type Description
Task<IFtpResponse>
| Improve this Doc View Source

HandlePbszAsync(Int64, CancellationToken)

Declaration
public abstract Task<IFtpResponse> HandlePbszAsync(long size, CancellationToken cancellationToken)
Parameters
Type Name Description
Int64 size
CancellationToken cancellationToken
Returns
Type Description
Task<IFtpResponse>
| Improve this Doc View Source

HandleProtAsync(String, CancellationToken)

Declaration
public abstract Task<IFtpResponse> HandleProtAsync(string protCode, CancellationToken cancellationToken)
Parameters
Type Name Description
String protCode
CancellationToken cancellationToken
Returns
Type Description
Task<IFtpResponse>
| Improve this Doc View Source

Reset()

Declaration
public abstract void Reset()
| Improve this Doc View Source

T(String)

Translates a message using the current catalog of the active connection.

Declaration
protected string T(string message)
Parameters
Type Name Description
String message

The message to translate.
Returns
Type Description
String

The translated message.
| Improve this Doc View Source

T(String, Object[])

Translates a message using the current catalog of the active connection.

Declaration
[StringFormatMethod("message")]
protected string T(string message, params object[] args)
Parameters
Type Name Description
String message

The message to translate.
Object[] args

The format arguments.
Returns
Type Description
String

The translated message.

Implements