Class DatarouterUserDeprovisioningStrategy

java.lang.Object
io.datarouter.auth.service.deprovisioning.DatarouterUserDeprovisioningStrategy
All Implemented Interfaces:
UserDeprovisioningStrategy

@Singleton
public class DatarouterUserDeprovisioningStrategy
extends java.lang.Object
implements UserDeprovisioningStrategy
  • Constructor Summary

    Constructors 
    Constructor Description
    DatarouterUserDeprovisioningStrategy()  
  • Method Summary

    Modifier and Type Method Description
    java.util.List<java.lang.String> deprovisionUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
    for each username, removes all permissions, deletes or invalidates all sessions, and sets the user to disabled.
    java.util.List<java.lang.String> flagUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
    flag users for later manual deprovisioning.
    java.util.List<java.lang.String> restoreUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
    restores previously deprovisioned users.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • flagUsers

      public java.util.List<java.lang.String> flagUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
      Description copied from interface: UserDeprovisioningStrategy
      flag users for later manual deprovisioning. should be fault tolerant for usernames that do not exist.
      Specified by:
      flagUsers in interface UserDeprovisioningStrategy
      Parameters:
      usernames - to flag
      editorUsername - (if manually triggered)
      Returns:
      returns the successfully flagged usernames
    • deprovisionUsers

      public java.util.List<java.lang.String> deprovisionUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
      Description copied from interface: UserDeprovisioningStrategy
      for each username, removes all permissions, deletes or invalidates all sessions, and sets the user to disabled. should be fault tolerant for usernames that do not exist.
      Specified by:
      deprovisionUsers in interface UserDeprovisioningStrategy
      Parameters:
      usernames - to deprovision
      editorUsername - (if manually triggered)
      Returns:
      returns the successfully deprovisioned usernames
    • restoreUsers

      public java.util.List<java.lang.String> restoreUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
      Description copied from interface: UserDeprovisioningStrategy
      restores previously deprovisioned users. should be fault tolerant for usernames that do not exist or are not in a restorable state.
      Specified by:
      restoreUsers in interface UserDeprovisioningStrategy
      Parameters:
      usernames - to restore, which were previously deprovisioned using UserDeprovisioningStrategy.deprovisionUsers(List, Optional)
      editorUsername - (if manually triggered)
      Returns:
      returns the successfully restored usernames