org.cyclos.impl.access

Interface AuthHandler

public interface AuthHandler

Handles authentication and authorization for the current logged user

Author:

luis

Method Summary

Modifier and Type	Method and Description
java.util.Collection<?>	getRequiredValues(Permission permission) Returns the required values to be enforced on the given permission.
boolean	isAdminOf(User admin, BasicUser user) Returns whether the given user is an administrator of the given user
boolean	isBrokerOf(User broker, BasicUser user) Returns whether the given user is a broker of the given user
boolean	manages(BasicUser manager, BasicUser basicUser) Returns whether the first user manages the second user
org.cyclos.impl.access.UserPermissionCheck	permission(BasicUser user) Returns an UserPermissionCheck for the logged user over the given user
org.cyclos.impl.access.PermissionCheck	permission(Permission permission) Returns a PermissionCheck for the logged user with a permission which is not related to users
org.cyclos.impl.access.UserPermissionCheck	permissionOptionalValue(BasicUser user) Returns an UserPermissionCheck for the logged user over the given user, optionally checking related values
org.cyclos.impl.access.PermissionCheck	permissionOptionalValue(Permission permission) Returns a PermissionCheck which can check any type of permission and, optionally, related values.
boolean	relatesTo(BasicUser basicUser, BasicUser related) Returns whether the first user is related to (is allowed to view) the second user
boolean	requiresValues(Permission permission) Returns whether the given permission would require a value check for the currently logged user

Method Detail

getRequiredValues

java.util.Collection<?> getRequiredValues(Permission permission)

Returns the required values to be enforced on the given permission. Required values are obtained from permissions which are granted / denied according to a collection of related entities on products. For example, the permission to perform a payment comes from having related payment types.

isAdminOf

boolean isAdminOf(User admin,
                  BasicUser user)

Returns whether the given user is an administrator of the given user

isBrokerOf

boolean isBrokerOf(User broker,
                   BasicUser user)

Returns whether the given user is a broker of the given user

manages

boolean manages(BasicUser manager,
                BasicUser basicUser)

Returns whether the first user manages the second user

permission

org.cyclos.impl.access.UserPermissionCheck permission(BasicUser user)

Returns an UserPermissionCheck for the logged user over the given user

permission

org.cyclos.impl.access.PermissionCheck permission(Permission permission)

Returns a PermissionCheck for the logged user with a permission which is not related to users

permissionOptionalValue

org.cyclos.impl.access.UserPermissionCheck permissionOptionalValue(BasicUser user)

Returns an UserPermissionCheck for the logged user over the given user, optionally checking related values

permissionOptionalValue

org.cyclos.impl.access.PermissionCheck permissionOptionalValue(Permission permission)

Returns a PermissionCheck which can check any type of permission and, optionally, related values. Never checks users.

relatesTo

boolean relatesTo(BasicUser basicUser,
                  BasicUser related)

Returns whether the first user is related to (is allowed to view) the second user

requiresValues

boolean requiresValues(Permission permission)

Returns whether the given permission would require a value check for the currently logged user