Package org.bonitasoft.engine.external.identity.mapping

Interface ExternalIdentityMappingService

  • All Known Implementing Classes:
    ExternalIdentityMappingServiceImpl
    public interface ExternalIdentityMappingService
    Since:
    6.0
    Author:
    Emmanuel Duchastenier, Celine Souchet

    • Method Detail

      • getExternalIdentityMappingForUser

        SExternalIdentityMapping getExternalIdentityMappingForUser​(long mappingId)
                                                    throws SExternalIdentityMappingNotFoundException
        Get externalIdentityMapping by its id with displayNamePart having user related informations
        Parameters:
        mappingId - the identifier of externalIdentityMapping
        Returns:
        the externalIdentityMapping with displayNamePart having userName informations
        Throws:
        SExternalIdentityMappingNotFoundException - error thrown if no externalIdentityMapping have an id corresponding to the parameter.

      • getExternalIdentityMappingForGroup

        SExternalIdentityMapping getExternalIdentityMappingForGroup​(long mappingId)
                                                     throws SExternalIdentityMappingNotFoundException
        Get externalIdentityMapping by its id with displayNamePart having group related informations
        Parameters:
        mappingId - the identifier of externalIdentityMapping
        Returns:
        the externalIdentityMapping with displayNamePart having group related informations
        Throws:
        SExternalIdentityMappingNotFoundException - error thrown if no externalIdentityMapping have an id corresponding to the parameter.

      • getExternalIdentityMappingForRole

        SExternalIdentityMapping getExternalIdentityMappingForRole​(long mappingId)
                                                    throws SExternalIdentityMappingNotFoundException
        Get externalIdentityMapping by its id with displayNamePart having role related informations
        Parameters:
        mappingId - the identifier of externalIdentityMapping
        Returns:
        the externalIdentityMapping with displayNamePart having role related informations
        Throws:
        SExternalIdentityMappingNotFoundException - error thrown if no externalIdentityMapping have an id corresponding to the parameter.

      • getExternalIdentityMappingForRoleAndGroup

        SExternalIdentityMapping getExternalIdentityMappingForRoleAndGroup​(long mappingId)
                                                            throws SExternalIdentityMappingNotFoundException
        Get externalIdentityMapping by its id with displayNamePart having role and group related informations
        Parameters:
        mappingId - the identifier of externalIdentityMapping
        Returns:
        the externalIdentityMapping with displayNamePart having role and group related informations
        Throws:
        SExternalIdentityMappingNotFoundException - error thrown if no externalIdentityMapping have an id corresponding to the parameter.

      • searchExternalIdentityMappings

        java.util.List<SExternalIdentityMapping> searchExternalIdentityMappings​(java.lang.String kind,
                                                                        QueryOptions queryOptions,
                                                                        java.lang.String querySuffix)
                                                                 throws SBonitaReadException
        Get all externalIdentityMappings for specific kind according to the queryOptions. use querySuffix to indicate what the displayNamePart is related to
        Parameters:
        kind - the discriminator of the SExternalIdentityMapping to search for.
        queryOptions - a QueryOptions object containing some query conditions
        querySuffix - The query suffix, it can be "USER", "GROUP", "ROLE", "MEMBERSHIP";
        Returns:
        a list of SExternalIdentityMapping objects matching the criteria.
        Throws:
        SBonitaReadException

      • getNumberOfExternalIdentityMappings

        long getNumberOfExternalIdentityMappings​(java.lang.String kind,
                                         QueryOptions searchOptions,
                                         java.lang.String querySuffix)
                                  throws SBonitaReadException
        Get total number of externalIdentityMappings for specific kind according to the queryOptions.
        Parameters:
        kind - the discriminator of the SExternalIdentityMapping to search for.
        searchOptions - a QueryOptions object containing some query conditions
        querySuffix - the query suffix, it can be "USER", "GROUP", "ROLE", "MEMBERSHIP";
        Returns:
        number of externalIdentityMappings matching the criteria.
        Throws:
        SBonitaReadException

      • searchExternalIdentityMappingsForUser

        java.util.List<SExternalIdentityMapping> searchExternalIdentityMappingsForUser​(java.lang.String kind,
                                                                               long userId,
                                                                               java.lang.String externalId,
                                                                               QueryOptions queryOptions,
                                                                               java.lang.String querySuffix)
                                                                        throws SBonitaReadException
        Search all SExternalIdentityMapping objects associated with the specified externalId and kind for the specific user. Use querySuffix to indicate what the displayNamePart is related to
        Parameters:
        kind - the discriminator of the SExternalIdentityMapping to search for.
        userId - The identifier of user
        externalId - the external Id identifying the SExternalIdentityMappings to search.
        queryOptions - a QueryOptions object containing some query conditions
        querySuffix - the query suffix, it can be "USER", "GROUP", "ROLE", "MEMBERSHIP";
        Returns:
        the list of results matching the criteria.
        Throws:
        SBonitaReadException

      • getNumberOfExternalIdentityMappingsForUser

        long getNumberOfExternalIdentityMappingsForUser​(java.lang.String kind,
                                                long userId,
                                                java.lang.String externalId,
                                                QueryOptions searchOptions,
                                                java.lang.String querySuffix)
                                         throws SBonitaReadException
        Get total number of SExternalIdentityMapping objects associated with the specified externalId and kind for the specific user. Use querySuffix to indicate what the displayNamePart is related to
        Parameters:
        kind - the discriminator of the SExternalIdentityMapping to search for.
        userId - The identifier of user
        externalId - the external Id identifying the SExternalIdentityMappings to search.
        searchOptions - a QueryOptions object containing some query conditions
        querySuffix - the query suffix, it can be "USER", "GROUP", "ROLE", "MEMBERSHIP";
        Returns:
        the number of externalIdentityMappings matching the criteria.
        Throws:
        SBonitaReadException

      • searchExternalIdentityMappings

        java.util.List<SExternalIdentityMapping> searchExternalIdentityMappings​(java.lang.String kind,
                                                                        java.lang.String externalId,
                                                                        QueryOptions queryOptions)
                                                                 throws SBonitaReadException
        Search all SExternalIdentityMapping objects associated with the specified externalId and kind.
        Parameters:
        kind - the discriminator of the SExternalIdentityMapping to search for.
        externalId - the external Id identifying the SExternalIdentityMappings to search.
        queryOptions - a QueryOptions object containing some query conditions
        Returns:
        the list of results matching the criteria.
        Throws:
        SBonitaReadException - in case of search error.