Package org.openiam.srvc.user

Interface LoginDataWebService

  • All Known Implementing Classes:
    LoginDataWebServiceImpl
    public interface LoginDataWebService
    Web Service Interface to manage the principals that are associated with a user. The login object is largely used for service that use password based authentication.
    Version:
    2.1
    Author:
    Suneet Shah

    • Method Detail

      • isValidLogin

        Response isValidLogin​(Login principal)
        Checks if login is valid.
        Parameters:
        principal - Login to check.
        Returns:
        Response.

      • getLoginByManagedSys

        LoginResponse getLoginByManagedSys​(String pricipal,
                                   String sysId)
        Retrieves LoginResponse for given principal and managedSysId.
        Parameters:
        pricipal - Principal.
        sysId - Managed system Id.
        Returns:
        LoginResponse.

      • getPrimaryIdentity

        LoginResponse getPrimaryIdentity​(String userId)
        Retrieves primary identity for given user Id.
        Parameters:
        userId - User Id.
        Returns:
        LoginResponse.

      • findById

        Login findById​(String loginId)
        Retrieves login for given login Id.
        Parameters:
        loginId - Login Id.
        Returns:
        Login.

      • findBeans

        @Deprecated
List<Login> findBeans​(LoginSearchBean searchBean,
                      int from,
                      int size)
        Deprecated.
        Retrieves Login beans that match given search criteria.
        Parameters:
        searchBean - Search bean used for search criteria.
        from - Index of first bean to retrieve.
        size - Number of beans to retrieve.
        Returns:
        List of Login beans.

      • count

        Integer count​(LoginSearchBean searchBean)
        Counts number of logins that match given search criteria.
        Parameters:
        searchBean - Search bean used for search criteria.
        Returns:
        Number of beans that match search criteria.

      • resetPasswordAndNotifyUser

        Response resetPasswordAndNotifyUser​(String userId,
                                    String managedSysId,
                                    String password,
                                    String contentProviderId,
                                    boolean notifyUserViaEmail,
                                    boolean doActivateUser,
                                    boolean resetPasswordAlongWithRelatedAccounts)
        Parameters:
        userId - User Id.
        managedSysId - Managed system Id.
        password - Password.
        contentProviderId - Content provider Id.
        notifyUserViaEmail - If true user will be notified via email otherwise no.
        doActivateUser -
        resetPasswordAlongWithRelatedAccounts -
        Returns:

      • encryptPassword

        Response encryptPassword​(String userId,
                         String password)
        Encrypts the password string.
        Parameters:
        userId - User Id.
        password - Password.
        Returns:
        Response.

      • decryptPassword

        StringResponse decryptPassword​(String userId,
                               String password)
        Decrypts password for user with given user Id.
        Parameters:
        userId - User Id.
        password - Password for decryption.
        Returns:
        Response.

      • getLoginByUser

        @Deprecated
LoginListResponse getLoginByUser​(String userId)
        Deprecated.
        Retrieves LoginListResponse for given user Id.
        Parameters:
        userId - User Id.
        Returns:
        LoginListResponse

      • unLockLogin

        Response unLockLogin​(String userId,
                     String managedSysId)
        Unlocks user with given user Id.
        Parameters:
        userId - User Id.
        managedSysId - Managed System Id.
        Returns:
        Response.

      • bulkResetPasswordChangeCount

        Response bulkResetPasswordChangeCount()
        Resets number of times password has been changed to 0 for all users.
        Returns:
        Response.

      • isPasswordEq

        Response isPasswordEq​(String principal,
                      String managedSysId,
                      String newPassword)
        Determines if the new password is equal to the current password that is associated with this principal.
        Parameters:
        principal - Principal.
        managedSysId - Managed system Id.
        newPassword - New password.
        Returns:
        Response.

      • loginExists

        Response loginExists​(String principal,
                     String managedSysId)
        Checks to see if a login exists for a user - domain - managed system combination
        Parameters:
        principal - Principal.
        managedSysId - Managed System Id.
        Returns:
        Response.

      • getLockedUserSince

        LoginListResponse getLockedUserSince​(Date lastExecTime)
        Retrieves users that has been locked since given date.
        Parameters:
        lastExecTime - Date since users has been locked.
        Returns:
        List of locked user logins.

      • getInactiveUsers

        LoginListResponse getInactiveUsers​(int startDays,
                                   int endDays)
        Return the list of users that have not logged in certain number of days.
        Parameters:
        startDays - Start days.
        endDays - End days.
        Returns:
        LoginListResponse.

      • getUserNearPswdExpiration

        LoginListResponse getUserNearPswdExpiration​(int expDays)
        Retrieves list of users whose password will soon expire.
        Parameters:
        expDays -
        Returns:

      • getUsersNearPswdExpiration

        LoginListResponse getUsersNearPswdExpiration()
        Returns a list of Login objects which are nearing expiry depending on PWD_EXP_WARN password attribute If attribute unset, default is assumed to be 5.
        Returns:
        LoginListResponse.

      • forgotUsername

        Response forgotUsername​(String email)
        Sends password to user with registered email.
        Parameters:
        email - Registered user email.
        Returns:
        Response.

      • reindex

        Response reindex​(String id)
        Reindexes a user
        Parameters:
        id -

      • refreshIdentity

        LoginResponse refreshIdentity​(String loginId)
        Refresh user identity
        Parameters:
        loginId -