com.pushtechnology.diffusion.client.features

Interface Security

All Superinterfaces:

Feature

public interface Security
extends Feature

This feature provides a client session with the ability to change its associated principal as well as to query permissions assigned to it.

Access control

There are no permissions requirements associated with this feature. The client provides credentials that authenticate the new principal.

Accessing the feature

This feature may be obtained from a session as follows:

 
 Security security = session.feature(Security.class);
 
 

Since:

5.0

Author:

DiffusionData Limited

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Security.ChangePrincipalCallback Deprecated. since 6.7 Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.
static interface	Security.ChangePrincipalContextCallback<C> Deprecated. since 6.7 Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	changePrincipal(String principal, Credentials credentials) Change the security principal associated with the session.
<C> void	changePrincipal(String principal, Credentials credentials, C context, Security.ChangePrincipalContextCallback<C> callback) Deprecated. since 6.7 Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.
void	changePrincipal(String principal, Credentials credentials, Security.ChangePrincipalCallback callback) Deprecated. since 6.7 Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.
CompletableFuture<Set<GlobalPermission>>	getGlobalPermissions() Query the global permissions assigned to the calling session.
CompletableFuture<Set<PathPermission>>	getPermissionsForPath(String path) Query the path permissions assigned to the calling session on a given path.

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

getSession

Method Detail

changePrincipal

CompletableFuture<Boolean> changePrincipal(String principal,
                                           Credentials credentials)

Change the security principal associated with the session.

Parameters:

principal - the new principal name

credentials - the credentials authenticating the new principal

Returns:

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

If authentication succeeded and the session principal has been changed, the CompletableFuture will complete successfully with a TRUE result.

If authentication failed because the principal was unknown or the credentials were invalid, the session's principal has not changed and the CompletableFuture will complete successfully with a FALSE result.

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

• SessionClosedException – if the session is closed.

Since:

6.0

changePrincipal

@Deprecated
void changePrincipal(String principal,
                                 Credentials credentials,
                                 Security.ChangePrincipalCallback callback)

Deprecated. since 6.7

Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.

Change the security principal associated with the session.

If authentication fails, the session's current principal will not be changed.

Parameters:

principal - the new principal name

credentials - the credentials authenticating the new principal

callback - called on success or failure

changePrincipal

@Deprecated
<C> void changePrincipal(String principal,
                                     Credentials credentials,
                                     C context,
                                     Security.ChangePrincipalContextCallback<C> callback)

Deprecated. since 6.7

Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.

Change the security principal associated with the session.

If authentication fails, the session's current principal will not be changed.

Type Parameters:

C - the context object type

Parameters:

principal - the new principal name

credentials - credentials authenticating the new principal

context - passed to the callback

callback - called on success or failure

getGlobalPermissions

CompletableFuture<Set<GlobalPermission>> getGlobalPermissions()

Query the global permissions assigned to the calling session.

Returns:

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

If the request was successful, the CompletableFuture will complete successfully with the session's global permissions.

Since:

6.3

getPermissionsForPath

CompletableFuture<Set<PathPermission>> getPermissionsForPath(String path)

Query the path permissions assigned to the calling session on a given path.

Parameters:

path - the path to query for permissions

Returns:

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

If the request was successful, the CompletableFuture will complete successfully with the session's permissions for path.

Since:

6.5