Package com.broadleafcommerce.auth.user.service

Interface UserFieldMappingService<P extends UserFieldMapping>

All Known Implementing Classes:
DefaultUserFieldMappingService
public interface UserFieldMappingService<P extends UserFieldMapping>

  • Method Details

    • readByTenantIdAndAttributeName

      Optional<P> readByTenantIdAndAttributeName(String tenantId, String attributeName)
      Find a user field mapping by tenant ID and attribute name
      Parameters:
      tenantId - the tenant ID
      attributeName - the attribute name
      Returns:
      an optional of user field mapping

    • readByTargetKey

      Optional<P> readByTargetKey(String targetKey)
      Find a user field mapping by target key
      Parameters:
      targetKey - the target key
      Returns:
      an optional of user field mapping

    • readAllByTenantId

      List<P> readAllByTenantId(String tenantId)
      Find all user field mappings for a tenant
      Parameters:
      tenantId - the tenant ID
      Returns:
      a page of user field mappings for the tenant

    • replace

      P replace(String id, P userFieldMapping)
      Replace a user field mapping
      Parameters:
      userFieldMapping - The replacement
      Returns:
      The replaced user field mapping

    • create

      P create(P payload)
      Create a new user field mapping
      Parameters:
      payload - the user field mapping to create
      Returns:
      the created user field mapping

    • delete

      void delete(String id)
      Delete the user field mapping
      Parameters:
      id - the id of the entity to delete

    • clearCache

      void clearCache(String tenantId)
      Clear cached field mappings for the tenant ID.
      Parameters:
      tenantId - The tenant ID to clear