PasswordExpiredException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.inductiveautomation.ignition.gateway.user.PasswordExpiredException

All Implemented Interfaces:: Serializable

public class PasswordExpiredException extends Exception

Throw this from UserSourceProfile.authenticate(AuthChallenge) if the password was correct but expired.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

PasswordExpiredException()

PasswordExpiredException(String userSource)

PasswordExpiredException(String userSource, String username)
Method Summary

Modifier and Type

Method

Description

Optional<String>

getUsername()

Optional<String>

getUserSource()

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- PasswordExpiredException
  
  public PasswordExpiredException()
- PasswordExpiredException
  
  public PasswordExpiredException(@Nullable String userSource)
- PasswordExpiredException
  
  public PasswordExpiredException(@Nullable String userSource, @Nullable String username)
Method Details
- getUserSource
  
  public Optional<String> getUserSource()
  
  Returns:
  
  an Optional containing the name of the user source profile containing the user whose password has expired, in case the user's password has expired in a failover user source. if the Optional is empty, the same user source used for authentication which threw this exception.
- getUsername
  
  public Optional<String> getUsername()