Package com.adobe.granite.security.user

Interface UserPropertiesQueryParams

@ProviderType public interface UserPropertiesQueryParams
Groups together all the criteria and controls that can be used to configure the search for authorizables.

  • Method Details

    • getOffset

      long getOffset()
      Returns the offset of the query.
      Returns:
      The index of the first resulted item to be returned by the query.

    • withOffset

      @Nonnull UserPropertiesQueryParams withOffset(long offset)
      Sets the offset of the query.
      Parameters:
      offset - The index of the first resulted item to be returned by the query.
      Returns:
      this

    • getLimit

      long getLimit()
      Returns the limit of the query.
      Returns:
      The maximum count of items to be returned by the query.

    • withLimit

      @Nonnull UserPropertiesQueryParams withLimit(long limit)
      Sets the limit of the query.
      Parameters:
      limit - The maximum count of items to be returned by the query.
      Returns:
      this

    • getFulltextQuery

      @Nullable String getFulltextQuery()
      Returns the string used during fulltext search.
      Returns:
      The fulltext query string.

    • withFulltextQuery

      @Nonnull UserPropertiesQueryParams withFulltextQuery(@Nullable String fulltextQuery)
      Sets the string used during fulltext search.
      Parameters:
      fulltextQuery - The fulltext query string.
      Returns:
      this

    • getAuthorizableTypes

      @Nullable AuthorizableTypes getAuthorizableTypes()
      Returns the AuthorizableTypes of the query.
      Returns:
      The AuthorizableTypes.

    • withAuthorizableTypes

      @Nonnull UserPropertiesQueryParams withAuthorizableTypes(@Nonnull AuthorizableTypes authorizableTypes)
      Sets the AuthorizableTypes of the query.
      Parameters:
      authorizableTypes - The AuthorizableTypes.
      Returns:
      this

    • getImpersonableUserFilter

      @Nullable Boolean getImpersonableUserFilter()
      Returns whether to filter for the users that the provided user can impersonate:
      Boolean.TRUE
      Include only the users that the provided user can impersonate.
      Boolean.FALSE
      Currently not supported
      null
      No filtering is performed with regards to impersonation.
      When this methods returns a non null value, it is guaranteed that a non null impersonator principal name has been set. Using this feature requires that the user making the call has jcr:read permissions for the authorizable node.
      Returns:
      The Boolean whether to filter the impersonatees.

    • getImpersonatorPrincipalName

      @Nullable String getImpersonatorPrincipalName()
      Gets the name of the user that can or cannot impersonate the users from the query.
      Returns:
      the name of the user or null if no filtering is performed with regards to impersonation.

    • withOnlyUsersThatCanBeImpersonatedBy

      @Nonnull UserPropertiesQueryParams withOnlyUsersThatCanBeImpersonatedBy(@Nullable String impersonatorPrincipalName)
      Sets whether to filter for the users that the provided user can
      Parameters:
      impersonatorPrincipalName - the name of the user that can impersonate the users from the query result. If set to null, no filter will be performed with regards to impersonation
      Returns:
      this