Package com.pushtechnology.diffusion.client.features.control.clients

Interface SystemAuthenticationControl

All Superinterfaces:

Feature, SecurityStoreFeature

public interface SystemAuthenticationControl
extends SecurityStoreFeature

This feature allows a client session to query and update the system authentication store.

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 session as follows:

 SystemAuthenticationControl systemAuthenticationControl =
     session.feature(SystemAuthenticationControl.class);
 

Since:

5.2

Author:

DiffusionData Limited

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SystemAuthenticationControl.AnonymousConnectionAction	Action to be taken by the system authentication handler for connection attempts that do not provide a principal name and credentials.
static interface	SystemAuthenticationControl.ScriptBuilder	A script builder may be used to create a script of commands to apply to the system authentication store at the server.
static interface	SystemAuthenticationControl.SessionPropertyValidation	Defines the validation for a trusted client proposed session property.
static interface	SystemAuthenticationControl.SystemAuthenticationConfiguration	Snapshot of information from the system authentication store.
static interface	SystemAuthenticationControl.SystemPrincipal	A principal in the system authentication store.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SystemAuthenticationControl.SystemAuthenticationConfiguration>	getSystemAuthentication()	Obtain the current contents of the store.
SystemAuthenticationControl.ScriptBuilder	scriptBuilder()	Returns a builder that can be used to create scripts for use with updateStore.

Methods inherited from interface com.pushtechnology.diffusion.client.session.Feature

getSession

Methods inherited from interface com.pushtechnology.diffusion.client.features.control.clients.SecurityStoreFeature

updateStore

Method Details

getSystemAuthentication

CompletableFuture<SystemAuthenticationControl.SystemAuthenticationConfiguration> getSystemAuthentication()

Obtain the current contents of the store.

Returns:

a CompletableFuture that completes when a response is received from the server.

If the request was successful, the CompletableFuture will complete successfully with a SystemAuthenticationControl.SystemAuthenticationConfiguration result.

Otherwise, the CompletableFuture will complete exceptionally with a CompletionException. Common reasons for failure, listed by the exception reported as the cause, include:

• PermissionsException – if the session does not have VIEW_SECURITY permission;
• SessionClosedException – if the session is closed.

Since:

6.0

scriptBuilder

SystemAuthenticationControl.ScriptBuilder scriptBuilder()

Returns a builder that can be used to create scripts for use with updateStore.

Returns:

an initial builder that creates an empty script