Joutsen.AuthenticationControl.AuthenticatedCommand Class Reference

A base class used when the command requires authentication before it is executed. More...

Public Member Functions
abstract void	ExecuteAuthenticated ()
	In derived classes contains the logic of the command. More...
override void	Execute ()
	In derived classes executes the logic of the command. More...

Static Public Member Functions
static SubParser	ConfigureParser (SubParser parser)
	Can be used to configure a parser with the credentials argument. More...

Properties
String	Credentials [set]
	The username and password separated by a colon used to authenticate the execution of a command. More...
Authenticator	AuthProvider [get, set]
	The authentication provider used to check the credentials. More...

Detailed Description

A base class used when the command requires authentication before it is executed.

Remarks

The command will always check the credentials before executing any logic. If no valid credentials are provided the logic will not be executed. In order to pass the credentials check, the provided user must be authenticated using a password and needs to have the "Admin" role for the AuthenticationService. Additionally the command will ask for missing credentials using the command line.

Since

0.1.0

Member Function Documentation

ConfigureParser()

static SubParser Joutsen.AuthenticationControl.AuthenticatedCommand.ConfigureParser ( SubParser  parser )

static

Can be used to configure a parser with the credentials argument.

Execute()

override void Joutsen.AuthenticationControl.AuthenticatedCommand.Execute ( )

virtual

In derived classes executes the logic of the command.

Implements Joutsen.AuthenticationControl.Command.

ExecuteAuthenticated()

abstract void Joutsen.AuthenticationControl.AuthenticatedCommand.ExecuteAuthenticated ( )

pure virtual

In derived classes contains the logic of the command.

Implemented in Joutsen.AuthenticationControl.CreateRoleCommand, Joutsen.AuthenticationControl.ListUsersCommand, Joutsen.AuthenticationControl.DeleteRoleCommand, Joutsen.AuthenticationControl.CreateApplicationCommand, Joutsen.AuthenticationControl.ListRolesCommand, Joutsen.AuthenticationControl.ListApplicationsCommand, Joutsen.AuthenticationControl.UpdateUserCommand, Joutsen.AuthenticationControl.DeleteApplicationCommand, Joutsen.AuthenticationControl.CreateUserCommand, and Joutsen.AuthenticationControl.DeleteUserCommand.

Property Documentation

AuthProvider

Authenticator Joutsen.AuthenticationControl.AuthenticatedCommand.AuthProvider

getset

The authentication provider used to check the credentials.

Credentials

String Joutsen.AuthenticationControl.AuthenticatedCommand.Credentials

set

The username and password separated by a colon used to authenticate the execution of a command.