Package de.elo.ix.client

Class UserInfo

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.UserInfo
All Implemented Interfaces:
java.io.Serializable
public class UserInfo
extends ValueClass
implements java.io.Serializable

Data class containing the user information data for the user logged in to the Index server. User information includes ID, name, rights, parent, etc.

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:
Serialized Form

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected java.util.List<UserName> availableRoles
    The user can activate this roles.
    protected java.lang.String desc
    User description.
    protected int flags
    User rights.
    protected int flags2
    Second bitset of user rights.
    protected int[] groupList
    The groups the user is a member of.
    protected java.lang.String guid
    GUID
    protected int id
    User identifier
    protected int[] keylist
    Deprecated. 
    protected java.lang.String lastLoginIso
    Last login timestamp (in timezone UTC).
    protected java.util.Map<java.lang.String,​java.lang.String> ldapProperties
    Reserved (LDAP user properties).
    protected java.lang.String name
    User name
    protected int[] orgUnitIds
    Organisation unit IDs.
    protected java.lang.String packageName
    The package name of UserInfo
    protected int parent
    User ID of the users parent (users adminstrator).
    protected java.lang.String pwd
    User password
    protected SessionInfo[] sessions
    The currently active tickets for the user
    protected int superiorId
    ID of the users superior.
    protected java.lang.String tStamp
    Timestamp The format is JJJJ.MM.DD.hh.mm.ss
    protected java.lang.String tStampSync
    Timestamp of this object's last export by the replication.
    protected int type
    User type.
    protected java.lang.String[] userProps
    Reserved (Additional user properties).

    Fields inherited from class byps.BValueClass

    bypsClient, changedMembers, dbHelper, FLAG_SEALED

  • Constructor Summary

    Constructors 
    Constructor Description
    UserInfo()
    Constructor
    UserInfo​(int id, java.lang.String name)
    Constructor with initiatisation.
    UserInfo​(UserInfo rhs)
    Copies user information.

  • Method Summary

    Modifier and Type Method Description
    void assign​(UserInfo rhs)
    Copies user information.
    java.util.Map<java.lang.String,​java.lang.String> compareToUserDirectoryStatus​(UserInfo o, java.util.Set<java.lang.Integer> ignoreGroups)
    Compare this object with an object received from a UserDirectory.
    boolean equals​(java.lang.Object obj)  
    java.util.List<UserName> getAvailableRoles()  
    java.lang.String getDesc()  
    int getFlags()  
    int getFlags2()  
    int[] getGroupList()  
    java.lang.String getGuid()  
    int getId()  
    int[] getKeylist()  
    java.lang.String getLastLoginIso()  
    java.util.Map<java.lang.String,​java.lang.String> getLdapProperties()  
    java.lang.String getName()  
    int[] getOrgUnitIds()  
    java.lang.String getPackageName()  
    int getParent()  
    java.lang.String getPwd()  
    SessionInfo[] getSessions()  
    int getSuperiorId()  
    java.lang.String getTStamp()  
    java.lang.String getTStampSync()  
    int getType()  
    java.lang.String[] getUserProps()  
    int hashCode()  
    void setAvailableRoles​(java.util.List<UserName> availableRoles)  
    void setDesc​(java.lang.String desc)  
    void setFlags​(int flags)  
    void setFlags2​(int flags2)  
    void setGroupList​(int[] groupList)  
    void setGuid​(java.lang.String guid)  
    void setId​(int id)  
    void setKeylist​(int[] keylist)  
    void setLastLoginIso​(java.lang.String v)  
    void setLdapProperties​(java.util.Map<java.lang.String,​java.lang.String> ldapProperties)  
    void setName​(java.lang.String name)  
    void setOrgUnitIds​(int[] orgUnitIds)  
    void setPackageName​(java.lang.String packageName)  
    void setParent​(int parent)  
    void setPwd​(java.lang.String pwd)  
    void setSessions​(SessionInfo[] sessions)  
    void setSuperiorId​(int superiorId)  
    void setTStamp​(java.lang.String stamp)  
    void setTStampSync​(java.lang.String tStampSync)  
    void setType​(int type)  
    void setUserProps​(java.lang.String[] userProps)  
    java.lang.String toString()  

    Methods inherited from class byps.BValueClass

    getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • desc

      protected java.lang.String desc
      User description.

    • flags

      protected int flags
      User rights. Possible values are combinations of AccessC.FLAG_* constants.
      See Also:
      AccessC.FLAG_ADMIN

    • groupList

      protected int[] groupList
      The groups the user is a member of.

      It contains all groups the user inherits the rights because of active substitutions (groups which are set in Substitution.groupsToInheritRights).

      See Also:
      UserInfoC.MAX_GROUPS

    • id

      protected int id
      User identifier

    • keylist

      @Deprecated protected int[] keylist
      Deprecated.
      User keys. Array of key access rights. Each item is a combination of the access constants AccessC.LUR_*. The key ID corresponds to the index of the key access item in the key array. A user owns a key, if at least one access constant is included in the key item. Keys do not distinguish between LUR_WRTE and LUR_LIST: LUR_WRITE implies LUR_LIST and v.v.
      See Also:
      AccessC.LUR_READ, UserInfoC.MAX_KEY

    • name

      protected java.lang.String name
      User name

    • parent

      protected int parent
      User ID of the users parent (users adminstrator).

    • pwd

      protected java.lang.String pwd
      User password

    • sessions

      protected SessionInfo[] sessions
      The currently active tickets for the user

    • type

      protected int type
      User type. TYPE_USER for user, TYPE_GROUP for group.
      See Also:
      UserInfoC.TYPE_USER, UserInfoC.TYPE_GROUP

    • userProps

      protected java.lang.String[] userProps
      Reserved (Additional user properties). Index this array with constants named PROP_* in class UserInfoC.
      See Also:
      UserInfoC

    • ldapProperties

      protected java.util.Map<java.lang.String,​java.lang.String> ldapProperties
      Reserved (LDAP user properties). Keys of this map named LDAP_PROP_* in class UserInfoC. All keys are lower case. Mandatory properties - For user: objectGUID, distinguishedName, displayName, sAMAccountName und UserPrincipalName - For group: objectGUID, distinguishedName, name und sAMAccountName
      Since:
      9.00.040.005

    • guid

      protected java.lang.String guid
      GUID
      Since:
      7.00.000.012

    • tStamp

      protected java.lang.String tStamp
      Timestamp The format is JJJJ.MM.DD.hh.mm.ss
      Since:
      7.00.000.013

    • lastLoginIso

      protected java.lang.String lastLoginIso
      Last login timestamp (in timezone UTC). This value is read-only and undefined for groups. Only the date part is valid.
      Since:
      7.00.040.011

    • superiorId

      protected int superiorId
      ID of the users superior. If the user does not have a superior, this value is equal to id.
      Since:
      7.00.040.017

    • flags2

      protected int flags2
      Second bitset of user rights.
      Since:
      7.00.040.017
      See Also:
      flags

    • orgUnitIds

      protected int[] orgUnitIds
      Organisation unit IDs. A user or group can be assigned to at most one organization unit. But due to its group membership a user or group can actually belong to a list of organization units. When writing this UserInfo object, only the first organization unit in the array is taken into account. In order to remove the relationship, set an empty array.
      Since:
      9.00.000.009

    • tStampSync

      protected java.lang.String tStampSync
      Timestamp of this object's last export by the replication.
      Since:
      12.01.001.000

    • availableRoles

      protected java.util.List<UserName> availableRoles
      The user can activate this roles.
      Since:
      20.00.000.003

    • packageName

      protected java.lang.String packageName
      The package name of UserInfo
      Since:
      20.00.000.009

  • Constructor Details

    • UserInfo

      public UserInfo()
      Constructor

    • UserInfo

      public UserInfo​(int id, java.lang.String name)
      Constructor with initiatisation.
      Parameters:
      id - User ID
      name - User name

    • UserInfo

      public UserInfo​(UserInfo rhs)
      Copies user information.
      Parameters:
      rhs - User information to copy from.

  • Method Details

    • assign

      public void assign​(UserInfo rhs)
      Copies user information.
      Parameters:
      rhs - User information to copy from.

    • getDesc

      public java.lang.String getDesc()

    • setDesc

      public void setDesc​(java.lang.String desc)

    • getFlags

      public int getFlags()

    • setFlags

      public void setFlags​(int flags)

    • getGroupList

      public int[] getGroupList()

    • setGroupList

      public void setGroupList​(int[] groupList)

    • getId

      public int getId()

    • setId

      public void setId​(int id)

    • getKeylist

      public int[] getKeylist()

    • setKeylist

      public void setKeylist​(int[] keylist)

    • getName

      public java.lang.String getName()

    • setName

      public void setName​(java.lang.String name)

    • getParent

      public int getParent()

    • setParent

      public void setParent​(int parent)

    • getPwd

      public java.lang.String getPwd()

    • setPwd

      public void setPwd​(java.lang.String pwd)

    • getSessions

      public SessionInfo[] getSessions()

    • setSessions

      public void setSessions​(SessionInfo[] sessions)

    • getType

      public int getType()

    • setType

      public void setType​(int type)

    • getUserProps

      public java.lang.String[] getUserProps()

    • setUserProps

      public void setUserProps​(java.lang.String[] userProps)

    • getGuid

      public java.lang.String getGuid()

    • setGuid

      public void setGuid​(java.lang.String guid)

    • getTStamp

      public java.lang.String getTStamp()

    • setTStamp

      public void setTStamp​(java.lang.String stamp)

    • getTStampSync

      public java.lang.String getTStampSync()

    • setTStampSync

      public void setTStampSync​(java.lang.String tStampSync)

    • getLastLoginIso

      public java.lang.String getLastLoginIso()

    • setLastLoginIso

      public void setLastLoginIso​(java.lang.String v)

    • getSuperiorId

      public int getSuperiorId()

    • setSuperiorId

      public void setSuperiorId​(int superiorId)

    • getFlags2

      public int getFlags2()

    • setFlags2

      public void setFlags2​(int flags2)

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object

    • getOrgUnitIds

      public int[] getOrgUnitIds()

    • setOrgUnitIds

      public void setOrgUnitIds​(int[] orgUnitIds)

    • getLdapProperties

      public java.util.Map<java.lang.String,​java.lang.String> getLdapProperties()

    • setLdapProperties

      public void setLdapProperties​(java.util.Map<java.lang.String,​java.lang.String> ldapProperties)

    • getAvailableRoles

      public java.util.List<UserName> getAvailableRoles()

    • setAvailableRoles

      public void setAvailableRoles​(java.util.List<UserName> availableRoles)

    • getPackageName

      public java.lang.String getPackageName()

    • setPackageName

      public void setPackageName​(java.lang.String packageName)

    • compareToUserDirectoryStatus

      public java.util.Map<java.lang.String,​java.lang.String> compareToUserDirectoryStatus​(UserInfo o, java.util.Set<java.lang.Integer> ignoreGroups)
      Compare this object with an object received from a UserDirectory.
      Parameters:
      o - Object from UserDirectory
      ignoreGroups - Groups to ignore
      Returns:
      Map of different members and their values.