io.aeron.security

Class SimpleAuthorisationService

java.lang.Object

io.aeron.security.SimpleAuthorisationService

All Implemented Interfaces:

AuthorisationService

public final class SimpleAuthorisationService
extends Object
implements AuthorisationService

Authorisation service that supports setting general and per-principal rules as well as scoping to protocol, action and type. Uses a fluent API to add authorisation rules.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleAuthorisationService.Builder Builder to create the authorisation service.

Field Summary

Fields inherited from interface io.aeron.security.AuthorisationService

ALLOW_ALL, DENY_ALL

Method Summary

Modifier and Type	Method and Description
boolean	isAuthorised(int protocolId, int actionId, Object type, byte[] encodedPrincipal) Checks if the client with authenticated credentials is allowed to perform an operation indicated by the given actionId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isAuthorised

public boolean isAuthorised(int protocolId,
                            int actionId,
                            Object type,
                            byte[] encodedPrincipal)

Checks if the client with authenticated credentials is allowed to perform an operation indicated by the given actionId.

Specified by:

isAuthorised in interface AuthorisationService

Parameters:

protocolId - of the protocol to which the action belongs, e.g. a SBE schema id.

actionId - of the command being checked, e.g. a SBE message template id.

type - optional type for the command being checked, may be null. For example for an admin request in the cluster it will contain AdminRequestType value which denotes the exact kind of the request.

encodedPrincipal - that has been authenticated.

Returns:

true if the client is authorised to execute the action or false otherwise.