org.hawkular.accounts.api

Interface OperationService.Setup

All Known Implementing Classes:

OperationServiceImpl.Setup

Enclosing interface:

OperationService

public static interface OperationService.Setup

Convenience builder-style interface for setting up operations with the required roles. When adding roles, all implicit roles are also included. For instance, if a system has two roles, "SuperUser" and "Monitor", and "SuperUser" includes all permissions from "Monitor", then adding "SuperUser" will also add "Monitor". Note that changes are effective only when the persist() is called.

The following example could be used for setting up four operations:

        operationService
          .setup("sample-create")
            .add("Monitor") // adds not only Monitor, but all roles that "include" Monitor
          .commit()

          .setup("sample-read")
            .add("Maintainer") // adds a role with the name "Maintainer" and all roles that include it
          .commit()

          .setup("sample-delete")
            .add(superUser) // using a Role instance
            .add(auditor) // using a Role instance
          .commit()

          .setup("sample-update")
            .add(maintainer, superUser, auditor) // using multiple Role instances at once
          .commit();
     

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
OperationService.Setup	add(Role... roles) Adds new roles for the current operation with identical semantics as add(Role).
OperationService.Setup	add(Role role) Adds a new role for the current operation
OperationService.Setup	add(Role role1, Role role2) Adds new roles for the current operation with identical semantics as add(Role).
OperationService.Setup	add(Role role1, Role role2, Role role3) Adds new roles for the current operation with identical semantics as add(Role).
OperationService.Setup	add(String roleName) Adds a new role for the current operation.
OperationService.Setup	clear() Removes all current roles from the operation.
Operation	make() Instructs the builder that the setup has finished.
OperationService	persist() Instructs the builder that the setup has finished and changes are effectively applied.

Method Detail

add

OperationService.Setup add(Role role)

Adds a new role for the current operation

Parameters:

role - the role to add, cannot be null

Returns:

this

Throws:

IllegalArgumentException - if the role is null

add

OperationService.Setup add(String roleName)

Adds a new role for the current operation. The role is retrieved based on its name. If a role with the given name is not found, an exception is thrown.

Parameters:

roleName - the role name to be retrieved and to added to the operation

Returns:

this

Throws:

IllegalArgumentException - if a role with the given name is not found

add

OperationService.Setup add(Role role1,
                           Role role2)

Adds new roles for the current operation with identical semantics as add(Role).

Parameters:

role1 - the first role to add

role2 - the second role to add

Returns:

this

See Also:

add(Role)

add

OperationService.Setup add(Role role1,
                           Role role2,
                           Role role3)

Adds new roles for the current operation with identical semantics as add(Role).

Parameters:

role1 - the first role to add

role2 - the second role to add

role3 - the third role to add

Returns:

this

See Also:

add(Role)

add

OperationService.Setup add(Role... roles)

Adds new roles for the current operation with identical semantics as add(Role).

Parameters:

roles - the roles to add

Returns:

this

See Also:

add(Role)

clear

OperationService.Setup clear()

Removes all current roles from the operation. Useful if it's known that the current set of roles is invalid and a new set is to be specified.

Returns:

this

persist

OperationService persist()

Instructs the builder that the setup has finished and changes are effectively applied.

Returns:

the Operation related to this setup

make

Operation make()

Instructs the builder that the setup has finished. The changes are applied and the resulting operation is returned.

Returns:

either the provided operation or a newly created one.