Interface ISystemAuthenticationControl

The system authentication control feature that allows a client session to query and update the system authentication store.

Inherited Members
Namespace: PushTechnology.ClientInterface.Client.Features.Control.Clients
Assembly: Diffusion.Client.dll
Syntax
public interface ISystemAuthenticationControl : ISecurityStoreFeature, IFeature
Remarks

Access control

In order to query the store the session needs VIEW_SECURITY permission and in order to update the store it needs MODIFY_SECURITY permission.

Accessing the feature

This feature may be obtained from a ISession as follows 

var systemAuthenticationControl = session.SystemAuthenticationControl;

Added in version 5.2.

Properties

Script

Gets the builder that can be used to create scripts for use with UpdateStore(String, IUpdateStoreCallback).

Declaration
IScriptBuilder Script { get; }
Property Value
Type Description
IScriptBuilder

The default builder instance that creates an empty script.

Methods

GetSystemAuthentication(IConfigurationCallback)

Obtains the current contents of the store.

Declaration
void GetSystemAuthentication(IConfigurationCallback callback)
Parameters
Type Name Description
IConfigurationCallback callback

The callback to receive status notifications for this operation.
Remarks

Caution

Deprecated since 6.7. Methods that use callbacks are deprecated and will be removed in a future release. Use a Task instead.

GetSystemAuthentication<TContext>(TContext, IConfigurationContextCallback<TContext>)

Obtains the current contents of the store.

Declaration
void GetSystemAuthentication<TContext>(TContext context, IConfigurationContextCallback<TContext> callback)
Parameters
Type Name Description
TContext context

The context of this operation.
IConfigurationContextCallback<TContext> callback

The callback to receive status notifications for this operation.
Type Parameters
Name Description
TContext

The context type.
Remarks

Caution

Deprecated since 6.7. Methods that use contextual callbacks are deprecated and will be removed in a future release. Use a Task instead.

GetSystemAuthenticationAsync()

Obtains the current contents of the store.

Declaration
Task<ISystemAuthenticationConfiguration> GetSystemAuthenticationAsync()
Returns
Type Description
Task<ISystemAuthenticationConfiguration>

The Task representing the current operation.
Remarks

If the operation completes successfully, the Task result will be a ISystemAuthenticationConfiguration instance.

This method is the same as calling GetSystemAuthenticationAsync(CancellationToken) with System.Threading.CancellationToken.None.

Exceptions
Type Condition
SessionSecurityException

The calling session does not have VIEW_SECURITY permission. Thrown by the returned Task.
SessionClosedException

The calling session is closed. Thrown by the returned Task.

GetSystemAuthenticationAsync(CancellationToken)

Obtains the current contents of the store.

Declaration
Task<ISystemAuthenticationConfiguration> GetSystemAuthenticationAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

The cancellation token used to cancel the current operation.
Returns
Type Description
Task<ISystemAuthenticationConfiguration>

The Task representing the current operation.
Remarks

If the operation completes successfully, the Task result will be a ISystemAuthenticationConfiguration instance.

Exceptions
Type Condition
SessionSecurityException

The calling session does not have VIEW_SECURITY permission. Thrown by the returned Task.
SessionClosedException

The calling session is closed. Thrown by the returned Task.