Class AuthorizationMechanism

The base class for an authorization mechanism.

Inheritance

Object

AuthorizationMechanism

PasswordAuthorization

Implements

IAuthorizationMechanism

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: FubarDev.FtpServer.Authorization

Assembly: FubarDev.FtpServer.Abstractions.dll

Syntax

public abstract class AuthorizationMechanism : IAuthorizationMechanism

Constructors

| Improve this Doc View Source

AuthorizationMechanism(IFtpConnection)

Initializes a new instance of the AuthorizationMechanism class.

Declaration

protected AuthorizationMechanism(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

HandleAcctAsync(String, CancellationToken)

Declaration

public abstract Task<IFtpResponse> HandleAcctAsync(string account, CancellationToken cancellationToken)

Parameters

Type	Name	Description
String	account
CancellationToken	cancellationToken

Returns

Type	Description
Task<IFtpResponse>

| Improve this Doc View Source

HandlePassAsync(String, CancellationToken)

Declaration

public abstract Task<IFtpResponse> HandlePassAsync(string password, CancellationToken cancellationToken)

Parameters

Type	Name	Description
String	password
CancellationToken	cancellationToken

Returns

Type	Description
Task<IFtpResponse>

| Improve this Doc View Source

HandleUserAsync(String, CancellationToken)

Declaration

public abstract Task<IFtpResponse> HandleUserAsync(string userIdentifier, CancellationToken cancellationToken)

Parameters

Type	Name	Description
String	userIdentifier
CancellationToken	cancellationToken

Returns

Type	Description
Task<IFtpResponse>

| Improve this Doc View Source

Reset(Nullable<IAuthenticationMechanism>)

Declaration

public abstract void Reset(IAuthenticationMechanism? authenticationMechanism)

Parameters

Type	Name	Description
Nullable<IAuthenticationMechanism>	authenticationMechanism

| 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

IAuthorizationMechanism