Package com.sas.lsaf.security.user

Class UserDescriptor

java.lang.Object
com.sas.lsaf.core.AbstractIdentifiable
com.sas.lsaf.security.user.UserDescriptor
All Implemented Interfaces:
Identifiable, Principal, Serializable
Direct Known Subclasses:
User
public class UserDescriptor extends AbstractIdentifiable implements Principal
Lightweight representation of a user account defined in the system. A User account has a unique user ID that can be used to login and to identify the user in the system.
Since:
1.2
See Also:

  • Constructor Details

    • UserDescriptor

      public UserDescriptor(String id, String userId, String displayName)
      It is not intended or recommended that the consumer of this API construct these objects. They should only deal with the user descriptors returned by the API.
      Parameters:
      id - the unique identifier of the user account.
      userId - the user identifier of the user account.
      displayName - the display name of the user account.

    • UserDescriptor

      public UserDescriptor(String id, String userId, String displayName, String createdBy, Date created, String lastModifiedBy, Date lastModified)
      It is not intended or recommended that the consumer of this API construct these objects. They should only deal with the user descriptors returned by the API.
      Parameters:
      id - the unique identifier of the user account.
      userId - the user identifier of the user account.
      displayName - the display name of the user account.
      createdBy - The user who created the user.
      created - The date on which the user was created.
      lastModifiedBy - The user who last modified the user.
      lastModified - The date on which the user was last modified.

  • Method Details

    • getUserId

      public String getUserId()
      Returns the user identifier for a user account. User identifiers are unique for each the user account in the system.
      Returns:
      The user identifier for the user account.

    • getDisplayName

      public String getDisplayName()
      Returns the display name for a user account.
      Returns:
      The display name for a user account.

    • setDisplayName

      public void setDisplayName(String displayName)
      Sets the display name for a user account.
      Parameters:
      displayName - the display name for a user account.

    • getPrincipalId

      public String getPrincipalId()
      Description copied from interface: Principal
      Returns the principal identifier of a user or group. This uniquely identifies the principal within the system.
      Specified by:
      getPrincipalId in interface Principal
      Returns:
      The principal identifier of a user or group.

    • getPrincipalName

      public String getPrincipalName()
      Description copied from interface: Principal
      Returns the principal name of a user or group. This may not uniquely identify the principal and should only be used for display purposes.
      Specified by:
      getPrincipalName in interface Principal
      Returns:
      The principal name of a user or group.

    • getCreated

      public Date getCreated()
      Gets the date the user was created.
      Returns:
      The date the user was created.

    • getCreatedBy

      public String getCreatedBy()
      Gets the user who created the user.
      Returns:
      The user who created the user.

    • getLastModified

      public Date getLastModified()
      Gets the date on which the user was last modified.
      Returns:
      The date on which the user was last modified.

    • getLastModifiedBy

      public String getLastModifiedBy()
      Gets the user who last modified the user.
      Returns:
      The user who last modified the user.

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface Principal
      Overrides:
      hashCode in class AbstractIdentifiable

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface Principal
      Overrides:
      equals in class AbstractIdentifiable

    • toString

      public String toString()
      Overrides:
      toString in class AbstractIdentifiable