Package com.logicaldoc.gui.login.client.services

Interface LoginService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
All Known Implementing Classes:
LoginServiceImpl
@RemoteServiceRelativePath("login") public interface LoginService extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the Login Service. This service gives all needed methods to handle the login operations.

  • Method Details

    • changePassword

      GUIValue changePassword(long userId, String oldPassword, String newPassword)
      Changes the password of a user
      Parameters:
      userId - The user Identifier
      oldPassword - can be null or is the old password
      newPassword - the new password
      Returns:
      the error code and message. 0 if all went ok, 1 if the password is incorrect, 2 if the new password cannot be notified, 3 if the password has been already used, otherwise a positive number grater than 3

    • resetPassword

      void resetPassword(String username, String emailAddress, String productName) throws ServerException
      Reset the password for the given email.
      Parameters:
      username - the username for which reset password
      emailAddress - the email for which reset password
      productName - the application product name
      Throws:
      ServerException - error in the server application

    • isSecretKeyRequired

      boolean isSecretKeyRequired(String username, String deviceId) throws ServerException
      Check if a secret key must be provided by the user
      Parameters:
      username - the username trying to login
      deviceId - identifier of the current device
      Returns:
      True only if the user must provide the secret key
      Throws:
      ServerException - if the user is unexisting or any kind of server error

    • getUser

      GUIUser getUser(String username)

    • generatePassword

      String generatePassword(String username)
      Generates a password using the configured policies.
      Parameters:
      username - the current user
      Returns:
      the generated password

    • getLegalsToConfirm

      List<GUIParameter> getLegalsToConfirm(String username) throws ServerException
      Returns the legals the current user is required to confirm
      Parameters:
      username - The user to check
      Returns:
      The legals (name-title)
      Throws:
      ServerException - Error retrieving the legals information

    • confirmLegal

      void confirmLegal(String username, String legal) throws ServerException
      Confirms the reading and understanding of a specific legal
      Parameters:
      username - The user that takes the action
      legal - The name of the legal to confirm
      Throws:
      ServerException - Error marking the legal as read