Package com.lexmark.saperion.client.administration

Interface UserClient

All Known Subinterfaces:
UserContextClient
All Known Implementing Classes:
UserClientImpl, UserContextClientImpl
public interface UserClient
This client provides functionality to administrate a given user.
Author:
jschwarz

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
    This method deletes the user.
    void
    deleteExtension()
    This method deletes the schema-extension properties of the user.
    void
    expirePassword()
    This method makes the users password expire.
    List<com.lexmark.saperion.administration.AclReferenceType>
    getACLs()
    This method returns the ACLs currently set on the user.
    default Map<String,com.lexmark.saperion.PropertyType>
    getExtension()
    Deprecated.
    use getSchemaExtension() instead
    Date
    getPasswordExpiration()
    This method gets the date when the users password will expire or null if the password never expires.
    com.lexmark.saperion.administration.ExtensionPropertiesType
    getSchemaExtension()
    This method returns the schema-extension properties of the user.
    com.lexmark.saperion.administration.UserType
    load()
    This method loads the user entity from the user management system.
    default void
    setExtension(Map<String,com.lexmark.saperion.PropertyType> extension)
    Deprecated.
    use setSchemaExtension(ExtensionPropertiesType) instead
    void
    setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension)
    This method sets the schema-extension properties of the user.
    void
    undelete()
    This method un-deletes the user.
    void
    update(com.lexmark.saperion.administration.UserPropertiesType properties)
    This method updates the referenced user with the given properties.
    void
    updatePassword(String password)
    This method updates the password of the user.

  • Method Details

    • delete

      void delete() throws com.lexmark.saperion.exceptions.EcmException
      This method deletes the user.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • undelete

      void undelete() throws com.lexmark.saperion.exceptions.EcmException
      This method un-deletes the user.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • load

      com.lexmark.saperion.administration.UserType load() throws com.lexmark.saperion.exceptions.EcmException
      This method loads the user entity from the user management system. If the user exists the corresponding user entity is returned. Otherwise an exception is thrown.
      Returns:
      the referenced user entity
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • update

      void update(com.lexmark.saperion.administration.UserPropertiesType properties) throws com.lexmark.saperion.exceptions.EcmException
      This method updates the referenced user with the given properties.
      Parameters:
      properties - the properties to change
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • updatePassword

      void updatePassword(String password) throws com.lexmark.saperion.exceptions.EcmException
      This method updates the password of the user.
      Parameters:
      password - the password of the user
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • getPasswordExpiration

      Date getPasswordExpiration() throws com.lexmark.saperion.exceptions.EcmException
      This method gets the date when the users password will expire or null if the password never expires.
      Returns:
      the date when the users password will expire or null if the password never expires
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • expirePassword

      void expirePassword() throws com.lexmark.saperion.exceptions.EcmException
      This method makes the users password expire.
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • setExtension

      @Deprecated default void setExtension(Map<String,com.lexmark.saperion.PropertyType> extension) throws com.lexmark.saperion.exceptions.EcmException
      Deprecated.
      use setSchemaExtension(ExtensionPropertiesType) instead
      This method sets the schema-extension properties of the user. Note that only non-null values will be updated when a schema-extension already exists.
      Parameters:
      extension - schema-extension properties
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be set

    • setSchemaExtension

      void setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension) throws com.lexmark.saperion.exceptions.EcmException
      This method sets the schema-extension properties of the user. Note that only non-null values will be updated when a schema-extension already exists.
      Parameters:
      extension - schema-extension properties
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be set

    • getExtension

      @Deprecated default Map<String,com.lexmark.saperion.PropertyType> getExtension() throws com.lexmark.saperion.exceptions.EcmException
      Deprecated.
      use getSchemaExtension() instead
      This method returns the schema-extension properties of the user.
      Returns:
      schema-extension properties of the user
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be loaded

    • getSchemaExtension

      com.lexmark.saperion.administration.ExtensionPropertiesType getSchemaExtension() throws com.lexmark.saperion.exceptions.EcmException
      This method returns the schema-extension properties of the user.
      Returns:
      schema-extension properties of the user
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be loaded

    • deleteExtension

      void deleteExtension() throws com.lexmark.saperion.exceptions.EcmException
      This method deletes the schema-extension properties of the user.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be deleted

    • getACLs

      List<com.lexmark.saperion.administration.AclReferenceType> getACLs() throws com.lexmark.saperion.exceptions.EcmException
      This method returns the ACLs currently set on the user.
      Returns:
      the ACLs currently set on the user
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when loading the ACLs failed