io.aeron.samples.archive

Class SampleAuthorisationService

java.lang.Object

io.aeron.samples.archive.SampleAuthorisationService

All Implemented Interfaces:

AuthorisationService

public class SampleAuthorisationService
extends Object
implements AuthorisationService

Trivial authorisation service that allows a set of US-ASCII encoded principals access to all services.

Field Summary

Fields inherited from interface io.aeron.security.AuthorisationService

ALLOW_ALL, DENY_ALL

Constructor Summary

Constructors

Constructor and Description
SampleAuthorisationService(Collection<String> allowedPrincipals) Create with a collection of principals that are allowed access to resources governed by this service.

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

Constructor Detail

SampleAuthorisationService

public SampleAuthorisationService(Collection<String> allowedPrincipals)

Create with a collection of principals that are allowed access to resources governed by this service.

Parameters:

allowedPrincipals - the collection of principals allow to access servivce

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.