Package de.elo.ix.client.plugin

Interface UserDirectory

All Known Subinterfaces:
LdapUserDirectory
public interface UserDirectory
Authenticate a user.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final UserInfo
    NOT_RESPONSIBLE_FOR_AUTHENTICATION
    Used to indicated that this UserDirectory is not responsible for authentication of the given user.

  • Method Summary

    Modifier and Type
    Method
    Description
    UserInfo
    authenticate(String loginName, String password, String runAsName)
    Authenticate a user and optionally return information of a second user.

  • Field Details

    • NOT_RESPONSIBLE_FOR_AUTHENTICATION

      static final UserInfo NOT_RESPONSIBLE_FOR_AUTHENTICATION
      Used to indicated that this UserDirectory is not responsible for authentication of the given user. Used as return value of authenticate(String, String, String). E.g. the ELO user Administrator with ID as 0 is usually not authenticated by a UserDirectory.

  • Method Details

    • authenticate

      UserInfo authenticate(String loginName, String password, String runAsName) throws byps.RemoteException
      Authenticate a user and optionally return information of a second user.
      Parameters:
      loginName - User to authenticate. If runAsName is null or empty, the implementation can decide to create this user in ELO if it does not exist. If a runAsName is supplied, this user must exist in ELO. This parameter can be empty if the implementation provides a default login account.
      password - Password to loginName. Ignored, if loginName is empty.
      runAsName - Return information of this user. The implementation can decide to create this user in ELO if it does not exist. If this parameter is null, the returned object refers to loginName.
      Returns:
      UserInfo object. UserInfo.getName() has to return the unique ELO user name. UserInfo.getId() must return the unique ELO user ID. If this UserDirectory is not responsible for authentication of the user specified by loginName, value NOT_RESPONSIBLE_FOR_AUTHENTICATION is returned.
      Throws:
      byps.RemoteException