Package lumis.portal.webservice.user

Class UserService

  • public class UserService
extends java.lang.Object
    Web Service class for User operations.
    Since:
    4.0.9
    Version:
    $Revision$ $Date$

    • Constructor Summary

      Constructors 
      Constructor Description
      UserService()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String add​(java.lang.String sessionId, User user, java.lang.String password)
      Add a user to portal and returns its identifier.
      void delete​(java.lang.String sessionId, java.lang.String userId)
      Delete a user
      User get​(java.lang.String sessionId, java.lang.String userId)
      Get a User object by its identifier
      java.lang.String getUserIdByLogin​(java.lang.String sessionId, java.lang.String login)
      Get a user identifier by its login
      void setPassword​(java.lang.String sessionId, java.lang.String userId, java.lang.String password)
      Change a user's password
      void update​(java.lang.String sessionId, User user)
      Update a user's data.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UserService

        public UserService()

    • Method Detail

      • add

        public java.lang.String add​(java.lang.String sessionId,
                            User user,
                            java.lang.String password)
                     throws WebServicePortalFault
        Add a user to portal and returns its identifier.
        Parameters:
        sessionId - session identifier
        user - user data to be added
        password - password of user being added
        Returns:
        identifier (userId) of the added user
        Throws:
        WebServicePortalFault - if the operation failed.

      • update

        public void update​(java.lang.String sessionId,
                   User user)
            throws WebServicePortalFault
        Update a user's data.
        Parameters:
        sessionId - session identifier
        user - user data to be updated
        Throws:
        WebServicePortalFault - if the operation failed.

      • delete

        public void delete​(java.lang.String sessionId,
                   java.lang.String userId)
            throws WebServicePortalFault
        Delete a user
        Parameters:
        sessionId - session identifier
        userId - identifier of user to be deleted
        Throws:
        WebServicePortalFault - if the operation failed.

      • get

        public User get​(java.lang.String sessionId,
                java.lang.String userId)
         throws WebServicePortalFault
        Get a User object by its identifier
        Parameters:
        sessionId - session identifier
        userId - identifier of the user to get
        Returns:
        user object
        Throws:
        WebServicePortalFault - if the operation failed.

      • getUserIdByLogin

        public java.lang.String getUserIdByLogin​(java.lang.String sessionId,
                                         java.lang.String login)
                                  throws WebServicePortalFault
        Get a user identifier by its login
        Parameters:
        sessionId - session identifier
        login - user login
        Returns:
        user identifier
        Throws:
        WebServicePortalFault - if the operation failed.

      • setPassword

        public void setPassword​(java.lang.String sessionId,
                        java.lang.String userId,
                        java.lang.String password)
                 throws WebServicePortalFault
        Change a user's password
        Parameters:
        sessionId - session identifier
        userId - user identifier
        password - new user's password
        Throws:
        WebServicePortalFault - if the operation failed.