io.gravitee.rest.api.service.UserService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-rest-api-service Show documentation
Gravitee IO Manager Service
There is a newer version: 3.10.0
Show newest version
/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gravitee.rest.api.service;

import io.gravitee.common.data.domain.Page;
import io.gravitee.repository.management.api.search.UserCriteria;
import io.gravitee.rest.api.model.*;
import io.gravitee.rest.api.model.common.Pageable;
import io.gravitee.rest.api.model.configuration.identity.SocialIdentityProviderEntity;
import io.gravitee.rest.api.service.common.JWTHelper.ACTION;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

/**
 * @author David BRASSELY (david.brassely at graviteesource.com)
 * @author Nicolas GERAUD (nicolas.geraud at graviteesource.com)
 * @author Azize Elamrani (azize.elamrani at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface UserService {
    UserEntity connect(String userId);

    UserEntity findById(String id, boolean defaultValue);

    default UserEntity findById(String id) {
        return findById(id, false);
    }

    Optional findByEmail(String email);

    UserEntity findByIdWithRoles(String id);

    UserEntity findBySource(String source, String sourceId, boolean loadRoles);

    Set findByIds(List ids);

    Set findByIds(List ids, boolean withUserMetadata);

    UserEntity create(NewExternalUserEntity newExternalUserEntity, boolean addDefaultRole);

    UserEntity update(String userId, UpdateUserEntity updateUserEntity);

    UserEntity update(String userId, UpdateUserEntity updateUserEntity, String newsletterEmail);

    Page search(String query, Pageable pageable);

    Page search(UserCriteria criteria, Pageable pageable);

    UserEntity register(NewExternalUserEntity newExternalUserEntity);

    UserEntity register(NewExternalUserEntity newExternalUserEntity, String confirmationPageUrl);

    UserEntity finalizeRegistration(RegisterUserEntity registerUserEntity);

    UserEntity finalizeResetPassword(ResetPasswordUserEntity registerUserEntity);

    UserEntity processRegistration(String userId, boolean accepted);

    PictureEntity getPicture(String id);

    void delete(String id);

    void resetPassword(String id);

    UserEntity resetPasswordFromSourceId(String sourceId, String resetPageUrl);

    Map getTokenRegistrationParams(UserEntity userEntity, String portalUri, ACTION action);

    Map getTokenRegistrationParams(UserEntity userEntity, String portalUri, ACTION action, String confirmationPageUrl);

    UserEntity create(NewExternalUserEntity newExternalUserEntity);

    UserEntity createOrUpdateUserFromSocialIdentityProvider(SocialIdentityProviderEntity socialProvider, String userInfo);

    void updateUserRoles(String userId, MembershipReferenceType referenceType, String referenceId, List roleIds);
}