Class LoginCommand

Namespace

Core.CliniCore.Commands.Authentication

Assembly

Core.CliniCore.dll

Command that authenticates a user and creates a new session.

public class LoginCommand : AbstractCommand, ICommand

Inheritance

object

AbstractCommand

LoginCommand

Implements

ICommand

Inherited Members

AbstractCommand._lastExecutionParameters

AbstractCommand._lastExecutionSession

AbstractCommand._previousState

AbstractCommand.CommandId

AbstractCommand.CommandName

AbstractCommand.Validate(CommandParameters, SessionContext)

AbstractCommand.Execute(CommandParameters, SessionContext)

AbstractCommand.Undo(SessionContext)

AbstractCommand.ValidateAuthorization(SessionContext)

AbstractCommand.CaptureStateForUndo(CommandParameters, SessionContext)

AbstractCommand.UndoCore(object, SessionContext)

AbstractCommand.LogExecution(SessionContext)

AbstractCommand.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

LoginCommand(IAuthenticationService)

Initializes a new instance of the LoginCommand class.

public LoginCommand(IAuthenticationService authService)

Parameters

authService IAuthenticationService

The authentication service used to validate credentials.

Exceptions

ArgumentNullException

Thrown when authService is null.

Fields

Key

The unique key used to identify this command.

public const string Key = "login"

Field Value

string

Properties

CanUndo

Whether this command can be undone - defaults to false

public override bool CanUndo { get; }

Property Value

bool

CommandKey

Unique key identifier for this command type Generated from the class name, converted to lowercase without "Command" suffix E.g., "LoginCommand" becomes "login", "CreatePatientCommand" becomes "createpatient"

public override string CommandKey { get; }

Property Value

string

Description

Description of what this command does

public override string Description { get; }

Property Value

string

Methods

ExecuteCore(CommandParameters, SessionContext?)

Executes the core command logic - must be implemented by derived classes

protected override CommandResult ExecuteCore(CommandParameters parameters, SessionContext? session)

Parameters

parameters CommandParameters

session SessionContext

Returns

CommandResult

GetRequiredPermission()

Gets the required permission to execute this command

public override Permission? GetRequiredPermission()

Returns

Permission?

ValidateParameters(CommandParameters)

Validates command parameters - override in derived classes

protected override CommandValidationResult ValidateParameters(CommandParameters parameters)

Parameters

parameters CommandParameters

The parameters to validate (never null, but may be empty)

Returns

CommandValidationResult

Validation result indicating success or failure with error messages

ValidateSpecific(CommandParameters, SessionContext?)

Performs command-specific validation - override in derived classes if needed

protected override CommandValidationResult ValidateSpecific(CommandParameters parameters, SessionContext? session)

Parameters

parameters CommandParameters

session SessionContext

Returns

CommandValidationResult