Package com.sap.cds.services.request

Interface ModifiableUserInfo

All Superinterfaces:
UserInfo
public interface ModifiableUserInfo extends UserInfo
Interface to modify the values of a UserInfo used in a RequestContext..

  • Method Details

    • setId

      ModifiableUserInfo setId(String id)
      Sets the ID of the user.
      Parameters:
      id - The ID to set.
      Returns:
      The same User.

    • setName

      ModifiableUserInfo setName(String name)
      Sets the name of the user which is used for $user to uniquely identify.
      Parameters:
      name - The name to set.
      Returns:
      The same User.

    • setTenant

      ModifiableUserInfo setTenant(String tenant)
      Sets the tenant of the user.
      Parameters:
      tenant - The tenant to set.
      Returns:
      The same User.

    • addRole

      ModifiableUserInfo addRole(String role)
      Adds a role to the user.
      Parameters:
      role - The role to add.
      Returns:
      The same User.

    • removeRole

      ModifiableUserInfo removeRole(String role)
      Removes a role from the user.
      Parameters:
      role - The role to remove.
      Returns:
      The same User.

    • setRoles

      ModifiableUserInfo setRoles(Set<String> roles)
      Sets the roles of the user. null is allowed.
      Parameters:
      roles - The roles to set.
      Returns:
      The same User.

    • setAttributeValues

      ModifiableUserInfo setAttributeValues(String attribute, List<String> values)
      Sets the value list of an attribute of the user. null is allowed.
      Parameters:
      attribute - The name of the attribute.
      values - The values of the attribute.
      Returns:
      The same User.

    • setAttributes

      ModifiableUserInfo setAttributes(Map<String,List<String>> attributes)
      Sets an attribute value of the user. null is allowed.
      Parameters:
      attributes - The attributes to set.
      Returns:
      The same User.

    • setUnrestrictedAttributes

      @Deprecated ModifiableUserInfo setUnrestrictedAttributes(Set<String> attributes)
      Deprecated.
      Parameters:
      attributes - The name attributes to set as unrestricted.
      Returns:
      The same User.

    • addUnrestrictedAttribute

      @Deprecated ModifiableUserInfo addUnrestrictedAttribute(String attribute)
      Deprecated.
      Adds the attribute from the list of unrestricted attributes.
      Parameters:
      attribute - The name of the attribute.
      Returns:
      The same User.

    • removeUnrestrictedAttribute

      @Deprecated ModifiableUserInfo removeUnrestrictedAttribute(String attribute)
      Deprecated.
      Removes the attribute from the list of unrestricted attributes.
      Parameters:
      attribute - The name of the attribute.
      Returns:
      The same User.

    • setAdditionalAttributes

      ModifiableUserInfo setAdditionalAttributes(Map<String,Object> additionalAttributes)
      Sets the additional attributes.
      Parameters:
      additionalAttributes - The attributes
      Returns:
      The same User.

    • setAdditionalAttribute

      ModifiableUserInfo setAdditionalAttribute(String name, Object value)
      Sets additional attributes.
      Parameters:
      name - The name of the attribute
      value - The value of the attribute
      Returns:
      The same User.

    • setIsAuthenticated

      ModifiableUserInfo setIsAuthenticated(boolean val)
      Specifies if the current user is an authenticated (i.e. business) user.
      Parameters:
      val - The new value
      Returns:
      The same User.

    • setIsSystemUser

      ModifiableUserInfo setIsSystemUser(boolean val)
      Specifies if the current user is a system user.
      Parameters:
      val - The new value
      Returns:
      The same User.

    • setIsInternalUser

      ModifiableUserInfo setIsInternalUser(boolean val)
      Specifies if the current user is an internal user.
      Parameters:
      val - The new value
      Returns:
      The same User.