org.openbase.bco.authentication.lib

Class AuthorizationHelper

java.lang.Object

org.openbase.bco.authentication.lib.AuthorizationHelper

public class AuthorizationHelper
extends Object

Helper class to determine the permissions for a given user on a given permission configuration. All methods return the highest permission, i.e. if the permission is true for any level applying to the user, it can't be revoked at any other level and true will be returned.

Author:

Constantin Romankiewicz

Constructor Summary

Constructors

Constructor and Description
AuthorizationHelper()

Method Summary

Modifier and Type	Method and Description
static boolean	canAccess(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig, String userId, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> groups, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locations) Checks whether a user has the permission to access a unit with the given permissionConfig.
static boolean	canRead(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig, String userId, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> groups, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locations) Checks whether a user has the permission to read from a permissionConfig, for example to query information about the unit's state who has this permissionConfig.
static boolean	canWrite(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig, String userId, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> groups, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locations) Checks whether a user has the permission to write to a something with the given permissionConfig, for example to run any action on a unit.
static rst.domotic.authentication.PermissionType.Permission	getPermission(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig, String userId, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> groups, Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locations) Checks all permissions for a user.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationHelper

public AuthorizationHelper()

Method Detail

canRead

public static boolean canRead(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig,
                              String userId,
                              Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> groups,
                              Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locations)
                       throws org.openbase.jul.exception.CouldNotPerformException

Checks whether a user has the permission to read from a permissionConfig, for example to query information about the unit's state who has this permissionConfig.

Parameters:

unitConfig - The unitConfig of the unit the user wants to read.

userId - ID of the user whose permissions should be checked.

groups - All available groups in the system, indexed by their group ID.

locations - All available locations in the system, indexed by their id.

Returns:

True if the user can read from the unit, false if not.

Throws:

org.openbase.jul.exception.CouldNotPerformException - If the permissions could not be checked, probably because of invalid location information.

canWrite

public static boolean canWrite(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig,
                               String userId,
                               Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> groups,
                               Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locations)
                        throws org.openbase.jul.exception.CouldNotPerformException

Checks whether a user has the permission to write to a something with the given permissionConfig, for example to run any action on a unit.

Parameters:

unitConfig - The unitConfig of the unit the user wants to write to.

userId - ID of the user whose permissions should be checked.

groups - All available groups in the system, indexed by their group ID.

locations - All available locations in the system, indexed by their id.

Returns:

True if the user can write to the unit, false if not.

Throws:

org.openbase.jul.exception.CouldNotPerformException - If the permissions could not be checked, probably because of invalid location information.

canAccess

public static boolean canAccess(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig,
                                String userId,
                                Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> groups,
                                Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locations)
                         throws org.openbase.jul.exception.CouldNotPerformException

Checks whether a user has the permission to access a unit with the given permissionConfig.

Parameters:

unitConfig - The unitConfig of the unit the user wants to access.

userId - ID of the user whose permissions should be checked.

groups - All available groups in the system, indexed by their group ID.

locations - All available locations in the system, indexed by their id.

Returns:

True if the user can access the unit, false if not.

Throws:

org.openbase.jul.exception.CouldNotPerformException - If the permissions could not be checked, probably because of invalid location information.

getPermission

public static rst.domotic.authentication.PermissionType.Permission getPermission(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig,
                                                                                 String userId,
                                                                                 Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> groups,
                                                                                 Map<String,org.openbase.jul.extension.protobuf.IdentifiableMessage<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder>> locations)
                                                                          throws org.openbase.jul.exception.CouldNotPerformException

Checks all permissions for a user.

Parameters:

unitConfig - The unitConfig of the unit for which the permissions apply.

userId - ID of the user whose permissions should be checked.

groups - All available groups in the system, indexed by their group ID.

locations - All available locations in the system, indexed by their id.

Returns:

Permission object representing the maximum permissions for the given user on the given unit.

Throws:

org.openbase.jul.exception.CouldNotPerformException - If the permissions could not be checked, probably because of invalid location information.