PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder Interface Reference

A script builder may be used to create a script of commands to apply to the system authentication store at the server. More...

Inherited by PushTechnology.ClientInterface.Client.Features.Impl.SystemAuthenticationControl.ScriptBuilderImpl.

Public Member Functions
ISystemAuthenticationControlScriptBuilder	AddPrincipal (string name, string password, List< string > roles)
	Add a new principal. More...
ISystemAuthenticationControlScriptBuilder	SetPassword (string principal, string password)
	Set a principal's password. More...
ISystemAuthenticationControlScriptBuilder	VerifyPassword (string principal, string password)
	Assert that a principal's password is password . More...
ISystemAuthenticationControlScriptBuilder	AssignRoles (string principal, List< string > roles)
	Change a principal's assigned roles. More...
ISystemAuthenticationControlScriptBuilder	RemovePrincipal (string principal)
	Remove a principal. More...
ISystemAuthenticationControlScriptBuilder	AllowAnonymousConnections (List< string > roles)
	Instruct the system authentication handler to allow anonymous connections. This may be empty. More...
ISystemAuthenticationControlScriptBuilder	DenyAnonymousConnections ()
	Instruct the system authentication handler to deny anonymous connections. More...
ISystemAuthenticationControlScriptBuilder	AbstainAnonymousConnections ()
	Instruct the system authentication handler to defer authentication decisions for anonymous connections to subsequent handlers. More...
string	Script ()
	Create a script. More...

Detailed Description

A script builder may be used to create a script of commands to apply to the system authentication store at the server.

Each method call on the builder adds a line to the script and then the script may be built using the Script method which produces a string script which may be sent to the server using ISecurityStoreFeature.UpdateStore.

Such a builder may be created using ISystemAuthenticationControl.ScriptBuilder.

Member Function Documentation

ISystemAuthenticationControlScriptBuilder PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder.AbstainAnonymousConnections

(

)

Instruct the system authentication handler to defer authentication decisions for anonymous connections to subsequent handlers.

Returns

A new builder for scripts that abstain from authentication decisions for anonymous connections.

ISystemAuthenticationControlScriptBuilder PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder.AddPrincipal	(	string	name,
		string	password,
		List< string >	roles
	)

Add a new principal.

The script will fail if the principal is already defined at the server.

Parameters

name	The principal name.
password	The password.
roles	Assigned roles - may be empty.

Returns

A new builder for scripts that also add the princpal.

ISystemAuthenticationControlScriptBuilder PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder.AllowAnonymousConnections

(

List< string >

roles

)

Instruct the system authentication handler to allow anonymous connections. This may be empty.

Parameters

roles

The roles to assign anonymous session.

Returns

A new builder for scripts to allow anonymous connections.

ISystemAuthenticationControlScriptBuilder PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder.AssignRoles	(	string	principal,
		List< string >	roles
	)

Change a principal's assigned roles.

The specified principal must already be defined at the server.

Parameters

principal	The principal name.
roles	The assigned roles

Returns

A new builder for scripts that assign the roles.

ISystemAuthenticationControlScriptBuilder PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder.DenyAnonymousConnections

(

)

Instruct the system authentication handler to deny anonymous connections.

Returns

A new builder for scripts to deny anonymous connections.

ISystemAuthenticationControlScriptBuilder PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder.RemovePrincipal

(

string

principal

)

Remove a principal.

The principal must be the one that is already defined at the server.

Parameters

principal

The principal name.

Returns

A new builder for scripts that remove the principal.

string PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder.Script

(

)

Create a script.

Returns

The script.

ISystemAuthenticationControlScriptBuilder PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder.SetPassword	(	string	principal,
		string	password
	)

Set a principal's password.

The principal must already be defined at the server in order to set the password.

Parameters

principal	The principal name.
password	The password.

Returns

A new builder for scripts that also set the password.

ISystemAuthenticationControlScriptBuilder PushTechnology.ClientInterface.Client.Features.Control.Clients.ISystemAuthenticationControlScriptBuilder.VerifyPassword	(	string	principal,
		string	password
	)

Assert that a principal's password is password .

This command does not update the store. It can be used on conjunction with SetPassword to create a script that updates a password only if the previous password is supplied.

Parameters

principal	The principal name.
password	The password.

Returns

A new builder for scripts that also verify the password.

---

The documentation for this interface was generated from the following file:

• LegacyModule/Client/Features/Control/Clients/ISystemAuthenticationControlScriptBuilder.cs