Package org.bonitasoft.engine.authorization

Class PermissionServiceImpl

java.lang.Object

org.bonitasoft.engine.authorization.PermissionServiceImpl

All Implemented Interfaces:

PermissionService, LifecycleService, TenantLifecycleService

@Component
@ConditionalOnSingleCandidate(PermissionService.class)
public class PermissionServiceImpl
extends java.lang.Object
implements PermissionService

Permission service implementation

Author:

Baptiste Mesta

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EXTENSION_SEPARATOR
static java.lang.String	PROPERTY_API_EXTENSIONS
static java.lang.String	PROPERTY_CONTENT_TYPE
static java.lang.String	PROPERTY_METHOD_MASK
static java.lang.String	PROPERTY_PATH_TEMPLATE_MASK
static java.lang.String	PROPERTY_PERMISSIONS_MASK
static java.lang.String	RESOURCE_PERMISSION_KEY_MASK
static java.lang.String	RESOURCE_PERMISSION_VALUE
static java.lang.String	RESOURCES_PROPERTY
protected long	tenantId

Fields inherited from interface org.bonitasoft.engine.authorization.PermissionService

PROFILE_TYPE_AUTHORIZATION_PREFIX, SCRIPT_TYPE_AUTHORIZATION_PREFIX, USER_TYPE_AUTHORIZATION_PREFIX

Constructor Summary

Constructors

Constructor	Description
PermissionServiceImpl(ClassLoaderService classLoaderService, SessionAccessor sessionAccessor, SessionService sessionService, long tenantId, CompoundPermissionsMapping compoundPermissionsMapping, ResourcesPermissionsMapping resourcesPermissionsMapping, CustomPermissionsMapping customPermissionsMapping)

Method Summary

Modifier and Type	Method	Description
void	addCustomEntityPermissions(java.lang.String entity, java.util.Set<java.lang.String> resourcePermissions)
void	addPermissions(java.lang.String pageName, java.util.Properties pageProperties)
boolean	checkAPICallWithScript(java.lang.String className, org.bonitasoft.engine.api.permission.APICallContext context, boolean reload)	execute the PermissionRule having the class name in parameter using the given context
protected APIAccessorImpl	createAPIAccessorImpl()
java.util.Set<java.lang.String>	getCustomPagePermissions(java.lang.String declaredPageResources, ResourcesPermissionsMapping resourcesPermissionsMapping)
protected java.util.Set<java.lang.String>	getDeclaredPermissions(java.lang.String apiName, java.lang.String resourceName, java.lang.String method, java.lang.String resourceQualifiers, ResourcesPermissionsMapping resourcesPermissionsMapping)
java.util.Set<java.lang.String>	getResourcePermissions(java.lang.String resourceKey)
SSession	getSession()
boolean	isAuthorized(org.bonitasoft.engine.api.permission.APICallContext apiCallContext)
void	pause()	Temporary halt the execution of this service.
void	removeCustomEntityPermissions(java.lang.String entity)
void	removePermissions(java.util.Properties pageProperties)
void	resume()	resume the execution the service
void	start()	Start the service
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bonitasoft.engine.commons.TenantLifecycleService

init

Field Detail

RESOURCES_PROPERTY

public static final java.lang.String RESOURCES_PROPERTY

See Also:

Constant Field Values

PROPERTY_CONTENT_TYPE

public static final java.lang.String PROPERTY_CONTENT_TYPE

See Also:

Constant Field Values

PROPERTY_API_EXTENSIONS

public static final java.lang.String PROPERTY_API_EXTENSIONS

See Also:

Constant Field Values

PROPERTY_METHOD_MASK

public static final java.lang.String PROPERTY_METHOD_MASK

See Also:

Constant Field Values

PROPERTY_PATH_TEMPLATE_MASK

public static final java.lang.String PROPERTY_PATH_TEMPLATE_MASK

See Also:

Constant Field Values

PROPERTY_PERMISSIONS_MASK

public static final java.lang.String PROPERTY_PERMISSIONS_MASK

See Also:

Constant Field Values

RESOURCE_PERMISSION_KEY_MASK

public static final java.lang.String RESOURCE_PERMISSION_KEY_MASK

See Also:

Constant Field Values

RESOURCE_PERMISSION_VALUE

public static final java.lang.String RESOURCE_PERMISSION_VALUE

See Also:

Constant Field Values

EXTENSION_SEPARATOR

public static final java.lang.String EXTENSION_SEPARATOR

See Also:

Constant Field Values

tenantId

protected final long tenantId

Constructor Detail

PermissionServiceImpl

public PermissionServiceImpl(ClassLoaderService classLoaderService,
                             SessionAccessor sessionAccessor,
                             SessionService sessionService,
                             @Value("${tenantId}")
                             long tenantId,
                             CompoundPermissionsMapping compoundPermissionsMapping,
                             ResourcesPermissionsMapping resourcesPermissionsMapping,
                             CustomPermissionsMapping customPermissionsMapping)

Method Detail

checkAPICallWithScript

public boolean checkAPICallWithScript(java.lang.String className,
                                      org.bonitasoft.engine.api.permission.APICallContext context,
                                      boolean reload)
                               throws SExecutionException,
                                      java.lang.ClassNotFoundException

Description copied from interface: PermissionService

execute the PermissionRule having the class name in parameter using the given context

Specified by:

checkAPICallWithScript in interface PermissionService

Parameters:

className - the class name of the rule to execute

context - the context of the api call to check

reload - reload class when calling this method, warning if some class were called with reload set to false, they will never be reloadable

Returns:

true if the security script allows the user to make the api call

Throws:

SExecutionException

java.lang.ClassNotFoundException

getSession

public SSession getSession()
                    throws SExecutionException

Throws:

SExecutionException

createAPIAccessorImpl

protected APIAccessorImpl createAPIAccessorImpl()

start

public void start()
           throws SBonitaException

Description copied from interface: LifecycleService

Start the service

Specified by:

start in interface LifecycleService

Throws:

SBonitaException

stop

public void stop()

Specified by:

stop in interface LifecycleService

pause

public void pause()

Description copied from interface: LifecycleService

Temporary halt the execution of this service.

Specified by:

pause in interface LifecycleService

resume

public void resume()
            throws SBonitaException

Description copied from interface: LifecycleService

resume the execution the service

Specified by:

resume in interface LifecycleService

Throws:

SBonitaException

isAuthorized

public boolean isAuthorized(org.bonitasoft.engine.api.permission.APICallContext apiCallContext)
                     throws SExecutionException

Specified by:

isAuthorized in interface PermissionService

Throws:

SExecutionException

getDeclaredPermissions

protected java.util.Set<java.lang.String> getDeclaredPermissions(java.lang.String apiName,
                                                                 java.lang.String resourceName,
                                                                 java.lang.String method,
                                                                 java.lang.String resourceQualifiers,
                                                                 ResourcesPermissionsMapping resourcesPermissionsMapping)

addPermissions

public void addPermissions(java.lang.String pageName,
                           java.util.Properties pageProperties)

Specified by:

addPermissions in interface PermissionService

removePermissions

public void removePermissions(java.util.Properties pageProperties)

Specified by:

removePermissions in interface PermissionService

getCustomPagePermissions

public java.util.Set<java.lang.String> getCustomPagePermissions(java.lang.String declaredPageResources,
                                                                ResourcesPermissionsMapping resourcesPermissionsMapping)

getResourcePermissions

public java.util.Set<java.lang.String> getResourcePermissions(java.lang.String resourceKey)

Specified by:

getResourcePermissions in interface PermissionService

addCustomEntityPermissions

public void addCustomEntityPermissions(java.lang.String entity,
                                       java.util.Set<java.lang.String> resourcePermissions)

removeCustomEntityPermissions

public void removeCustomEntityPermissions(java.lang.String entity)