com.netflix.iep.userservice

Interface UserService

All Known Implementing Classes:

HttpUserService

public interface UserService

Service for tracking the set of valid users (email addresses) available in the environment. This is typically used for validation in use-cases where we should only have known good addresses.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	emailAddresses() Returns the set of all email addresses.
default boolean	isValidEmail(java.lang.String email) Checks to see if an email address is valid for this service.
default java.lang.String	toValidEmail(java.lang.String email) Attempts to convert a given email address to a valid address for this service.

Method Detail

emailAddresses

java.util.Set<java.lang.String> emailAddresses()

Returns the set of all email addresses.

isValidEmail

default boolean isValidEmail(java.lang.String email)

Checks to see if an email address is valid for this service.

Parameters:

email - The email address to check. This may not be an exact match for an address in the set returned by emailAddresses(). In particular, subaddresses will not be in the set, but will be indicated as valid.

Returns:

True if the email is valid based on the set of available addresses for this service.

toValidEmail

default java.lang.String toValidEmail(java.lang.String email)

Attempts to convert a given email address to a valid address for this service. By default it will simply check if the provided email is valid and return it without modification. Some implementations may also support replacing old mailing lists or departed users with replacements.

Parameters:

email - The email address to convert.

Returns:

Valid email or null if none could be found.