Package org.uberfire.security.impl.authz

Class DefaultAuthorizationManager

java.lang.Object

org.uberfire.security.impl.authz.DefaultAuthorizationManager

All Implemented Interfaces:

AuthorizationManager

@ApplicationScoped
public class DefaultAuthorizationManager
extends Object
implements AuthorizationManager

Constructor Summary

Constructors

Constructor	Description
DefaultAuthorizationManager()
DefaultAuthorizationManager(PermissionManager permissionManager)

Method Summary

Modifier and Type	Method	Description
boolean	authorize(String permission, org.jboss.errai.security.shared.api.identity.User user)	It redirects to AuthorizationManager.authorize(String, User, VotingStrategy) using the default voting strategy defined at PermissionManager.
boolean	authorize(String permission, org.jboss.errai.security.shared.api.identity.User user, org.uberfire.security.authz.VotingStrategy votingStrategy)	Check of the given permission has been granted to the user.
boolean	authorize(Permission permission, org.jboss.errai.security.shared.api.identity.User user)	It redirects to AuthorizationManager.authorize(Permission, User, VotingStrategy) using the default voting strategy defined at PermissionManager.
boolean	authorize(Permission permission, org.jboss.errai.security.shared.api.identity.User user, org.uberfire.security.authz.VotingStrategy votingStrategy)	Check of the given permission has been granted to the user.
boolean	authorize(org.uberfire.security.Resource resource, Collection<org.uberfire.security.Contributor> contributors, org.uberfire.security.ResourceAction action, org.jboss.errai.security.shared.api.identity.User user)	It checks whether user is one of the contributors of resource as well permissions to access resource from security admin screen
boolean	authorize(org.uberfire.security.Resource resource, org.jboss.errai.security.shared.api.identity.User user)	It redirects to AuthorizationManager.authorize(Resource, User, VotingStrategy) using the default voting strategy defined at PermissionManager.
boolean	authorize(org.uberfire.security.Resource resource, org.jboss.errai.security.shared.api.identity.User user, org.uberfire.security.authz.VotingStrategy votingStrategy)	Check if the specified user can "access" a given resource.
boolean	authorize(org.uberfire.security.Resource resource, org.uberfire.security.ResourceAction action, org.jboss.errai.security.shared.api.identity.User user)	It redirects to AuthorizationManager.authorize(Resource, ResourceAction, User) using the default voting strategy defined at PermissionManager.
boolean	authorize(org.uberfire.security.Resource resource, org.uberfire.security.ResourceAction action, org.jboss.errai.security.shared.api.identity.User user, org.uberfire.security.authz.VotingStrategy votingStrategy)	Check if the given action can be performed over the specified resource or any of its dependent resource references (see Resource.getDependencies()).
boolean	authorize(org.uberfire.security.ResourceType resourceType, org.uberfire.security.ResourceAction action, org.jboss.errai.security.shared.api.identity.User user)	It redirects to AuthorizationManager.authorize(ResourceType, ResourceAction, User, VotingStrategy) using the default voting strategy defined at PermissionManager.
boolean	authorize(org.uberfire.security.ResourceType resourceType, org.uberfire.security.ResourceAction action, org.jboss.errai.security.shared.api.identity.User user, org.uberfire.security.authz.VotingStrategy votingStrategy)	Check if the given action can be performed over the specified resource or any of its dependent resource references (see Resource.getDependencies()).
PermissionCheck	check(String permission, org.jboss.errai.security.shared.api.identity.User user)	It redirects to AuthorizationManager.check(String, User, VotingStrategy) using the default voting strategy defined at PermissionManager.
PermissionCheck	check(String permission, org.jboss.errai.security.shared.api.identity.User user, org.uberfire.security.authz.VotingStrategy votingStrategy)	Creates a brand new PermissionCheck instance which provides a fluent styled API for checking permissions.
ResourceCheck	check(org.uberfire.security.Resource target, org.jboss.errai.security.shared.api.identity.User user)	It redirects to AuthorizationManager.check(Resource, User, VotingStrategy) using the default voting strategy defined at PermissionManager.
ResourceCheck	check(org.uberfire.security.Resource target, org.jboss.errai.security.shared.api.identity.User user, org.uberfire.security.authz.VotingStrategy votingStrategy)	Creates a brand new ResourceCheck instance which provides a fluent styled API for the checking of restricted actions over Resource instances.
ResourceCheck	check(org.uberfire.security.ResourceType target, org.jboss.errai.security.shared.api.identity.User user)	It redirects to AuthorizationManager.check(ResourceType, User, VotingStrategy) using the default voting strategy defined at PermissionManager.
ResourceCheck	check(org.uberfire.security.ResourceType target, org.jboss.errai.security.shared.api.identity.User user, org.uberfire.security.authz.VotingStrategy votingStrategy)	Creates a brand new ResourceCheck instance which provides a fluent styled API for the checking of restricted actions over a ResourceType.
void	invalidate(org.jboss.errai.security.shared.api.identity.User user)	Invalidate user related authorization data cached

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAuthorizationManager

public DefaultAuthorizationManager()

DefaultAuthorizationManager

@Inject
public DefaultAuthorizationManager(PermissionManager permissionManager)

Method Detail

authorize

public boolean authorize(org.uberfire.security.Resource resource,
                         org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

It redirects to AuthorizationManager.authorize(Resource, User, VotingStrategy) using the default voting strategy defined at PermissionManager.

Specified by:

authorize in interface AuthorizationManager

authorize

public boolean authorize(org.uberfire.security.Resource resource,
                         org.uberfire.security.ResourceAction action,
                         org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

It redirects to AuthorizationManager.authorize(Resource, ResourceAction, User) using the default voting strategy defined at PermissionManager.

Specified by:

authorize in interface AuthorizationManager

authorize

public boolean authorize(org.uberfire.security.Resource resource,
                         Collection<org.uberfire.security.Contributor> contributors,
                         org.uberfire.security.ResourceAction action,
                         org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

It checks whether user is one of the contributors of resource as well permissions to access resource from security admin screen

Specified by:

authorize in interface AuthorizationManager

authorize

public boolean authorize(org.uberfire.security.ResourceType resourceType,
                         org.uberfire.security.ResourceAction action,
                         org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

It redirects to AuthorizationManager.authorize(ResourceType, ResourceAction, User, VotingStrategy) using the default voting strategy defined at PermissionManager.

Specified by:

authorize in interface AuthorizationManager

authorize

public boolean authorize(org.uberfire.security.Resource resource,
                         org.jboss.errai.security.shared.api.identity.User user,
                         org.uberfire.security.authz.VotingStrategy votingStrategy)

Description copied from interface: AuthorizationManager

Check if the specified user can "access" a given resource. The term "access" refers to the ability to be able to reach, read or view a resource. For instance, read a file, view an item in the UI, etc.

Notice the resource may have dependencies (Resource.getDependencies()) to other resources, in such case the resource is only accessible if and only if one of its dependent references is accessible too.

Specified by:

authorize in interface AuthorizationManager

Parameters:

resource - The resource

user - The user instance

votingStrategy - The voting strategy to use when voting is required (users with more than one role and/or group assigned).

Returns:

true if access is granted, false otherwise.

authorize

public boolean authorize(org.uberfire.security.Resource resource,
                         org.uberfire.security.ResourceAction action,
                         org.jboss.errai.security.shared.api.identity.User user,
                         org.uberfire.security.authz.VotingStrategy votingStrategy)

Description copied from interface: AuthorizationManager

Check if the given action can be performed over the specified resource or any of its dependent resource references (see Resource.getDependencies()).

Specified by:

authorize in interface AuthorizationManager

Parameters:

resource - The resource instance to check

action - The action to check. If null then the AuthorizationManager.authorize(Resource, User) method is invoked.

user - The user instance

votingStrategy - The voting strategy to use when voting is required (users with more than one role and/or group assigned).

Returns:

true if the action is granted, false otherwise.

authorize

public boolean authorize(org.uberfire.security.ResourceType resourceType,
                         org.uberfire.security.ResourceAction action,
                         org.jboss.errai.security.shared.api.identity.User user,
                         org.uberfire.security.authz.VotingStrategy votingStrategy)

Description copied from interface: AuthorizationManager

Check if the given action can be performed over the specified resource or any of its dependent resource references (see Resource.getDependencies()).

Specified by:

authorize in interface AuthorizationManager

Parameters:

resourceType - The resource type to check

action - The action to check.

user - The user instance

votingStrategy - The voting strategy to use when voting is required (users with more than one role and/or group assigned).

Returns:

true if the action is granted, false otherwise.

authorize

public boolean authorize(String permission,
                         org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

It redirects to AuthorizationManager.authorize(String, User, VotingStrategy) using the default voting strategy defined at PermissionManager.

Specified by:

authorize in interface AuthorizationManager

authorize

public boolean authorize(Permission permission,
                         org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

It redirects to AuthorizationManager.authorize(Permission, User, VotingStrategy) using the default voting strategy defined at PermissionManager.

Specified by:

authorize in interface AuthorizationManager

authorize

public boolean authorize(String permission,
                         org.jboss.errai.security.shared.api.identity.User user,
                         org.uberfire.security.authz.VotingStrategy votingStrategy)

Description copied from interface: AuthorizationManager

Check of the given permission has been granted to the user.

Specified by:

authorize in interface AuthorizationManager

Parameters:

permission - The name of the permission to check

user - The user instance

votingStrategy - The voting strategy to use when voting is required (users with more than one role and/or group assigned).

Returns:

true if the permission is granted, false otherwise.

authorize

public boolean authorize(Permission permission,
                         org.jboss.errai.security.shared.api.identity.User user,
                         org.uberfire.security.authz.VotingStrategy votingStrategy)

Description copied from interface: AuthorizationManager

Check of the given permission has been granted to the user.

Specified by:

authorize in interface AuthorizationManager

Parameters:

permission - The name of the permission to check

user - The user instance

votingStrategy - The voting strategy to use when voting is required (users with more than one role and/or group assigned).

Returns:

true if the permission is granted, false otherwise.

check

public ResourceCheck check(org.uberfire.security.Resource target,
                           org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

It redirects to AuthorizationManager.check(Resource, User, VotingStrategy) using the default voting strategy defined at PermissionManager.

Specified by:

check in interface AuthorizationManager

check

public ResourceCheck check(org.uberfire.security.Resource target,
                           org.jboss.errai.security.shared.api.identity.User user,
                           org.uberfire.security.authz.VotingStrategy votingStrategy)

Description copied from interface: AuthorizationManager

Creates a brand new ResourceCheck instance which provides a fluent styled API for the checking of restricted actions over Resource instances.

ExampleUsage:

 User user;
   Resource resource;
   AuthorizationManager authzManager;

   boolean result = authzManager.check(resource, user)
      .granted(() -> System.out.println("Access granted"))
      .denied(() -> System.out.println("Access denied"))
      .result();
 
 

Specified by:

check in interface AuthorizationManager

Parameters:

target - The resource to check

votingStrategy - The voting strategy to use when voting is required (users with more than one role and/or group assigned).

Returns:

A AuthorizationCheck instance.

check

public ResourceCheck check(org.uberfire.security.ResourceType target,
                           org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

It redirects to AuthorizationManager.check(ResourceType, User, VotingStrategy) using the default voting strategy defined at PermissionManager.

Specified by:

check in interface AuthorizationManager

check

public ResourceCheck check(org.uberfire.security.ResourceType target,
                           org.jboss.errai.security.shared.api.identity.User user,
                           org.uberfire.security.authz.VotingStrategy votingStrategy)

Description copied from interface: AuthorizationManager

Creates a brand new ResourceCheck instance which provides a fluent styled API for the checking of restricted actions over a ResourceType.

ExampleUsage:

 User user;
   AuthorizationManager authzManager;

   boolean result = authzManager.check(ActivityResourceType.PERSPECTIVE, user)
      .granted(() -> System.out.println("Access granted"))
      .denied(() -> System.out.println("Access denied"))
      .result();
 
 

Specified by:

check in interface AuthorizationManager

Parameters:

target - The resource type to check

votingStrategy - The voting strategy to use when voting is required (users with more than one role and/or group assigned).

Returns:

A AuthorizationCheck instance.

check

public PermissionCheck check(String permission,
                             org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

It redirects to AuthorizationManager.check(String, User, VotingStrategy) using the default voting strategy defined at PermissionManager.

Specified by:

check in interface AuthorizationManager

check

public PermissionCheck check(String permission,
                             org.jboss.errai.security.shared.api.identity.User user,
                             org.uberfire.security.authz.VotingStrategy votingStrategy)

Description copied from interface: AuthorizationManager

Creates a brand new PermissionCheck instance which provides a fluent styled API for checking permissions.

ExampleUsage:

 User user;
   AuthorizationManager authzManager;

   boolean result = authzManager.check("myfeature", user)
      .granted(() -> System.out.println("Access granted"))
      .denied(() -> System.out.println("Access denied"))
      .result();
 
 

Specified by:

check in interface AuthorizationManager

Parameters:

permission - The name of the permission to check

votingStrategy - The voting strategy to use when voting is required (users with more than one role and/or group assigned).

Returns:

A AuthorizationCheck instance.

invalidate

public void invalidate(org.jboss.errai.security.shared.api.identity.User user)

Description copied from interface: AuthorizationManager

Invalidate user related authorization data cached

Specified by:

invalidate in interface AuthorizationManager

Parameters:

user - user to invalidate cache