com.sap.cds.services.request

Interface UserInfo

public interface UserInfo

Interface to fetch user and authorization information.

The current user refers to the authenticated user for whom the request context has been opened. All user information like ids, names, roles, tenant and user attributes are assumed to be verified, i.e. they are secured by adequate means like JWT verification.

Method Summary

Modifier and Type	Method and Description
Stream<String>	getAttribute(String attribute) Returns the verified value of the specified attribute as presented in the request.
String	getId() Returns the verified user id of the request's authenticated user.
String	getName() Returns the verified user name of the request's authenticated user.
String	getTenant() Returns the verified tenant of the request's authenticated user.
boolean	hasRole(String role) Checks if the current user is associated with the specified user role.
boolean	isAuthenticated() Returns true if UserInfo is filled with data of an authenticated user
boolean	isSystemUser() Returns true if the user is a system user and not a named user.

Method Detail

getId

String getId()

Returns the verified user id of the request's authenticated user.

Returns:

The user id

getName

String getName()

Returns the verified user name of the request's authenticated user.

Returns:

The user name

getTenant

String getTenant()

Returns the verified tenant of the request's authenticated user.

Returns:

The tenant of the user

isSystemUser

boolean isSystemUser()

Returns true if the user is a system user and not a named user.

Returns:

true if the user is a system user and not a named user.

hasRole

boolean hasRole(String role)

Checks if the current user is associated with the specified user role.

Parameters:

role - The name of the role

Returns:

true if role is present, false otherwise

getAttribute

Stream<String> getAttribute(String attribute)

Returns the verified value of the specified attribute as presented in the request.

Parameters:

attribute - The name of the attribute

Returns:

The value of the attribute or null if not existing

isAuthenticated

boolean isAuthenticated()

Returns true if UserInfo is filled with data of an authenticated user

Returns:

true if UserInfo is filled with data of an authenticated user