io.aeron.security

Class SimpleAuthorisationService.Builder

java.lang.Object

io.aeron.security.SimpleAuthorisationService.Builder

Enclosing class:

SimpleAuthorisationService

public static class SimpleAuthorisationService.Builder
extends Object

Builder to create the authorisation service.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SimpleAuthorisationService.Builder	addGeneralRule(int protocolId, boolean isAllowed) Add rule for all principals that is scoped to a protocolId.
SimpleAuthorisationService.Builder	addGeneralRule(int protocolId, int actionId, boolean isAllowed) Add rule for all principals that is scoped to a protocolId and actionId.
SimpleAuthorisationService.Builder	addGeneralRule(int protocolId, int actionId, Object type, boolean isAllowed) Add rule for all principals that is scoped to a protocolId, actionId and type.
SimpleAuthorisationService.Builder	addPrincipalRule(int protocolId, byte[] encodedPrincipal, boolean isAllowed) Add rule for a specific principal that is scope to a protocolId.
SimpleAuthorisationService.Builder	addPrincipalRule(int protocolId, int actionId, byte[] encodedPrincipal, boolean isAllowed) Add rule for a specific principal that is scope to a protocolId and actionId.
SimpleAuthorisationService.Builder	addPrincipalRule(int protocolId, int actionId, Object type, byte[] encodedPrincipal, boolean isAllowed) Add rule for a specific principal that is scope to a protocolId, actionId, and type.
SimpleAuthorisationService.Builder	defaultAuthorisation(AuthorisationService defaultAuthorisation) Set the default authorisation if the authorisation request does not match any of the supplied rules.
SimpleAuthorisationService	newInstance() Create and instance of the SimpleAuthorisationService.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

defaultAuthorisation

public SimpleAuthorisationService.Builder defaultAuthorisation(AuthorisationService defaultAuthorisation)

Set the default authorisation if the authorisation request does not match any of the supplied rules.

Parameters:

defaultAuthorisation - an authorisation service to fall back to.

Returns:

this for a fluent API

See Also:

AuthorisationService.ALLOW_ALL, AuthorisationService.DENY_ALL

addPrincipalRule

public SimpleAuthorisationService.Builder addPrincipalRule(int protocolId,
                                                           int actionId,
                                                           Object type,
                                                           byte[] encodedPrincipal,
                                                           boolean isAllowed)

Add rule for a specific principal that is scope to a protocolId, actionId, and type.

Parameters:

protocolId - sbe:messageSchema@id value that the rule applies to.

actionId - sbe:message@id value that the rule applies to.

type - a parameter of the message can be used to narrow the scope of the authorisation rule. This is message dependent.

encodedPrincipal - The principal encoded as byte array.

isAllowed - If the rule should allow or deny access.

Returns:

this for a fluent API.

addPrincipalRule

public SimpleAuthorisationService.Builder addPrincipalRule(int protocolId,
                                                           int actionId,
                                                           byte[] encodedPrincipal,
                                                           boolean isAllowed)

Add rule for a specific principal that is scope to a protocolId and actionId.

Parameters:

protocolId - sbe:messageSchema@id value that the rule applies to.

actionId - sbe:message@id value that the rule applies to.

encodedPrincipal - The principal encoded as byte array.

isAllowed - If the rule should allow or deny access.

Returns:

this for a fluent API.

addPrincipalRule

public SimpleAuthorisationService.Builder addPrincipalRule(int protocolId,
                                                           byte[] encodedPrincipal,
                                                           boolean isAllowed)

Add rule for a specific principal that is scope to a protocolId.

Parameters:

protocolId - sbe:messageSchema@id value that the rule applies to.

encodedPrincipal - The principal encoded as byte array.

isAllowed - If the rule should allow or deny access.

Returns:

this for a fluent API.

addGeneralRule

public SimpleAuthorisationService.Builder addGeneralRule(int protocolId,
                                                         int actionId,
                                                         Object type,
                                                         boolean isAllowed)

Add rule for all principals that is scoped to a protocolId, actionId and type.

Parameters:

protocolId - sbe:messageSchema@id value that the rule applies to.

actionId - sbe:message@id value that the rule applies to.

type - a parameter of the message can be used to narrow the scope of the authorisation rule. This is message dependent.

isAllowed - If the rule should allow or deny access.

Returns:

this for a fluent API.

addGeneralRule

public SimpleAuthorisationService.Builder addGeneralRule(int protocolId,
                                                         int actionId,
                                                         boolean isAllowed)

Add rule for all principals that is scoped to a protocolId and actionId.

Parameters:

protocolId - sbe:messageSchema@id value that the rule applies to.

actionId - sbe:message@id value that the rule applies to.

isAllowed - If the rule should allow or deny access.

Returns:

this for a fluent API.

addGeneralRule

public SimpleAuthorisationService.Builder addGeneralRule(int protocolId,
                                                         boolean isAllowed)

Add rule for all principals that is scoped to a protocolId.

Parameters:

protocolId - sbe:messageSchema@id value that the rule applies to.

isAllowed - If the rule should allow or deny access.

Returns:

this for a fluent API.

newInstance

public SimpleAuthorisationService newInstance()

Create and instance of the SimpleAuthorisationService.

Returns:

new SimpleAuthorisationService.