Package com.inductiveautomation.ignition.gateway.user

Class PasswordExpiredException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.inductiveautomation.ignition.gateway.user.PasswordExpiredException

All Implemented Interfaces:

java.io.Serializable

public class PasswordExpiredException
extends java.lang.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(java.lang.String userSource)
PasswordExpiredException(java.lang.String userSource, java.lang.String username)

Method Summary

Modifier and Type	Method	Description
java.util.Optional<java.lang.String>	getUsername()
java.util.Optional<java.lang.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 Detail

PasswordExpiredException

public PasswordExpiredException()

PasswordExpiredException

public PasswordExpiredException(@Nullable
                                java.lang.String userSource)

PasswordExpiredException

public PasswordExpiredException(@Nullable
                                java.lang.String userSource,
                                @Nullable
                                java.lang.String username)

Method Detail

getUserSource

public java.util.Optional<java.lang.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 java.util.Optional<java.lang.String> getUsername()