com.qcadoo.security.api

Interface SecurityService

public interface SecurityService

Service for getting current user.

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
Long	getCurrentUserId() Returns the id of the currently logged in user
String	getCurrentUserName() Returns the name of the currently logged in user
Long	getCurrentUserOrQcadooBotId() Returns the id of the currently logged in user or qcadoo_bot
String	getCurrentUserOrQcadooBotName() Returns the name of the currently logged in user or qcadoo_bot
boolean	hasCurrentUserRole(String targetRoleIdentifier)
boolean	hasRole(Entity userEntity, String targetRoleIdentifier) Checks if given user can access resource with specified access role identifier

Method Detail

getCurrentUserId

Long getCurrentUserId()

Returns the id of the currently logged in user

Returns:

currently logged in user's id

getCurrentUserName

String getCurrentUserName()

Returns the name of the currently logged in user

Returns:

currently logged in user's name

getCurrentUserOrQcadooBotId

Long getCurrentUserOrQcadooBotId()

Returns the id of the currently logged in user or qcadoo_bot

Returns:

currently logged in user's id

getCurrentUserOrQcadooBotName

String getCurrentUserOrQcadooBotName()

Returns the name of the currently logged in user or qcadoo_bot

Returns:

currently logged in user's name

hasCurrentUserRole

boolean hasCurrentUserRole(String targetRoleIdentifier)

hasRole

boolean hasRole(Entity userEntity,
                String targetRoleIdentifier)

Checks if given user can access resource with specified access role identifier

Parameters:

userEntity - user to check

targetRoleIdentifier - resource access role identifier

Returns:

true if given user can access to defined role, false otherwise