org.hawkular.accounts.api

Interface PermissionChecker

All Known Implementing Classes:

PermissionCheckerImpl

public interface PermissionChecker

Central part of the API, allowing a component to perform permission checking of users against resources. Can be injected via CDI into managed beans as follows:

         @Inject PermissionChecker permissionChecker;
     

Concrete implementations do not hold any state, but it's advised to get an instance through CDI or as an EJB.

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
boolean	isAllowedTo(Operation operation, Resource resource) Checks whether the current Persona has access to perform Operation on the given Resource.
boolean	isAllowedTo(Operation operation, Resource resource, Persona persona) Checks whether the given Persona has access to perform Operation on the given Resource.
boolean	isAllowedTo(Operation operation, String resourceId) Checks whether the current Persona has access to perform Operation on the given Resource.
boolean	isAllowedTo(Operation operation, String resourceId, Persona persona) Checks whether the given Persona has access to perform Operation on the given Resource.

Method Detail

isAllowedTo

boolean isAllowedTo(Operation operation,
                    Resource resource,
                    Persona persona)

Checks whether the given Persona has access to perform Operation on the given Resource.

Parameters:

operation - the operation that is to be performed. Example: "create-metric".

resource - the resource onto which the operation is to be performed. Example: "cpu-usage".

persona - the persona that is about to perform the operation. Example: "jdoe".

Returns:

true if the given persona is allowed to perform the operation on the resource.

Throws:

IllegalArgumentException - if any of the parameters is null

isAllowedTo

boolean isAllowedTo(Operation operation,
                    String resourceId,
                    Persona persona)

Checks whether the given Persona has access to perform Operation on the given Resource. Resource here is referenced by its ID.

Parameters:

operation - the operation that is to be performed. Example: "create-metric".

resourceId - the ID for the resource onto which the operation is to be performed. Example: "cpu-usage".

persona - the persona that is about to perform the operation. Example: "jdoe".

Returns:

true if the given persona is allowed to perform the operation on the resource.

Throws:

IllegalArgumentException - if any of the parameters is null or if the resourceId doesn't references an existing resource.

See Also:

isAllowedTo(Operation, Resource, Persona)

isAllowedTo

boolean isAllowedTo(Operation operation,
                    Resource resource)

Checks whether the current Persona has access to perform Operation on the given Resource.

Parameters:

operation - the operation that is to be performed. Example: "create-metric".

resource - the resource onto which the operation is to be performed. Example: "cpu-usage".

Returns:

true if the current persona is allowed to perform the operation on the resource.

Throws:

IllegalArgumentException - if any of the parameters is null

See Also:

isAllowedTo(Operation, Resource, Persona)

isAllowedTo

boolean isAllowedTo(Operation operation,
                    String resourceId)

Checks whether the current Persona has access to perform Operation on the given Resource. Resource here is referenced by its ID.

Parameters:

operation - the operation that is to be performed. Example: "create-metric".

resourceId - the ID for the resource onto which the operation is to be performed. Example: "cpu-usage".

Returns:

true if the current persona is allowed to perform the operation on the resource.

Throws:

IllegalArgumentException - if any of the parameters is null or if the resourceId doesn't references an existing resource.

See Also:

isAllowedTo(Operation, Resource, Persona)