Package io.datarouter.auth.service

Interface UserDeprovisioningService

All Known Implementing Classes:

DatarouterUserDeprovisioningService, UserDeprovisioningService.NoOpUserDeprovisioningService

public interface UserDeprovisioningService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UserDeprovisioningService.NoOpUserDeprovisioningService
static class	UserDeprovisioningService.ShouldFlagUsersInsteadOfDeprovisioningSupplier	a class that can be used as a helper for implementations

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	deprovisionUsers(java.util.List<java.lang.String> usernames)	for each username, removes all permissions, deletes or invalidates all sessions, and sets the user to disabled.
default java.util.List<java.lang.String>	flagOrDeprovisionUsers(java.util.List<java.lang.String> usernames)	calls flagUsersForDeprovisioning(List) or deprovisionUsers(List) depending on the result of shouldFlagUsersInsteadOfDeprovisioning()
java.util.List<java.lang.String>	flagUsersForDeprovisioning(java.util.List<java.lang.String> usernames)	flag users for later manual deprovisioning.
java.util.List<java.lang.String>	restoreDeprovisionedUsers(java.util.List<java.lang.String> usernames)	restores previously deprovisioned users.
boolean	shouldFlagUsersInsteadOfDeprovisioning()	indicates whether deprovisionUsers(List) users should be flagged for deprovisioning instead of being immediately deprovisioned

Method Details

flagUsersForDeprovisioning

java.util.List<java.lang.String> flagUsersForDeprovisioning(java.util.List<java.lang.String> usernames)

flag users for later manual deprovisioning. should be fault tolerant for usernames that do not exist.

Parameters:

usernames - to flag

Returns:

returns the successfully flagged usernames

deprovisionUsers

java.util.List<java.lang.String> deprovisionUsers(java.util.List<java.lang.String> usernames)

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.

Parameters:

usernames - to deprovision

Returns:

returns the successfully deprovisioned usernames

flagOrDeprovisionUsers

default java.util.List<java.lang.String> flagOrDeprovisionUsers(java.util.List<java.lang.String> usernames)

calls flagUsersForDeprovisioning(List) or deprovisionUsers(List) depending on the result of shouldFlagUsersInsteadOfDeprovisioning()

Parameters:

usernames - to flag or deprovision

Returns:

successfully flagged or deprovisioned usernames

restoreDeprovisionedUsers

java.util.List<java.lang.String> restoreDeprovisionedUsers(java.util.List<java.lang.String> usernames)

restores previously deprovisioned users. should be fault tolerant for usernames that do not exist or are not in a restorable state.

Parameters:

usernames - to restore, which were previously deprovisioned using deprovisionUsers(List)

Returns:

returns the successfully restored usernames

shouldFlagUsersInsteadOfDeprovisioning

boolean shouldFlagUsersInsteadOfDeprovisioning()

indicates whether deprovisionUsers(List) users should be flagged for deprovisioning instead of being immediately deprovisioned

Returns:

true if user should not be immediately deprovisioned