Sirius.server.middleware.interfaces.proxy

Interface UserService

All Superinterfaces:

Remote

All Known Subinterfaces:

CallServerService

All Known Implementing Classes:

DomainServerCallServerService, ProxyImpl, RESTfulInterfaceConnector, RESTfulSerialInterfaceConnector

public interface UserService
extends Remote

encapsulates methods relatad to user management.

Version:

$Revision$, $Date$

Method Summary

Modifier and Type	Method and Description
boolean	changePassword(User user, String oldPassword, String newPassword) Deprecated.
boolean	changePassword(User user, String oldPassword, String newPassword, de.cismet.connectioncontext.ConnectionContext context) changes users password.
String	getConfigAttr(User user, String key) Deprecated.
String	getConfigAttr(User user, String key, de.cismet.connectioncontext.ConnectionContext context) Retrieves the value for the given key for the given User.
Key	getPublicJwtKey(String domain) DOCUMENT ME!
User	getUser(String userGroupLsName, String userGroupName, String userLsName, String userName, String password) Deprecated.
User	getUser(String userGroupLsName, String userGroupName, String userLsName, String userName, String password, de.cismet.connectioncontext.ConnectionContext context) retrieves a user token.
Vector	getUserGroupNames() Deprecated.
Vector	getUserGroupNames(de.cismet.connectioncontext.ConnectionContext context) list all available (of domain servers online) usergroups eg admins@altlasten.
Vector	getUserGroupNames(String userName, String lsHome) Deprecated.
Vector	getUserGroupNames(String userName, String lsHome, de.cismet.connectioncontext.ConnectionContext context) list all available (of domain servers online) usergroups eg admins@altlasten for a certain login.
boolean	hasConfigAttr(User user, String key) Deprecated.
boolean	hasConfigAttr(User user, String key, de.cismet.connectioncontext.ConnectionContext context) Determines whether the given User has a value associated with the given key or not.

Method Detail

changePassword

@Deprecated
boolean changePassword(User user,
                                   String oldPassword,
                                   String newPassword)
                            throws RemoteException,
                                   UserException,
                                   PasswordCheckException

Deprecated.

DOCUMENT ME!

Parameters:

user - DOCUMENT ME!

oldPassword - DOCUMENT ME!

newPassword - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

RemoteException - DOCUMENT ME!

UserException - DOCUMENT ME!

PasswordCheckException - DOCUMENT ME!

changePassword

boolean changePassword(User user,
                       String oldPassword,
                       String newPassword,
                       de.cismet.connectioncontext.ConnectionContext context)
                throws RemoteException,
                       UserException,
                       PasswordCheckException

changes users password.

Parameters:

user - user token of the user whose password is to be changed

oldPassword - current password

newPassword - new password

context - DOCUMENT ME!

Returns:

password changed successfully

Throws:

RemoteException - non user related server error

UserException - Sirius.server.newuser.UserException server error (eg wrong current password)

PasswordCheckException - DOCUMENT ME!

getUser

@Deprecated
User getUser(String userGroupLsName,
                         String userGroupName,
                         String userLsName,
                         String userName,
                         String password)
                  throws RemoteException,
                         UserException

Deprecated.

DOCUMENT ME!

Parameters:

userGroupLsName - DOCUMENT ME!

userGroupName - DOCUMENT ME!

userLsName - DOCUMENT ME!

userName - DOCUMENT ME!

password - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

RemoteException - DOCUMENT ME!

UserException - DOCUMENT ME!

getUser

User getUser(String userGroupLsName,
             String userGroupName,
             String userLsName,
             String userName,
             String password,
             de.cismet.connectioncontext.ConnectionContext context)
      throws RemoteException,
             UserException

retrieves a user token.

Parameters:

userGroupLsName - domain of the user group the user belongs to

userGroupName - name of the user group the user belongs to

userLsName - domain where the user is hosted

userName - login of the user

password - password

context - DOCUMENT ME!

Returns:

a user abject (user token)

Throws:

RemoteException - server error (non user dependant)

UserException - Sirius.server.newuser.UserException server error (eg bad login)

getPublicJwtKey

Key getPublicJwtKey(String domain)
             throws RemoteException

DOCUMENT ME!

Parameters:

domain - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

RemoteException - DOCUMENT ME!

getUserGroupNames

@Deprecated
Vector getUserGroupNames()
                              throws RemoteException

Deprecated.

DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

RemoteException - DOCUMENT ME!

getUserGroupNames

Vector getUserGroupNames(de.cismet.connectioncontext.ConnectionContext context)
                  throws RemoteException

list all available (of domain servers online) usergroups eg admins@altlasten.

Parameters:

context - DOCUMENT ME!

Returns:

list of user group names eg admins@altlasen

Throws:

RemoteException - server error (eg no domain servers online)

getUserGroupNames

@Deprecated
Vector getUserGroupNames(String userName,
                                     String lsHome)
                              throws RemoteException

Deprecated.

DOCUMENT ME!

Parameters:

userName - DOCUMENT ME!

lsHome - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

RemoteException - DOCUMENT ME!

getUserGroupNames

Vector getUserGroupNames(String userName,
                         String lsHome,
                         de.cismet.connectioncontext.ConnectionContext context)
                  throws RemoteException

list all available (of domain servers online) usergroups eg admins@altlasten for a certain login.

Parameters:

userName - login name

lsHome - domain where the user login is hosted

context - DOCUMENT ME!

Returns:

list of user group names eg admins@altlasen if userName is member of these user groups

Throws:

RemoteException - server error (bad login)

getConfigAttr

@Deprecated
String getConfigAttr(User user,
                                 String key)
                          throws RemoteException

Deprecated.

DOCUMENT ME!

Parameters:

user - DOCUMENT ME!

key - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

RemoteException - DOCUMENT ME!

getConfigAttr

String getConfigAttr(User user,
                     String key,
                     de.cismet.connectioncontext.ConnectionContext context)
              throws RemoteException

Retrieves the value for the given key for the given User. That means if a user requests a value for a key the value is delivered with the following strategy:

• the value of the User if it is set
• the value of the User's UserGroup if it is set
• the value of the UserGroup's Domain if it is set.
• null otherwise.

If you want to explicitely retrieve the value for the UserGroup though the User's value is set hand over an User object with id < 0.
If you want to explicitely retrieve the value for the Domain though any other value is set hand over an User object with id < 0 that contains a UserGroup object with id < 0.

Parameters:

user - the User whose value shall be retrieved

key - the key for the value to be retrieved

context - DOCUMENT ME!

Returns:

the associated values or null

Throws:

RemoteException - if an internal error occurs

hasConfigAttr

@Deprecated
boolean hasConfigAttr(User user,
                                  String key)
                           throws RemoteException

Deprecated.

DOCUMENT ME!

Parameters:

user - DOCUMENT ME!

key - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

RemoteException - DOCUMENT ME!

hasConfigAttr

boolean hasConfigAttr(User user,
                      String key,
                      de.cismet.connectioncontext.ConnectionContext context)
               throws RemoteException

Determines whether the given User has a value associated with the given key or not. For value retrieval strategy see getConfigAttr(Sirius.server.newuser.User, java.lang.String).

Parameters:

user - the User to be checked

key - the key to be checked

context - DOCUMENT ME!

Returns:

true whether there is a value associated with the given key for the given User, false otherwise.

Throws:

RemoteException - if an internal error occurs

See Also:

getConfigAttr(Sirius.server.newuser.User, java.lang.String)